@zohodesk/react-cli 1.1.26 → 1.1.27-exp.2

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/I18nKeysIdentifer.js

@@ -0,0 +1,76 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = require("./utils");
+
+var _LocaleChunkAssetsStore = require("./LocaleChunkAssetsStore");
+
+/* eslint-disable max-classes-per-file */
+const pluginName = 'I18nKeysIdentifier';
+/**
+ * this plugin search the i18 keys and make it as I18nDependency.
+ * how it works?
+ *  this plugin get jsResourceI18nKeys in constructor.
+ *  we walk thought the js files AST
+ *      if any string literal in that AST is in jsResourceI18nKeys then  we consider that string as I18n key
+ *  after the walk of AST we get some I18n keys
+ *  then we make it as I18nDependency.
+ */
+
+class I18nKeysIdentifer {
+  constructor({
+    jsResourceI18nKeys
+  }) {
+    this.jsResourceI18nKeys = jsResourceI18nKeys;
+    this.store = new _LocaleChunkAssetsStore.LocaleChunkAssetsStore();
+  }
+
+  apply(compiler) {
+    // const { splitChunks } = compiler.options.optimization;
+    // if (splitChunks) {
+    //   if (splitChunks.defaultSizeTypes.includes('...')) {
+    //     splitChunks.defaultSizeTypes.push(MODULE_TYPE);
+    //   }
+    // }
+    compiler.hooks.thisCompilation.tap(pluginName, compilation => {
+      this.store.updateCompilation(compilation);
+      (0, _LocaleChunkAssetsStore.setLocaleChunkAssetsStore)(compilation, this.store);
+    });
+    compiler.hooks.normalModuleFactory.tap(pluginName, factory => {
+      // handler for parser
+      const handler = parser => {
+        parser.hooks.program.tap(pluginName, (ast, comments) => {
+          const {
+            module
+          } = parser.state; //
+
+          if (!(module && /\.jsx?$/.test(module.resource))) {
+            return;
+          } // i18n grep proper contract regex
+
+
+          let i18nKeys = (0, _utils.collectI18nKeysfromAST)(ast, this.jsResourceI18nKeys);
+          i18nKeys = i18nKeys.concat( // i18n grep proper contract regex
+          (0, _utils.collectI18nKeysfromComments)(comments, this.jsResourceI18nKeys));
+
+          if (i18nKeys.length) {
+            // console.log('i18nKeys.length', module.resource, i18nKeys);
+            this.store.updateModuleI18nKeys(module.resource, i18nKeys);
+          }
+        });
+      }; // this below  hook was tapped for collect I18n Key from files and add as Dependency
+      // const factory = params.normalModuleFactory;
+
+
+      factory.hooks.parser.for('javascript/auto').tap(pluginName, handler);
+      factory.hooks.parser.for('javascript/dynamic').tap(pluginName, handler);
+    });
+  }
+
+}
+
+exports.default = I18nKeysIdentifer;

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/I18nRuntimeDealerPlugin.js

