-
Notifications
You must be signed in to change notification settings - Fork 128
/
getWordPressProps.tsx
214 lines (185 loc) · 5.59 KB
/
getWordPressProps.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
// eslint-disable-next-line import/extensions
import { print } from '@apollo/client/utilities';
import type { DocumentNode } from 'graphql';
import { sha256 } from 'js-sha256';
import { GetServerSidePropsContext, GetStaticPropsContext } from 'next';
import { addApolloState, getApolloClient } from './client.js';
import { FaustTemplateProps } from './components/WordPressTemplate.js';
import { getConfig } from './config/index.js';
import { getPossibleTemplates, getTemplate } from './getTemplate.js';
import { SEED_QUERY, SeedNode } from './queries/seedQuery.js';
import { debugLog, infoLog } from './utils/log.js';
import { hooks } from './wpHooks/index.js';
import { FaustQueries } from './store/FaustContext.js';
export const DEFAULT_ISR_REVALIDATE = 60 * 15; // 15 minutes
function isSSR(
ctx: GetServerSidePropsContext | GetStaticPropsContext,
): ctx is GetServerSidePropsContext {
return (ctx as GetServerSidePropsContext).req !== undefined;
}
type QueryVariablesArgs = [
seedNode: SeedNode,
context?: {
asPreview?: boolean;
locale?: string;
},
extra?: Record<string, unknown>,
];
const createNotFound = (
ctx: GetStaticPropsContext,
revalidate?: number | boolean,
) => ({
notFound: true as const,
...(!isSSR(ctx) && { revalidate: revalidate ?? DEFAULT_ISR_REVALIDATE }),
});
export type WordPressTemplate = React.FC & {
query?: DocumentNode;
queries?: {
query: DocumentNode;
variables?: (...args: QueryVariablesArgs) => {
[key: string]: any;
};
}[];
variables?: (...args: QueryVariablesArgs) => {
[key: string]: any;
};
};
export interface FaustTemplate<Data>
extends React.FC<FaustTemplateProps<Data>> {
query?: WordPressTemplate['query'];
variables?: WordPressTemplate['variables'];
}
export interface GetWordPressPropsConfig<Props = Record<string, unknown>> {
ctx: GetServerSidePropsContext | GetStaticPropsContext;
props?: Props;
revalidate?: number | boolean;
/**
* Provide extra parameters for the Page.variables function call.
*/
extra?: Props;
}
export async function getWordPressProps(
options: GetWordPressPropsConfig,
): Promise<
| {
props: {
[key: string]: any;
};
revalidate?: number | boolean | undefined;
}
| {
notFound: true;
revalidate?: number | boolean | undefined;
}
> {
const { templates } = getConfig();
if (!templates) {
throw new Error('Templates are required. Please add them to your config.');
}
const { ctx, props, revalidate, extra } = options;
const client = getApolloClient();
let resolvedUrl = null;
if (!isSSR(ctx)) {
const wordPressNodeParams = ctx.params?.wordpressNode;
if (wordPressNodeParams && Array.isArray(wordPressNodeParams)) {
resolvedUrl = `/${wordPressNodeParams.join('/')}`;
} else {
resolvedUrl = '/';
}
} else {
resolvedUrl = ctx.resolvedUrl;
ctx.res.setHeader('x-using', 'faust');
}
resolvedUrl = hooks.applyFilters('resolvedUrl', resolvedUrl, {
nextContext: ctx,
}) as string | null;
if (!resolvedUrl) {
return createNotFound(ctx, revalidate);
}
const seedQuery = hooks.applyFilters('seedQueryDocumentNode', SEED_QUERY, {
resolvedUrl,
}) as DocumentNode;
const seedQueryRes = await client.query({
query: seedQuery,
variables: { uri: resolvedUrl },
});
// Since previews only work for client side, we only need to handle nodeByUri instead of both that and contentNode.
const seedNode = seedQueryRes?.data?.nodeByUri as SeedNode;
debugLog(`Seed Node for resolved url: "${resolvedUrl}": `, seedNode);
if (!seedNode) {
return createNotFound(ctx, revalidate);
}
infoLog(
`Possible templates for resolved url: "${resolvedUrl}":`,
getPossibleTemplates(seedNode),
);
const template = getTemplate(seedNode, templates);
if (!template) {
return createNotFound(ctx, revalidate);
}
if (template.query && template.queries) {
throw new Error(
'`Only either `Component.query` or `Component.queries` can be provided, but not both.',
);
}
let templateQueryRes;
const templateVariables = template?.variables
? template?.variables(
seedNode,
{
asPreview: false,
locale: ctx.locale,
},
extra,
)
: undefined;
if (template.query) {
templateQueryRes = await client.query({
query: template.query,
variables: templateVariables,
});
}
let queries: FaustQueries | null = null;
if (template.queries) {
const queryCalls = template.queries.map(({ query, variables }) => {
const queryVariables = variables
? variables(
seedNode,
{
asPreview: false,
locale: ctx.locale,
},
extra,
)
: undefined;
return client.query({
query,
variables: queryVariables,
});
});
const queriesRes = await Promise.all(queryCalls);
queries = {};
queriesRes.forEach((queryRes, index) => {
if (queries && template.queries) {
queries[sha256(print(template.queries[index].query))] = queryRes.data;
}
});
}
const appProps = addApolloState(client, {
props: {
/**
* The following props may be null coalesced as an "undefined"
* value is not able to be serialized
*/
__SEED_NODE__: seedNode ?? null,
__TEMPLATE_QUERY_DATA__: templateQueryRes?.data ?? null,
__TEMPLATE_VARIABLES__: templateVariables ?? null,
__FAUST_QUERIES__: queries ?? null,
...props,
},
});
if (!isSSR(ctx)) {
appProps.revalidate = revalidate ?? DEFAULT_ISR_REVALIDATE;
}
return appProps;
}