Add tests for Sleeps

Signed-off-by: Xavier Geerinck <[email protected]>

Author: XavierGeerinck

package-lock.json

@@ -5,9 +5,9 @@
     "types": "http/index.d.ts",
     "scripts": {
         "test": "npm run test:unit:all && npm run test:e2e:all",
-        "test:load": "jest --runInBand",
+        "test:load": "jest --runInBand --detectOpenHandles",
         "test:load:http": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components npm run test:load 'test/load'",
-        "test:e2e": "jest --runInBand",
+        "test:e2e": "jest --runInBand --detectOpenHandles",
         "test:e2e:all": "npm run test:e2e:grpc:main && npm run test:e2e:http:main && npm run test:e2e:http:actors",
         "test:e2e:grpc:main": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol grpc --app-port 50001 --dapr-grpc-port 50000 --components-path ./test/components npm run test:e2e 'test/e2e/main.grpc.test.ts'",
         "test:e2e:http:main": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components npm run test:e2e 'test/e2e/main.http.test.ts'",
@@ -28,6 +28,7 @@
         "@js-temporal/polyfill": "^0.3.0",
         "body-parser": "^1.19.0",
         "google-protobuf": "^3.18.0",
+        "http-terminator": "^3.0.4",
         "node-fetch": "^2.6.1",
         "restana": "^4.9.1",
         "uuid": "^8.3.2"

package.json

@@ -17,7 +17,7 @@ export default class GRPCServer implements IServer {
   server: IServerType;
   serverImpl: IServerImplType;
   serverCredentials: grpc.ServerCredentials;
-  serverStartupDelay = 1000; // @todo: use health api https://docs.dapr.io/reference/api/health_api/
+  serverStartupDelay = 1000;
   client: DaprClient;
 
   constructor(client: DaprClient) {

src/implementation/Server/GRPCServer/GRPCServer.ts

@@ -4,6 +4,7 @@ import HTTPServerImpl from "./HTTPServerImpl";
 import IServer from "../../../interfaces/Server/IServer";
 import * as NodeJSUtils from "../../../utils/NodeJS.util";
 import { DaprClient } from "../../..";
+import { createHttpTerminator } from 'http-terminator';
 
 // eslint-disable-next-line
 export interface IServerImplType extends HTTPServerImpl { }
@@ -17,7 +18,7 @@ export default class HTTPServer implements IServer {
   server: IServerType;
   serverAddress: string;
   serverImpl: IServerImplType;
-  serverStartupDelay = 1000; // @todo: use health api https://docs.dapr.io/reference/api/health_api/
+  serverStartupDelay = 1000;
   client: DaprClient;
 
   constructor(client: DaprClient) {
@@ -124,7 +125,10 @@ export default class HTTPServer implements IServer {
   }
 
   async stop(): Promise<void> {
-    await this.server.close();
+    const s = this.server.getServer();
+    const httpTerminator = createHttpTerminator({ server: this.server.getServer() });
+    await httpTerminator.terminate();
+    // await this.server.close();
     this.isInitialized = false;
   }
 }

src/implementation/Server/HTTPServer/HTTPServer.ts

@@ -39,10 +39,7 @@ export default class HTTPServerActor implements IServerActor {
    * This will create the routes that get invoked by the Dapr Sidecar
    */
   async init(): Promise<void> {
-    // Change the server startupDelay to 3s since we want the placement tables to get updated correctly
-    // @todo: is there a better way to detect this?
-    this.server.serverStartupDelay = 4000;
-    console.log("[Actors] Initializing, changing startup delay to 4s to allow for placement tables to propagate");
+    console.log("[Actors] Initializing");
 
     // Probes the application for a response to state that the app is healthy and running
     // https://docs.dapr.io/reference/api/actors_api/#health-check

src/implementation/Server/HTTPServer/actor.ts

@@ -1,5 +1,5 @@
 export async function sleep(ms = 1000): Promise<void> {
-  await (new Promise(resolve => setTimeout(resolve, ms)));
+  return new Promise(resolve => setTimeout(resolve, ms));
 }
 
 export async function flushPromises() {

src/utils/NodeJS.util.ts

@@ -8,6 +8,7 @@ import DemoActorSayImpl from '../actor/DemoActorSayImpl';
 import DemoActorTimerImpl from '../actor/DemoActorTimerImpl';
 import ActorId from '../../src/actors/ActorId';
 import ActorProxyBuilder from '../../src/actors/client/ActorProxyBuilder';
+import * as NodeJSUtil from '../../src/utils/NodeJS.util';
 
 const serverHost = "127.0.0.1";
 const serverPort = "50001";
@@ -48,10 +49,26 @@ describe('http/actors', () => {
   }, 30 * 1000);
 
   afterAll(async () => {
-    // await server.stop();
+    await server.stop(); // if we hang here, it means connections are open that were not closed. Debug why
     // await client.stop();
   });
 
+  describe('general', () => {
+    it('should allow us to use promises as some testing libraries have issues within the Node Ecosystem', async () => {
+      const mock = jest.fn(() => {
+        return new Promise((resolve) => setTimeout(resolve, 500));
+      });
+
+      const handler = jest.fn();
+
+      await mock().then(handler);
+
+      await (new Promise(resolve => setTimeout(resolve, 2000)));
+
+      expect(handler).toHaveBeenCalled();
+    });
+  });
+
   describe('actorProxy', () => {
     it('should be able to create an actor object through the proxy', async () => {
       const builder = new ActorProxyBuilder<DemoActorCounterImpl>(DemoActorCounterImpl, client);
@@ -163,7 +180,7 @@ describe('http/actors', () => {
       expect(res0).toEqual(0);
 
       // Now we wait for dueTime (2s)
-      await (new Promise(resolve => setTimeout(resolve, 2000)));
+      await NodeJSUtil.sleep(2000);
 
       // After that the reminder callback will be called
       // In our case, the callback increments the count attribute

test/e2e/actors.http.test.ts

@@ -1,4 +1,5 @@
 import { CommunicationProtocolEnum, DaprClient, DaprServer, HttpMethod } from '../../src';
+import DemoActorCounterImpl from '../actor/DemoActorCounterImpl';
 
 const serverHost = '127.0.0.1';
 const serverPort = '50001';
@@ -37,6 +38,22 @@ describe('http/main', () => {
     await client.stop();
   });
 
+  describe('general', () => {
+    it('should allow us to use promises as some testing libraries have issues within the Node Ecosystem', async () => {
+      const mock = jest.fn(() => {
+        return new Promise((resolve) => setTimeout(resolve, 500));
+      });
+
+      const handler = jest.fn();
+
+      await mock().then(handler);
+
+      await (new Promise(resolve => setTimeout(resolve, 2000)));
+
+      expect(handler).toHaveBeenCalled();
+    });
+  });
+
   describe('metadata', () => {
     it('should be able to get the metadata of the Dapr sidecar', async () => {
       const res = await client.metadata.get();

test/e2e/main.http.test.ts

@@ -0,0 +1,15 @@
+describe('General', () => {
+  it('should allow us to use promises as some testing libraries have issues within the Node Ecosystem', async () => {
+    const mock = jest.fn(() => {
+      return new Promise((resolve) => setTimeout(resolve, 500));
+    });
+
+    const handler = jest.fn();
+
+    await mock().then(handler);
+
+    await (new Promise(resolve => setTimeout(resolve, 2000)));
+
+    expect(handler).toHaveBeenCalled();
+  });
+});