@@ -0,0 +1,223 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.I18nRuntimeDealerPlugin = void 0;
+
+var _webpack = require("webpack");
+
+var _htmlWebpackPlugin = _interopRequireDefault(require("html-webpack-plugin"));
+
+var _constants = require("./constants");
+
+var _getI18nLoadingRuntimeModule = require("./getI18nLoadingRuntimeModule");
+
+var _templateFileName = require("./templateFileName");
+
+var _hashUtils = require("./utils/hashUtils");
+
+var _urlConcat = require("../../../../server/urlConcat");
+
+var _I18nFilesEmitPlugin = require("./I18nFilesEmitPlugin");
+
+var _LocaleChunkAssetsStore = require("./LocaleChunkAssetsStore");
+
+var _logger = require("../../../../../logger");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const {
+  RawSource
+} = _webpack.sources;
+const pluginName = 'I18nRuntimeDealerPlugin'; // I18nExtractPlugin.loader = require.resolve('./loader');
+
+class I18nRuntimeDealerPlugin {
+  constructor(options) {
+    this.options = options;
+  }
+
+  apply(compiler) {
+    compiler.hooks.thisCompilation.tap(pluginName, compilation => {
+      // Get store for cache
+      this.store = (0, _LocaleChunkAssetsStore.getLocaleChunkAssetsStore)(compilation);
+
+      if (!this.options.runtime) {
+        return;
+      }
+
+      this.createI18nDownloadCodeInRuntimeFile(compilation);
+      this.addI18nIntoInitialHtml(compilation);
+    });
+  }
+
+  addI18nIntoInitialHtml(compilation) {
+    const i18nStore = this.store;
+
+    _htmlWebpackPlugin.default.getHooks(compilation).beforeAssetTagGeneration.tap(pluginName, hookOptions => {
+      const {
+        assets
+      } = hookOptions;
+      const {
+        templateLabel,
+        filename,
+        publicPath = '',
+        mainChunkName
+      } = this.options; // const dummyContent = '// dummy comment';
+
+      const dummyContentHash = 'dummy0content0hashes';
+      const entryPoint = compilation.entrypoints.get(mainChunkName);
+      const initialChunks = Array.from(entryPoint.chunks).filter(c => c.canBeInitial() && c.id !== c.runtime);
+      const initialI18nAssets = initialChunks.filter(c => i18nStore.isChunkHasI18n(c)).map(c => {
+        const data = _I18nFilesEmitPlugin.I18nFilesEmitPlugin.createFilenameWithHash({
+          compilation,
+          fileNameTemplate: filename,
+          chunk: c,
+          locale: templateLabel,
+          // NOTE: we used dummy  content hash.
+          //  Because we have no plan on use in content hash to initial I18n chunks
+          // So Dummy hash was being used it will not work  just skip warnings
+          contentHash: dummyContentHash
+        });
+
+        return (0, _urlConcat.urlConcat)(publicPath, data.filename);
+      });
+      const allJSAssets = [...initialI18nAssets, ...assets.js].map(url => url.replaceAll('[locale]', templateLabel).replaceAll('%5Blocale%5D', templateLabel));
+      return {
+        assets: { ...assets,
+          js: allJSAssets
+        }
+      };
+    });
+  }
+
+  createI18nDownloadCodeInRuntimeFile(compilation) {
+    const {
+      chunkFilename,
+      locales,
+      localeVarName
+    } = this.options;
+    const chunkFilenameHasContentHash = (0, _hashUtils.hasContentHash)(chunkFilename);
+
+    const getI18nChunks = mainChunk => this.filterI18nUsedChunks(mainChunk.getAllAsyncChunks());
+
+    const I18nLoadingRuntimeModule = (0, _getI18nLoadingRuntimeModule.getI18nLoadingRuntimeModule)({
+      getI18nChunks
+    });
+    const enabledChunks = new WeakSet();
+
+    const chunkFilenameUrlGenerator = (i18nChunks, locale) => (0, _templateFileName.templateFileName)({
+      compilation,
+      localeVarName,
+      dynamicFilename: chunkFilename,
+      contentHashes: this.getContentHashes(locale),
+      chunks: i18nChunks
+    });
+
+    const prefixFunc = () => _constants.I18N_CHUNK_NAME_GENERATION_SEGMENT;
+
+    const handler = (entryRuntimeChunk, set) => {
+      if (enabledChunks.has(entryRuntimeChunk)) {
+        return;
+      }
+
+      enabledChunks.add(entryRuntimeChunk);
+      const {
+        chunkFilename,
+        // filename: initialFilename,
+        runtimeOptions
+      } = this.options;
+
+      if (typeof chunkFilename === 'string' && /\[(full)?hash(:\d+)?\]/.test(chunkFilename)) {
+        set.add(_webpack.RuntimeGlobals.getFullHash);
+      }
+
+      set.add(_webpack.RuntimeGlobals.publicPath);
+      compilation.addRuntimeModule(entryRuntimeChunk, new I18nLoadingRuntimeModule(set, {
+        prefixFunc: chunkFilenameHasContentHash ? prefixFunc : chunkFilenameUrlGenerator,
+        runtimeOptions,
+        chunkFilename
+      }));
+    };
+
+    compilation.hooks.runtimeRequirementInTree.for(_webpack.RuntimeGlobals.ensureChunkHandlers).tap(pluginName, handler);
+
+    if (chunkFilenameHasContentHash) {
+      compilation.hooks.processAssets.tap({
+        name: pluginName,
+        stage: _webpack.Compilation.PROCESS_ASSETS_STAGE_DERIVED // additionalAssets: true
+
+      }, assets => {
+        // eslint-disable-next-line no-underscore-dangle
+        const entries = compilation._getChunkGraphEntries();
+
+        function createRuntimeFilePerLocale({
+          locale,
+          runtimeFileName,
+          runtimeFileSourceStr,
+          i18nChunks
+        }) {
+          const newRuntimeName = runtimeFileName.replaceAll('[locale]', locale);
+          const replaceText = chunkFilenameUrlGenerator(i18nChunks, locale);
+          const replacedStr = runtimeFileSourceStr.replace(_constants.I18N_CHUNK_NAME_GENERATION_SEGMENT, replaceText);
+          compilation.emitAsset(newRuntimeName, new RawSource(replacedStr));
+        } // eslint-disable-next-line no-restricted-syntax
+
+
+        for (const entryChunk of entries) {
+          const i18nChunks = getI18nChunks(entryChunk);
+          const runtimeFileName = [...entryChunk.files][0];
+          const runtimeFileSourceStr = assets[runtimeFileName].source();
+          locales.forEach(locale => createRuntimeFilePerLocale({
+            locale,
+            entryChunk,
+            runtimeFileName,
+            runtimeFileSourceStr,
+            i18nChunks
+          })); // NOTE: we don't delete, Because of HTML plugin needs to add runtime file in html and  efc 
+          // compilation.deleteAsset(runtimeFileName);
+        }
+      });
+      compilation.hooks.processAssets.tap({
+        name: pluginName,
+        stage: _webpack.Compilation.PROCESS_ASSETS_STAGE_SUMMARIZE // additionalAssets: true
+
+      }, () => {
+        // eslint-disable-next-line no-underscore-dangle
+        const entries = compilation._getChunkGraphEntries(); // eslint-disable-next-line no-restricted-syntax
+
+
+        for (const entryChunk of entries) {
+          const runtimeFileName = [...entryChunk.files][0] || '';
+
+          if (runtimeFileName.includes('runtime') && runtimeFileName.includes('[locale]')) {
+            (0, _logger.verboseLogger)('deleteAsset', runtimeFileName);
+            compilation.deleteAsset(runtimeFileName);
+          }
+        }
+      });
+    }
+  }
+
+  filterI18nUsedChunks(chunks) {
+    const i18nStore = this.store;
+    return Array.from(chunks).filter(c => i18nStore.isChunkHasI18n(c.id));
+  }
+
+  getContentHashes(locale) {
+    const i18nStore = this.store;
+    const contentHashes = {};
+    i18nStore.forEachChunkId(chunkId => {
+      const contentHash = i18nStore.getContentHash(chunkId, locale);
+
+      if (contentHash) {
+        contentHashes[chunkId] = contentHash;
+      }
+    }); // console.log({ contentHashes });
+
+    return contentHashes;
+  }
+
+}
+
+exports.I18nRuntimeDealerPlugin = I18nRuntimeDealerPlugin;

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/I18nSplit.md

