i18n в JSON-коллекциях

Общие задачи

Реализовать систему локализации для JSON-коллекций, загружаемых при upgrade

Описание проблемы 

На настоящий момент в JSON-коллекциях, загружаемых при upgrade отсутсвуют переводы на языки, отличные от английского. Для EventClass и AlarmClass предусмотрен механизм, позволяющий задать разные варанты перевода. Но он жестко зашит в код, не предусматривает каких-либо инструментов для локализаторов за исключением ручной правки JSON. Кроме того, все переводы устанавливаются в базу и извлекаются из MongoDB при каждом обращении к event class. Кроме того, отсутсвует механизм поиска по локализованным сообщениям.

Общие предположения

• Механизм должен выбирать сообщение на правильном языке в момент запуска upgrade и записывать его как обычное текстовое поле
• Любое текстовое поле имеет право на локализацию
• Локализаторы могут быть незнакомы с синтакисисом JSON
• Переводчики на разные языки могут быть не связаны друг с другом
• JSON-файлы создаются разными людьми и поступают в проект разными способами
• Помимо записей, импортированных из JSON каждая база NOC в процессе работы пополняется локально. Часть изменений может вернуться в проект
• В качестве базового языка для текста по историческим причинам принят английский (в королевском варианте)
• Список поддерживаемых переводов будет расти

Требования

Общий дизайн

Дополнительные соглашения при обработки JSON

Вместо текстового значения атрибута может быть указан особым образом сформатированый dict. Например

...
   "subject": "Link down"
...

может быть заменено на

...
   "subject": {
		"$i18n": {
			"en": "Link down",
			"ru": "Упал линк"
		}
	},

Признаками наличия переводов являюется:

• dict вместо строки
• единственный ключ $i18n в dict
• наличие ключа en во вложенном dict

Настройки

В noc.conf

[i18n]
collection.global = ua,ru,en
collection.fm.eventclasses = en
 
collection.global.allow_fuzzy = true
collection.gm.eventclasses.allow_fuzzy = false

Опция collection.global задает глобальные настройки для всех коллекций. Языки указываются через запятую, наиболее предпочтительными является первый в списке. В качестве fallback всегда используется английский (код en)

Настройки для коллекции перебивают глобальные.

Дополнительно настраивается возможность использования неточного перевода (allow_fuzzy), как глобально, так и на уровне коллекции

fuzzy translation

При изменении текста для первичного языка (en) все остальные переводы помечаются как нечеткие (fuzzy). Нечеткий перевод требует дополнительной проверки со стороны локализаторов, в противном случае смысл перевода может быть сильно искажен.

нечеткие переводы помечены соответсвующим префиксом.

...
   "subject": {
		"$i18n": {
			"en": "Network Link down",
			"ru": "[FUZZY] Упал линк"
		}
	},

При установке в базу префикс FUZZY удаляется и далее нигде, кроме JSON, не фигурирует.

upgrade

Upgrade строит список предпочтительных языков для коллекции. Процесс upgrade происходит в штатном режиме за одним исключением – если в качестве значения поля указан dict c размером в один ключ со значением $i18n, который в свою очередь также является dict, содержащим, как минимум, ключ en, то upgrade переходит в режим поиска перевода.

Upgrade проверяет наличие ключа для первого предпочтительного языка. Если перевод помечен как нечеткий, то проверяется соответсвующая настройка конфига. В случае неудачи проверяется следующий язык. И так далее. Для языка по умолчанию параметр fuzzy игнорируется.

В результате перевода получается строка, которая и записывается в базу.

Дополнительное приложения для локализаторов

Необходимо разработать дополнительное приложение (dev.translation) для локализаторов, позволяющее заводить переводы.

Приложение позволяет отфильтровывать только пропущенные или только нечеткие переводы.

При нажатии на кнопку Save происходит запись переводов в коллекции. При изменении нечеткого перевода признак FUZZY снимается

Открытые вопросы

Отрытые вопросы, нерешенные проблемы:

Related Issues

Отложенные задачи

• Список задач и предложений, которые были исключены из документа, но могут быть реализованы в рамках отдельных задач и предложений