Skip to content

feat(getMarkupFromTree): Add onBeforeRender handler. #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion src/__tests__/getMarkupFromTree-test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@ import ApolloClient from 'apollo-client';
import { ApolloLink, Observable } from 'apollo-link';
import { MockedResponse } from 'apollo-link-mock';
import gql from 'graphql-tag';
import * as React from 'react';
import React, {
HTMLAttributes,
ReactElement,
createContext,
useContext,
} from 'react';
import { renderToString } from 'react-dom/server';

import { ApolloProvider } from '../ApolloContext';
Expand Down Expand Up @@ -305,3 +310,49 @@ Object {
});
}
);

it('runs onBeforeRender', async () => {
const client = createMockClient();
const context: { headTags: Array<ReactElement<object>> } = { headTags: [] };
const Context = createContext(context);

function Title(props: HTMLAttributes<HTMLTitleElement>) {
const ctx = useContext(Context);

ctx.headTags.push(<title {...props} />);

return null;
}

let step = 0;

await getMarkupFromTree({
onBeforeRender: () => {
switch (++step) {
case 1: {
// First attempt, nothing happened yet.
expect(context.headTags).toHaveLength(0);
break;
}

case 2: {
// Second attempt, we should have populated context.
expect(context.headTags).toHaveLength(1);
break;
}
}
},
renderFunction: renderToString,
tree: (
<>
<Title>Hello!</Title>
<UserDetailsWrapper client={client} />
</>
),
});

// Second attempt should create duplicates.
expect(context.headTags).toHaveLength(2);

expect.assertions(3);
});
6 changes: 6 additions & 0 deletions src/getMarkupFromTree.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ import { isPromiseLike } from './utils';

export interface GetMarkupFromTreeOptions {
tree: React.ReactNode;
onBeforeRender?: () => void;
renderFunction: (tree: React.ReactElement<object>) => string;
}

export function getMarkupFromTree({
tree,
onBeforeRender,
renderFunction,
}: GetMarkupFromTreeOptions): Promise<string> {
const ssrManager = createSSRManager();

function process(): string | Promise<string> {
try {
if (onBeforeRender) {
onBeforeRender();
}

const html = renderFunction(
<SSRContext.Provider value={ssrManager}>{tree}</SSRContext.Provider>
);
Expand Down