@queue-it/fastly 2.0.0 → 2.0.3-beta.0

package/README.md

@@ -1,12 +1,12 @@
 # KnownUser.V3.Fastly
 
 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
+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.
+behavior and operations are managed in Queue-it's Go Platform and/or via the Queue-it Admin API.
 
-This Fastly Queue-it Connector SDK (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.
@@ -52,7 +52,7 @@ There are two methods of installation:
   - You can verify that the `Config store` has been linked by going to your service and see it in the section `Config stores`
 - 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.
@@ -61,9 +61,9 @@ 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**
 - Go to **Resources -> Config stores** and create a new config store named `IntegrationConfiguration`.
   - Add the following items in the config store (you can find these values in the Go Queue-It self-service platform):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@queue-it/fastly",
-  "version": "2.0.0",
+  "version": "2.0.3-beta.0",
   "description": "Queue-it connector for Fastly",
   "main": "src/index.ts",
   "author": "devs@queue-it.com",
@@ -9,7 +9,7 @@
   "files": [
     "package.json",
     "README.md",
-    "src/sdk",
+    "src/helpers",
     "src/contextProvider.ts",
     "src/helper.ts",
     "src/integrationConfigProvider.ts",
@@ -17,19 +17,16 @@
     "src/index.ts"
   ],
   "scripts": {
-    "test": "jest",
     "bundle": "esbuild src/index.ts --bundle --outfile=bin/index.js --platform=node --target=es2022 && js-compute-runtime bin/index.js bin/main.wasm",
     "build": "fastly compute build",
     "deploy": "fastly compute deploy"
   },
   "dependencies": {
-    "@fastly/js-compute": "^3.0.0"
+    "@fastly/js-compute": "^3.0.0",
+    "@queue-it/connector-javascript": "^5.0.1"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
     "esbuild": "^0.27.3",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0",
     "typescript": "^5.4.0"
   }
 }

package/src/contextProvider.ts

@@ -1,11 +1,11 @@
-import {IHttpContextProvider, IHttpRequest, IHttpResponse} from "./sdk/HttpContextProvider";
-import {decodeURIComponent, encodeURIComponent} from "./sdk/helpers/Uri";
+import { IConnectorContextProvider, IHttpRequest, IHttpResponse } from '@queue-it/connector-javascript';
+import { FastlyCryptoProvider } from './fastlyCryptoProvider';
 
 export function getHttpHandler(req: Request): FastlyHttpContextProvider {
     return new FastlyHttpContextProvider(req);
 }
 
