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

package/{assembly → src}/integrationConfigProvider.ts

@@ -1,10 +1,9 @@
-import { Fastly, Headers, Request } from "@fastly/as-compute";
 import { RequestLogger } from "./helper";
 
-export function getIntegrationConfig(
+export async function getIntegrationConfig(
   details: IntegrationDetails,
   endpointProvider: IntegrationEndpointProvider
-): string {
+): Promise<string> {
   const headers = new Headers();
   headers.set("api-key", details.apiKey);
   headers.set("host", endpointProvider.getHostname(details.customerId));
@@ -16,19 +15,16 @@ export function getIntegrationConfig(
       headers: headers,
     }
   );
-  let cacheOverride = new Fastly.CacheOverride();
-  let cacheConf = endpointProvider.getCacheConfig();
-  if (cacheConf.maxAge != -1) {
-    cacheOverride.setTTL(cacheConf.maxAge);
-  }
-  if (cacheConf.staleWhileRevalidate != -1) {
-    cacheOverride.setSWR(cacheConf.staleWhileRevalidate);
-  }
+  const cacheConf = endpointProvider.getCacheConfig();
+  const cacheInit: { ttl?: number; swr?: number } = {};
+  if (cacheConf.maxAge !== -1) cacheInit.ttl = cacheConf.maxAge;
+  if (cacheConf.staleWhileRevalidate !== -1) cacheInit.swr = cacheConf.staleWhileRevalidate;
+  const cacheOverride = new CacheOverride("override", cacheInit);
 
-  let beresp = Fastly.fetch(request, {
+  const beresp = await fetch(request, {
     backend: details.queueItOrigin,
     cacheOverride: cacheOverride,
-  }).wait();
+  });
 
   if (!(details.logger instanceof MockLogger)) {
     let cacheState = beresp.headers.get("x-cache");
@@ -41,7 +37,7 @@ export function getIntegrationConfig(
   if (beresp.status != 200) {
     return "";
   }
-  return beresp.text();
+  return await beresp.text();
 }
 
 const integrationCustomerId = "customerId",
@@ -52,19 +48,20 @@ const integrationCustomerId = "customerId",
   workerHost = "workerHost";
 
 export function resolveIntegrationDetails(): IntegrationDetails | null {
-  const dict = new Fastly.Dictionary(integrationDictionary);
+  const dict = new ConfigStore(integrationDictionary);
   if (
-    !dict.contains(integrationCustomerId) ||
-    !dict.contains(integrationApiKey) ||
-    !dict.contains(integrationSecret) ||
-    !dict.contains(integrationQueueItOrigin)
+    dict.get(integrationCustomerId) === null ||
+    dict.get(integrationApiKey) === null ||
+    dict.get(integrationSecret) === null ||
+    dict.get(integrationQueueItOrigin) === null
   ) {
     return null;
   }
 
   let workerHostValue = "";
-  if (dict.contains(workerHost)) {
-    workerHostValue = dict.get(workerHost)!;
+  const workerHostVal = dict.get(workerHost);
+  if (workerHostVal !== null) {
+    workerHostValue = workerHostVal;
   }
 
   return new IntegrationDetails(
@@ -77,8 +74,8 @@ export function resolveIntegrationDetails(): IntegrationDetails | null {
 }
 
 export class IntegrationEndpointCacheConfig {
-  maxAge: i16 = -1;
-  staleWhileRevalidate: i16 = -1;
+  maxAge: number = -1;
+  staleWhileRevalidate: number = -1;
 }
 
 export interface IntegrationEndpointProvider {

package/{assembly → src}/requestResponseHandler.ts

@@ -1,137 +1,131 @@
-import { Request, Response, Headers } from "@fastly/as-compute";
-import { KnownUser } from "./sdk/KnownUser";
-import { QueueITHelper } from "./helper";
-import { FastlyHttpContextProvider, getHttpHandler } from "./contextProvider";
-import {
-  getIntegrationConfig,
-  resolveIntegrationDetails,
-  IntegrationDetails,
-  QueueItIntegrationEndpointProvider,
-} from "./integrationConfigProvider";
-import { Utils } from "./sdk/QueueITHelpers";
-
-const QUEUEIT_FAILED_HEADERNAME = "x-queueit-failed";
-let httpProvider: FastlyHttpContextProvider | null = null;
-
-export function onQueueITRequest(
-  req: Request,
-  conf: IntegrationDetails | null = null
-): Response | null {
-  if (conf == null) {
-    conf = resolveIntegrationDetails();
-  }
-  if (conf == null) {
-    return new Response(String.UTF8.encode("No integration details found."), {
-      headers: new Headers(),
-      status: 404,
-      url: "",
-    });
-  }
-
-  const integrationProvider =
-    conf.provider == null
-      ? new QueueItIntegrationEndpointProvider()
-      : conf.provider;
-  QueueITHelper.configureKnownUserHashing();
-  httpProvider = getHttpHandler(req);
-
-  let integrationConfigJson = getIntegrationConfig(conf, integrationProvider);
-  const requestUrl: string = conf.resolveWorkerRequestUrl(req.url);
-
-  const queueItToken = Utils.getParameterByName(
-    requestUrl,
-    KnownUser.QueueITTokenKey
-  );
-  const requestUrlWithoutToken: string = Utils.removeQueueItToken(requestUrl);
-
-  // The requestUrlWithoutToken is used to match Triggers and as the Target url (where to return the users to).
-  // It is therefor important that this is exactly the url of the users browsers. So, if your webserver is
-  // behind e.g. a load balancer that modifies the host name or port, reformat requestUrlWithoutToken before proceeding.
-  const validationResultPair = KnownUser.validateRequestByIntegrationConfig(
-    requestUrlWithoutToken,
-    queueItToken,
-    integrationConfigJson,
-    conf.customerId,
-    conf.secretKey,
-    httpProvider!
-  );
-
-  if (
-    validationResultPair.first != null &&
-    validationResultPair.first!.doRedirect()
-  ) {
-    const validationResult = validationResultPair.first!;
-
-    if (validationResult.isAjaxResult) {
-      let response = new Response(null, {
-        status: 200,
-        headers: httpProvider!.getHttpResponse().getHeaders(),
-        url: "",
-      });
-      // In case of ajax call send the user to the queue by sending a custom queue-it header and redirecting user to queue from javascript
-      response.headers.set("Access-Control-Expose-Headers", validationResult.getAjaxQueueRedirectHeaderKey());
-      response.headers.set(
-        validationResult.getAjaxQueueRedirectHeaderKey(),
-        QueueITHelper.addKUPlatformVersion(
-          validationResult.getAjaxRedirectUrl()
-        )
-      );
-      Utils.addNoCacheHeaders(response);
-      return response;
-    } else {
-      let response = new Response(null, {
-        status: 302,
-        headers: httpProvider!.getHttpResponse().getHeaders(),
-        url: "",
-      });
-      // Send the user to the queue - either because hash was missing or because is was invalid
-      response.headers.set(
-        "Location",
-        QueueITHelper.addKUPlatformVersion(validationResult.redirectUrl)
-      );
-      Utils.addNoCacheHeaders(response);
-      return response;
-    }
-  } else if (validationResultPair.first != null) {
-    const validationResult = validationResultPair.first!;
-    // Request can continue - we remove queueittoken form querystring parameter to avoid sharing of user specific token
-    // Support mobile scenario adding the condition !validationResult.isAjaxResult
-    if (
-      queueItToken != "" &&
-      !validationResult.isAjaxResult &&
-      validationResult.actionType == "Queue"
-    ) {
-      let response = new Response(null, {
-        status: 302,
-        headers: httpProvider!.getHttpResponse().getHeaders(),
-        url: requestUrlWithoutToken,
-      });
-      response.headers.set("Location", requestUrlWithoutToken);
-      Utils.addNoCacheHeaders(response);
-      return response;
-    } else {
-      // lets caller decide the next step, or just serve the request normally
-      return null;
-    }
-  } else if (validationResultPair.second != null) {
-    httpProvider!.isError = true;
-  }
-
-  return null;
-}
-
-//Fill in the Queue-it headers
-export function onQueueITResponse(res: Response): void {
-  const contextHeaders = httpProvider!.getHttpResponse().getHeaders();
-  const contextHeaderKeys = contextHeaders.keys();
-
-  if (httpProvider!.isError) {
-    res.headers.append(QUEUEIT_FAILED_HEADERNAME, "true");
-  }
-  for (let i = 0; i < contextHeaderKeys.length; i++) {
-    if (contextHeaderKeys[i].length == 0) continue;
-    let value = contextHeaders.get(contextHeaderKeys[i]);
-    if (value != null && value!.length > 0)
-      res.headers.append(contextHeaderKeys[i], value!);
-  }
-}
+import { KnownUser } from "./sdk/KnownUser";
+import { QueueITHelper } from "./helper";
+import { FastlyHttpContextProvider, getHttpHandler } from "./contextProvider";
+import {
+  getIntegrationConfig,
+  resolveIntegrationDetails,
+  IntegrationDetails,
+  QueueItIntegrationEndpointProvider,
+} from "./integrationConfigProvider";
+import { Utils } from "./sdk/QueueITHelpers";
+
+const QUEUEIT_FAILED_HEADERNAME = "x-queueit-failed";
+let httpProvider: FastlyHttpContextProvider | null = null;
+
+export async function onQueueITRequest(
+  req: Request,
+  conf: IntegrationDetails | null = null
+): Promise<Response | null> {
+  if (conf == null) {
+    conf = resolveIntegrationDetails();
+  }
+  if (conf == null) {
+    return new Response("No integration details found.", {
+      headers: new Headers(),
+      status: 404,
+    });
+  }
+
+  const integrationProvider =
+    conf.provider == null
+      ? new QueueItIntegrationEndpointProvider()
+      : conf.provider;
+  QueueITHelper.configureKnownUserHashing();
+  httpProvider = getHttpHandler(req);
+
+  let integrationConfigJson = await getIntegrationConfig(conf, integrationProvider);
+  const requestUrl: string = conf.resolveWorkerRequestUrl(req.url);
+
+  const queueItToken = Utils.getParameterByName(
+    requestUrl,
+    KnownUser.QueueITTokenKey
+  );
+  const requestUrlWithoutToken: string = Utils.removeQueueItToken(requestUrl);
+
+  // The requestUrlWithoutToken is used to match Triggers and as the Target url (where to return the users to).
+  // It is therefor important that this is exactly the url of the users browsers. So, if your webserver is
+  // behind e.g. a load balancer that modifies the host name or port, reformat requestUrlWithoutToken before proceeding.
+  const validationResultPair = KnownUser.validateRequestByIntegrationConfig(
+    requestUrlWithoutToken,
+    queueItToken,
+    integrationConfigJson,
+    conf.customerId,
+    conf.secretKey,
+    httpProvider!
+  );
+
+  if (
+    validationResultPair.first != null &&
+    validationResultPair.first!.doRedirect()
+  ) {
+    const validationResult = validationResultPair.first!;
+
+    if (validationResult.isAjaxResult) {
+      let response = new Response(null, {
+        status: 200,
+        headers: httpProvider!.getHttpResponse().getHeaders(),
+      });
+      // In case of ajax call send the user to the queue by sending a custom queue-it header and redirecting user to queue from javascript
+      response.headers.set("Access-Control-Expose-Headers", validationResult.getAjaxQueueRedirectHeaderKey());
+      response.headers.set(
+        validationResult.getAjaxQueueRedirectHeaderKey(),
+        QueueITHelper.addKUPlatformVersion(
+          validationResult.getAjaxRedirectUrl()
+        )
+      );
+      Utils.addNoCacheHeaders(response);
+      return response;
+    } else {
+      let response = new Response(null, {
+        status: 302,
+        headers: httpProvider!.getHttpResponse().getHeaders(),
+      });
+      // Send the user to the queue - either because hash was missing or because is was invalid
+      response.headers.set(
+        "Location",
+        QueueITHelper.addKUPlatformVersion(validationResult.redirectUrl)
+      );
+      Utils.addNoCacheHeaders(response);
+      return response;
+    }
+  } else if (validationResultPair.first != null) {
+    const validationResult = validationResultPair.first!;
+    // Request can continue - we remove queueittoken form querystring parameter to avoid sharing of user specific token
+    // Support mobile scenario adding the condition !validationResult.isAjaxResult
+    if (
+      queueItToken != "" &&
+      !validationResult.isAjaxResult &&
+      validationResult.actionType == "Queue"
+    ) {
+      let response = new Response(null, {
+        status: 302,
+        headers: httpProvider!.getHttpResponse().getHeaders(),
+      });
+      response.headers.set("Location", requestUrlWithoutToken);
+      Utils.addNoCacheHeaders(response);
+      return response;
+    } else {
+      // lets caller decide the next step, or just serve the request normally
+      return null;
+    }
+  } else if (validationResultPair.second != null) {
+    httpProvider!.isError = true;
+  }
+
+  return null;
+}
+
+//Fill in the Queue-it headers
+export function onQueueITResponse(res: Response): void {
+  const contextHeaders = httpProvider!.getHttpResponse().getHeaders();
+
+  if (httpProvider!.isError) {
+    res.headers.append(QUEUEIT_FAILED_HEADERNAME, "true");
+  }
+  for (const key of contextHeaders.keys()) {
+    if (key.length == 0) continue;
+    const value = contextHeaders.get(key);
+    if (value != null && value.length > 0)
+      res.headers.append(key, value);
+  }
+}

package/{assembly → src}/sdk/HttpContextProvider.ts

@@ -1,24 +1,23 @@
-import { Headers } from "@fastly/as-compute";
-
-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: i64): void;
-    getHeaders(): Headers;
-}
-
-export interface IHttpContextProvider {
-    getHttpRequest(): IHttpRequest;
-    getHttpResponse(): IHttpResponse;
-}
-
-export interface IDateTimeProvider {
-    getCurrentTime(): Date
-}
+
+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

@@ -0,0 +1,57 @@
+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;
+    }
+}