test(@ngtools/webpack): add unit test for register_locate_data transformer

Author: filipesilva

packages/@ngtools/webpack/src/angular_compiler_plugin.ts

@@ -236,8 +236,8 @@ export class AngularCompilerPlugin implements Tapable {
     if (options.hasOwnProperty('i18nFormat')) {
       this._angularCompilerOptions.i18nInFormat = options.i18nFormat;
     }
-    if (options.hasOwnProperty('locale')) {
-      this._angularCompilerOptions.i18nInLocale = options.locale;
+    if (options.hasOwnProperty('locale') && options.locale) {
+      this._angularCompilerOptions.i18nInLocale = this._validateLocale(options.locale);
     }
     if (options.hasOwnProperty('missingTranslation')) {
       this._angularCompilerOptions.i18nInMissingTranslations =
@@ -657,7 +657,7 @@ export class AngularCompilerPlugin implements Tapable {
                 transformOps.push(...replaceBootstrap(sf, this.entryModule));
               }
 
-              // if we have a locale, auto import the locale data file
+              // If we have a locale, auto import the locale data file.
               if (this._angularCompilerOptions.i18nInLocale) {
                 transformOps.push(...registerLocaleData(
                   sf,
@@ -824,4 +824,41 @@ export class AngularCompilerPlugin implements Tapable {
     timeEnd('AngularCompilerPlugin._emit');
     return { program, emitResult, diagnostics: allDiagnostics };
   }
+
+  private _validateLocale(locale: string) {
+    // Get the path of the common module.
+    const commonPath = path.dirname(require.resolve('@angular/common/package.json'));
+    // Check if the locale file exists
+    if (!fs.existsSync(path.resolve(commonPath, 'locales', `${locale}.js`))) {
+      // Check for an alternative locale (if the locale id was badly formatted).
+      const locales = fs.readdirSync(path.resolve(commonPath, 'locales'))
+        .filter(file => file.endsWith('.js'))
+        .map(file => file.replace('.js', ''));
+
+      let newLocale;
+      const normalizedLocale = locale.toLowerCase().replace(/_/g, '-');
+      for (const l of locales) {
+        if (l.toLowerCase() === normalizedLocale) {
+          newLocale = l;
+          break;
+        }
+      }
+
+      if (newLocale) {
+        locale = newLocale;
+      } else {
+        // Check for a parent locale
+        const parentLocale = normalizedLocale.split('-')[0];
+        if (locales.indexOf(parentLocale) !== -1) {
+          locale = parentLocale;
+        } else {
+          throw new Error(
+            `Unable to load the locale data file "@angular/common/locales/${locale}", ` +
+            `please check that "${locale}" is a valid locale id.`);
+        }
+      }
+    }
+
+    return locale;
+  }
 }

packages/@ngtools/webpack/src/transformers/register_locale_data.spec.ts

@@ -0,0 +1,47 @@
+import * as ts from 'typescript';
+import { oneLine, stripIndent } from 'common-tags';
+import { transformTypescript } from './ast_helpers';
+import { registerLocaleData } from './register_locale_data';
+
+describe('@ngtools/webpack transformers', () => {
+  describe('register_locale_data', () => {
+    it('should add locale imports', () => {
+      const input = stripIndent`
+        import { enableProdMode } from '@angular/core';
+        import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+        import { AppModule } from './app/app.module';
+        import { environment } from './environments/environment';
+
+        if (environment.production) {
+          enableProdMode();
+        }
+
+        platformBrowserDynamic().bootstrapModule(AppModule);
+      `;
+      const output = stripIndent`
+        import __locale_fr__ from "@angular/common/locales/fr";
+        import { registerLocaleData } from "@angular/common";
+        registerLocaleData(__locale_fr__);
+
+        import { enableProdMode } from '@angular/core';
+        import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+        import { AppModule } from './app/app.module';
+        import { environment } from './environments/environment';
+
+        if (environment.production) {
+            enableProdMode();
+        }
+
+        platformBrowserDynamic().bootstrapModule(AppModule);
+      `;
+
+      const transformOpsCb = (sourceFile: ts.SourceFile) =>
+        registerLocaleData(sourceFile, { path: '/app.module', className: 'AppModule' }, 'fr');
+      const result = transformTypescript(input, transformOpsCb);
+
+      expect(oneLine`${result}`).toEqual(oneLine`${output}`);
+    });
+  });
+});

packages/@ngtools/webpack/src/transformers/register_locale_data.ts

@@ -1,5 +1,3 @@
-import * as path from 'path';
-import * as fs from 'fs';
 import * as ts from 'typescript';
 
 import { findAstNodes, getFirstNode } from './ast_helpers';
@@ -45,39 +43,6 @@ export function registerLocaleData(
       return;
     }
 
-    // get the path of the common module
-    const commonPath = path.dirname(require.resolve('@angular/common/package.json'));
-    // check if the locale file exists
-    if (!fs.existsSync(path.resolve(commonPath, 'locales', `${locale}.js`))) {
-      // check for an alternative locale (if the locale id was badly formatted)
-      const locales = fs.readdirSync(path.resolve(commonPath, 'locales'))
-        .filter(file => file.endsWith('.js'))
-        .map(file => file.replace('.js', ''));
-
-      let newLocale;
-      const normalizedLocale = locale.toLowerCase().replace(/_/g, '-');
-      for (const l of locales) {
-        if (l.toLowerCase() === normalizedLocale) {
-          newLocale = l;
-          break;
-        }
-      }
-
-      if (newLocale) {
-        locale = newLocale;
-      } else {
-        // check for a parent locale
-        const parentLocale = normalizedLocale.split('-')[0];
-        if (locales.indexOf(parentLocale) !== -1) {
-          locale = parentLocale;
-        } else {
-          throw new Error(
-            `Unable to load the locale data file "@angular/common/locales/${locale}", ` +
-            `please check that "${locale}" is a valid locale id.`);
-        }
-      }
-    }
-
     // Create the import node for the locale.
     const localeIdentifier = ts.createIdentifier(`__locale_${locale.replace(/-/g, '')}__`);
     const localeImportClause = ts.createImportClause(localeIdentifier, undefined);
@@ -92,7 +57,7 @@ export function registerLocaleData(
 
     // Create the import node for the registerLocaleData function.
     const regIdentifier = ts.createIdentifier(`registerLocaleData`);
-    const regImportSpecifier = ts.createImportSpecifier(regIdentifier, regIdentifier);
+    const regImportSpecifier = ts.createImportSpecifier(undefined, regIdentifier);
     const regNamedImport = ts.createNamedImports([regImportSpecifier]);
     const regImportClause = ts.createImportClause(undefined, regNamedImport);
     const regNewImport = ts.createImportDeclaration(undefined, undefined, regImportClause,

tests/e2e/tests/build/aot/angular-compiler.ts

@@ -42,14 +42,14 @@ export default function () {
 
     // tests for register_locale_data transformer
     .then(() => rimraf('dist'))
-    .then(() => ng('build', '--aot', '--locale=fr'))
+    .then(() => ng('build', '--locale=fr'))
     .then(() => expectFileToMatch('dist/main.bundle.js',
       /registerLocaleData/))
     .then(() => expectFileToMatch('dist/main.bundle.js',
       /angular_common_locales_fr/))
     .then(() => rimraf('dist'))
     .then(() => expectToFail(() =>
-      ng('build', '--aot', '--locale=no-locale')))
+      ng('build', '--locale=no-locale')))
 
     // Cleanup
     .then(() => {