feat: pass renderCtx to document hooks

shuvijs · Apr 27, 2020 · e776a55 · e776a55
1 parent c31c553
commit e776a55
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 14 deletions.
diff --git a/packages/shuvi/src/renderer/base.ts b/packages/shuvi/src/renderer/base.ts
@@ -15,7 +15,7 @@ import { IBuiltResource } from '../api';
 import IHtmlTag = Runtime.IHtmlTag;
 import IDocumentProps = Runtime.IDocumentProps;
 import IRenderResultRedirect = Runtime.IRenderResultRedirect;
-import IRequest = Runtime.IRequest;
+import IRendererContext = Runtime.IRendererContext;
 
 export function isRedirect(obj: any): obj is IRenderResultRedirect {
   return obj && (obj as IRenderResultRedirect).$type === 'redirect';
@@ -38,27 +38,29 @@ export abstract class BaseRenderer {
       parsedUrl = parseUrl(req.url, true);
     }
     const { document } = this._resources.server;
-
-    const docProps = await this.getDocumentProps({
-      ...req,
-      parsedUrl,
-      headers: req.headers || {}
-    });
+    const ctx: IRendererContext = {
+      req: {
+        ...req,
+        parsedUrl,
+        headers: req.headers || {}
+      }
+    };
+    const docProps = await this.getDocumentProps(ctx);
     if (isRedirect(docProps)) {
       return docProps;
     }
 
     if (document.onDocumentProps) {
-      document.onDocumentProps(docProps);
+      document.onDocumentProps(docProps, ctx);
     }
     return this._renderDocument(
       docProps,
-      document.getTemplateData ? document.getTemplateData() : {}
+      document.getTemplateData ? document.getTemplateData(ctx) : {}
     );
   }
 
   protected abstract getDocumentProps(
-    req: IRequest
+    ctx: IRendererContext
   ):
     | Promise<IDocumentProps | IRenderResultRedirect>
     | IDocumentProps

diff --git a/packages/shuvi/src/renderer/ssr.ts b/packages/shuvi/src/renderer/ssr.ts
@@ -8,14 +8,14 @@ import { IServerContext } from './types';
 
 import IAppData = Runtime.IAppData;
 import IHtmlTag = Runtime.IHtmlTag;
-import IRequest = Runtime.IRequest;
+import IRendererContext = Runtime.IRendererContext;
 
 export class SsrRenderer extends BaseRenderer {
   constructor(ctx: IServerContext) {
     super(ctx);
   }
 
-  async getDocumentProps(req: IRequest) {
+  async getDocumentProps({ req }: IRendererContext) {
     const { api } = this._serverCtx;
     const { renderer, App, routes } = api.resources.server;
     const result = await renderer({

diff --git a/packages/types/src/runtime.d.ts b/packages/types/src/runtime.d.ts
@@ -149,11 +149,16 @@ export interface IRouter {
   onChange(listener: IRouterListener): () => void;
 }
 
+export interface IRendererContext {
+  req: IRequest;
+}
+
 export interface IDocumentModule {
   onDocumentProps(
-    documentProps: IDocumentProps
+    documentProps: IDocumentProps,
+    ctx: IRendererContext
   ): Promise<IDocumentProps> | IDocumentProps;
-  getTemplateData(): Promise<ITemplateData> | ITemplateData;
+  getTemplateData(ctx: IRendererContext): Promise<ITemplateData> | ITemplateData;
 }
 
 export interface IRuntime<CompType = unknown> {