Merge pull request #184 from XavierGeerinck/issue_177

Fix test sequence and dev container

Author: XavierGeerinck

.devcontainer/Dockerfile

@@ -43,11 +43,16 @@ RUN apt-get update \
     # Install Node 14.16 (latest LTS)
     && nvm install v14.16.1 \
     #
+    # Install Typescript Globally
+    && npm install -g typescript \
+    #
     # Install Dapr CLI
     && wget -q https://raw.githubusercontent.com/dapr/cli/master/install/install.sh -O - | /bin/bash \
+    #
     # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
     && groupadd --gid $USER_GID $USERNAME \
     && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
+    #
     # [Optional] Add sudo support for the non-root user
     && apt-get install -y sudo \
     && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\

.github/workflows/build.yml

@@ -28,16 +28,8 @@ jobs:
         node-version: ${{ env.NODE_VER }}
         registry-url: 'https://registry.npmjs.org'
 
-    - run: npm ci
-      env:
-        CI: true
-    
-    - run: npm run lint
-      env:
-        CI: true
-    
-    - run: npm run test:unit:main
-    - run: npm run test:unit:actors
+    - name: Build Package
+      run: ./scripts/build.sh
 
     - name: Is Release?
       if: startswith(github.ref, 'refs/tags/v')

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 --detectOpenHandles --forceExit",
+        "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 --detectOpenHandles --forceExit",
+        "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"
@@ -48,11 +49,11 @@
         "nodemon": "^2.0.12",
         "prettier": "^2.4.0",
         "ts-jest": "^27.0.5",
-        "typescript": "^4.4.4"
+        "typescript": "^4.5.5"
     },
     "repository": {
         "type": "git",
         "url": "https://github.com/dapr/js-sdk.git",
         "directory": ""
     }
-}
+}

package.json

@@ -10,6 +10,9 @@ echo "Executing in $(pwd)"
 echo "Description: Build the package in build/"
 echo "====================================================="
 
+echo "Installing Dependencies"
+npm install > /dev/null
+
 # Prepare build
 echo "Preparing Build"
 rm -rf build/
@@ -22,8 +25,7 @@ mkdir build/
 
 # Build Package
 echo "Building Library"
-npm install > /dev/null
-npm run lint > /dev/null
+npm run lint
 tsc --outDir ./build/
 
 # Prepare Publish

scripts/build.sh

@@ -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/
+  daprSidecarPollingDelayMs = 1000;
   client: DaprClient;
 
   constructor(client: DaprClient) {
@@ -82,7 +82,7 @@ export default class GRPCServer implements IServer {
     console.log(`[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)`);
     while (!isHealthy) {
       console.log(`[Dapr-JS] - Waiting till Dapr Started (#${isHealthyRetryCount})`);
-      await NodeJSUtils.sleep(this.serverStartupDelay);
+      await NodeJSUtils.sleep(this.daprSidecarPollingDelayMs);
       isHealthy = await this.client.health.isHealthy();
       isHealthyRetryCount++;
 

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/
+  daprSidecarPollingDelayMs = 1000;
   client: DaprClient;
 
   constructor(client: DaprClient) {
@@ -109,7 +110,7 @@ export default class HTTPServer implements IServer {
     console.log(`[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)`);
     while (!isHealthy) {
       console.log(`[Dapr-JS] - Waiting till Dapr Started (#${isHealthyRetryCount})`);
-      await NodeJSUtils.sleep(this.serverStartupDelay);
+      await NodeJSUtils.sleep(this.daprSidecarPollingDelayMs);
       isHealthy = await this.client.health.isHealthy();
       isHealthyRetryCount++;
 
@@ -124,7 +125,9 @@ export default class HTTPServer implements IServer {
   }
 
   async stop(): Promise<void> {
-    await this.server.close();
+    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,4 +1,4 @@
-import { KeyValuePairType } from "../KeyValuePair.type";
+import { KeyValueType } from "../KeyValue.type";
 
 export type GetMetadataResponse = {
   id: string;

src/types/metadata/GetMetadataResponse.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() {