@@ -0,0 +1,95 @@
+# I18n Split As Chunks Plugin
+
+generaly we have manage our all I18n keys and values as language specific i18n files and then we download all i18n in initial page load.
+
+### what is the problem with this?.
+
+the problem is i18n file keep get's grown it will affect the the inital page load and critial rendering path.
+So, We have decide to create a plugin for split i18n per chunk's of js vise.
+
+### what is i18n split?
+
+it is like code split for i18n.
+we will collect i18n from js chunk and we will create separate i18n chunk per js chunk,  
+ with this we already load Js chunks are on demand and now we also download i18n also ondemand with this the initial and forthere actions.  
+ when js download's we will download i18n with it.
+
+### How to we going to i18n split?
+
+we will read the js chunk and collect I18n keys form it,  
+ then we will create i18n chunk files with these used keys.
+
+### how do you collect i18n keys from js files?
+
+we will traverse the js file's AST (static analysis) and find i18 keys,  
+ we will concider all string which is in jsResource file as i18n keys.  
+ and you can tell dynamic i18n key by js comments,  
+ Like Below:-
+
+```js
+fetch('tickets?view=view1').then(data => {
+  // I18n support.ticketsEmpty
+  // I18n support.viewNotFount
+  // I18n support.permissionDenied
+  let text = getI18nValue(data.i18nkey);
+});
+```
+
+### is there any posiblity for unwanted keys in some chunk?
+
+Yes, there is two posiblity
+
+1. js comment , if you write js comment but it is not needed then it will be add into i18n chunk  
+   `To Resolve` we currently do not have perfect idea for this, But we can check this by chunk size limit.  
+   `idea's will be welcome`
+2. like we said "we will concider all string which is in jsResource file as i18n keys",  
+   So if you use string not for i18n but it was in jsResource then it will be add into i18n chunk.  
+   `To Resolve` this problem we can use some kinda prefix or something.
+
+### how do we downlowd and give to app?
+
+we have over write defualt webpack requireEnsure (every dynamic chunk requests are done by that function) function.  
+ and we parlarly dowload i18n files. and we ask jsonFunction, to our plugin.  
+So we send i18nkeys , when it was download,  
+you must store all i18n keys, we give asycrnsly by that function download in that patticular.  
+so you must store and update (like append or assign) everytime that function call.
+
+### how to use this feature?
+
+to use this feature use have give the below oprtions  
+ `package.json`
+
+```json
+{
+  /// ...some things
+  "react-cli": {
+    //  ...some things
+    "i18n": {
+      "chunkSplitEnable": true,
+      "jsResource": "./deskapp/properties/JSResources.properties",
+      "localeVarName": "window.userInfo.langCode",
+      "jsonpFunc": "window.loadI18nChunk",
+      "templateLabel": "{{--user-locale}}", // this is  for html template i18n file path locate template
+      "propertiesFolder": "./deskapp/properties"
+    }
+    //  ...some things
+  }
+}
+```
+
+<!-- not need below -->
+<!--we have added new feature for css to write logic to how hover related css work in hoverhover and a
+
+### is there any problems with static analysis?
+  Yes,
+
+### how do we use dynamic i18n key?
+
+  and we will download i18n file with
+
+  and when js chunk download's then we will download i18n as need.
+  we all know in our app we loading i18n as one single big file for each locale(language).
+  we are going to split i18n as per js chunk, and when js chunk download's then we will download i18n as need.
+
+
+  -->

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/LocaleChunkAssetsStore.js

