fix: integration configuration serialization

juar-queue-it · juar-queue-it · commit 64d74071dce4 · 2026-02-05T11:51:54.000+01:00
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+18
diff --git a/.whitesource b/.whitesource
@@ -0,0 +1,23 @@
+{
+  "scanSettings": {
+    "configMode": "AUTO",
+    "configExternalURL": "",
+    "enableLicenseViolations": "true",
+    "projectToken": "",
+    "baseBranches": []
+  },
+  "pullRequestStatusSettings": {
+    "vulnerablePullRequestStatus": "failed",
+    "displayMode": "diff",
+    "useMendStatusNames": true
+  },
+  "issueSettings": {
+    "minSeverityLevel": "MEDIUM"
+  },
+  "remediateSettings": {
+    "workflowRules": {
+      "enabled": true,
+      "minVulnerabilitySeverity": "MEDIUM"
+    }
+  }
+}
diff --git a/README.md b/README.md
@@ -1,14 +1,32 @@
 # KnownUser.V3.Fastly
 
-Before getting started please read the [documentation](https://github.com/queueit/Documentation/tree/main/edge-connectors) to get acquainted with edge connectors.
+The Queue-it Security Framework ensures that end-users are not able to access your online application without first
+going through the queue for any and all �protected� areas and paths on your sites. The queue system is implemented by
+adding a server-side (request-level) integration that protects your online application by redirecting users to a waiting
+room according to web traffic settings in the Queue-it GO Platform. After the integration is complete, queue system
+behavior and operations are managed in Queue-it�s Go Platform and/or via the Queue-it Admin API.
 
-This Fastly Queue-it Connector (aka, Queue-it's server-side KnownUser connector) uses a Compute@Edge service to
+This Fastly Queue-it Connector SDK (aka, Queue-it�s server-side KnownUser connector) uses a Compute@Edge service to
 integrate Queue-it's functionality into Fastly's network.
 
 A Wasm service is required to utilize this connector.
 
 > You can find the latest released version [here](https://github.com/queueit/KnownUser.V3.Fastly/releases/latest).
 
+## Introduction
+
+When a user makes a request to your Fastly service our connector validates the request and if it is needed, it will
+redirect the user to the waiting room. After waiting in the waiting room, the queue engine will redirect the user back
+to your end attaching a query string parameter ( `queueittoken` ) containing some information about the user to the URL.
+The most important fields of the `queueittoken` are:
+
+- q - The user's unique queue identifier
+- ts - A timestamp of how long this redirect is valid
+- h - A hash of the token
+
+After the user returns from the queue, the connector will let the user continue his request to your backend ( without
+redirecting to the queue since the request has a valid queueittoken as query string) .
+
 ## Installation
 
 There are two methods of installation:
@@ -24,14 +42,14 @@ There are two methods of installation:
   Edit the host, go to advanced options and fill in the same hostname in **Override host**
 - Go to **Dictionaries** and create a new dictionary named `IntegrationConfiguration`.  
   Add the following items in the dictionary:
-  - customerId: Your customer ID
-  - apiKey: The API key for your account
-  - secret: Your KnownUserV3 secret
-  - queueItOrigin: The name of the queue-it host, in this case it's `queue-it`  
+    - customerId: Your customer ID
+    - apiKey: The API key for your account
+    - secret: Your KnownUserV3 secret
+    - queueItOrigin: The name of the queue-it host, in this case it's `queue-it`  
       You can find these values in the Go Queue-It self-service platform.
-- Download the latest package file (release-package.tar.gz) from the releases page and unarchive it.
+- Download the latest package from the releases page and unarchive it.
 - Edit the `fastly.toml` file and copy the ID of your service (you can see this by opening up the service in Fastly) and
-  replace **{YourServiceId}** with it.
+  replace __{YourServiceId}__ with it.
 - Archive the directory in the same format (tar.gz).
 - Go to `Package` in the Fastly service page and upload the package.
 - To finish up and deploy your service click on the **Activate** button.
@@ -40,17 +58,17 @@ There are two methods of installation:
 
 - Go to the Fastly services page and create a new **Wasm** service and copy it's ID.
 - Clone this repository and edit the fastly.toml file, make sure to set the `service_id` field to the ID you copied.
-- Then click on *Origins* and add a new host that has the hostname of your origin server.
+- Then click on *Origins* and add a new host that has the hostname of your origin server.   
   You can name the host **origin** or whatever you choose.
-- Create a host that has the hostname of `{yourCustomerId}.queue-it.net` and name it **queue-it**.
+- Create a host that has the hostname of `{yourCustomerId}.queue-it.net` and name it **queue-it**.    
   Edit the host, go to advanced options and fill in the same hostname in **Override host**
 - Open up the service in Fastly and go to **Dictionaries** and create a new dictionary named `IntegrationConfiguration`
   .  
   Add the following items in the dictionary:
-  - customerId: Your customer ID
-  - apiKey: The API key for your account
-  - secret: Your KnownUserV3 secret
-  - queueItOrigin: The name of the queue-it origin, in this case it's `queue-it`  
+    - customerId: Your customer ID
+    - apiKey: The API key for your account
+    - secret: Your KnownUserV3 secret
+    - queueItOrigin: The name of the queue-it origin, in this case it's `queue-it`  
       You can find these values in the Go Queue-It self-service platform.
 - You need to add some code that uses this connector. Here is an example:
 
@@ -61,21 +79,17 @@ import {onQueueITRequest, IntegrationDetails, onQueueITResponse} from "@queue-it
 const req = Fastly.getClientRequest();
 
 // This is optional and can be null if it's specified in your Dictionary
-/* const integrationDetails = new IntegrationDetails(
-        {QueueItOriginName},
-        {CustomerId},
-        {SecretKey},
-        {ApiKey},
-        {workerHost});
+const integrationDetails = new IntegrationDetails(
+        "QueueItOriginName",
+        "CustomerId",
+        "SecretKey",
+        "ApiKey");
 let res = onQueueITRequest(req, integrationDetails);
-*/
-
-let res = onQueueITRequest(req, null);
 
 if (res != null) {
     Fastly.respondWith(res!);
 } else {
-    const myOrigin = 'origin';
+    const myOrigin = 'Ticketania';
     const cacheOverride = new Fastly.CacheOverride();
     const res = Fastly.fetch(req, {
         backend: myOrigin,
@@ -89,3 +103,27 @@ if (res != null) {
 - Build and deploy the package running `fastly compute build` and `fastly compute deploy` in the same directory.
 - Create desired waiting room(s), triggers, and actions in the Go Queue-It self-service platform.  
   Then, save/publish the configuration.
+
+## Providing the queue configuration
+
+The recommended way is to use the Go Queue-it self-service portal to setup the configuration. The configuration
+specifies a set of Triggers and Actions. A Trigger is an expression matching one, more or all URLs on your website. When
+a user enter your website and the URL matches a Trigger-expression the corresponding Action will be triggered. The
+Action specifies which waiting room the users should be send to. In this way you can specify which waiting room(s)
+should protect which page(s) on the fly without changing the server-side integration.
+
+## Protecting AJAX calls
+
+If you need to protect AJAX calls beside page loads you need to add the below JavaScript tags to your pages:
+
+```html
+
+<script type="text/javascript" src="//static.queue-it.net/script/queueclient.min.js"></script>
+<script
+        data-queueit-intercept-domain="{YOUR_CURRENT_DOMAIN}"
+        data-queueit-intercept="true"
+        data-queueit-c="{YOUR_CUSTOMER_ID}"
+        type="text/javascript"
+        src="//static.queue-it.net/script/queueconfigloader.min.js">
+</script>
+```
diff --git a/assembly/__tests__/CustomerIntegrationDecodingHandler.spec.ts b/assembly/__tests__/CustomerIntegrationDecodingHandler.spec.ts
@@ -8,6 +8,26 @@ describe('CustomerIntegrationDecodingHandler', () => {
         const integrationConfigString = `{
    "Description":"tst",
    "Integrations":[
+      {
+         "Name":"Integration - With InvolvedWaitingRoomIds",
+         "ActionType":"Cancel",
+         "EventId":"event2",
+         "InvolvedWaitingRoomIds":["event2"],
+         "Triggers":[
+            {
+               "TriggerParts":[
+                  {
+                     "ValidatorType":"UrlValidator",
+                     "Operator":"Contains",
+                     "ValueToCompare":"test2",
+                     "IsNegative":false,
+                     "IsIgnoreCase":true
+                  }
+               ],
+               "LogicalOperator":"And"
+            }
+         ]
+      },
       {
          "Name":"mojitest",
          "ActionType":"Queue",
@@ -1050,6 +1070,26 @@ describe('CustomerIntegrationDecodingHandler', () => {
          "QueueDomain":"queueitknownusertst.test.queue-it.net",
          "RedirectLogic":"AllowTParameter",
          "ForcedTargetUrl":""
+      },
+      {
+         "Name":"Integration - With InvolvedWaitingRoomIds null",
+         "ActionType":"Queue",
+         "EventId":"event1",
+         "InvolvedWaitingRoomIds":null,
+         "Triggers":[
+            {
+               "TriggerParts":[
+                  {
+                     "ValidatorType":"UrlValidator",
+                     "Operator":"Contains",
+                     "ValueToCompare":"test1",
+                     "IsNegative":false,
+                     "IsIgnoreCase":true
+                  }
+               ],
+               "LogicalOperator":"And"
+            }
+         ]
       }
    ],
    "CustomerId":"queueitknownusertst",
@@ -1066,21 +1106,29 @@ describe('CustomerIntegrationDecodingHandler', () => {
 
         expect(customerIntegrationInfo.Version).toBe(55);
         expect(customerIntegrationInfo.Description).toBe("tst", 'Description should be deserialized');
-        expect(customerIntegrationInfo.Integrations.length).toBe(23);
-        expect(customerIntegrationInfo.Integrations[0].Name).toBe("mojitest");
-        expect(customerIntegrationInfo.Integrations[1].Name).toBe("all pages");
-        let triggerModel = customerIntegrationInfo.Integrations[0].Triggers[0];
+        expect(customerIntegrationInfo.Integrations.length).toBe(25);
+        
+        // Test InvolvedWaitingRoomIds array handling first (verifies no trigger accumulation bug)
+        expect(customerIntegrationInfo.Integrations[0].Name).toBe('Integration - With InvolvedWaitingRoomIds');
+        expect(customerIntegrationInfo.Integrations[0].Triggers.length).toBe(1, 'Integration - With InvolvedWaitingRoomIds should have exactly 1 trigger');
+        
+        expect(customerIntegrationInfo.Integrations[1].Name).toBe("mojitest");
+        expect(customerIntegrationInfo.Integrations[2].Name).toBe("all pages");
+        let triggerModel = customerIntegrationInfo.Integrations[1].Triggers[0];
         expect(triggerModel.LogicalOperator).toBe("And");
         expect(triggerModel.TriggerParts[0].ValueToCompare).toBe("mojitest");
         expect(triggerModel.TriggerParts[0].IsNegative).toBe(false);
         expect(triggerModel.TriggerParts[0].IsIgnoreCase).toBe(true);
 
-        triggerModel = customerIntegrationInfo.Integrations[1].Triggers[0];
+        triggerModel = customerIntegrationInfo.Integrations[2].Triggers[0];
         expect(triggerModel.TriggerParts[0].ValueToCompare).toBe('test02082018');
 
-        triggerModel = customerIntegrationInfo.Integrations[2].Triggers[0];
+        triggerModel = customerIntegrationInfo.Integrations[3].Triggers[0];
         expect(triggerModel.TriggerParts[1].ValuesToCompare.length).toBe(2);
         expect(triggerModel.TriggerParts[1].ValuesToCompare[0]).toBe('ignore-this-queue-event1-nodomain');
         expect(triggerModel.TriggerParts[1].ValuesToCompare[1]).toBe('ignore-that-queue-event1-nodomain');
+
+        expect(customerIntegrationInfo.Integrations[24].Name).toBe('Integration - With InvolvedWaitingRoomIds null');
+        expect(customerIntegrationInfo.Integrations[24].Triggers.length).toBe(1, 'Integration - With InvolvedWaitingRoomIds null should have exactly 1 trigger');
     });
 })
diff --git a/assembly/helper.ts b/assembly/helper.ts
@@ -2,7 +2,7 @@ import { Utils } from "./sdk/QueueITHelpers";
 import { hmacString } from "./sdk/helpers/crypto";
 
 export class QueueITHelper {
-  static readonly KUP_VERSION: string = "fastly-1.0.4";
+  static readonly KUP_VERSION: string = "fastly-1.1.0";
 
   static configureKnownUserHashing(): void {
     Utils.generateSHA256Hash = hmacString;
diff --git a/assembly/sdk/IntegrationConfig/CustomerIntegrationDecodingHandler.ts b/assembly/sdk/IntegrationConfig/CustomerIntegrationDecodingHandler.ts
@@ -7,6 +7,11 @@ import {
 } from "./IntegrationConfigModel";
 import {JSONDecoder} from "assemblyscript-json";
 
+const ARRAY_NAME_INTEGRATIONS = "Integrations";
+const ARRAY_NAME_TRIGGERS = "Triggers";
+const ARRAY_NAME_TRIGGER_PARTS = "TriggerParts";
+const ARRAY_NAME_VALUES_TO_COMPARE = "ValuesToCompare";
+
 export class CustomerIntegrationDecodingHandler extends JSONHandler {
     private readonly _deserializedValue: CustomerIntegration;
     private isInIntegrations: bool = false;
@@ -19,6 +24,7 @@ export class CustomerIntegrationDecodingHandler extends JSONHandler {
     private currentTriggerPart: TriggerPart | null;
     private isInTriggerParts: bool = false;
     private isInTriggerPartValuesToCompare: bool = false;
+    private arrayStack: string[] = [];
 
     constructor() {
         super();
@@ -29,13 +35,18 @@ export class CustomerIntegrationDecodingHandler extends JSONHandler {
         // Handle array start
         // true means that nested object needs to be traversed, false otherwise
         // Note that returning false means JSONDecoder.startIndex need to be updated by handler
-        if (name == "Integrations") {
+
+        // Push array name to stack BEFORE checking if we recognize it
+        // This ensures every pushArray has a matching popArray
+        this.arrayStack.push(name);
+
+        if (name == ARRAY_NAME_INTEGRATIONS) {
             this.isInIntegrations = true;
-        } else if (name == "Triggers") {
+        } else if (name == ARRAY_NAME_TRIGGERS) {
             this.isInTriggers = true;
-        } else if (name == "TriggerParts") {
+        } else if (name == ARRAY_NAME_TRIGGER_PARTS) {
             this.isInTriggerParts = true;
-        } else if (name == "ValuesToCompare") {
+        } else if (name == ARRAY_NAME_VALUES_TO_COMPARE) {
             this.isInTriggerPartValuesToCompare = true;
         }
         return this.isInIntegrations
@@ -46,15 +57,24 @@ export class CustomerIntegrationDecodingHandler extends JSONHandler {
 
 
     popArray(): void {
-        if (this.isInTriggerPartValuesToCompare) {
+        // Pop array name from stack
+        if (this.arrayStack.length == 0) {
+            return; // Defensive: should never happen
+        }
+
+        const arrayName = this.arrayStack.pop();
+
+        // Only clear flags for recognized arrays
+        if (arrayName == ARRAY_NAME_VALUES_TO_COMPARE) {
             this.isInTriggerPartValuesToCompare = false;
-        } else if (this.isInTriggerParts) {
+        } else if (arrayName == ARRAY_NAME_TRIGGER_PARTS) {
             this.isInTriggerParts = false;
-        } else if (this.isInTriggers) {
+        } else if (arrayName == ARRAY_NAME_TRIGGERS) {
             this.isInTriggers = false;
-        } else if (this.isInIntegrations) {
+        } else if (arrayName == ARRAY_NAME_INTEGRATIONS) {
             this.isInIntegrations = false;
         }
+        // Note: Unrecognized arrays (like InvolvedWaitingRoomIds) are popped but don't affect flags
     }
 
     pushObject(name: string): bool {
@@ -76,7 +96,10 @@ export class CustomerIntegrationDecodingHandler extends JSONHandler {
             this.currentTriggerModel!.TriggerParts.push(this.currentTriggerPart!);
             this.isInTriggerPart = false;
         } else if (this.isInTriggerModel) {
-            this.currentIntegrationConfigModel!.Triggers.push(this.currentTriggerModel!);
+            // Defensive: only add trigger if we have a valid integration
+            if (this.currentIntegrationConfigModel != null) {
+                this.currentIntegrationConfigModel!.Triggers.push(this.currentTriggerModel!);
+            }
             this.isInTriggerModel = false;
         } else if (this.isInConfigModel) {
             this._deserializedValue.Integrations.push(this.currentIntegrationConfigModel!);
diff --git a/assembly/sdk/UserInQueueService.ts b/assembly/sdk/UserInQueueService.ts
@@ -3,7 +3,7 @@ import {ActionTypes, RequestValidationResult, QueueEventConfig, CancelEventConfi
 import {StateInfo, UserInQueueStateCookieRepository} from './UserInQueueStateCookieRepository'
 
 export class UserInQueueService {
-    static readonly SDK_VERSION: string = "v3-asmscrpt-3.6.1";
+    static readonly SDK_VERSION: string = "v3-asmscrpt-3.6.2";
 
     constructor(private userInQueueStateRepository: UserInQueueStateCookieRepository) {
     }
diff --git a/index.js b/index.js
@@ -1,8 +1,5 @@
 const fs = require("fs");
 const loader = require("@assemblyscript/loader");
 const imports = {};
-const wasmModule = loader.instantiateSync(
-  fs.readFileSync(__dirname + "/build/optimized.wasm"),
-  imports
-);
+const wasmModule = loader.instantiateSync(fs.readFileSync(__dirname + "/build/optimized.wasm"), imports);
 module.exports = wasmModule.exports;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import {ActionTypes, RequestValidationResult, QueueEventConfig, CancelEventConfi`
`3`	`3`	`import {StateInfo, UserInQueueStateCookieRepository} from './UserInQueueStateCookieRepository'`
`4`	`4`
`5`	`5`	`export class UserInQueueService {`
`6`		`- static readonly SDK_VERSION: string = "v3-asmscrpt-3.6.1";`
	`6`	`+ static readonly SDK_VERSION: string = "v3-asmscrpt-3.6.2";`
`7`	`7`
`8`	`8`	`constructor(private userInQueueStateRepository: UserInQueueStateCookieRepository) {`
`9`	`9`	`}`