feat: add eval reasons to nodejs

.github/workflows/run-test-harness.yml

@@ -36,3 +36,4 @@ jobs:
                   sdks-to-test: nodejs,of-nodejs
                   sdk-github-sha: ${{github.event.pull_request.head.sha}}
                   github-token: ${{ secrets.AUTOMATION_USER_TOKEN }}
+                  sdk-capabilities: '{ "NodeJS":["edgeDB", "cloud", "lastModifiedHeader", "bootstrapping", "sdkConfigEvent", "clientUUID", "v2Config", "clientCustomData", "variablesFeatureId", "cloudEvalReason", "evalReason"]}'

.gitignore

@@ -103,3 +103,6 @@ verdaccio
 e2e/js/js-cdn/src/assets/devcycle.min.js
 e2e/js/js-cdn/playwright-report/
 e2e/js/js-esm/playwright-report/
+
+#opencode ai guidelines
+AGENTS.md

sdk/nodejs/__tests__/client.spec.ts

@@ -1,7 +1,12 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import { DevCycleClient } from '../src/client'
 import { DevCycleUser } from '@devcycle/js-cloud-server-sdk'
-import { DVCCustomDataJSON } from '@devcycle/types'
+import {
+    DEFAULT_REASON_DETAILS,
+    DVCCustomDataJSON,
+    EVAL_REASON_DETAILS,
+    EVAL_REASONS,
+} from '@devcycle/types'
 import { EvalHook } from '../src/hooks/EvalHook'
 
 jest.mock('../src/bucketing')
@@ -34,10 +39,10 @@
 describe('DevCycleClient', () => {
     it('imports bucketing lib on initialize', async () => {
         const client = new DevCycleClient('token')
         expect((client as any).bucketingLib).toBeUndefined()
         await client.onClientInitialized()
         const platformData = (
             (client as any).bucketingLib.setPlatformData as any
         ).mock.calls[0][0]
 
         expect(JSON.parse(platformData)).toEqual({
@@ -80,6 +85,11 @@
         const variable = client.variable(user, 'test-key', false)
         expect(variable.value).toEqual(true)
         expect(variable.type).toEqual('Boolean')
+        expect(variable.eval).toEqual({
+            reason: EVAL_REASONS.TARGETING_MATCH,
+            details: EVAL_REASON_DETAILS.ALL_USERS,
+            target_id: 'mockTargetId',
+        })
 
         expect(client.variableValue(user, 'test-key', false)).toEqual(true)
     })
@@ -98,6 +108,10 @@
         const variable = client.variable(user, 'test-key2', false)
         expect(variable.value).toEqual(false)
         expect(variable.isDefaulted).toEqual(true)
+        expect(variable.eval).toEqual({
+            reason: EVAL_REASONS.DEFAULT,
+            details: DEFAULT_REASON_DETAILS.USER_NOT_TARGETED,
+        })
 
         // @ts-ignore
         client.bucketingLib.variableForUser_PB.mockReturnValueOnce(null)
@@ -110,6 +124,10 @@
         const variable = client.variable(user, 'test-key', 'test')
         expect(variable.value).toEqual('test')
         expect(variable.isDefaulted).toEqual(true)
+        expect(variable.eval).toEqual({
+            reason: EVAL_REASONS.DEFAULT,
+            details: DEFAULT_REASON_DETAILS.TYPE_MISMATCH,
+        })
 
         expect(client.variableValue(user, 'test-key', 'test')).toEqual('test')
     })
@@ -168,7 +186,7 @@
         client.setClientCustomData(customData)
 
         expect(
             (client as any).bucketingLib.setClientCustomData,
         ).toHaveBeenCalledWith('token', JSON.stringify(customData))
     })
 

sdk/nodejs/src/__mocks__/bucketing.ts

@@ -1,11 +1,17 @@
 import { Exports, ProtobufTypes } from '@devcycle/bucketing-assembly-script'
+import { EVAL_REASON_DETAILS, EVAL_REASONS } from '@devcycle/types'
 
 const testVariable = {
     _id: 'test-id',
     value: true,
     type: 'Boolean',
     key: 'test-key',
     evalReason: null,
+    eval: {
+        reason: EVAL_REASONS.TARGETING_MATCH,
+        details: EVAL_REASON_DETAILS.ALL_USERS,
+        target_id: 'mockTargetId',
+    },
 }
 const buffer = ProtobufTypes.SDKVariable_PB.encode({
     _id: testVariable._id,
@@ -14,6 +20,7 @@ const buffer = ProtobufTypes.SDKVariable_PB.encode({
     boolValue: testVariable.value,
     doubleValue: 0,
     stringValue: '',
+    eval: testVariable.eval,
 }).finish()
 
 enum VariableType {

sdk/nodejs/src/client.ts

@@ -18,6 +18,8 @@ import {
     VariableDefinitions,
     InferredVariableType,
     DVCCustomDataJSON,
+    EVAL_REASONS,
+    DEFAULT_REASON_DETAILS,
 } from '@devcycle/types'
 import os from 'os'
 import {
@@ -260,6 +262,10 @@ export class DevCycleClient<
                 defaultValue,
                 type,
                 key,
+                eval: {
+                    reason: EVAL_REASONS.DEFAULT,
+                    details: DEFAULT_REASON_DETAILS.MISSING_CONFIG,
+                },
             })
         }
 
@@ -279,12 +285,23 @@ export class DevCycleClient<
         if (configVariable) {
             if (type === configVariable.type) {
                 options.value = configVariable.value as VariableTypeAlias<T>
-                options.evalReason = configVariable.eval?.reason
+                if (configVariable.eval) {
+                    options.eval = { ...configVariable.eval }
+                }
             } else {
+                options.eval = {
+                    reason: EVAL_REASONS.DEFAULT,
+                    details: DEFAULT_REASON_DETAILS.TYPE_MISMATCH,
+                }
                 this.logger.error(
                     `Type mismatch for variable ${key}. Expected ${type}, got ${configVariable.type}`,
                 )
             }
+        } else {
+            options.eval = {
+                reason: EVAL_REASONS.DEFAULT,
+                details: DEFAULT_REASON_DETAILS.USER_NOT_TARGETED,
+            }
         }
 
         return new DVCVariable(options)

sdk/nodejs/src/pb-types/pbTypeHelpers.ts

@@ -52,5 +52,6 @@ export function pbSDKVariableTransform(
             !variable._feature || variable._feature.isNull
                 ? null
                 : variable._feature.value,
+        eval: variable.eval,
     }
 }