Optimise bundle size with locales (#2099)

* Add react * Fix bindings * Optimise bundle with locale * Clean up * Remove timeout * Fixes * Fixes * Fix build * Fix links
electricitymaps · Nov 23, 2019 · 901bcce · 901bcce
1 parent 27e956d
commit 901bcce
Show file tree

Hide file tree

Showing 17 changed files with 298 additions and 259 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -53,6 +53,7 @@ stages:
           set -euo pipefail
           docker-compose build
           docker-compose run web npm run build-release
+        no_output_timeout: 30m
       - type: shell
         name: Start environment
         command: |

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -22,6 +22,7 @@ services:
       - './config:/home/config'
       - './web/generate-geometries.js:/home/web/generate-geometries.js'
       - './web/locales:/home/web/locales'
+      - './web/locales-config.json:/home/web/locales-config.json'
       - './web/package.json:/home/web/package.json'
       - './web/public:/home/web/public'
       - './web/server.js:/home/web/server.js'

diff --git a/mobileapp/build.sh b/mobileapp/build.sh
@@ -9,6 +9,7 @@ docker cp $CONTAINER_ID:/home/web/public/ www/electricitymap
 
 rm -rf locales || true
 docker cp $CONTAINER_ID:/home/web/locales/ .
+docker cp $CONTAINER_ID:/home/web/locales-config.json ./locales-config.json
 docker cp $CONTAINER_ID:/home/web/src .
 
 docker rm $CONTAINER_ID

diff --git a/mobileapp/generate-index.js b/mobileapp/generate-index.js
@@ -1,85 +1,63 @@
 var ejs = require('ejs');
 var fs = require('fs');
 var i18n = require('i18n');
+const { vsprintf } = require('sprintf-js');
 
-// Custom module
-var translation = require(__dirname + '/src/helpers/translation');
+const STATIC_PATH = 'www/electricitymap';
 
-// duplicated from server.js
-function getHash(key, ext) {
-    var filename;
-    if (typeof obj.assetsByChunkName[key] == 'string') {
-        filename = obj.assetsByChunkName[key];
-    } else {
-        // assume list
-        filename = obj.assetsByChunkName[key]
-            .filter((d) => d.match(new RegExp('\.' + ext + '$')))[0]
-    }
-    return filename.replace('.' + ext, '').replace(key + '.', '');
+const {
+  localeToFacebookLocale,
+  supportedFacebookLocales,
+  languageNames,
+} = require('./locales-config.json');
+
+const locales = Object.keys(languageNames);
+
+/*
+Note: Translation function should be removed and
+let the client deal with all translations / formatting of ejs
+*/
+const localeConfigs = {};
+locales.forEach((d) => {
+  localeConfigs[d] = require(`${__dirname}/locales/${d}.json`);
+});
+function translateWithLocale(locale, keyStr) {
+  const keys = keyStr.split('.');
+  let result = localeConfigs[locale];
+  for (let i = 0; i < keys.length; i += 1) {
+    if (result == null) { break; }
+    result = result[keys[i]];
+  }
+  if (locale !== 'en' && !result) {
+    return translateWithLocale('en', keyStr);
+  }
+  const formatArgs = Array.prototype.slice.call(arguments).slice(2); // remove 2 first
+  return result && vsprintf(result, formatArgs);
 }
-var obj = JSON.parse(fs.readFileSync('www/electricitymap/dist/manifest.json'));
-var BUNDLE_HASH = getHash('bundle', 'js');
-var STYLES_HASH = getHash('styles', 'css');
-var VENDOR_HASH = getHash('vendor', 'js');
-var VENDOR_STYLES_HASH = getHash('vendor', 'css');
 
-// TODO:
-// Currently, those variables are duplicated from server.js
-// We should instead have a central configuration file in the `config` folder
-var locales = ['ar', 'cs', 'da', 'de', 'en', 'es', 'fr', 'hr', 'it', 'ja', 'kr', 'nl', 'pl', 'pt-br', 'ru', 'sv', 'sk', 'vi', 'zh-cn', 'zh-hk', 'zh-tw'];
-var LOCALE_TO_FB_LOCALE = {
-    'ar': 'ar_AR',
-    'cs':'cs_CZ',
-    'da': 'da_DK',
-    'de': 'de_DE',
-    'en': 'en_US',
-    'es': 'es_ES',
-    'fr': 'fr_FR',
-    'hr': 'hr_HR',
-    'it': 'it_IT',
-    'ja': 'ja_JP',
-    'kr': 'kr_KR',
-    'nl': 'nl_NL',
-    'pt-br': 'pt_BR',
-    'pl': 'pl_PL',
-    'ru': 'ru_RU',
-    'sk': 'sk_SK',
-    'sv': 'sv_SE',
-    'vn': 'vi_VN',
-    'zh-cn': 'zh_CN',
-    'zh-hk': 'zh_HK',
-    'zh-tw': 'zh_TW',
-};
-var SUPPORTED_FB_LOCALES = [
-    'ar_AR',
-    'cs_CZ',
-    'da_DK',
-    'de_DE',
-    'es_ES',
-    'es_LA',
-    'es_MX',
-    'en_GB',
-    'en_PI',
-    'en_UD',
-    'en_US',
-    'fr_CA',
-    'fr_FR',
-    'hr_HR',
-    'it_IT',
-    'ja_JP',
-    'kr_KR',
-    'nl_BE',
-    'nl_NL',
-    'pl_PL',
-    'pt_BR',
-    'ru_RU',
-    'sk_SK',
-    'sv_SE',
-    'vi_VN',
-    'zh_CN',
-    'zh_HK',
-    'zh_TW',
-];
+// duplicated from server.js
+// * Long-term caching
+function getHash(key, ext, obj) {
+  let filename;
+  if (typeof obj.assetsByChunkName[key] == 'string') {
+    filename = obj.assetsByChunkName[key];
+  } else {
+    // assume list
+    filename = obj.assetsByChunkName[key]
+      .filter((d) => d.match(new RegExp('\.' + ext + '$')))[0]
+  }
+  return filename.replace('.' + ext, '').replace(key + '.', '');
+}
+const srcHashes = Object.fromEntries(locales.map((k) => {
+  const obj = JSON.parse(fs.readFileSync(`${STATIC_PATH}/dist/manifest_${k}.json`));
+  const BUNDLE_HASH = getHash('bundle', 'js', obj);
+  const STYLES_HASH = getHash('styles', 'css', obj);
+  const VENDOR_HASH = getHash('vendor', 'js', obj);
+  const VENDOR_STYLES_HASH = getHash('vendor', 'css', obj);
+  return [k, {
+    BUNDLE_HASH, STYLES_HASH, VENDOR_HASH, VENDOR_STYLES_HASH,
+  }];
+}));
 
 // * i18n
 i18n.configure({
@@ -97,20 +75,20 @@ locales.forEach(function(locale) {
     var template = ejs.compile(fs.readFileSync('../web/views/pages/index.ejs', 'utf8'));
     var html = template({
         alternateUrls: [],
-        bundleHash: BUNDLE_HASH,
-        vendorHash: VENDOR_HASH,
-        stylesHash: STYLES_HASH,
-        vendorStylesHash: VENDOR_STYLES_HASH,
+        bundleHash: srcHashes[locale].BUNDLE_HASH,
+        vendorHash: srcHashes[locale].VENDOR_HASH,
+        stylesHash: srcHashes[locale].STYLES_HASH,
+        vendorStylesHash: srcHashes[locale].VENDOR_STYLES_HASH,
         isCordova: true,
         locale: locale,
-        FBLocale: LOCALE_TO_FB_LOCALE[locale],
+        FBLocale: localeToFacebookLocale[locale],
         supportedLocales: locales,
-        supportedFBLocales: SUPPORTED_FB_LOCALES,
+        supportedFBLocales: supportedFacebookLocales,
         '__': function() {
             var argsArray = Array.prototype.slice.call(arguments);
             // Prepend the first argument which is the locale
             argsArray.unshift(locale);
-            return translation.translateWithLocale.apply(null, argsArray);
+            return translateWithLocale.apply(null, argsArray);
         }
     });
 

diff --git a/mobileapp/www/index.html b/mobileapp/www/index.html
@@ -1,8 +1,8 @@
 <html>
   <script>
       document.addEventListener('deviceready', onDeviceReady, false);
-      // Warning: those locales are duplicated from server.js
-      var locales = ['ar', 'cs', 'da', 'de', 'en', 'es', 'fr', 'hr', 'it', 'ja', 'nl', 'pl', 'pt-br', 'ru', 'sv', 'sk', 'zh-cn', 'zh-hk', 'zh-tw'];
+      // Warning: those locales are duplicated from locales-config.json
+      var locales = ['ar', 'cs', 'da', 'de', 'en', 'es', 'fr', 'hr', 'it', 'ja', 'nl', 'pl', 'pt-br', 'ru', 'sk', 'sv', 'vi', 'zh-cn', 'zh-hk', 'zh-tw'];
       function onDeviceReady() {
         var Sentry = cordova.require("sentry-cordova.Sentry");
         Sentry.init({ dsn: 'https://[email protected]/1829181' });

diff --git a/web/Dockerfile b/web/Dockerfile
@@ -1,8 +1,8 @@
-FROM node:10.15.3
+FROM node:12.13.1
 WORKDIR /home/web
 
 # Install dependencies
-RUN apt-get update && apt-get install -y unzip
+RUN apt-get update && apt-get install -y jq unzip
 ADD web/package.json /home/web/package.json
 ADD web/yarn.lock /home/web/yarn.lock
 RUN yarn

diff --git a/web/locales-config.json b/web/locales-config.json
@@ -0,0 +1,78 @@
+{
+  "localeToFacebookLocale": {
+    "ar": "ar_AR",
+    "cs": "cs_CZ",
+    "da": "da_DK",
+    "de": "de_DE",
+    "en": "en_US",
+    "es": "es_ES",
+    "fr": "fr_FR",
+    "hr": "hr_HR",
+    "it": "it_IT",
+    "ja": "ja_JP",
+    "kr": "kr_KR",
+    "nl": "nl_NL",
+    "pt-br": "pt_BR",
+    "pl": "pl_PL",
+    "ru": "ru_RU",
+    "sk": "sk_SK",
+    "sv": "sv_SE",
+    "vn": "vi_VN",
+    "zh-cn": "zh_CN",
+    "zh-hk": "zh_HK",
+    "zh-tw": "zh_TW"
+  },
+  "supportedFacebookLocales": [
+    "ar_AR",
+    "cs_CZ",
+    "da_DK",
+    "de_DE",
+    "es_ES",
+    "es_LA",
+    "es_MX",
+    "en_GB",
+    "en_PI",
+    "en_UD",
+    "en_US",
+    "fr_CA",
+    "fr_FR",
+    "hr_HR",
+    "it_IT",
+    "ja_JP",
+    "kr_KR",
+    "nl_BE",
+    "nl_NL",
+    "pl_PL",
+    "pt_BR",
+    "ru_RU",
+    "sk_SK",
+    "sv_SE",
+    "vi_VN",
+    "zh_CN",
+    "zh_HK",
+    "zh_TW"
+  ],
+  "languageNames": {
+    "ar": "اللغة العربية الفصحى",
+    "cs": "Čeština",
+    "da": "Dansk",
+    "de": "Deutsch",
+    "en": "English",
+    "es": "Español",
+    "fr": "Français",
+    "hr": "Hrvatski",
+    "it": "Italiano",
+    "ja": "日本語",
+    "kr": "한국어",
+    "nl": "Nederlands",
+    "pl": "Polski",
+    "pt-br": "Português (Brazilian)",
+    "ru": "Русский язык",
+    "sk": "Slovenčina",
+    "sv": "Svenska",
+    "vi": "Tiếng Việt",
+    "zh-cn": "中文 (Mainland China)",
+    "zh-hk": "中文 (Hong Kong)",
+    "zh-tw": "中文 (Taiwan)"
+  }
+}
diff --git a/web/package.json b/web/package.json
@@ -32,6 +32,7 @@
     "react-redux": "^7.1.3",
     "redux": "^3.7.2",
     "redux-logger": "^3.0.6",
+    "sprintf-js": "^1.1.2",
     "topojson": "^3.0.2"
   },
   "devDependencies": {
@@ -62,7 +63,7 @@
   },
   "scripts": {
     "build-debug": "webpack --bail --progress --mode development",
-    "build-release": "NODE_ENV=production webpack --mode production --bail",
+    "build-release": "export NODE_ENV=production && cat locales-config.json| jq '.languageNames | keys[]' | xargs -L1 -I {} node_modules/.bin/webpack --mode production --bail --config-name {}",
     "clean": "mkdir -p public/dist && rm public/dist/bundle.*.js",
     "eslint": "eslint src",
     "server-dev": "nodemon server.js",