Add compat layer for unit tests, re-enable tests in CI

Author: lreading

.github/workflows/pull_request.yaml

@@ -147,11 +147,8 @@ jobs:
       - name: Site lint
         run: npm run lint
 
-      # TODO: Reinstate tests as part of build
-      # I am disabling this for now to see how the rest of the build pipeline works
-      # with the Vue 3 upgrade.  
-      # - name: Run unit tests
-      #   run: npm run test:unit
+      - name: Run unit tests
+        run: npm run test:unit
 
   desktop_unit_tests:
     name: Desktop unit tests

td.vue/jest.config.js

@@ -10,6 +10,8 @@ module.exports = async () => {
             // TODO: Remove this alias when fully migrated to Vue 3 and
             // the compat dependency is removed
             '^vue$': require.resolve('@vue/compat'),
+            '^@vue/test-utils$': '<rootDir>/src/plugins/vue-test-utils-compat.js',
+            '^vue-i18n$': '<rootDir>/src/plugins/vue-i18n-test-compat.js',
             '^@/(.*)$': '<rootDir>/src/$1',
             '^lodash-es$': 'lodash'
         },
@@ -29,4 +31,3 @@ module.exports = async () => {
         ]
     };
 };
-

td.vue/src/plugins/vue-i18n-test-compat.js

@@ -0,0 +1,61 @@
+import * as actual from 'vue-i18n/dist/vue-i18n.cjs';
+
+const installLegacyCompat = (instance) => {
+    if (typeof instance.t !== 'function' && typeof instance.global?.t === 'function') {
+        instance.t = instance.global.t.bind(instance.global);
+    }
+
+    if (typeof instance.tc !== 'function' && typeof instance.global?.tc === 'function') {
+        instance.tc = instance.global.tc.bind(instance.global);
+    }
+
+    if (!Object.getOwnPropertyDescriptor(instance, 'locale') && instance.global) {
+        Object.defineProperty(instance, 'locale', {
+            get() {
+                return instance.global.locale;
+            },
+            set(value) {
+                instance.global.locale = value;
+            }
+        });
+    }
+
+    if (!Object.getOwnPropertyDescriptor(instance, 'availableLocales') && instance.global) {
+        Object.defineProperty(instance, 'availableLocales', {
+            get() {
+                return instance.global.availableLocales || [];
+            }
+        });
+    }
+
+    return instance;
+};
+
+function VueI18n(options = {}) {
+    return installLegacyCompat(actual.createI18n({
+        legacy: true,
+        ...options
+    }));
+}
+
+VueI18n.install = () => {};
+VueI18n.createI18n = actual.createI18n;
+VueI18n.useI18n = actual.useI18n;
+
+export const castToVueI18n = (instance) => installLegacyCompat(actual.castToVueI18n(instance));
+export const createI18n = (...args) => installLegacyCompat(actual.createI18n(...args));
+
+export const {
+    DatetimeFormat,
+    I18nD,
+    I18nInjectionKey,
+    I18nN,
+    I18nT,
+    NumberFormat,
+    Translation,
+    VERSION,
+    useI18n,
+    vTDirective
+} = actual;
+
+export default VueI18n;