fix: correctly specify the SDK name under test for node-server (#126)

* fix: correctly spec sdk name

* return SDK details from node-server-relay

* update relay to latest SDK

* fix: verify SDK connected to test runner is the same as expected

* bump version patch for sdk-test-runner

Author: typotter

.github/workflows/test-sdk-packages.yml

@@ -40,6 +40,6 @@ jobs:
     uses: ./.github/workflows/test-server-sdk.yml
     with:
       platform: ${{ matrix.platform }}
-      sdkName: 'eppo/node-server-sdk'
+      sdkName: 'node-server-sdk'
       sdkRelayDir: 'node-sdk-relay'
     secrets: inherit

package-testing/node-sdk-relay/package.json

@@ -21,7 +21,7 @@
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },
   "dependencies": {
-    "@eppo/node-server-sdk": "^3.7.2",
+    "@eppo/node-server-sdk": "^3.9.3",
     "@eslint/js": "^9.16.0",
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",

package-testing/node-sdk-relay/src/app.controller.ts

@@ -4,6 +4,7 @@ import { AssignmentDto, BanditDto, BanditTestRunnerInput } from './types';
 import { EppoClientProxy } from './eppoClientProxy';
 import { BanditActions, getInstance, init } from '@eppo/node-server-sdk';
 import getLogger from './main';
+import { sdkName, sdkVersion } from '@eppo/node-server-sdk/dist/sdk-data';
 
 @Controller()
 export class AppController {
@@ -15,6 +16,11 @@ export class AppController {
     return this.appService.getHello();
   }
 
+  @Get('sdk/details')
+  getSdkDetails() {
+    return { sdkName, sdkVersion, supportsBandits: true, supportsDynamicTyping: true };
+  }
+
   @Post('flags/v1/assignment')
   getAssignment(@Body() requestedAssignmentBody: AssignmentDto) {
     return this.eppoClientProxy.getAssignment(getInstance(), requestedAssignmentBody);

package-testing/node-sdk-relay/yarn.lock

@@ -320,10 +320,10 @@
   dependencies:
     "@jridgewell/trace-mapping" "0.3.9"
 
-"@eppo/js-client-sdk-common@4.8.4":
-  version "4.8.4"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.8.4.tgz#a1919233fa52399b86ce75b9eebed1c6d2bac16e"
-  integrity sha512-cDxOOHjGU0kJLp2zXWGXaH2xcEd/oxsAT4e78jbbhktb+e5vkU3+SCFTvijFykr1h/hQ2a3O1PPP0M8HFfdrZA==
+"@eppo/js-client-sdk-common@4.14.1":
+  version "4.14.1"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.14.1.tgz#db908420c47a1327921493072892923e58c2039f"
+  integrity sha512-trXgxPgbS+vFkYd0w0Xb2V9NntE2SgLsThhxoDbRENw1ynb8b8b3MDdwFH+5DheVT1ji6mZ+Qrh40uNIxMptYA==
   dependencies:
     buffer "npm:@eppo/[email protected]"
     js-base64 "^3.7.7"
@@ -332,12 +332,12 @@
     spark-md5 "^3.0.2"
     uuid "^11.0.5"
 
-"@eppo/node-server-sdk@^3.7.2":
-  version "3.7.2"
-  resolved "https://registry.yarnpkg.com/@eppo/node-server-sdk/-/node-server-sdk-3.7.2.tgz#086f5a211ab848792afb4a9292396e60bf5bfd62"
-  integrity sha512-rFXZx4312AbWTwB2astTCNZv1K9sMfRXvWRYJQuidfojqG8iDH0+l1nBCH9GPSNgNw4hdoh1pj4leX8tTkwRoQ==
+"@eppo/node-server-sdk@^3.9.3":
+  version "3.9.3"
+  resolved "https://registry.yarnpkg.com/@eppo/node-server-sdk/-/node-server-sdk-3.9.3.tgz#5954ed53ca676880642ed821f37ef07fe06862bd"
+  integrity sha512-yHPTJkYhHszKWWXKrgtbBr4Ugsf4fCP+6pDi3o6zU8HJu2lK5QN+bROaKAeILwBY8dD+h8+CHZnFZpq1JmdK3g==
   dependencies:
-    "@eppo/js-client-sdk-common" "4.8.4"
+    "@eppo/js-client-sdk-common" "4.14.1"
 
 "@eslint-community/eslint-utils@^4.2.0", "@eslint-community/eslint-utils@^4.4.0":
   version "4.4.1"

package-testing/sdk-test-runner/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdk-test-runner",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Test runner for SDK package testing",
   "main": "src/app.ts",
   "repository": "https://github.com/Eppo-exp/sdk-test-data",

package-testing/sdk-test-runner/src/app.ts

@@ -40,10 +40,8 @@ export default class App {
 
     const sdkRelay = new ClientSDKRelay();
     const sdkInfo = await sdkRelay.isReady();
-    if ('errorMessage' in sdkInfo) {
-      const error = sdkInfo as SDKConnectionFailure;
-      log(red('SDK Relay Client failed to load: '));
-      log(red(error.errorMessage));
+
+    if (!this.validateSdkInfo(sdkInfo)) {
       return false;
     }
 
@@ -58,10 +56,8 @@ export default class App {
 
     const sdkRelay = new ServerSDKRelay(this.config.sdkServer, this.config.sdkName);
     const sdkInfo = await sdkRelay.isReady();
-    if ('errorMessage' in sdkInfo && typeof sdkInfo.errorMessage === 'string') {
-      const error = sdkInfo as SDKConnectionFailure;
-      log(red('SDK Relay Server failed to load: '));
-      log(red(error.errorMessage));
+
+    if (!this.validateSdkInfo(sdkInfo)) {
       return false;
     }
 
@@ -70,6 +66,24 @@ export default class App {
     return this.innerRun(sdkRelay);
   }
 
+  private validateSdkInfo(sdkInfo: SDKInfo | SDKConnectionFailure): boolean {
+    if ('errorMessage' in sdkInfo) {
+      const error = sdkInfo as SDKConnectionFailure;
+      log(red('SDK Relay failed to load: '));
+      log(red(error.errorMessage));
+      return false;
+    }
+
+    if (sdkInfo && (sdkInfo as SDKInfo).sdkName !== this.config.sdkName) {
+      const actualName = (sdkInfo as SDKInfo).sdkName;
+      // Throw an error as setting the test scenarios won't work if the names don't match.
+      log(red(`SDK name ${actualName} does not match expected ${this.config.sdkName}.`));
+      return false;
+    }
+
+    return true;
+  }
+
   private printHeader(): void {
     log(`Running tests for ${this.config.sdkType} SDK: ${this.config.sdkName}`);
     log(`Test Cluster Details`);
@@ -283,9 +297,13 @@ export default class App {
                 message: `Value ${JSON.stringify(result.result)} did not match expected ${JSON.stringify(subject.assignment)}`,
               });
 
-              logIndent(1, red('fail') + ` ${testCaseLabel}:\n` + 
-                `  Expected: ${JSON.stringify(subject.assignment, null, 2)}\n` +
-                `  Received: ${JSON.stringify(result.result, null, 2)}`);
+              logIndent(
+                1,
+                red('fail') +
+                  ` ${testCaseLabel}:\n` +
+                  `  Expected: ${JSON.stringify(subject.assignment, null, 2)}\n` +
+                  `  Received: ${JSON.stringify(result.result, null, 2)}`,
+              );
             } else {
               testCaseResult.assertions = 1;