fix(deeplinks): make deep link config parsing support 2.x and 3.x deep link config

Author: danbucholtz

src/deep-linking/util.spec.ts

@@ -3,7 +3,7 @@ import * as util from './util';
 
 describe('util', () => {
   describe('extractDeepLinkPathData', () => {
-    /*it('should return the deep link metadata', () => {
+    it('should return the parsed deep link metadata', () => {
       const fileContent = `
 import { NgModule } from '@angular/core';
 import { IonicApp, IonicModule } from 'ionic-angular';
@@ -33,27 +33,92 @@ export function getSharedIonicModule() {
   return IonicModule.forRoot(MyApp, {}, {
     links: [
       { loadChildren: '../pages/home/home.module#HomePageModule', name: 'Home' },
-      { loadChildren: '../pages/page-one/page-one.module#PageOneModule', name: 'PageOne' },
-      { loadChildren: '../pages/page-two/page-two.module#PageTwoModule', name: 'PageTwo' }
+      { name: "PageOne", loadChildren: "../pages/page-one/page-one.module#PageOneModule" },
+      { loadChildren: \`../pages/page-two/page-two.module#PageTwoModule\`, name: \`PageTwo\` },
+      { Component: MyComponent, name: 'SomePage'},
+      { name: 'SomePage2', Component: MyComponent2 }
     ]
   });
 }
       `;
       const results = util.extractDeepLinkPathData(fileContent);
-
       expect(results).toBeTruthy();
-      expect(Array.isArray(results)).toBeTruthy();
-      expect(results[0].modulePath).toEqual('../pages/home/home.module');
-      expect(results[0].namedExport).toEqual('HomePageModule');
-      expect(results[0].name).toEqual('Home');
-      expect(results[1].modulePath).toEqual('../pages/page-one/page-one.module');
-      expect(results[1].namedExport).toEqual('PageOneModule');
-      expect(results[1].name).toEqual('PageOne');
-      expect(results[2].modulePath).toEqual('../pages/page-two/page-two.module');
-      expect(results[2].namedExport).toEqual('PageTwoModule');
-      expect(results[2].name).toEqual('PageTwo');
+
+      expect(results[0].component).toEqual(null);
+      expect(results[0].name).toBe('Home');
+      expect(results[0].modulePath).toBe('../pages/home/home.module');
+      expect(results[0].namedExport).toBe('HomePageModule');
+
+      expect(results[1].component).toEqual(null);
+      expect(results[1].name).toBe('PageOne');
+      expect(results[1].modulePath).toBe('../pages/page-one/page-one.module');
+      expect(results[1].namedExport).toBe('PageOneModule');
+
+      expect(results[2].component).toEqual(null);
+      expect(results[2].name).toBe('PageTwo');
+      expect(results[2].modulePath).toBe('../pages/page-two/page-two.module');
+      expect(results[2].namedExport).toBe('PageTwoModule');
+
+      expect(results[3].component).toEqual('MyComponent');
+      expect(results[3].name).toBe('SomePage');
+      expect(results[3].modulePath).toBe(null);
+      expect(results[3].namedExport).toBe(null);
+
+      expect(results[4].component).toEqual('MyComponent2');
+      expect(results[4].name).toBe('SomePage2');
+      expect(results[4].modulePath).toBe(null);
+      expect(results[4].namedExport).toBe(null);
+    });
+
+    it('should throw an exception when there is an invalid deep link config', () => {
+      // arrange
+      const fileContent = `
+import { NgModule } from '@angular/core';
+import { IonicApp, IonicModule } from 'ionic-angular';
+import { MyApp } from './app.component';
+import { HomePage } from '../pages/home/home';
+
+import * as Constants from '../util/constants';
+
+@NgModule({
+  declarations: [
+    MyApp,
+    HomePage
+  ],
+  imports: [
+    getSharedIonicModule()
+  ],
+  bootstrap: [IonicApp],
+  entryComponents: [
+    MyApp,
+    HomePage
+  ],
+  providers: []
+})
+export class AppModule {}
+
+export function getSharedIonicModule() {
+  return IonicModule.forRoot(MyApp, {}, {
+    links: [
+      { loadChildren: '../pages/home/home.module#HomePageModule'},
+      { name: "PageOne", loadChildren: "../pages/page-one/page-one.module#PageOneModule" },
+      { loadChildren: \`../pages/page-two/page-two.module#PageTwoModule\`, name: \`PageTwo\` },
+      { Component: MyComponent, name: 'SomePage'},
+      { name: 'SomePage2', Component: MyComponent2 }
+    ]
+  });
+}
+      `;
+      // act
+      const knownMessage = 'Should never get here';
+      try {
+        util.extractDeepLinkPathData(fileContent);
+        throw new Error(knownMessage);
+      } catch (ex) {
+        // assert
+        expect(ex.message).not.toEqual(knownMessage);
+      }
     });
-    */
   });
 
   describe('getDeepLinkData', () => {
@@ -126,8 +191,9 @@ export function getSharedIonicModule() {
   return IonicModule.forRoot(MyApp, {}, {
     links: [
       { loadChildren: '../pages/home/home.module#HomePageModule', name: 'Home' },
-      { loadChildren: '../pages/page-one/page-one.module#PageOneModule', name: 'PageOne' },
-      { loadChildren: '../pages/page-two/page-two.module#PageTwoModule', name: 'PageTwo' }
+      { name: "PageOne", loadChildren: "../pages/page-one/page-one.module#PageOneModule" },
+      { loadChildren: \`../pages/page-two/page-two.module#PageTwoModule\`, name: \`PageTwo\` },
+      { Component: MyComponent, name: 'SomePage'},
     ]
   });
 }
@@ -136,20 +202,31 @@ export function getSharedIonicModule() {
       const srcDir = '/Users/dan/Dev/myApp/src';
       const result = util.getDeepLinkData(join(srcDir, 'app/app.module.ts'), fileContent, false);
       expect(result[0].modulePath).toEqual('../pages/home/home.module');
+      expect(result[0].namedExport).toEqual('HomePageModule');
       expect(result[0].name).toEqual('Home');
+      expect(result[0].component).toEqual(null);
       expect(result[0].absolutePath).toEqual('/Users/dan/Dev/myApp/src/pages/home/home.module.ts');
 
       expect(result[1].modulePath).toEqual('../pages/page-one/page-one.module');
+      expect(result[1].namedExport).toEqual('PageOneModule');
       expect(result[1].name).toEqual('PageOne');
+      expect(result[1].component).toEqual(null);
       expect(result[1].absolutePath).toEqual('/Users/dan/Dev/myApp/src/pages/page-one/page-one.module.ts');
 
       expect(result[2].modulePath).toEqual('../pages/page-two/page-two.module');
+      expect(result[2].namedExport).toEqual('PageTwoModule');
       expect(result[2].name).toEqual('PageTwo');
+      expect(result[2].component).toEqual(null);
       expect(result[2].absolutePath).toEqual('/Users/dan/Dev/myApp/src/pages/page-two/page-two.module.ts');
 
+      expect(result[3].modulePath).toEqual(null);
+      expect(result[3].namedExport).toEqual(null);
+      expect(result[3].name).toEqual('SomePage');
+      expect(result[3].component).toEqual('MyComponent');
+      expect(result[3].absolutePath).toEqual(null);
     });
 
-    /*it('should return a deep link data adjusted for AoT', () => {
+    it('should return a deep link data adjusted for AoT', () => {
 
       const fileContent = `
 import { NgModule } from '@angular/core';
@@ -180,9 +257,9 @@ export function getSharedIonicModule() {
   return IonicModule.forRoot(MyApp, {}, {
     links: [
       { loadChildren: '../pages/home/home.module#HomePageModule', name: 'Home' },
-      { loadChildren: '../pages/page-one/page-one.module#PageOneModule', name: 'PageOne' },
-      { loadChildren: '../pages/page-two/page-two.module#PageTwoModule', name: 'PageTwo' },
-      { loadChildren: '../pages/page-three/page-three.module#PageThreeModule', name: 'PageThree' }
+      { name: "PageOne", loadChildren: "../pages/page-one/page-one.module#PageOneModule" },
+      { loadChildren: \`../pages/page-two/page-two.module#PageTwoModule\`, name: \`PageTwo\` },
+      { Component: MyComponent, name: 'SomePage'},
     ]
   });
 }
@@ -193,18 +270,132 @@ export function getSharedIonicModule() {
       expect(result[0].modulePath).toEqual('../pages/home/home.module.ngfactory');
       expect(result[0].namedExport).toEqual('HomePageModuleNgFactory');
       expect(result[0].name).toEqual('Home');
+      expect(result[0].component).toEqual(null);
       expect(result[0].absolutePath).toEqual('/Users/dan/Dev/myApp/src/pages/home/home.module.ngfactory.ts');
 
       expect(result[1].modulePath).toEqual('../pages/page-one/page-one.module.ngfactory');
       expect(result[1].namedExport).toEqual('PageOneModuleNgFactory');
       expect(result[1].name).toEqual('PageOne');
+      expect(result[1].component).toEqual(null);
       expect(result[1].absolutePath).toEqual('/Users/dan/Dev/myApp/src/pages/page-one/page-one.module.ngfactory.ts');
 
       expect(result[2].modulePath).toEqual('../pages/page-two/page-two.module.ngfactory');
       expect(result[2].namedExport).toEqual('PageTwoModuleNgFactory');
       expect(result[2].name).toEqual('PageTwo');
+      expect(result[2].component).toEqual(null);
       expect(result[2].absolutePath).toEqual('/Users/dan/Dev/myApp/src/pages/page-two/page-two.module.ngfactory.ts');
+
+      expect(result[3].modulePath).toEqual(null);
+      expect(result[3].namedExport).toEqual(null);
+      expect(result[3].name).toEqual('SomePage');
+      expect(result[3].component).toEqual('MyComponent');
+      expect(result[3].absolutePath).toEqual(null);
+    });
+  });
+
+  describe('validateDeepLinks', () => {
+    it('should return false when one entry is missing name', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: null,
+       component: {}
+      };
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(false);
+    });
+
+    it('should return false when one entry has empty name', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: '',
+       component: {}
+      };
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(false);
+    });
+
+    it('should return false when missing component and (modulePath or namedExport)', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: 'someName',
+       component: null,
+       modulePath: null
+      };
+
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(false);
+    });
+
+    it('should return false when missing component and (modulePath or namedExport)', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: 'someName',
+       component: '',
+       modulePath: ''
+      };
+
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(false);
+    });
+
+    it('should return false when missing component and has valid modulePath but missing namedExport', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: 'someName',
+       component: '',
+       modulePath: 'somePath',
+       namedExport: ''
+      };
+
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(false);
+    });
+
+    it('should return true when it has a valid modulePath and namedExport', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: 'someName',
+       component: '',
+       modulePath: 'somePath',
+       namedExport: 'someNamedExport'
+      };
+
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(true);
+    });
+
+    it('should return true when it has a valid component', () => {
+      // arrange
+      const invalidDeepLinkConfig: any = {
+       name: 'someName',
+       component: 'MyComponent',
+       modulePath: null,
+       namedExport: null
+      };
+
+      // act
+      const result = util.validateDeepLinks([invalidDeepLinkConfig]);
+
+      // assert
+      expect(result).toEqual(true);
     });
-    */
   });
 });