@adobe/spacecat-shared-tokowaka-client 1.19.0 → 1.20.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-tokowaka-client-v1.20.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.19.1...@adobe/spacecat-shared-tokowaka-client-v1.20.0) (2026-06-27)
+
+### Features
+
+* **tokowaka-client:** add CloudFront Optimize-at-Edge control-plane ([#1722](https://github.com/adobe/spacecat-shared/issues/1722)) ([e465be0](https://github.com/adobe/spacecat-shared/commit/e465be0a21e61b13db8dd06dacbec7895cb91272))
+
+## [@adobe/spacecat-shared-tokowaka-client-v1.19.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.19.0...@adobe/spacecat-shared-tokowaka-client-v1.19.1) (2026-06-21)
+
+### Bug Fixes
+
+* apply stale config in IVE edge deployment flow ([#1691](https://github.com/adobe/spacecat-shared/issues/1691)) ([9f07a9c](https://github.com/adobe/spacecat-shared/commit/9f07a9ccc73140249aad16e9c9d0d7f5cededf59))
+
 ## [@adobe/spacecat-shared-tokowaka-client-v1.19.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.18.2...@adobe/spacecat-shared-tokowaka-client-v1.19.0) (2026-06-03)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {
@@ -36,7 +36,10 @@
   "dependencies": {
     "@adobe/spacecat-shared-utils": "1.81.1",
     "@aws-sdk/client-cloudfront": "3.1057.0",
+    "@aws-sdk/client-iam": "3.1057.0",
+    "@aws-sdk/client-lambda": "3.1057.0",
     "@aws-sdk/client-s3": "3.1057.0",
+    "@aws-sdk/client-sts": "3.1057.0",
     "hast-util-from-html": "2.0.3",
     "mdast-util-from-markdown": "2.0.3",
     "mdast-util-to-hast": "13.2.1",

package/src/cdn/cloudfront/edge-code.js

@@ -0,0 +1,152 @@
+/*
+ * Copyright 2026 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/**
+ * Edge runtime code for the CloudFront "Optimize at Edge" onboarding, kept out of the
+ * orchestrator (index.js) so it stays readable. Both exports are plain JS-module
+ * strings (not sibling-file reads) so the helix-deploy bundle preserves them — see CLAUDE.md
+ * "Lambda Bundle Constraints".
+ */
+
+/**
+ * Build the CloudFront Function (viewer-request) routing code. Ported verbatim from the standalone
+ * wizard's `buildFunctionCode` (server.mjs). It detects agentic bots on HTML pages and, for them,
+ * creates a request origin group that fails over from the Edge Optimize origin to the default
+ * origin.
+ *
+ * @param {string} defaultOriginId - the distribution's default-behavior target origin id.
+ * @param {string[]|null} [targetedPaths] - explicit paths to target, or null for "all HTML pages".
+ * @returns {string} the CloudFront Function source code.
+ */
+export function buildCloudfrontFunctionCode(defaultOriginId, targetedPaths = null) {
+  const targetedPathsValue = targetedPaths === null ? 'null' : JSON.stringify(targetedPaths);
+  const defaultOriginIdValue = JSON.stringify(defaultOriginId);
+
+  return `import cf from 'cloudfront';
+
+function handler(event) {
+    var request = event.request;
+    var headers = request.headers;
+
+    delete headers['x-edgeoptimize-api-key'];
+    delete headers['x-edgeoptimize-url'];
+    delete headers['x-edgeoptimize-config'];
+
+    var AGENTIC_BOTS = ['AdobeEdgeOptimize-AI', 'ChatGPT-User', 'GPTBot', 'OAI-SearchBot', 'PerplexityBot', 'Perplexity-User', 'ClaudeBot', 'Claude-User', 'Claude-SearchBot'];
+    var TARGETED_PATHS = ${targetedPathsValue};
+
+    var userAgent = headers['user-agent'] ? headers['user-agent'].value.toLowerCase() : '';
+    var isEdgeOptimizeRequest = headers['x-edgeoptimize-request'];
+
+    var path = request.uri;
+    var pattern = /(?:\\/[^./]+|\\.html|\\/)$/;
+    var isHtmlPage = pattern.test(path);
+
+    var isTargetedPath = TARGETED_PATHS === null
+        ? isHtmlPage
+        : isHtmlPage && TARGETED_PATHS.includes(path);
+
+    var isAgenticBot = AGENTIC_BOTS.some(function(bot) {
+        return userAgent.includes(bot.toLowerCase());
+    });
+
+    if (!isEdgeOptimizeRequest && isAgenticBot && isTargetedPath) {
+        request.headers['x-edgeoptimize-url'] = { value: request.uri };
+        request.headers['x-edgeoptimize-config'] = { value: "LLMCLIENT=true" };
+
+        console.log("Adding origin group for userAgent: " + userAgent);
+
+        cf.createRequestOriginGroup({
+            "originIds": [
+                { "originId": "EdgeOptimize_Origin" },
+                { "originId": ${defaultOriginIdValue} }
+            ],
+            "failoverCriteria": {
+                "statusCodes": [400, 403, 404, 416, 500, 502, 503, 504]
+            }
+        });
+
+        console.log("Routing to Edge Optimize origin for userAgent: " + userAgent);
+        return request;
+    }
+
+    console.log("Routing to Default origin for userAgent: " + userAgent);
+    return request;
+}`;
+}
+
+/**
+ * Build the Lambda@Edge origin-request/response handler. Ported from the standalone wizard's
+ * templates/origin-request-response.js. Returned as an inline JS module string (not a sibling-file
+ * read) so the helix-deploy bundle preserves it — see CLAUDE.md "Lambda Bundle Constraints".
+ *
+ * The Edge Optimize origin domain is injected so the same handler works per environment
+ * (e.g. dev.edgeoptimize.net on dev, live.edgeoptimize.net on prod): the origin-request branch
+ * routes to the EO origin only when CloudFront's current origin matches this domain — otherwise it
+ * marks the request as a failover. It MUST be the same value used as the EO origin's DomainName.
+ *
+ * @param {string} eoOriginDomain - the Edge Optimize origin domain baked into the routing check.
+ * @returns {string} the Lambda@Edge function source code.
+ */
+export function buildEdgeOptimizeLambdaCode(eoOriginDomain) {
+  const eoOriginDomainValue = JSON.stringify(eoOriginDomain);
+
+  return `function hasHeader(map, name) {
+  const h = map?.[name];
+  return Array.isArray(h) && h.length > 0 && (h[0].value || '').trim() !== '';
+}
+
+function setHeader(map, name, value) {
+  if (map) {
+    map[name.toLowerCase()] = [{ key: name, value: String(value) }];
+  }
+}
+
+export const handler = async (event) => {
+  const request = event?.Records?.[0]?.cf?.request;
+  const response = event?.Records?.[0]?.cf?.response;
+  const eventType = event.Records[0].cf.config.eventType;
+  const reqHeaders = request.headers || {};
+
+  if (eventType === 'origin-request') {
+    const originDomain = request.origin?.custom?.domainName;
+    const isEdgeOptimizeConfig = hasHeader(reqHeaders, 'x-edgeoptimize-config');
+    const isEdgeOptimizeRequest = hasHeader(reqHeaders, 'x-edgeoptimize-request');
+
+    if (isEdgeOptimizeConfig && !isEdgeOptimizeRequest) {
+      if (originDomain === ${eoOriginDomainValue}) {
+        console.log("Calling Edge Optimize Origin for agentic requests");
+        setHeader(request.headers, 'host', originDomain);
+      } else {
+        console.log("Calling Default Origin in case of failover for agentic requests");
+        setHeader(request.headers, 'x-edgeoptimize-request', 'fo');
+      }
+    }
+
+    return request;
+
+  } else if (eventType === 'origin-response') {
+    const resHeaders = response.headers || {};
+    const isEdgeOptimizeConfig = hasHeader(reqHeaders, 'x-edgeoptimize-config');
+    const isEdgeOptimizeRequestId = hasHeader(resHeaders, 'x-edgeoptimize-request-id');
+
+    if (isEdgeOptimizeConfig && !isEdgeOptimizeRequestId) {
+      setHeader(response.headers, 'x-edgeoptimize-fo', '1');
+      setHeader(response.headers, 'cache-control', 'no-store');
+      console.log('Failover Triggered for agentic requests');
+    }
+
+    return response;
+  }
+};
+`;
+}