Support configuring Html props from react-server

react-html's <Html> component supports a bunch of props for configuring content to inject into the head, however previously that was not exposed from react-server's createRender and createServer functions. This commit lets you pass a htmlProps option into createRender and createServer that will then be applied to the Html element. This means you can use createServer, and inject arbitary content into the head using <Html>'s headMarkup prop (and use any of <Html>'s other props too)
Shopify · Oct 22, 2020 · c0736df · c0736df
1 parent 82fe8eb
commit c0736df
Show file tree

Hide file tree

Showing 10 changed files with 133 additions and 16 deletions.
diff --git a/packages/react-html/CHANGELOG.md b/packages/react-html/CHANGELOG.md
@@ -7,6 +7,8 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- ## [Unreleased] -->
 
+- Update `HtmlProps` to mark children as optional (same as any React component) and export it ([#1661](https://github.com/Shopify/quilt/pull/1661))
+
 ## [10.0.1] - 2020-10-20
 
 - Updated `tslib` dependency to `^1.14.1`. [#1657](https://github.com/Shopify/quilt/pull/1657)

diff --git a/packages/react-html/src/server/components/Html.tsx b/packages/react-html/src/server/components/Html.tsx
@@ -20,10 +20,10 @@ export interface InlineStyle {
   content: string;
 }
 
-export interface Props {
+export interface HtmlProps {
   manager?: HtmlManager;
   hydrationManager?: HydrationManager;
-  children: React.ReactElement<any> | string;
+  children?: React.ReactElement<any> | string;
   locale?: string;
   styles?: Asset[];
   inlineStyles?: InlineStyle[];
@@ -37,7 +37,7 @@ export interface Props {
 export default function Html({
   manager,
   hydrationManager,
-  children,
+  children = '',
   locale = 'en',
   blockingScripts = [],
   scripts = [],
@@ -46,7 +46,7 @@ export default function Html({
   preloadAssets = [],
   headMarkup = null,
   bodyMarkup = null,
-}: Props) {
+}: HtmlProps) {
   const markup =
     typeof children === 'string'
       ? children

diff --git a/packages/react-html/src/server/components/index.ts b/packages/react-html/src/server/components/index.ts
@@ -1,2 +1,2 @@
 export {default as Serialize} from './Serialize';
-export {default as Html} from './Html';
+export {default as Html, HtmlProps} from './Html';
diff --git a/packages/react-server/CHANGELOG.md b/packages/react-server/CHANGELOG.md
@@ -7,6 +7,8 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- ## [Unreleased] -->
 
+- Add `htmlProps` to the options for `createRender` and `createServer`, these props will be passed into the call to `@shopify/react-html`'s `<Html>` component ([#1661](https://github.com/Shopify/quilt/pull/1661))
+
 ## [0.18.4] - 2020-10-20
 
 - Added `tslib@^1.14.1` in the list of dependencies. [#1657](https://github.com/Shopify/quilt/pull/1657)

diff --git a/packages/react-server/README.md b/packages/react-server/README.md
@@ -87,6 +87,9 @@ interface Options {
   debug?: boolean;
   // a function similar to the render option but specifically used to render error pages for production SSR errors
   renderError: RenderFunction;
+  // additional props to pass into the Html component, or a function that takes a Koa.Context and returns a props object.
+  // See https://github.com/Shopify/quilt/blob/master/packages/react-html/README.md#html-
+  htmlProps?: HtmlProps | (ctx: Context) => HtmlProps
 }
 ```
 

diff --git a/packages/react-server/src/render/index.ts b/packages/react-server/src/render/index.ts
@@ -1 +1 @@
-export {createRender, Context, RenderFunction} from './render';
+export {createRender, Context, RenderFunction, RenderOptions} from './render';
diff --git a/packages/react-server/src/render/render.tsx b/packages/react-server/src/render/render.tsx
@@ -6,6 +6,7 @@ import {Context} from 'koa';
 import compose from 'koa-compose';
 import {
   Html,
+  HtmlProps,
   HtmlManager,
   HtmlContext,
   stream,
@@ -46,26 +47,31 @@ interface Data {
   value: {[key: string]: any} | undefined;
 }
 
-type Options = Pick<
+export type RenderOptions = Pick<
   NonNullable<ArgumentAtIndex<typeof extract, 1>>,
   'afterEachPass' | 'betweenEachPass'
 > & {
   assetPrefix?: string;
   assetName?: string | ValueFromContext<string>;
   renderError?: RenderFunction;
+  htmlProps?: HtmlProps | ValueFromContext<HtmlProps>;
 };
 
 /**
  * Creates a Koa middleware for rendering an `@shopify/react-html` based React application defined by `render`.
  * @param render
  * @param options
  */
-export function createRender(render: RenderFunction, options: Options = {}) {
+export function createRender(
+  render: RenderFunction,
+  options: RenderOptions = {},
+) {
   const manifestPath = getManifestPath(process.cwd());
   const {
     assetPrefix,
     assetName: assetNameInput = 'main',
     renderError,
+    htmlProps: htmlPropsInput = {},
   } = options;
 
   async function renderFunction(ctx: Context) {
@@ -74,6 +80,15 @@ export function createRender(render: RenderFunction, options: Options = {}) {
         ? assetNameInput(ctx)
         : assetNameInput;
 
+    const {
+      scripts: additionalScripts = [],
+      styles: additionalStyles = [],
+      ...additionalHtmlProps
+    } =
+      typeof htmlPropsInput === 'function'
+        ? htmlPropsInput(ctx)
+        : htmlPropsInput;
+
     const logger = getLogger(ctx) || console;
     const assets = getAssets(ctx);
 
@@ -133,8 +148,16 @@ export function createRender(render: RenderFunction, options: Options = {}) {
         assets.scripts({name: assetName, asyncAssets: immediateAsyncAssets}),
       ]);
 
+      styles.push(...additionalStyles);
+      scripts.push(...additionalScripts);
+
       const response = stream(
-        <Html manager={htmlManager} styles={styles} scripts={scripts}>
+        <Html
+          {...additionalHtmlProps}
+          manager={htmlManager}
+          styles={styles}
+          scripts={scripts}
+        >
           <Providers>{app}</Providers>
         </Html>,
       );

diff --git a/packages/react-server/src/render/test/render.test.tsx b/packages/react-server/src/render/test/render.test.tsx
@@ -7,8 +7,8 @@ import withEnv from '@shopify/with-env';
 import {createRender, Context} from '../render';
 import {mockMiddleware} from '../../test/utilities';
 
-const mockAssetsScripts = jest.fn(() => Promise.resolve([]));
-const mockAssetsStyles = jest.fn(() => Promise.resolve([]));
+const mockAssetsScripts = jest.fn(() => Promise.resolve([{path: 'main.js'}]));
+const mockAssetsStyles = jest.fn(() => Promise.resolve([{path: 'main.css'}]));
 
 jest.mock('@shopify/sewing-kit-koa', () => ({
   middleware: jest.fn(() => mockMiddleware),
@@ -36,6 +36,59 @@ describe('createRender', () => {
     expect(await readStream(ctx.body)).toContain(myCoolApp);
   });
 
+  it.each([
+    [
+      'as Plain object',
+      {
+        scripts: [{path: '/extraScript.js'}],
+        styles: [{path: '/extraStyle.css'}],
+        headMarkup: <script>let ScriptFromHeadMarkup = 1;</script>,
+      },
+    ],
+    [
+      'as Function',
+      () => ({
+        scripts: [{path: '/extraScript.js'}],
+        styles: [{path: '/extraStyle.css'}],
+        headMarkup: <script>let ScriptFromHeadMarkup = 1;</script>,
+      }),
+    ],
+  ])(
+    'response contains data passed in through htmlProps (%s)',
+    async (style, htmlProps) => {
+      const myCoolApp = 'My cool app';
+      const ctx = createMockContext();
+
+      const renderFunction = createRender(() => <>{myCoolApp}</>, {
+        htmlProps,
+      });
+      await renderFunction(ctx, noop);
+
+      const bodyResult = await readStream(ctx.body);
+
+      // Assets from manifest are still present
+      expect(bodyResult).toContain(
+        '<script type="text/javascript" src="main.js" crossorigin="anonymous" defer=""></script>',
+      );
+      expect(bodyResult).toContain(
+        '<link rel="stylesheet" type="text/css" href="main.css" crossorigin="anonymous"/>',
+      );
+
+      // Additional script/style assets are added
+      expect(bodyResult).toContain(
+        '<script type="text/javascript" src="/extraScript.js" crossorigin="anonymous" defer=""></script>',
+      );
+      expect(bodyResult).toContain(
+        '<link rel="stylesheet" type="text/css" href="/extraStyle.css" crossorigin="anonymous"/>',
+      );
+
+      // Other props work
+      expect(bodyResult).toContain(
+        '<script>let ScriptFromHeadMarkup = 1;</script>',
+      );
+    },
+  );
+
   it('response contains x-quilt-data from headers', async () => {
     const myCoolApp = 'My cool app';
     const data = {foo: 'bar'};

diff --git a/packages/react-server/src/server/server.ts b/packages/react-server/src/server/server.ts
@@ -5,11 +5,10 @@ import Koa, {Context} from 'koa';
 import compose from 'koa-compose';
 import mount from 'koa-mount';
 
-import {createRender, RenderFunction} from '../render';
+import {createRender, RenderFunction, RenderOptions} from '../render';
 import {requestLogger} from '../logger';
 import {metricsMiddleware as metrics} from '../metrics';
 import {ping} from '../ping';
-import {ValueFromContext} from '../types';
 
 const logger = console;
 
@@ -18,10 +17,11 @@ interface Options {
   port?: number;
   assetPrefix?: string;
   proxy?: boolean;
-  assetName?: string | ValueFromContext<string>;
+  assetName?: RenderOptions['assetName'];
+  htmlProps?: RenderOptions['htmlProps'];
   serverMiddleware?: compose.Middleware<Context>[];
   render: RenderFunction;
-  renderError?: RenderFunction;
+  renderError?: RenderOptions['renderError'];
   app?: Koa;
 }
 
@@ -50,6 +50,7 @@ export function createServer(options: Options): Server {
     renderError,
     serverMiddleware,
     assetName,
+    htmlProps,
     proxy = false,
     app = new Koa(),
   } = options;
@@ -65,7 +66,9 @@ export function createServer(options: Options): Server {
     app.use(compose(serverMiddleware));
   }
 
-  app.use(createRender(render, {assetPrefix, assetName, renderError}));
+  app.use(
+    createRender(render, {assetPrefix, assetName, renderError, htmlProps}),
+  );
 
   return app.listen(port, ip, () => {
     logger.log(`started react-server on ${ip}:${port}`);

diff --git a/packages/react-server/src/server/test/server.test.tsx b/packages/react-server/src/server/test/server.test.tsx
@@ -53,6 +53,37 @@ describe('createServer()', () => {
     );
   });
 
+  it('passes htmlProps through to the Html component', async () => {
+    function MockApp() {
+      return <div>markup</div>;
+    }
+
+    const wrapper = await saddle((port, host) =>
+      createServer({
+        port,
+        ip: host,
+        render: () => <MockApp />,
+        htmlProps: {
+          scripts: [{path: '/extraScript.js'}],
+          styles: [{path: '/extraStyle.css'}],
+          headMarkup: <script>let ScriptFromHeadMarkup = 1;</script>,
+        },
+      }),
+    );
+
+    const response = await wrapper.fetch('/');
+
+    await expect(response).toHaveBodyText(
+      `<script type="text/javascript" src="/extraScript.js" crossorigin="anonymous" defer="">`,
+    );
+    await expect(response).toHaveBodyText(
+      `<link rel="stylesheet" type="text/css" href="/extraStyle.css" crossorigin="anonymous"/>`,
+    );
+    await expect(response).toHaveBodyText(
+      `<script>let ScriptFromHeadMarkup = 1;</script>`,
+    );
+  });
+
   it('supports updatable meta components', async () => {
     const myTitle = 'Shopify Mock App';