From 846e207090becef8315bd28d6e028de3806752e4 Mon Sep 17 00:00:00 2001
From: Manuel Kocher <manuel.kocher@tugraz.at>
Date: Tue, 19 Jul 2022 12:23:00 +0200
Subject: [PATCH] Add better errorr handling to translation component
---
packages/common/i18next.js | 2 +-
packages/common/src/i18n.js | 4 ++--
packages/common/src/translation.js | 32 ++++++++++++++++--------------
3 files changed, 20 insertions(+), 18 deletions(-)
diff --git a/packages/common/i18next.js b/packages/common/i18next.js
index 4dd7ce2e..1a3b2417 100644
--- a/packages/common/i18next.js
+++ b/packages/common/i18next.js
@@ -78,7 +78,7 @@ export function humanFileSize(bytes, si = false) {
* @param {string} namespace The namespace to override
* @returns {string} The new namespace name
*/
-function getOverrideNamespace(namespace) {
+export function getOverrideNamespace(namespace) {
// This just needs to be different to the namespace, make it special
// so it's clear what it is used for in case it ends up in some error
// message or something
diff --git a/packages/common/src/i18n.js b/packages/common/src/i18n.js
index ec940db5..bd0a3dd0 100644
--- a/packages/common/src/i18n.js
+++ b/packages/common/src/i18n.js
@@ -1,4 +1,4 @@
-import {createInstance as _createInstance, setOverridesByGlobalCache} from '../i18next.js';
+import {createInstance as _createInstance, setOverridesByGlobalCache, getOverrideNamespace} from '../i18next.js';
import de from './i18n/de/translation.json';
import en from './i18n/en/translation.json';
@@ -11,4 +11,4 @@ export function createInstanceGivenResources(en, de) {
return _createInstance({en: en, de: de}, 'de', 'en');
}
-export {setOverridesByGlobalCache};
+export {setOverridesByGlobalCache, getOverrideNamespace};
diff --git a/packages/common/src/translation.js b/packages/common/src/translation.js
index f38be7a4..c5c7e6b6 100644
--- a/packages/common/src/translation.js
+++ b/packages/common/src/translation.js
@@ -2,7 +2,7 @@ import {html} from 'lit';
import {unsafeHTML} from 'lit/directives/unsafe-html.js';
import DBPLitElement from '../dbp-lit-element';
import * as commonStyles from '../styles.js';
-import {createInstanceGivenResources} from './i18n.js';
+import {getOverrideNamespace} from './i18n.js';
export class Translation extends DBPLitElement {
constructor() {
@@ -33,16 +33,6 @@ export class Translation extends DBPLitElement {
}
connectedCallback() {
-
- // init objects with empty string as value for key
- const de = {};
- const en = {};
- de[this.key] = "";
- en[this.key] = "";
-
- // create i18n instance with empty translations as default
- this._i18n = createInstanceGivenResources(en, de);
-
// supercall after default i18n init to override translations only
// if a override with this tagname is given
super.connectedCallback();
@@ -62,8 +52,14 @@ export class Translation extends DBPLitElement {
}
render() {
+ // get name of overridenamespace
+ let overrideNamespace =
+ this._i18n.options.fallbackNS.slice(0,2) == "--" ?
+ this._i18n.options.fallbackNS :
+ getOverrideNamespace(this._i18n.options.fallbackNS);
+
// request to i18n translation
- const translation = (() => {
+ let translation = (() => {
if (this.interpolation && this.unsafe)
return unsafeHTML(this._i18n.t(this.key, this.interpolation));
else if (this.interpolation)
@@ -72,12 +68,18 @@ export class Translation extends DBPLitElement {
return this._i18n.t(this.key);
})();
- // if translation == "" key was not found
+ // check if overrides have been loaded with overrideNamespace
+ // and then check if given key exists
let key = "";
- if (translation != "") {
+ if (this._i18n.exists(this.key) && this._i18n.hasResourceBundle(this.lang, overrideNamespace)) {
key = unsafeHTML("<!-- key: " + this.key + "-->");
+ } else if (this._i18n.hasResourceBundle(this.lang, overrideNamespace)){
+ key = unsafeHTML("<!-- key '" + this.key + "' not found! -->");
+ translation = "";
+ console.error("Key '" + this.key + "' not found!");
} else {
- key = unsafeHTML("<!-- key \"" + this.key + "\" not found! -->");
+ key = unsafeHTML("<!-- key '" + this.key + "' and namespace '" + overrideNamespace + "' not found! -->");
+ translation = "";
}
// load translation text
--
GitLab