feat(react): add addUrlForHydration and integrate into FeatureAppLoad…

…er (#320)
feature-hub · Jan 30, 2019 · 9de6cf2 · 9de6cf2
1 parent 420523a
commit 9de6cf2
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 5 deletions.
diff --git a/packages/react/src/__tests__/feature-app-loader.node.test.tsx b/packages/react/src/__tests__/feature-app-loader.node.test.tsx
@@ -24,6 +24,7 @@ describe('FeatureAppLoader (on Node.js)', () => {
   let mockGetAsyncFeatureAppDefinition: jest.Mock;
   let mockAsyncFeatureAppDefinition: AsyncValue<FeatureAppDefinition<unknown>>;
   let mockAsyncSsrManager: MockAsyncSsrManager;
+  let mockAddUrlForHydration: jest.Mock;
   let stubbedConsole: Stubbed<Console>;
 
   beforeEach(() => {
@@ -50,6 +51,8 @@ describe('FeatureAppLoader (on Node.js)', () => {
       renderUntilCompleted: jest.fn()
     };
 
+    mockAddUrlForHydration = jest.fn();
+
     stubbedConsole = stubMethods(console);
   });
 
@@ -62,7 +65,8 @@ describe('FeatureAppLoader (on Node.js)', () => {
       <FeatureHubContextProvider
         value={{
           featureAppManager: mockFeatureAppManager,
-          asyncSsrManager: mockAsyncSsrManager
+          asyncSsrManager: mockAsyncSsrManager,
+          addUrlForHydration: mockAddUrlForHydration
         }}
       >
         {node}
@@ -81,6 +85,12 @@ describe('FeatureAppLoader (on Node.js)', () => {
 
       expect(mockAsyncSsrManager.rerenderAfter).not.toHaveBeenCalled();
     });
+
+    it('does not add a URL for hydration', () => {
+      renderWithFeatureHubContext(<FeatureAppLoader src="example.js" />);
+
+      expect(mockAddUrlForHydration).not.toHaveBeenCalled();
+    });
   });
 
   describe('with a serverSrc', () => {
@@ -104,6 +114,14 @@ describe('FeatureAppLoader (on Node.js)', () => {
       ]);
     });
 
+    it('adds the src URL for hydration', () => {
+      renderWithFeatureHubContext(
+        <FeatureAppLoader src="example.js" serverSrc="example-node.js" />
+      );
+
+      expect(mockAddUrlForHydration).toHaveBeenCalledWith('example.js');
+    });
+
     describe('when a Feature App definition is synchronously available', () => {
       let mockFeatureAppDefinition: FeatureAppDefinition<unknown>;
 
@@ -163,6 +181,16 @@ describe('FeatureAppLoader (on Node.js)', () => {
 
         expect(mockAsyncSsrManager.rerenderAfter).not.toHaveBeenCalled();
       });
+
+      it('adds the src URL for hydration', () => {
+        try {
+          renderWithFeatureHubContext(
+            <FeatureAppLoader src="example.js" serverSrc="example-node.js" />
+          );
+        } catch {}
+
+        expect(mockAddUrlForHydration).toHaveBeenCalledWith('example.js');
+      });
     });
   });
 });
