Merge pull request #267 from siberiacancode/prototype/queue-as-handler

prototype/queue-as-handler 💎 resolve 'queue' variant as data handler internally

Author: MiaInturi

packages/server/README.md

@@ -99,7 +99,7 @@ Every route must be configured to handle response content in one of three ways:
   - `data?` `any` mock data of request
   - `queue?` `Array<{ time?: number; data: any}>` queue for polling with opportunity to set time for each response
   - `file?` `string` path to file for return in response
-  - `settings?` `Settings` settings for route (polling on/off, etc.)
+  - `settings?` `Settings` settings for route (status, delay)
   - `entities?` `Object<headers | cookies | query | params | body>` object that helps in data retrieval
   - `interceptors?` `Interceptors` functions to change request or response parameters, [read](#interceptors)
 - `interceptors?` `Interceptors` functions to change request or response parameters, [read](#interceptors)
@@ -539,7 +539,7 @@ export default flatMockServerConfig;
 
 #### Polling
 
-Routes support polling for data. To add polling for data, you must specify the `polling setting` and use `queue` property instead of `data` or `file`.
+Routes support polling for data. To add polling for data, use `queue` property instead of `data` or `file`.
 
 `queue` is an array containing `data` or `file` that should be returned in order.
 
@@ -558,7 +558,6 @@ const flatMockServerConfig = [
         method: "get",
         routes: [
           {
-            settings: { polling: true },
             queue: [
               { data: { emoji: "🦁", name: "Nursultan" } },
               { data: { emoji: "☄", name: "Dmitriy" } },
@@ -589,7 +588,6 @@ const flatMockServerConfig = [
         method: "get",
         routes: [
           {
-            settings: { polling: true },
             queue: [
               { time: 5000, data: { emoji: "🦁", name: "Nursultan" } },
               { data: { emoji: "☄", name: "Dmitriy" } },

packages/server/src/core/functions/graphql/graphql.test.ts

@@ -4,11 +4,7 @@ import { graphql } from './graphql';
 
 describe('graphql', () => {
   it('Should build config for inline response', () => {
-    const result = graphql.query(
-      'GetUsers',
-      { ok: true },
-      { delay: 25, polling: true, status: 201 }
-    );
+    const result = graphql.query('GetUsers', { ok: true }, { delay: 25, status: 201 });
 
     expect(result).toStrictEqual({
       operationName: 'GetUsers',
@@ -17,7 +13,7 @@ describe('graphql', () => {
         {
           data: { ok: true },
           entities: {},
-          settings: { delay: 25, polling: false, status: 201 }
+          settings: { delay: 25, status: 201 }
         }
       ]
     });
@@ -34,7 +30,7 @@ describe('graphql', () => {
         },
         response: { ok: true }
       },
-      { delay: 20, polling: true, status: 205 }
+      { delay: 20, status: 205 }
     );
 
     expect(result).toStrictEqual({
@@ -48,7 +44,7 @@ describe('graphql', () => {
               key: 'value'
             }
           },
-          settings: { delay: 20, polling: false, status: 205 }
+          settings: { delay: 20, status: 205 }
         }
       ]
     });
@@ -64,18 +60,15 @@ describe('graphql', () => {
         {
           data: { ok: true },
           entities: {},
-          settings: { polling: false }
+          settings: {}
         }
       ]
     });
   });
 
   it('Should build config for inline handler', () => {
     const handler = vi.fn().mockResolvedValue({ ok: true });
-    const result = graphql.query('GetUsers', handler, {
-      delay: 30,
-      polling: true
-    });
+    const result = graphql.query('GetUsers', handler, { delay: 30 });
 
     expect(result).toStrictEqual({
       operationName: 'GetUsers',
@@ -84,7 +77,7 @@ describe('graphql', () => {
         {
           data: handler,
           entities: {},
-          settings: { delay: 30, polling: false }
+          settings: { delay: 30 }
         }
       ]
     });
@@ -102,7 +95,7 @@ describe('graphql', () => {
           }
         }
       },
-      { delay: 40, polling: true, status: 206 }
+      { delay: 40, status: 206 }
     );
 
     expect(result).toStrictEqual({
@@ -116,13 +109,13 @@ describe('graphql', () => {
               key: 'value'
             }
           },
-          settings: { delay: 40, polling: false, status: 206 }
+          settings: { delay: 40, status: 206 }
         }
       ]
     });
   });
 
-  it('Should build config for queue object and normalize queue items', () => {
+  it('Should build config for queue object as data handler', () => {
     const queueHandler = vi.fn().mockResolvedValue({ ok: 'handler' });
     const result = graphql.query(
       'GetUsers',
@@ -137,24 +130,21 @@ describe('graphql', () => {
           { response: { ok: 'response' }, time: 200 }
         ]
       },
-      { delay: 50, polling: false, status: 207 }
+      { delay: 50, status: 207 }
     );
 
     expect(result).toStrictEqual({
       operationName: 'GetUsers',
       operationType: 'query',
       routes: [
         {
-          queue: [
-            { data: queueHandler, time: 100 },
-            { data: { ok: 'response' }, time: 200 }
-          ],
+          data: expect.any(Function),
           entities: {
             headers: {
               key: 'value'
             }
           },
-          settings: { delay: 50, polling: true, status: 207 }
+          settings: { delay: 50, status: 207 }
         }
       ]
     });
@@ -170,7 +160,7 @@ describe('graphql', () => {
         {
           data: { ok: true },
           entities: {},
-          settings: { polling: false }
+          settings: {}
         }
       ]
     });
@@ -186,7 +176,7 @@ describe('graphql', () => {
         {
           data: { ok: true },
           entities: {},
-          settings: { polling: false }
+          settings: {}
         }
       ]
     });
@@ -207,7 +197,7 @@ describe('graphql', () => {
         {
           data: { ok: true },
           entities: {},
-          settings: { polling: false }
+          settings: {}
         }
       ]
     });
@@ -217,7 +207,7 @@ describe('graphql', () => {
     const result = graphql.query(
       'GetUsers',
       { response: { ok: true } },
-      { delay: 150, polling: false, status: 200 }
+      { delay: 150, status: 200 }
     );
 
     expect(result).toStrictEqual({
@@ -227,7 +217,7 @@ describe('graphql', () => {
         {
           data: { ok: true },
           entities: {},
-          settings: { delay: 150, polling: false, status: 200 }
+          settings: { delay: 150, status: 200 }
         }
       ]
     });
@@ -255,7 +245,7 @@ describe('graphql', () => {
         {
           data: expect.any(Function),
           entities: {},
-          settings: { polling: false }
+          settings: {}
         }
       ]
     });

packages/server/src/core/functions/graphql/graphql.ts

@@ -1,4 +1,5 @@
 import type {
+  Data,
   GraphQLEntitiesByEntityName,
   GraphQLOperationName,
   GraphQLOperationType,
@@ -8,11 +9,13 @@ import type {
   GraphQLSettings
 } from '@/utils/types';
 
+import { createQueueHandler } from './helpers';
+
 interface GraphQLRequestInput {
   body?: unknown;
   params?: unknown;
   query?: unknown;
-  response?: unknown;
+  response?: Data;
 }
 
 type ReservedGraphQLConfigKeys = {
@@ -63,52 +66,58 @@ const resolveConfigType = <Options extends GraphQLRequestInput>(config: GraphQLC
 
 const createConfigResolver = <Options extends GraphQLRequestInput>(
   config: GraphQLConfig<Options>,
-  settings?: GraphQLSettings
-) => {
+  settings: GraphQLSettings = {}
+): GraphQLRouteConfig => {
   const resolvedConfig = resolveConfigType(config);
 
   switch (resolvedConfig.type) {
     case 'inlineResponse':
       return {
         data: resolvedConfig.config,
         entities: {},
-        settings: { ...settings, polling: false }
+        settings
       };
 
     case 'data': {
       return {
         data: resolvedConfig.config.response,
         entities: resolvedConfig.config.match ?? {},
-        settings: { ...settings, polling: false }
+        settings
       };
     }
 
     case 'queue': {
-      return {
-        queue: resolvedConfig.config.queue.map((item) => {
-          if ('handler' in item) {
-            return { data: item.handler, time: item.time };
-          }
+      const normalizedQueue = resolvedConfig.config.queue.map((item) => {
+        if ('handler' in item) {
+          return { data: item.handler, time: item.time };
+        }
 
+        if ('response' in item) {
           return { data: item.response, time: item.time };
-        }),
+        }
+
+        throw new Error(`Unexpected queue item kind: ${JSON.stringify(item, null, 2)}`);
+      });
+
+      return {
+        data: createQueueHandler(normalizedQueue),
         entities: resolvedConfig.config.match ?? {},
-        settings: { ...settings, polling: true }
+        settings
       };
     }
 
     case 'inlineHandler':
       return {
         data: resolvedConfig.config,
         entities: {},
-        settings: { ...settings, polling: false }
+        settings
       };
 
     case 'handlerObj': {
       return {
         data: resolvedConfig.config.handler,
         entities: resolvedConfig.config.match ?? {},
-        settings: { ...settings, polling: false }
+        settings
       };
     }
 
@@ -171,17 +180,15 @@ const createGraphQLFactory = <Mode extends GraphQLFactoryMode>(mode: Mode) => {
     if (mode === 'raw') {
       return {
         query: identifier as string,
-        operationType: (operationType ?? 'query') as GraphQLOperationType,
-        routes: [
-          createConfigResolver(config as GraphQLConfig<Options>, settings) as GraphQLRouteConfig
-        ]
+        operationType: operationType ?? 'query',
+        routes: [createConfigResolver(config, settings)]
       };
     }
 
     return {
-      operationName: identifier as GraphQLOperationName,
+      operationName: identifier,
       operationType: mode,
-      routes: [createConfigResolver(config, settings) as GraphQLRouteConfig]
+      routes: [createConfigResolver(config, settings)]
     };
   }