Merge pull request #265 from fingerprintjs/chore/smoke-tests-cleanup

INTER-2307: Low-hanging test coverage improvements (ecosystem care)

Author: JuroUhlar

.changeset/config.json

@@ -12,5 +12,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["node-sdk-example", "node-sdk-smoke-tests"]
+  "ignore": ["node-sdk-example", "node-sdk-functional-tests"]
 }

.github/workflows/functional_tests.yml

@@ -19,7 +19,7 @@ jobs:
       artifactPath: ./dist
 
   functional_tests:
-    name: 'Smoke test on node ${{ matrix.node-version }}'
+    name: 'Functional test on node ${{ matrix.node-version }}'
     needs: build
     runs-on: ubuntu-latest
 
@@ -59,20 +59,19 @@ jobs:
         env:
           CI: true
 
-      - name: Install Dependencies for example
-        run: pnpm install
-        working-directory: ./example
-        env:
-          CI: true
+      - name: Typecheck examples
+        run: pnpm typecheck:examples
 
-      - name: 'Switch to target Node version for smoke test'
+      - name: 'Switch to target Node version for functional test'
         uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Run test
         run: |
-          node smokeTests.mjs
+          node functionalTests.mjs
         working-directory: ./tests/functional-tests
         env:
           API_KEY: '${{ secrets.PRIVATE_KEY }}'
+          BASE64_SEALED_RESULT: '${{ secrets.BASE64_SEALED_RESULT }}'
+          BASE64_KEY: '${{ secrets.BASE64_KEY }}'

tests/functional-tests/.env.example

@@ -2,3 +2,6 @@ API_KEY=<API_KEY>
 # "eu" or "ap", "us" is the default
 REGION=<REGION>
 RULESET_ID=<RULESET_ID>
+# Optional: sealed-result validation is skipped unless both are set.
+BASE64_SEALED_RESULT=<BASE64_SEALED_RESULT>
+BASE64_KEY=<BASE64_KEY>

tests/functional-tests/CHANGELOG.md

@@ -1,4 +1,4 @@
-# node-sdk-smoke-tests
+# node-sdk-functional-tests
 
 ## 1.0.6
 

tests/functional-tests/smokeTests.mjs …sts/functional-tests/functionalTests.mjstests/functional-tests/smokeTests.mjs renamed to tests/functional-tests/functionalTests.mjs tests/functional-tests/smokeTests.mjs renamed to tests/functional-tests/functionalTests.mjs

@@ -1,4 +1,11 @@
-import { FingerprintServerApiClient, Region, RequestError, TooManyRequestsError } from '@fingerprint/node-sdk'
+import {
+  FingerprintServerApiClient,
+  Region,
+  RequestError,
+  TooManyRequestsError,
+  unsealEventsResponse,
+  DecryptionAlgorithm,
+} from '@fingerprint/node-sdk'
 import { config } from 'dotenv'
 import assert from 'node:assert'
 config()
@@ -128,6 +135,34 @@ async function validateOldestOrder(client, start, end) {
   }
 }
 
+async function validateSealedResult() {
+  const sealedData = process.env.BASE64_SEALED_RESULT
+  const decryptionKey = process.env.BASE64_KEY
+
+  if (!sealedData || !decryptionKey) {
+    // In CI the fixture must be present; locally we skip so contributors don't need it.
+    if (process.env.CI) {
+      throw new Error('BASE64_SEALED_RESULT and BASE64_KEY must be set in CI for sealed results validation')
+    }
+    console.log('BASE64_SEALED_RESULT or BASE64_KEY not set, skipping sealed results validation')
+    return
+  }
+
+  console.log('Validating sealed result...')
+  const unsealed = await unsealEventsResponse(Buffer.from(sealedData, 'base64'), [
+    {
+      key: Buffer.from(decryptionKey, 'base64'),
+      algorithm: DecryptionAlgorithm.Aes256Gcm,
+    },
+  ])
+
+  if (!unsealed?.identification?.visitor_id) {
+    throw new Error('Unsealed result missing identification.visitor_id')
+  }
+
+  console.log('Sealed result validation works!')
+}
+
 async function main() {
   try {
     const client = createClient()
@@ -141,6 +176,8 @@ async function main() {
 
     await validateOldestOrder(client, start, end)
 
+    await validateSealedResult()
+
     if (ruleset_id) {
       await validateRulesetEvaluationForBlock(client, start, end)
       await validateRulesetEvaluationForAllow(client, start, end)

tests/functional-tests/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "node-sdk-smoke-tests",
+  "name": "node-sdk-functional-tests",
   "version": "2.0.0",
   "description": "",
   "main": "index.mjs",