diff --git a/packages/react/src/__tests__/feature-app-loader.test.tsx b/packages/react/src/__tests__/feature-app-loader.test.tsx
@@ -25,6 +25,7 @@ describe('FeatureAppLoader', () => {
   let mockGetAsyncFeatureAppDefinition: jest.Mock;
   let mockAsyncFeatureAppDefinition: AsyncValue<FeatureAppDefinition<unknown>>;
   let mockAsyncSsrManager: MockAsyncSsrManager;
+  let mockAddUrlForHydration: jest.Mock;
   let stubbedConsole: Stubbed<Console>;
 
   beforeEach(() => {
@@ -52,6 +53,8 @@ describe('FeatureAppLoader', () => {
       renderUntilCompleted: jest.fn()
     };
 
+    mockAddUrlForHydration = jest.fn();
+
     stubbedConsole = stubMethods(console);
   });
 
@@ -74,7 +77,8 @@ describe('FeatureAppLoader', () => {
       <FeatureHubContextProvider
         value={{
           featureAppManager: mockFeatureAppManager,
-          asyncSsrManager: mockAsyncSsrManager
+          asyncSsrManager: mockAsyncSsrManager,
+          addUrlForHydration: mockAddUrlForHydration
         }}
       >
         {node}
@@ -166,6 +170,14 @@ describe('FeatureAppLoader', () => {
 
       expect(mockAsyncSsrManager.rerenderAfter).not.toHaveBeenCalled();
     });
+
+    it('does not add a URL for hydration', () => {
+      renderWithFeatureHubContext(
+        <FeatureAppLoader src="example.js" serverSrc="example-node.js" />
+      );
+
+      expect(mockAddUrlForHydration).not.toHaveBeenCalled();
+    });
   });
 
   describe('when the async Feature App definition synchronously has an error', () => {
@@ -240,6 +252,14 @@ describe('FeatureAppLoader', () => {
       expect(mockAsyncSsrManager.rerenderAfter).not.toHaveBeenCalled();
     });
 
+    it('does not add a URL for hydration', () => {
+      renderWithFeatureHubContext(
+        <FeatureAppLoader src="example.js" serverSrc="example-node.js" />
+      );
+
+      expect(mockAddUrlForHydration).not.toHaveBeenCalled();
+    });
+
     describe('when unmounted before loading has finished', () => {
       it('renders nothing', async () => {
         const testRenderer = renderWithFeatureHubContext(

diff --git a/packages/react/src/feature-app-loader.tsx b/packages/react/src/feature-app-loader.tsx
@@ -64,7 +64,8 @@ class InternalFeatureAppLoader extends React.PureComponent<
       featureAppManager,
       src: browserSrc,
       serverSrc,
-      asyncSsrManager
+      asyncSsrManager,
+      addUrlForHydration
     } = props;
 
     const src = inBrowser ? browserSrc : serverSrc;
@@ -77,6 +78,10 @@ class InternalFeatureAppLoader extends React.PureComponent<
       return;
     }
 
+    if (!inBrowser && addUrlForHydration) {
+      addUrlForHydration(browserSrc);
+    }
+
     const asyncFeatureAppDefinition = featureAppManager.getAsyncFeatureAppDefinition(
       src
     );
@@ -202,10 +207,11 @@ class InternalFeatureAppLoader extends React.PureComponent<
 export function FeatureAppLoader(props: FeatureAppLoaderProps): JSX.Element {
   return (
     <FeatureHubContextConsumer>
-      {({featureAppManager, asyncSsrManager}) => (
+      {({featureAppManager, asyncSsrManager, addUrlForHydration}) => (
         <InternalFeatureAppLoader
           featureAppManager={featureAppManager}
           asyncSsrManager={asyncSsrManager}
+          addUrlForHydration={addUrlForHydration}
           {...props}
         />
       )}

diff --git a/packages/react/src/feature-hub-context.tsx b/packages/react/src/feature-hub-context.tsx
@@ -7,10 +7,23 @@ export interface FeatureHubContextValue {
    * The `FeatureAppManager` singleton instance.
    */
   featureAppManager: FeatureAppManagerLike;
+
   /**
-   * The Async SSR Manager Feature Service that is bound to the integrator.
+   * The Async SSR Manager Feature Service that is bound to the integrator. It
+   * is only provided on the server.
    */
   asyncSsrManager?: AsyncSsrManagerV0;
+
+  /**
+   * A callback that the integrator provides on the server, mainly for the
+   * {@link FeatureAppLoader}, to add browser URLs of those Feature Apps that
+   * are rendered on the server, so that they can be preloaded in the browser
+   * before hydration. Calling it more than once with the same URL must not have
+   * any impact.
+   *
+   * @param url The browser URL of a Feature App that is rendered on the server.
+   */
+  addUrlForHydration?(url: string): void;
 }
 
 const dummyDefaultFeatureHubContextValue = {};