-export class FastlyHttpContextProvider implements IHttpContextProvider {
+export class FastlyHttpContextProvider implements IConnectorContextProvider {
     isError: boolean = false;
     private readonly req: FastlyHttpRequest;
     private readonly res: FastlyHttpResponse;
@@ -22,6 +22,14 @@ export class FastlyHttpContextProvider implements IHttpContextProvider {
     getHttpResponse(): IHttpResponse {
         return this.res;
     }
+
+    getCryptoProvider(): FastlyCryptoProvider {
+        return new FastlyCryptoProvider();
+    }
+
+    getEnqueueTokenProvider(): null {
+        return null;
+    }
 }
 
 export class FastlyHttpRequest implements IHttpRequest {
@@ -64,11 +72,11 @@ export class FastlyHttpRequest implements IHttpRequest {
         return this.baseReq.url;
     }
 
-    getCookieValue(cookieKey: string): string {
+    getCookieValue(cookieKey: string): string | undefined {
         if (this.parsedCookieDic.size == 0) {
             this.parseCookies(this.getHeader('cookie'))
         }
-        if (!this.parsedCookieDic.has(cookieKey)) return '';
+        if (!this.parsedCookieDic.has(cookieKey)) return undefined;
         const cookieVal = this.parsedCookieDic.get(cookieKey)!;
         try {
             return decodeURIComponent(cookieVal);
@@ -110,7 +118,7 @@ export class FastlyHttpResponse implements IHttpResponse {
         this.headers = new Headers();
     }
 
-    setCookie(cookieName: string, cookieValue: string, domain: string, expiration: number): void {
+    setCookie(cookieName: string, cookieValue: string, domain: string, expiration: number, _isHttpOnly: boolean, _isSecure: boolean): void {
         const expirationDate = new Date(expiration * 1000);
         let setCookieString = cookieName + "=" + encodeURIComponent(cookieValue) + "; expires=" + expirationDate.toUTCString() + ";";
         if (domain != "") {

package/src/helper.ts

@@ -1,12 +1,5 @@
-import { Utils } from "./sdk/QueueITHelpers";
-import { hmacString } from "./sdk/helpers/crypto";
-
 export class QueueITHelper {
-  static readonly KUP_VERSION: string = "fastly-2.0.0";
-
-  static configureKnownUserHashing(): void {
-    Utils.generateSHA256Hash = hmacString;
-  }
+  static readonly KUP_VERSION: string = "fastly-2.0.3-beta.0";
 
   static addKUPlatformVersion(redirectQueueUrl: string): string {
     return redirectQueueUrl + "&kupver=" + QueueITHelper.KUP_VERSION;

package/src/requestResponseHandler.ts

@@ -1,4 +1,4 @@
-import { KnownUser } from "./sdk/KnownUser";
+import { KnownUser, Utils } from "@queue-it/connector-javascript";
 import { QueueITHelper } from "./helper";
 import { FastlyHttpContextProvider, getHttpHandler } from "./contextProvider";
 import {
@@ -7,7 +7,6 @@ import {
   IntegrationDetails,
   QueueItIntegrationEndpointProvider,
 } from "./integrationConfigProvider";
-import { Utils } from "./sdk/QueueITHelpers";
 
 const QUEUEIT_FAILED_HEADERNAME = "x-queueit-failed";
 let httpProvider: FastlyHttpContextProvider | null = null;
@@ -30,7 +29,6 @@ export async function onQueueITRequest(
     conf.provider == null
       ? new QueueItIntegrationEndpointProvider()
       : conf.provider;
-  QueueITHelper.configureKnownUserHashing();
   httpProvider = getHttpHandler(req);
 
   let integrationConfigJson = await getIntegrationConfig(conf, integrationProvider);

package/src/sdk/HttpContextProvider.ts

@@ -1,23 +0,0 @@
-
-export interface IHttpRequest {
-    getUserAgent(): string;
-    getHeader(name: string): string;
-    getAbsoluteUri(): string;
-    getUserHostAddress(): string;
-    getCookieValue(cookieKey: string): string;
-    getRequestBodyAsString(): string;
-}
-
-export interface IHttpResponse {
-    setCookie(cookieName: string, cookieValue: string, domain: string, expiration: number): void;
-    getHeaders(): Headers;
-}
-
-export interface IHttpContextProvider {
-    getHttpRequest(): IHttpRequest;
-    getHttpResponse(): IHttpResponse;
-}
-
-export interface IDateTimeProvider {
-    getCurrentTime(): Date
-}

package/src/sdk/IntegrationConfig/CustomerIntegrationDecodingHandler.ts

@@ -1,57 +0,0 @@
-import {
-    CustomerIntegration,
-    IntegrationConfigModel,
-    TriggerModel,
-    TriggerPart
-} from "./IntegrationConfigModel";
-
-export class CustomerIntegrationDecodingHandler {
-    static deserialize(integrationsConfigString: string): CustomerIntegration {
-        const result = new CustomerIntegration();
-        if (!integrationsConfigString) return result;
-
-        const parsed = JSON.parse(integrationsConfigString);
-        result.Version = parsed.Version ?? 0;
-        result.Description = parsed.Description ?? '';
-
-        if (Array.isArray(parsed.Integrations)) {
-            result.Integrations = parsed.Integrations.map((item: any) => {
-                const model = new IntegrationConfigModel();
-                model.Name = item.Name ?? '';
-                model.EventId = item.EventId ?? '';
-                model.CookieDomain = item.CookieDomain ?? '';
-                model.LayoutName = item.LayoutName ?? '';
-                model.Culture = item.Culture ?? '';
-                model.ExtendCookieValidity = item.ExtendCookieValidity ?? false;
-                model.CookieValidityMinute = item.CookieValidityMinute ?? 0;
-                model.QueueDomain = item.QueueDomain ?? '';
-                model.RedirectLogic = item.RedirectLogic ?? '';
-                model.ForcedTargetUrl = item.ForcedTargetUrl ?? '';
-                model.ActionType = item.ActionType ?? '';
-
-                model.Triggers = (item.Triggers ?? []).map((trigger: any) => {
-                    const t = new TriggerModel();
-                    t.LogicalOperator = trigger.LogicalOperator ?? '';
-                    t.TriggerParts = (trigger.TriggerParts ?? []).map((part: any) => {
-                        const tp = new TriggerPart();
-                        tp.ValidatorType = part.ValidatorType ?? '';
-                        tp.Operator = part.Operator ?? '';
-                        tp.ValueToCompare = part.ValueToCompare ?? '';
-                        tp.ValuesToCompare = part.ValuesToCompare ?? [];
-                        tp.IsNegative = part.IsNegative ?? false;
-                        tp.IsIgnoreCase = part.IsIgnoreCase ?? false;
-                        tp.UrlPart = part.UrlPart ?? '';
-                        tp.CookieName = part.CookieName ?? '';
-                        tp.HttpHeaderName = part.HttpHeaderName ?? '';
-                        return tp;
-                    });
-                    return t;
-                });
-
-                return model;
-            });
-        }
-
-        return result;
-    }
-}

package/src/sdk/IntegrationConfig/IntegrationConfigHelpers.ts

@@ -1,230 +0,0 @@
-import * as IntegrationModels from './IntegrationConfigModel'
-import {KnownUserException} from '../Models'
-import {IHttpRequest} from '../HttpContextProvider'
-
-export interface IIntegrationEvaluator {
-    getMatchedIntegrationConfig(
-        customerIntegration: IntegrationModels.CustomerIntegration,
-        currentPageUrl: string,
-        request: IHttpRequest): IntegrationModels.IntegrationConfigModelResult | null;
-}
-
-export class IntegrationEvaluator implements IIntegrationEvaluator {
-    public getMatchedIntegrationConfig(
-        customerIntegration: IntegrationModels.CustomerIntegration,
-        currentPageUrl: string,
-        request: IHttpRequest | null): IntegrationModels.IntegrationConfigModelResult | null {
-
-        if (request == null)
-            return new IntegrationModels.IntegrationConfigModelResult(null, new KnownUserException("request is null"));
-
-        if (customerIntegration == null)
-            return new IntegrationModels.IntegrationConfigModelResult(null, new KnownUserException("customerIntegration is null"));
-
-        for (let i = 0; i < customerIntegration.Integrations.length; i++) {
-            let integration = customerIntegration.Integrations[i];
-            for (let t = 0; t < integration.Triggers.length; t++) {
-                let trigger = integration.Triggers[t];
-                if (this.evaluateTrigger(trigger, currentPageUrl, request)) {
-                    return new IntegrationModels.IntegrationConfigModelResult(integration, null);
-                }
-            }
-        }
-        return null;
-    }
-
-    private evaluateTrigger(trigger: IntegrationModels.TriggerModel, currentPageUrl: string, request: IHttpRequest): boolean {
-        if (trigger.LogicalOperator == IntegrationModels.LogicalOperatorType.Or) {
-            for (let i = 0; i < trigger.TriggerParts.length; i++) {
-                let part = trigger.TriggerParts[i];
-                if (this.evaluateTriggerPart(part, currentPageUrl, request))
-                    return true;
-            }
-            return false;
-        } else {
-            for (let i = 0; i < trigger.TriggerParts.length; i++) {
-                let part = trigger.TriggerParts[i];
-                let matched = this.evaluateTriggerPart(part, currentPageUrl, request);
-                if (!matched)
-                    return false;
-            }
-            return true;
-        }
-    }
-
-    private evaluateTriggerPart(triggerPart: IntegrationModels.TriggerPart, currentPageUrl: string, request: IHttpRequest): boolean {
-        if (triggerPart.ValidatorType == IntegrationModels.ValidatorType.UrlValidator) {
-            return UrlValidatorHelper.evaluate(triggerPart, currentPageUrl);
-        } else if (triggerPart.ValidatorType == IntegrationModels.ValidatorType.CookieValidator) {
-            return CookieValidatorHelper.evaluate(triggerPart, request);
-        } else if (triggerPart.ValidatorType == IntegrationModels.ValidatorType.UserAgentValidator) {
-            return UserAgentValidatorHelper.evaluate(triggerPart, request.getUserAgent());
-        } else if (triggerPart.ValidatorType == IntegrationModels.ValidatorType.HttpHeaderValidator) {
-            return HttpHeaderValidatorHelper.evaluate(triggerPart, request.getHeader(triggerPart.HttpHeaderName));
-        } else if (triggerPart.ValidatorType == IntegrationModels.ValidatorType.RequestBodyValidator) {
-            return RequestBodyValidatorHelper.evaluate(triggerPart, request.getRequestBodyAsString());
-        } else {
-            return false;
-        }
-    }
-}
-
-export class UrlValidatorHelper {
-    public static evaluate(triggerPart: IntegrationModels.TriggerPart, url: string): boolean {
-        let urlpart = this.getUrlPart(triggerPart, url);
-        return ComparisonOperatorHelper.evaluate(
-            triggerPart.Operator,
-            triggerPart.IsNegative,
-            triggerPart.IsIgnoreCase,
-            urlpart,
-            triggerPart.ValueToCompare,
-            triggerPart.ValuesToCompare);
-    }
-
-    private static getUrlPart(triggerPart: IntegrationModels.TriggerPart, url: string): string {
-        if (triggerPart.UrlPart == IntegrationModels.UrlPartType.PagePath) {
-            return this.getPathFromUrl(url);
-        } else if (triggerPart.UrlPart == IntegrationModels.UrlPartType.PageUrl) {
-            return url;
-        } else if (triggerPart.UrlPart == IntegrationModels.UrlPartType.HostName) {
-            return this.getHostNameFromUrl(url);
-        } else {
-            return "";
-        }
-    }
-
-    public static getHostNameFromUrl(url: string): string {
-        let urlx = new URL(url);
-        return urlx.host;
-    }
-
-    public static getPathFromUrl(url: string): string {
-        let urlx = new URL(url);
-        return urlx.pathname;
-    }
-}
-
-export class CookieValidatorHelper {
-    public static evaluate(triggerPart: IntegrationModels.TriggerPart, request: IHttpRequest): boolean {
-        return ComparisonOperatorHelper.evaluate(triggerPart.Operator,
-            triggerPart.IsNegative,
-            triggerPart.IsIgnoreCase,
-            this.getCookie(triggerPart.CookieName, request),
-            triggerPart.ValueToCompare,
-            triggerPart.ValuesToCompare);
-    }
-
-    private static getCookie(cookieName: string, request: IHttpRequest): string {
-        return request.getCookieValue(cookieName);
-    }
-}
-
-export class UserAgentValidatorHelper {
-    public static evaluate(triggerPart: IntegrationModels.TriggerPart, userAgent: string): boolean {
-
-        return ComparisonOperatorHelper.evaluate(triggerPart.Operator,
-            triggerPart.IsNegative,
-            triggerPart.IsIgnoreCase,
-            userAgent,
-            triggerPart.ValueToCompare,
-            triggerPart.ValuesToCompare);
-    }
-}
-
-export class RequestBodyValidatorHelper {
-    public static evaluate(triggerPart: IntegrationModels.TriggerPart, bodyString: string): boolean {
-
-        return ComparisonOperatorHelper.evaluate(triggerPart.Operator,
-            triggerPart.IsNegative,
-            triggerPart.IsIgnoreCase,
-            bodyString,
-            triggerPart.ValueToCompare,
-            triggerPart.ValuesToCompare);
-    }
-}
-
-export class HttpHeaderValidatorHelper {
-    public static evaluate(triggerPart: IntegrationModels.TriggerPart, headerValue: string): boolean {
-        return ComparisonOperatorHelper.evaluate(triggerPart.Operator,
-            triggerPart.IsNegative,
-            triggerPart.IsIgnoreCase,
-            headerValue,
-            triggerPart.ValueToCompare,
-            triggerPart.ValuesToCompare);
-    }
-}
-
-export class ComparisonOperatorHelper {
-    public static evaluate(opt: string,
-                           isNegative: boolean,
-                           isIgnoreCase: boolean,
-                           value: string,
-                           valueToCompare: string,
-                           valuesToCompare: Array<string> | null): boolean {
-        if (valuesToCompare == null) {
-            valuesToCompare = new Array<string>();
-        }
-        if (opt == IntegrationModels.ComparisonOperatorType.EqualS) {
-            return ComparisonOperatorHelper.equalS(value, valueToCompare, isNegative, isIgnoreCase);
-        } else if (opt == IntegrationModels.ComparisonOperatorType.Contains) {
-            return ComparisonOperatorHelper.contains(value, valueToCompare, isNegative, isIgnoreCase);
-        } else if (opt == IntegrationModels.ComparisonOperatorType.EqualsAny) {
-            return ComparisonOperatorHelper.equalsAny(value, valuesToCompare, isNegative, isIgnoreCase);
-        } else if (opt == IntegrationModels.ComparisonOperatorType.ContainsAny) {
-            return ComparisonOperatorHelper.containsAny(value, valuesToCompare, isNegative, isIgnoreCase);
-        } else {
-            return false;
-        }
-    }
-
-    private static contains(value: string, valueToCompare: string, isNegative: boolean, ignoreCase: boolean): boolean {
-        if (valueToCompare == "*" && value != "")
-            return true;
-
-        let evaluation = false;
-
-        if (ignoreCase)
-            evaluation = value.toUpperCase().indexOf(valueToCompare.toUpperCase()) != -1;
-        else
-            evaluation = value.indexOf(valueToCompare) != -1;
-
-        if (isNegative)
-            return !evaluation;
-        else
-            return evaluation;
-    }
-
-    private static equalS(value: string, valueToCompare: string, isNegative: boolean, ignoreCase: boolean): boolean {
-        let evaluation = false;
-
-        if (ignoreCase)
-            evaluation = value.toUpperCase() == valueToCompare.toUpperCase();
-        else
-            evaluation = value == valueToCompare;
-
-        if (isNegative)
-            return !evaluation;
-        else
-            return evaluation;
-    }
-
-    private static equalsAny(value: string, valuesToCompare: Array<string>, isNegative: boolean, isIgnoreCase: boolean): boolean {
-        for (let i = 0; i < valuesToCompare.length; i++) {
-            let valueToCompare = valuesToCompare[i];
-            if (ComparisonOperatorHelper.equalS(value, valueToCompare, false, isIgnoreCase))
-                return !isNegative;
-        }
-
-        return isNegative;
-    }
-
-    private static containsAny(value: string, valuesToCompare: Array<string>, isNegative: boolean, isIgnoreCase: boolean): boolean {
-        for (let i = 0; i < valuesToCompare.length; i++) {
-            let valueToCompare = valuesToCompare[i];
-            if (ComparisonOperatorHelper.contains(value, valueToCompare, false, isIgnoreCase))
-                return !isNegative;
-        }
-
-        return isNegative;
-    }
-}

package/src/sdk/IntegrationConfig/IntegrationConfigModel.ts

@@ -1,93 +0,0 @@
-import {KnownUserException, Tuple} from "../Models";
-
-export class IntegrationConfigModelResult extends Tuple<IntegrationConfigModel | null, KnownUserException | null> {
-}
-
-export class IntegrationConfigModel {
-    Name: string = "";
-    EventId: string = "";
-    CookieDomain: string = "";
-    LayoutName: string = "";
-    Culture: string = "";
-    ExtendCookieValidity: boolean = false;
-    CookieValidityMinute: number = 0;
-    QueueDomain: string = "";
-    RedirectLogic: string = "";
-    ForcedTargetUrl: string = "";
-    ActionType: string = "";
-    Triggers: Array<TriggerModel>;
-
-    constructor() {
-        this.Triggers = new Array<TriggerModel>();
-    }
-}
-
-export class CustomerIntegration {
-    Integrations: Array<IntegrationConfigModel>;
-    Version: number;
-    Description: string;
-
-    constructor() {
-        this.Integrations = new Array<IntegrationConfigModel>();
-        this.Version = 0;
-        this.Description = "";
-    }
-}
-
-export class TriggerPart {
-    ValidatorType: string = "";
-    Operator: string = "";
-    ValueToCompare: string = "";
-    ValuesToCompare: Array<string>;
-    IsNegative: boolean = false;
-    IsIgnoreCase: boolean = false;
-    UrlPart: string = ""; // UrlValidator
-    CookieName: string = ""; // CookieValidator
-    HttpHeaderName: string = ""; // HttpHeaderValidator
-
-    constructor() {
-        this.ValuesToCompare = new Array<string>();
-    }
-}
-
-export class TriggerModel {
-    constructor() {
-        this.TriggerParts = new Array<TriggerPart>();
-        this.LogicalOperator = "";
-    }
-
-    TriggerParts: Array<TriggerPart>;
-    LogicalOperator: string;
-}
-
-export class ValidatorType {
-    public static readonly UrlValidator: string = "UrlValidator";
-    public static readonly CookieValidator: string = "CookieValidator";
-    public static readonly UserAgentValidator: string = "UserAgentValidator";
-    public static readonly HttpHeaderValidator: string = "HttpHeaderValidator";
-    public static readonly RequestBodyValidator: string = "RequestBodyValidator";
-}
-
-export class UrlPartType {
-    static readonly HostName: string = "HostName";
-    static readonly PagePath: string = "PagePath";
-    static readonly PageUrl: string = "PageUrl";
-}
-
-export class ComparisonOperatorType {
-    static readonly EqualS: string = "Equals";
-    static readonly Contains: string = "Contains";
-    static readonly EqualsAny: string = "EqualsAny";
-    static readonly ContainsAny: string = "ContainsAny";
-}
-
-export class LogicalOperatorType {
-    public static readonly Or: string = "Or";
-    public static readonly And: string = "And";
-}
-
-export class ActionType {
-    public static readonly IgnoreAction: string = "Ignore";
-    public static readonly CancelAction: string = "Cancel";
-    public static readonly QueueAction: string = "Queue";
-}