@lenne.tech/nest-server 8.6.4 → 8.6.7

package/src/test/test.helper.ts

@@ -1,9 +1,10 @@
 import { INestApplication } from '@nestjs/common';
-// import { FastifyInstance } from 'fastify';
+import { createClient } from 'graphql-ws';
 import { jsonToGraphQLQuery } from 'json-to-graphql-query';
 import * as LightMyRequest from 'light-my-request';
 import * as supertest from 'supertest';
 import * as util from 'util';
+import * as ws from 'ws';
 
 /**
  * GraphQL request type
@@ -64,6 +65,11 @@ export interface TestGraphQLOptions {
    */
   convertEnums?: boolean | string[];
 
+  /**
+   * Count of subscription messages, specifies how many messages are to be received on subscription
+   */
+  countOfSubscriptionMessages?: number;
+
   /**
    * Print console logs
    */
@@ -104,33 +110,35 @@ export class TestHelper {
   // app: FastifyInstance | INestApplication;
   app: INestApplication;
 
+  // URL with port and directory to subscription endpoint
+  // e.g.: ws://localhost:3030/graphql
+  subscriptionUrl: string;
+
   /**
    * Constructor
    */
-  constructor(app: any) {
+  constructor(app: any, subscriptionUrl?: string) {
     this.app = app;
+    this.subscriptionUrl = subscriptionUrl;
   }
 
   /**
    * GraphQL request
-   * @param graphql
-   * @param options
    */
   async graphQl(graphql: string | TestGraphQLConfig, options: TestGraphQLOptions = {}): Promise<any> {
     // Default options
-    options = Object.assign(
-      {
-        convertEnums: true,
-        token: null,
-        statusCode: 200,
-        log: false,
-        logError: false,
-      },
-      options
-    );
+    const config = {
+      convertEnums: true,
+      countOfSubscriptionMessages: 1,
+      token: null,
+      statusCode: 200,
+      log: false,
+      logError: false,
+      ...options,
+    };
 
     // Init vars
-    const { token, statusCode, log, logError } = options;
+    const { token, statusCode, log, logError } = config;
 
     // Init
     let query = '';
@@ -174,10 +182,14 @@ export class TestHelper {
       query = jsonToGraphQLQuery(queryObj, { pretty: true });
     }
 
+    if ((graphql as TestGraphQLConfig).type === TestGraphQLType.SUBSCRIPTION) {
+      return this.getSubscription(graphql as TestGraphQLConfig, query, config);
+    }
+
     // Convert uppercase strings in arguments of query to enums
-    if (options.convertEnums) {
-      if (Array.isArray(options.convertEnums)) {
-        for (const key of Object.values(options.convertEnums)) {
+    if (config.convertEnums) {
+      if (Array.isArray(config.convertEnums)) {
+        for (const key of Object.values(config.convertEnums)) {
           const regExpStr = '(' + key + ': )\\"([_A-Z][_0-9A-Z]*)\\"';
           const regExp = new RegExp(regExpStr, 'g');
           query = query.replace(regExp, '$1$2');
@@ -225,28 +237,26 @@ export class TestHelper {
    */
   async rest(url: string, options: TestRestOptions = {}): Promise<any> {
     // Default options
-    options = Object.assign(
-      {
-        token: null,
-        statusCode: 200,
-        log: false,
-        logError: false,
-        payload: null,
-        method: 'GET',
-      },
-      options
-    );
+    const config: TestRestOptions = {
+      token: null,
+      statusCode: 200,
+      log: false,
+      logError: false,
+      payload: null,
+      method: 'GET',
+      ...options,
+    };
 
     // Init vars
-    const { token, statusCode, log, logError } = options;
+    const { token, statusCode, log, logError } = config;
 
     // Request configuration
     const requestConfig: LightMyRequest.InjectOptions = {
-      method: options.method,
+      method: config.method,
       url,
     };
-    if (options.payload) {
-      requestConfig.payload = options.payload;
+    if (config.payload) {
+      requestConfig.payload = config.payload;
     }
 
     // Process response
@@ -354,7 +364,7 @@ export class TestHelper {
 
     // Log response
     if (log) {
-      console.log(response);
+      console.log(JSON.stringify(response, null, 2));
     }
 
     // Log error
@@ -373,4 +383,52 @@ export class TestHelper {
     // Return response
     return response;
   }
+
+  /**
+   * Get subscription
+   */
+  async getSubscription(graphql: TestGraphQLConfig, query: string, options?: TestGraphQLOptions) {
+    // Check url
+    if (!this.subscriptionUrl) {
+      throw new Error("Missing subscriptionUrl in TestHelper: new TestHelper(app, 'ws://localhost:3030/graphql')");
+    }
+
+    // Prepare subscription
+    let connectionParams;
+    if (options?.token) {
+      connectionParams = { Authorization: `Bearer ${options?.token}` };
+    }
+
+    // Init client
+    if (options.log) {
+      console.log('Subscription query', JSON.stringify(query, null, 2));
+    }
+    const client = createClient({ url: this.subscriptionUrl, connectionParams, webSocketImpl: ws });
+    const messages: any[] = [];
+    let unsubscribe: () => void;
+    const onNext = (message) => {
+      if (options.log) {
+        console.log('Subscription message', JSON.stringify(message, null, 2));
+      }
+      messages.push(message?.data?.[graphql.name]);
+      if (messages.length <= options.countOfSubscriptionMessages) {
+        unsubscribe();
+      }
+    };
+
+    // Subscribe
+    await new Promise((resolve, reject) => {
+      unsubscribe = client.subscribe(
+        { query },
+        {
+          next: onNext,
+          error: reject,
+          complete: resolve as any,
+        }
+      );
+    });
+
+    // Return subscribed messages
+    return messages;
+  }
 }