fix(deep-linking): fix issue where deep link config ends up being null when full build is triggered via a change to a template file with the identical content

Author: danbucholtz

src/deep-linking.spec.ts

@@ -3,7 +3,7 @@ import { join } from 'path';
 import * as deepLinking from './deep-linking';
 import * as deeplinkUtils from './deep-linking/util';
 import * as Constants from './util/constants';
-import { ChangedFile } from './util/interfaces';
+import { BuildState, ChangedFile } from './util/interfaces';
 import { FileCache } from './util/file-cache';
 import * as helpers from './util/helpers';
 
@@ -335,5 +335,26 @@ export class AppModule { }
         expect(spy).toHaveBeenCalledTimes(2);
       });
     });
+
+    describe('deepLinkingUpdate', () => {
+      it('should clear an existing cached deep link string so it can generate a new one', () => {
+        const context = {
+          deepLinkState: BuildState.RequiresBuild,
+          fileCache: new FileCache()
+        };
+
+        const somePath = 'somePath';
+        context.fileCache.set(somePath, { path: somePath, content: 'someContent'});
+        const originalCachedDeepLinkString = 'someKnownString';
+        deepLinking.setCachedDeepLinkString(originalCachedDeepLinkString);
+        spyOn(helpers, helpers.getStringPropertyValue.name).and.returnValue(somePath);
+        spyOn(deeplinkUtils, deeplinkUtils.hasExistingDeepLinkConfig.name).and.returnValue(false);
+        const setDeeplinkConfigSpy = spyOn(helpers, helpers.setParsedDeepLinkConfig.name);
+        return deepLinking.deepLinkingUpdate([], context).then(() => {
+          expect(setDeeplinkConfigSpy.calls.mostRecent().args[0].length).toEqual(0);
+          expect(deepLinking.cachedDeepLinkString).toEqual(null);
+        });
+      });
+    });
   });
 });

src/deep-linking.ts

@@ -53,7 +53,6 @@ export function deepLinkingWorkerImpl(context: BuildContext, changedFiles: Chang
     const deepLinkConfigEntries = getDeepLinkData(appNgModulePath, context.fileCache, context.runAot) || [];
     if (deepLinkConfigEntries.length) {
       const newDeepLinkString = convertDeepLinkConfigEntriesToString(deepLinkConfigEntries);
-
       // 1. this is the first time running this, so update the build either way
       // 2. we have an existing deep link string, and we have a new one, and they're different - so go ahead and update the config
       // 3. the app's main ngmodule has changed, so we need to rewrite the config
@@ -104,6 +103,9 @@ export function deepLinkingUpdateImpl(changedFiles: ChangedFile[], context: Buil
 
 export function deepLinkingWorkerFullUpdate(context: BuildContext) {
   const logger = new Logger(`deeplinks update`);
+  // when a full build is required (when a template fails to update, etc), remove the cached deep link string to force a new one
+  // to be inserted
+  cachedDeepLinkString = null;
   return deepLinkingWorker(context).then((deepLinkConfigEntries: DeepLinkConfigEntry[]) => {
       setParsedDeepLinkConfig(deepLinkConfigEntries);
       logger.finish();
@@ -115,8 +117,12 @@ export function deepLinkingWorkerFullUpdate(context: BuildContext) {
     });
 }
 
-// this is purely for testing
+// these functions are  purely for testing
 export function reset() {
   cachedUnmodifiedAppNgModuleFileContent = null;
   cachedDeepLinkString = null;
 }
+
+export function setCachedDeepLinkString(input: string) {
+  cachedDeepLinkString = input;
+}