fix(@schematics/angular): migrate localized base HREF options for 9.0

Author: clydin

packages/schematics/angular/migrations/update-9/update-workspace-config.ts

@@ -71,7 +71,7 @@ function addProjectI18NOptions(
   }
 
   // browser builder options
-  let locales: Record<string, string> | undefined;
+  let locales: Record<string, string | { translation: string; baseHref: string }> | undefined;
   const options = getAllOptions(browserConfig);
   for (const option of options) {
     const localeId = findPropertyInAstObject(option, 'i18nLocale');
@@ -87,12 +87,30 @@ function addProjectI18NOptions(
     const localIdValue = localeId.value;
     const localeFileValue = localeFile.value;
 
+    const baseHref = findPropertyInAstObject(option, 'baseHref');
+    let baseHrefValue;
+    if (baseHref && baseHref.kind === 'string' && baseHref.value !== `/${localIdValue}/`) {
+      baseHrefValue = baseHref.value;
+    }
+
     if (!locales) {
       locales = {
-        [localIdValue]: localeFileValue,
+        [localIdValue]:
+          baseHrefValue === undefined
+            ? localeFileValue
+            : {
+                translation: localeFileValue,
+                baseHref: baseHrefValue,
+              },
       };
     } else {
-      locales[localIdValue] = localeFileValue;
+      locales[localIdValue] =
+        baseHrefValue === undefined
+          ? localeFileValue
+          : {
+              translation: localeFileValue,
+              baseHref: baseHrefValue,
+            };
     }
   }
 
@@ -145,6 +163,12 @@ function addBuilderI18NOptions(recorder: UpdateRecorder, builderConfig: JsonAstO
     if (i18nFormat) {
       removePropertyInAstObject(recorder, option, 'i18nFormat');
     }
+
+    // localize base HREF values are either automatic or controlled by the i18n configuration
+    const baseHref = findPropertyInAstObject(option, 'baseHref');
+    if (localeId && i18nFile && baseHref) {
+      removePropertyInAstObject(recorder, option, 'baseHref');
+    }
   }
 }
 

packages/schematics/angular/migrations/update-9/update-workspace-config_spec.ts

@@ -55,7 +55,7 @@ const stylesExpectWithLazy = [
 const workspacePath = '/angular.json';
 
 // tslint:disable:no-big-function
-describe('Migration to version 9', () => {
+fdescribe('Migration to version 9', () => {
   describe('Migrate workspace config', () => {
     const schematicRunner = new SchematicTestRunner(
       'migrations',
@@ -350,6 +350,41 @@ describe('Migration to version 9', () => {
           expect(config.configurations.de.i18nLocale).toBeUndefined();
         });
 
+        it('should remove baseHref option when used with i18n options and uses locale value', async () => {
+          let config = getWorkspaceTargets(tree);
+          config.build.options = getI18NConfig('fr');
+          config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/de/' };
+          updateWorkspaceTargets(tree, config);
+
+          const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
+          config = getWorkspaceTargets(tree2).build;
+          expect(config.configurations.de.baseHref).toBeUndefined();
+        });
+
+        it('should keep baseHref option when not used with i18n options', async () => {
+          let config = getWorkspaceTargets(tree);
+          config.build.options = getI18NConfig('fr');
+          config.build.configurations.de = getI18NConfig('de');
+          config.build.configurations.staging = { baseHref: '/de/' };
+          updateWorkspaceTargets(tree, config);
+
+          const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
+          config = getWorkspaceTargets(tree2).build;
+          expect(config.configurations.staging.baseHref).toBe('/de/');
+        });
+
+        it('should keep main baseHref option when used with i18n options', async () => {
+          let config = getWorkspaceTargets(tree);
+          config.build.options = { baseHref: '/my-app/' };
+          config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/de/' };
+          updateWorkspaceTargets(tree, config);
+
+          const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
+          config = getWorkspaceTargets(tree2).build;
+          expect(config.options.baseHref).toBe('/my-app/');
+          expect(config.configurations.de.baseHref).toBeUndefined();
+        });
+
         it('should remove deprecated extract-i18n options', async () => {
           let config = getWorkspaceTargets(tree);
           config['extract-i18n'].options.i18nFormat = 'xmb';
@@ -392,6 +427,22 @@ describe('Migration to version 9', () => {
             fr: 'src/locale/messages.fr.xlf',
           });
         });
+
+        it(`should add i18n 'locales' project config when using baseHref options`, async () => {
+          const config = getWorkspaceTargets(tree);
+          config.build.options = { baseHref: '/my-app/' };
+          config.build.configurations.fr = { ...getI18NConfig('fr'), baseHref: '/fr/' };
+          config.build.configurations.de = { ...getI18NConfig('de'), baseHref: '/abc/' };
+          updateWorkspaceTargets(tree, config);
+
+          const tree2 = await schematicRunner.runSchematicAsync('workspace-version-9', {}, tree.branch()).toPromise();
+          const projectConfig = JSON.parse(tree2.readContent(workspacePath)).projects['migration-test'];
+          expect(projectConfig.i18n.sourceLocale).toBeUndefined();
+          expect(projectConfig.i18n.locales).toEqual({
+            de: { translation: 'src/locale/messages.de.xlf', baseHref: '/abc/' },
+            fr: 'src/locale/messages.fr.xlf',
+          });
+        });
       });
 
       describe('when i18n builder options are not set', () => {