SWAMPy

✎ CARVE FLESH

EDITING: index.ts

/*
 * Copyright (C) 2022 - present Instructure, Inc.
 *
 * This file is part of Canvas.
 *
 * Canvas is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, version 3 of the License.
 *
 * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */

import IntlPolyfills from '../IntlPolyfills';
import type {Capability} from '@instructure/updown';
import {oncePerPage} from '@instructure/updown';
import {useTranslations} from '@canvas/i18n';
import doFetchApi from '@canvas/do-fetch-api-effect';
import fallbacks from 'translations/en.json';

declare const ENV: {
  RAILS_ENVIRONMENT: 'development' | 'test' | 'production'
  LOCALE?: string
  readonly LOCALE_TRANSLATION_FILE: string
  readonly LOCALES: string[] // array of the current locale and then all its fallbacks
  [propName: string]: unknown
};

// Backfill ENV.LOCALE from ENV.LOCALES[0] if it does not exist
const LocaleBackfill: Capability = {
  up: () => {
    if (Array.isArray(ENV.LOCALES) && typeof ENV.LOCALE === 'undefined') {
      ENV.LOCALE = ENV.LOCALES[0];
      return {
        down: () => {
          delete ENV.LOCALE;
        },
      };
    }
  },
  requires: [],
};

// load the string translation file for this locale
const Translations: Capability = {
  up: oncePerPage('translations', async () => {
    if (ENV.RAILS_ENVIRONMENT === 'test') {
      useTranslations(ENV.LOCALE, fallbacks);
      return;
    }
    try {
      const {json} = await doFetchApi({path: ENV.LOCALE_TRANSLATION_FILE});
      useTranslations(ENV.LOCALE, json);
    } catch {
      // We need to fall back to the bare bones English fallbacks so that things
      // like dates and times and community links can still translate; without
      // them the Canvas front end will not start at all. Using only the
      // fallbacks will result in an odd mix of the "correct" language (from
      // the Rails-rendered stuff) and English (from JS-rendered stuff), but
      // loading Canvas this way is better than just rendering a blank page
      // because none of the front-end code could start.
      useTranslations(ENV.LOCALE, fallbacks);
      // eslint-disable-next-line no-console
      console.error(
        `CAUTION could not load translations for "${ENV.LOCALE}", falling back to US English`
      );
    }
  }),
  requires: [LocaleBackfill],
};

const I18n: Capability = {
  up: () => {},
  requires: [IntlPolyfills, Translations],
};

export {I18n, Translations};

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 index.ts	TS	2.8 KB	2023-09-24 03:36	EDIT