add experimental data routes

Author: nickreese

src/routes/prepareRouter.ts

@@ -39,7 +39,27 @@ type Req = {
 interface IFindPrebuildRequest {
   req: Req;
   serverLookupObject: any;
+  dataRoutes: boolean | string;
 }
+
+export const getDataRequest = ({ req, server, serverLookupObject }) => {
+  // check data routes
+  let request;
+  if (server.dataRoutes) {
+    const dataSuffix = typeof server.dataRoutes === 'string' ? server.dataRoutes : 'data.json';
+    if (req.path.endsWith(dataSuffix)) {
+      const lookup = req.path.replace(dataSuffix, '');
+      request = serverLookupObject[lookup];
+    }
+  }
+
+  if (request) {
+    request.req = req;
+  }
+
+  return request;
+};
+
 export const findPrebuiltRequest = ({ req, serverLookupObject }: IFindPrebuildRequest): RequestOptions | false => {
   // see if we have a request object with the path as is. (could include / or not.)
   let request = serverLookupObject[req.path] ? serverLookupObject[req.path] : false;
@@ -128,19 +148,26 @@ function prepareRouter(Elder) {
     shortcodes: elder.shortcodes,
   };
 
-  async function handleRequest({ res, next, request, dynamic = false }) {
+  async function handleRequest({ res, next, request, dynamic = false, dataRequest = false }) {
     if (!request.route || typeof request.route !== 'string') return next();
     if (!routes[request.route]) return next();
     const page = new Page({ ...forPage, request, next: dynamic ? next : undefined, route: routes[request.route] });
-    const html = await page.html();
+    const { htmlString: html, data } = await page.build();
+
+    if (dataRequest && data) {
+      res.setHeader('Content-Type', 'application/json');
+      res.end(JSON.stringify(data));
+      return undefined;
+    }
 
-    // note: html will be undefined if a dynamic route calls skip() as it aborts page building.
     if (html && !res.headerSent && !res.headersSent) {
+      // note: html will be undefined if a dynamic route calls skip() as it aborts page building.
       res.setHeader('Content-Type', 'text/html');
       res.end(html);
 
       return undefined;
     }
+
     return next();
   }
 
@@ -151,7 +178,11 @@ function prepareRouter(Elder) {
         // initial request may be well formed if it is modified via a hook BEFORE the router runs.
         if (initialRequestIsWellFormed(initialRequest)) return handleRequest({ res, next, request: initialRequest });
         if (!needsElderRequest({ req, prefix })) return next();
-        const request = findPrebuiltRequest({ req, serverLookupObject });
+        const dataRequest = getDataRequest({ req, server: settings.server, serverLookupObject });
+        if (dataRequest) {
+          return handleRequest({ res, next, request: { ...dataRequest, ...initialRequest }, dataRequest: true });
+        }
+        const request = findPrebuiltRequest({ req, serverLookupObject, dataRoutes: settings?.server?.dataRoutes });
         if (request) return handleRequest({ res, next, request: { ...request, ...initialRequest } });
         const dynamicRequest = requestFromDynamicRoute({ req, dynamicRoutes, requestCache });
         if (dynamicRequest)

src/utils/__tests__/__snapshots__/validations.spec.ts.snap

@@ -789,6 +789,7 @@ Object {
       "_exclusive": Object {},
       "_mutate": undefined,
       "_nodes": Array [
+        "dataRoutes",
         "cacheRequests",
         "prefix",
       ],
@@ -830,6 +831,33 @@ Object {
           ],
           "type": "boolean",
         },
+        "dataRoutes": Object {
+          "_blacklist": Object {
+            "list": Set {},
+            "refs": Map {},
+          },
+          "_conditions": Array [],
+          "_default": false,
+          "_deps": Array [],
+          "_exclusive": Object {},
+          "_label": "Experimental: Allows for getting a json response of the data object of a url. Defaults to [path]/data.json but can be any suffix/filename after the route.",
+          "_mutate": undefined,
+          "_options": Object {
+            "abortEarly": true,
+            "recursive": true,
+          },
+          "_type": "boolean",
+          "_typeError": [Function],
+          "_whitelist": Object {
+            "list": Set {},
+            "refs": Map {},
+          },
+          "tests": Array [],
+          "transforms": Array [
+            [Function],
+          ],
+          "type": "boolean",
+        },
         "prefix": Object {
           "_blacklist": Object {
             "list": Set {},

src/utils/__tests__/getConfig.spec.ts

@@ -150,7 +150,9 @@ describe('#getConfig', () => {
         expect.objectContaining({
           ...common,
           context: 'server',
-          server: false,
+          server: {
+            prefix: '',
+          },
         }),
       );
       expect(r.$$internal).toMatchObject(common$$Internal);

src/utils/__tests__/validations.spec.ts

@@ -55,6 +55,7 @@ describe('#validations', () => {
     server: {
       prefix: '',
       cacheRequests: true,
+      dataRoutes: false,
     },
     shortcodes: {
       closePattern: '}}',

src/utils/validations.ts

@@ -105,6 +105,13 @@ const configSchema = yup.object({
       .label(
         `If Elder.js should cache requests when using dynamic routing. It may be useful to turn off the cache when combining Elder.js with another caching solution to reduce the resources consumed by the server.`,
       ),
+    dataRoutes: yup
+      .boolean()
+      .notRequired()
+      .default(false)
+      .label(
+        'Experimental: Allows for getting a json response of the data object of a url. Defaults to [path]/data.json but can be any suffix/filename after the route.',
+      ),
   }),
   prefix: yup
     .string()