@@ -0,0 +1,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.LocaleChunkAssetsStore = void 0;
+exports.getLocaleChunkAssetsStore = getLocaleChunkAssetsStore;
+exports.setLocaleChunkAssetsStore = setLocaleChunkAssetsStore;
+
+var _ModulesI18nKeysStore = require("./ModulesI18nKeysStore");
+
+class LocaleChunkAssetsStore extends _ModulesI18nKeysStore.ModulesI18nKeysStore {
+  constructor() {
+    super();
+    this.data = {};
+  }
+
+  clear() {
+    this.data = {};
+  }
+
+  storeData(chunkId, locale, data) {
+    if (!this.data[chunkId]) {
+      this.data[chunkId] = {};
+    }
+
+    const chunkBasedData = this.data[chunkId];
+    chunkBasedData[locale] = { ...(chunkBasedData[locale] || {}),
+      ...data
+    };
+  }
+
+  getChunkIdsWhichHasI18n() {
+    return Object.keys(this.data);
+  }
+
+  forEachChunkId(cb) {
+    // Object.keys(localeChunkAssestMap).forEach
+    this.getChunkIdsWhichHasI18n().forEach(cb);
+  }
+
+  isChunkHasI18n(chunkId) {
+    if (typeof chunkId === 'object') {
+      return super.isChunkHasI18n(chunkId);
+    }
+
+    return !!this.data[chunkId];
+  }
+
+  getDate(chunkId, locale) {
+    return this.data[chunkId]?.[locale];
+  }
+
+  getContent(chunkId, locale) {
+    return this.data[chunkId]?.[locale]?.content;
+  }
+
+  getContentHash(chunkId, locale) {
+    return this.data[chunkId]?.[locale]?.contentHash;
+  }
+
+}
+
+exports.LocaleChunkAssetsStore = LocaleChunkAssetsStore;
+const storeCache = new WeakMap();
+
+function getLocaleChunkAssetsStore(compilation) {
+  return storeCache.get(compilation);
+}
+
+function setLocaleChunkAssetsStore(compilation, store) {
+  return storeCache.set(compilation, store);
+}

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/ModulesI18nKeysStore.js

@@ -0,0 +1,88 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ModulesI18nKeysStore = void 0;
+
+var _iterateModulesInChunk = require("./iterateModulesInChunk");
+
+class ModulesI18nKeysStore {
+  constructor() {
+    this.modulesI18nKeysMap = {};
+    this.compilation = null;
+  }
+
+  updateCompilation(compilation) {
+    this.compilation = compilation;
+  }
+
+  updateModuleI18nKeys(resource, i18nKeys) {
+    this.modulesI18nKeysMap[resource] = i18nKeys;
+  }
+
+  getModuleI18nKeys(resource) {
+    return this.modulesI18nKeysMap[resource];
+  }
+
+  isChunkHasI18n(chunk) {
+    const {
+      modulesI18nKeysMap,
+      compilation
+    } = this;
+    let hasModuleI18n = false;
+    (0, _iterateModulesInChunk.iterateModulesInChunk)({
+      chunk,
+      compilation,
+      cb: ({
+        module: mod,
+        stop: stopLoop
+      }) => {
+        if (mod.resource) {
+          const keys = modulesI18nKeysMap[mod.resource];
+
+          if (keys && keys.length > 0) {
+            hasModuleI18n = true;
+            stopLoop();
+          }
+        }
+      }
+    });
+    return hasModuleI18n;
+  }
+
+  getI18nKeysForChunk(chunk) {
+    const {
+      modulesI18nKeysMap,
+      compilation
+    } = this;
+    const i18nKeysMap = {};
+
+    function updateI18nKeys(mod) {
+      const keys = modulesI18nKeysMap[mod.resource];
+
+      if (keys) {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const key of keys) {
+          i18nKeysMap[key] = 1;
+        }
+      }
+    }
+
+    (0, _iterateModulesInChunk.iterateModulesInChunk)({
+      chunk,
+      compilation,
+      cb: ({
+        module: mod
+      }) => {
+        if (mod.resource) {
+          updateI18nKeys(mod);
+        }
+      }
+    });
+    return Object.keys(i18nKeysMap);
+  }
+
+}
+
+exports.ModulesI18nKeysStore = ModulesI18nKeysStore;

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/README.md

@@ -0,0 +1,25 @@
+# I18n Split As Chunks Plugin
+
+generaly we have manage our all I18n keys and values as language specific i18n files and then we download all i18n in initial page load.
+
+Ok, what is the problem with this?.
+the problem is i18n file keep get's grown it will affect the the inital page load and critial rendering path.
+So, We have decide to create a plugin for split i18n per chunk's of js vise, Which mean we diside to create for each js chunk has its own i18n chunks, with this we already load Js chunks are on demand and now we also download i18n also ondemand with this the initial and forthere actions.
+
+Ok, How to you do this thing?
+we have read the js chunk and collect I18n keys what are used in that chunk and we will create i18n chunk files with only used key.
+
+Ok, How do you collect that keys?
+we now have two experimental stage to collect I18n keys.
+
+1. we read jsResource.properties (or all keys I18n file) then we walk this AST of js and we collect all string which is jsResource.properties.
+2. for dynamic we discide to use comment some thing like
+   `// I18n support.tickekt.email.notvalid`
+
+ok, how do you downlowd and give to app?
+we have over write defualt webpack require ensure function.
+So every dynamic chunk requset are done by that function.
+So we parlarly dowload i18n files. and we ask jsonFunction, to our plugin.
+So we send i18nkeys , when it was download,
+you must store all i18n keys, we give asycrnsly by that function download in that patticular.
+so you must store and update (like append or assign) everytime that function call.

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/constants.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TYPES = exports.SINGLE_DOT_PATH_SEGMENT = exports.MODULE_TYPE = exports.I18N_CHUNK_NAME_GENERATION_SEGMENT = exports.DEFAULT_FILENAME = exports.DEFAULT_CHUNK_FILENAME = exports.CODE_GENERATION_RESULT = exports.BASE_URI = exports.AUTO_PUBLIC_PATH = exports.ABSOLUTE_PUBLIC_PATH = void 0;
+const MODULE_TYPE = 'i18n/mini-extract';
+exports.MODULE_TYPE = MODULE_TYPE;
+const AUTO_PUBLIC_PATH = '__mini_i18n_extract_plugin_public_path_auto__';
+exports.AUTO_PUBLIC_PATH = AUTO_PUBLIC_PATH;
+const ABSOLUTE_PUBLIC_PATH = 'webpack:///mini-i18n-extract-plugin/';
+exports.ABSOLUTE_PUBLIC_PATH = ABSOLUTE_PUBLIC_PATH;
+const BASE_URI = 'webpack://';
+exports.BASE_URI = BASE_URI;
+const SINGLE_DOT_PATH_SEGMENT = '__mini_i18n_extract_plugin_single_dot_path_segment__';
+exports.SINGLE_DOT_PATH_SEGMENT = SINGLE_DOT_PATH_SEGMENT;
+const I18N_CHUNK_NAME_GENERATION_SEGMENT = '__mini_i18n_extract_plugin_i18n_chunk_name_generation_segment__';
+exports.I18N_CHUNK_NAME_GENERATION_SEGMENT = I18N_CHUNK_NAME_GENERATION_SEGMENT;
+const DEFAULT_FILENAME = 'i18n-chunks/[locale]/[name].[contenthash].i18n.js';
+exports.DEFAULT_FILENAME = DEFAULT_FILENAME;
+const DEFAULT_CHUNK_FILENAME = 'i18n-chunks/[locale]/[id].[contenthash].i18n.js';
+exports.DEFAULT_CHUNK_FILENAME = DEFAULT_CHUNK_FILENAME;
+const TYPES = new Set([MODULE_TYPE]);
+exports.TYPES = TYPES;
+const CODE_GENERATION_RESULT = {
+  sources: new Map(),
+  runtimeRequirements: new Set()
+};
+exports.CODE_GENERATION_RESULT = CODE_GENERATION_RESULT;

package/packages/client_build_tool/lib/shared/bundler/webpack/custom_plugins/I18nSplitPlugin/createHash.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createHash = createHash;
+
+var _webpack = require("webpack");
+
+function createHash({
+  outputOptions,
+  content
+}) {
+  const {
+    hashFunction,
+    hashDigest,
+    hashDigestLength
+  } = outputOptions;
+
+  const hash = _webpack.util.createHash(hashFunction);
+
+  hash.update(content);
+  return hash.digest(hashDigest).substring(0, hashDigestLength);
+}