@adobe/spacecat-shared-tokowaka-client 1.7.6 → 1.7.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.7.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.7.7...@adobe/spacecat-shared-tokowaka-client-v1.7.8) (2026-02-16)
+
+
+### Bug Fixes
+
+* timeout added for edge optimize status ([#1329](https://github.com/adobe/spacecat-shared/issues/1329)) ([93ef065](https://github.com/adobe/spacecat-shared/commit/93ef0653840929e9c76b14d370dbfa6db03cb97e))
+
+# [@adobe/spacecat-shared-tokowaka-client-v1.7.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.7.6...@adobe/spacecat-shared-tokowaka-client-v1.7.7) (2026-02-12)
+
+
+### Bug Fixes
+
+* export forwarded host compute method ([#1338](https://github.com/adobe/spacecat-shared/issues/1338)) ([91e5f5f](https://github.com/adobe/spacecat-shared/commit/91e5f5fb2b5a7d592886caea940a6313fe1c1c8c))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.7.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.7.5...@adobe/spacecat-shared-tokowaka-client-v1.7.6) (2026-02-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.7.6",
+  "version": "1.7.8",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {
@@ -46,6 +46,7 @@
     "c8": "^10.1.3",
     "chai": "^6.0.1",
     "eslint": "^9.36.0",
+    "esmock": "^2.7.3",
     "mocha": "^11.7.2",
     "nock": "^14.0.10",
     "sinon": "^21.0.0",

package/src/index.d.ts

@@ -147,6 +147,14 @@ export class FastlyKVClient {
   }): Promise<FastlyKVEntry[]>;
 }
 
+/**
+ * Compute the forwarded host for edge optimize (bare domain → www; subdomains unchanged).
+ * @param url - Full base URL (e.g. https://example.com)
+ * @param logger - Optional logger with debug and error methods
+ * @returns Host to use (e.g. www.example.com)
+ */
+export function calculateForwardedHost(url: string, logger?: { debug?: (msg: string) => void; error?: (msg: string) => void }): string;
+
 /**
  * Base class for opportunity mappers
  * Extend this class to create custom mappers for new opportunity types

package/src/index.js

@@ -12,7 +12,7 @@
 
 import crypto from 'crypto';
 import { GetObjectCommand, PutObjectCommand } from '@aws-sdk/client-s3';
-import { hasText, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { hasText, isNonEmptyObject, tracingFetch } from '@adobe/spacecat-shared-utils';
 import { v4 as uuidv4 } from 'uuid';
 import MapperRegistry from './mappers/mapper-registry.js';
 import CdnClientRegistry from './cdn/cdn-client-registry.js';
@@ -28,6 +28,7 @@ import { getEffectiveBaseURL } from './utils/site-utils.js';
 import { fetchHtmlWithWarmup, calculateForwardedHost } from './utils/custom-html-utils.js';
 
 export { FastlyKVClient } from './fastly-kv-client.js';
+export { calculateForwardedHost } from './utils/custom-html-utils.js';
 
 const HTTP_BAD_REQUEST = 400;
 const HTTP_INTERNAL_SERVER_ERROR = 500;
@@ -1071,17 +1072,20 @@ class TokowakaClient {
     const maxRetries = 3;
     let attempt = 0;
 
+    const REQUEST_TIMEOUT_MS = 5000;
+
     while (attempt <= maxRetries) {
       try {
         this.log.debug(`Attempt ${attempt + 1}/${maxRetries + 1}: Checking edge optimize status for ${targetUrl}`);
 
         // eslint-disable-next-line no-await-in-loop
-        const response = await fetch(targetUrl, {
+        const response = await tracingFetch(targetUrl, {
           method: 'GET',
           headers: {
             'User-Agent': 'Tokowaka-AI Tokowaka/1.0 AdobeEdgeOptimize-AI AdobeEdgeOptimize/1.0',
             'fastly-debug': '1',
           },
+          timeout: REQUEST_TIMEOUT_MS,
         });
 
         this.log.debug(`Response status: ${response.status}`);
@@ -1095,6 +1099,13 @@ class TokowakaClient {
           edgeOptimizeEnabled,
         };
       } catch (error) {
+        const isTimeout = error?.code === 'ETIMEOUT';
+
+        if (isTimeout) {
+          this.log.warn(`Request timed out after ${REQUEST_TIMEOUT_MS}ms for ${targetUrl}, returning edgeOptimizeEnabled: false`);
+          return { edgeOptimizeEnabled: false };
+        }
+
         attempt += 1;
 
         if (attempt > maxRetries) {

package/test/index.test.js

@@ -15,6 +15,7 @@
 import { expect, use } from 'chai';
 import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
+import esmock from 'esmock';
 import TokowakaClient from '../src/index.js';
 
 use(sinonChai);
@@ -3610,20 +3611,45 @@ describe('TokowakaClient', () => {
   });
 
   describe('checkEdgeOptimizeStatus', () => {
-    let fetchStub;
+    let tracingFetchStub;
+    let esmockClient;
 
-    beforeEach(() => {
-      fetchStub = sinon.stub(global, 'fetch');
-    });
+    beforeEach(async () => {
+      tracingFetchStub = sinon.stub();
 
-    afterEach(() => {
-      fetchStub.restore();
+      const MockedTokowakaClient = await esmock('../src/index.js', {
+        '@adobe/spacecat-shared-utils': {
+          hasText: (val) => typeof val === 'string' && val.trim().length > 0,
+          isNonEmptyObject: (val) => val !== null && typeof val === 'object' && Object.keys(val).length > 0,
+          tracingFetch: tracingFetchStub,
+        },
+      });
+
+      const env = {
+        TOKOWAKA_CDN_PROVIDER: 'cloudfront',
+        TOKOWAKA_CDN_CONFIG: JSON.stringify({
+          cloudfront: {
+            distributionId: 'E123456',
+            region: 'us-east-1',
+          },
+        }),
+      };
+
+      esmockClient = new MockedTokowakaClient(
+        {
+          bucketName: 'test-bucket',
+          previewBucketName: 'test-preview-bucket',
+          s3Client: { send: sinon.stub().resolves() },
+          env,
+        },
+        log,
+      );
     });
 
     describe('Input Validation', () => {
       it('should throw error when site is not provided', async () => {
         try {
-          await client.checkEdgeOptimizeStatus(null, '/');
+          await esmockClient.checkEdgeOptimizeStatus(null, '/');
           expect.fail('Should have thrown error');
         } catch (error) {
           expect(error.message).to.include('Site is required');
@@ -3633,7 +3659,7 @@ describe('TokowakaClient', () => {
 
       it('should throw error when site is empty object', async () => {
         try {
-          await client.checkEdgeOptimizeStatus({}, '/');
+          await esmockClient.checkEdgeOptimizeStatus({}, '/');
           expect.fail('Should have thrown error');
         } catch (error) {
           expect(error.message).to.include('Site is required');
@@ -3649,7 +3675,7 @@ describe('TokowakaClient', () => {
         };
 
         try {
-          await client.checkEdgeOptimizeStatus(site, '');
+          await esmockClient.checkEdgeOptimizeStatus(site, '');
           expect.fail('Should have thrown error');
         } catch (error) {
           expect(error.message).to.include('Path is required');
@@ -3666,7 +3692,7 @@ describe('TokowakaClient', () => {
         };
 
         try {
-          await client.checkEdgeOptimizeStatus(site, null);
+          await esmockClient.checkEdgeOptimizeStatus(site, null);
           expect.fail('Should have thrown error');
         } catch (error) {
           expect(error.message).to.include('Path is required');
@@ -3697,15 +3723,15 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        const result = await client.checkEdgeOptimizeStatus(site, '/');
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/');
 
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: true,
         });
-        expect(fetchStub).to.have.been.calledOnce;
-        expect(fetchStub.firstCall.args[0]).to.equal('https://example.com/');
+        expect(tracingFetchStub).to.have.been.calledOnce;
+        expect(tracingFetchStub.firstCall.args[0]).to.equal('https://example.com/');
       });
 
       it('should return edgeOptimizeEnabled: true when x-edgeoptimize-request-id header is present', async () => {
@@ -3719,14 +3745,14 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        const result = await client.checkEdgeOptimizeStatus(site, '/products');
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/products');
 
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: true,
         });
-        expect(fetchStub.firstCall.args[0]).to.equal('https://example.com/products');
+        expect(tracingFetchStub.firstCall.args[0]).to.equal('https://example.com/products');
       });
 
       it('should return edgeOptimizeEnabled: false when headers are not present', async () => {
@@ -3736,9 +3762,9 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        const result = await client.checkEdgeOptimizeStatus(site, '/');
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/');
 
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: false,
@@ -3756,9 +3782,9 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        const result = await client.checkEdgeOptimizeStatus(site, '/not-found');
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/not-found');
 
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: true,
@@ -3772,13 +3798,28 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        await client.checkEdgeOptimizeStatus(site, '/');
+        await esmockClient.checkEdgeOptimizeStatus(site, '/');
 
-        const fetchOptions = fetchStub.firstCall.args[1];
+        const fetchOptions = tracingFetchStub.firstCall.args[1];
         expect(fetchOptions.headers['User-Agent']).to.equal('Tokowaka-AI Tokowaka/1.0 AdobeEdgeOptimize-AI AdobeEdgeOptimize/1.0');
       });
+
+      it('should pass timeout option to tracingFetch', async () => {
+        const mockResponse = {
+          status: 200,
+          headers: new Map(),
+        };
+        mockResponse.headers.get = () => null;
+
+        tracingFetchStub.resolves(mockResponse);
+
+        await esmockClient.checkEdgeOptimizeStatus(site, '/');
+
+        const fetchOptions = tracingFetchStub.firstCall.args[1];
+        expect(fetchOptions.timeout).to.equal(5000);
+      });
     });
 
     describe('Retry Logic', () => {
@@ -3801,9 +3842,9 @@ describe('TokowakaClient', () => {
 
       it('should retry 3 times on network error with exponential backoff', async () => {
         const networkError = new Error('Network timeout');
-        fetchStub.rejects(networkError);
+        tracingFetchStub.rejects(networkError);
 
-        const promise = client.checkEdgeOptimizeStatus(site, '/');
+        const promise = esmockClient.checkEdgeOptimizeStatus(site, '/');
 
         // Wait for first attempt
         await clock.tickAsync(0);
@@ -3824,7 +3865,7 @@ describe('TokowakaClient', () => {
           expect(error.message).to.include('Failed to check edge optimize status');
           expect(error.message).to.include('Network timeout');
           expect(error.status).to.equal(500);
-          expect(fetchStub.callCount).to.equal(4); // Initial + 3 retries
+          expect(tracingFetchStub.callCount).to.equal(4); // Initial + 3 retries
         }
       });
 
@@ -3839,10 +3880,10 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.onFirstCall().rejects(new Error('Temporary failure'));
-        fetchStub.onSecondCall().resolves(mockResponse);
+        tracingFetchStub.onFirstCall().rejects(new Error('Temporary failure'));
+        tracingFetchStub.onSecondCall().resolves(mockResponse);
 
-        const promise = client.checkEdgeOptimizeStatus(site, '/');
+        const promise = esmockClient.checkEdgeOptimizeStatus(site, '/');
 
         await clock.tickAsync(200);
 
@@ -3851,7 +3892,7 @@ describe('TokowakaClient', () => {
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: true,
         });
-        expect(fetchStub).to.have.been.calledTwice;
+        expect(tracingFetchStub).to.have.been.calledTwice;
       });
 
       it('should succeed on third attempt after two failures', async () => {
@@ -3865,11 +3906,11 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.onFirstCall().rejects(new Error('Failure 1'));
-        fetchStub.onSecondCall().rejects(new Error('Failure 2'));
-        fetchStub.onThirdCall().resolves(mockResponse);
+        tracingFetchStub.onFirstCall().rejects(new Error('Failure 1'));
+        tracingFetchStub.onSecondCall().rejects(new Error('Failure 2'));
+        tracingFetchStub.onThirdCall().resolves(mockResponse);
 
-        const promise = client.checkEdgeOptimizeStatus(site, '/');
+        const promise = esmockClient.checkEdgeOptimizeStatus(site, '/');
 
         await clock.tickAsync(200); // First retry delay
         await clock.tickAsync(400); // Second retry delay
@@ -3879,7 +3920,7 @@ describe('TokowakaClient', () => {
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: true,
         });
-        expect(fetchStub.callCount).to.equal(3);
+        expect(tracingFetchStub.callCount).to.equal(3);
       });
 
       it('should log warnings on retries', async () => {
@@ -3890,10 +3931,10 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.onFirstCall().rejects(networkError);
-        fetchStub.onSecondCall().resolves(mockResponse);
+        tracingFetchStub.onFirstCall().rejects(networkError);
+        tracingFetchStub.onSecondCall().resolves(mockResponse);
 
-        const promise = client.checkEdgeOptimizeStatus(site, '/');
+        const promise = esmockClient.checkEdgeOptimizeStatus(site, '/');
         await clock.tickAsync(200);
         await promise;
 
@@ -3901,6 +3942,20 @@ describe('TokowakaClient', () => {
           sinon.match(/Attempt 1 to fetch failed.*Connection refused.*Retrying in 200ms/),
         );
       });
+
+      it('should return edgeOptimizeEnabled: false on request timeout (ETIMEOUT) without retrying', async () => {
+        const timeoutError = new Error('Request timeout after 5000ms');
+        timeoutError.code = 'ETIMEOUT';
+        tracingFetchStub.rejects(timeoutError);
+
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/');
+
+        expect(result).to.deep.equal({ edgeOptimizeEnabled: false });
+        expect(tracingFetchStub).to.have.been.calledOnce;
+        expect(log.warn).to.have.been.calledWith(
+          sinon.match(/Request timed out after 5000ms for https:\/\/example.com\/, returning edgeOptimizeEnabled: false/),
+        );
+      });
     });
 
     describe('URL Construction', () => {
@@ -3922,11 +3977,11 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        await client.checkEdgeOptimizeStatus(site, '/products/chairs');
+        await esmockClient.checkEdgeOptimizeStatus(site, '/products/chairs');
 
-        expect(fetchStub.firstCall.args[0]).to.equal('https://example.com/products/chairs');
+        expect(tracingFetchStub.firstCall.args[0]).to.equal('https://example.com/products/chairs');
       });
 
       it('should construct URL correctly with multi-level path', async () => {
@@ -3936,11 +3991,11 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        await client.checkEdgeOptimizeStatus(site, '/a/b/c/d');
+        await esmockClient.checkEdgeOptimizeStatus(site, '/a/b/c/d');
 
-        expect(fetchStub.firstCall.args[0]).to.equal('https://example.com/a/b/c/d');
+        expect(tracingFetchStub.firstCall.args[0]).to.equal('https://example.com/a/b/c/d');
       });
 
       it('should handle baseURL with trailing slash', async () => {
@@ -3957,11 +4012,11 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        await client.checkEdgeOptimizeStatus(site, '/about');
+        await esmockClient.checkEdgeOptimizeStatus(site, '/about');
 
-        expect(fetchStub.firstCall.args[0]).to.equal('https://example.com/about');
+        expect(tracingFetchStub.firstCall.args[0]).to.equal('https://example.com/about');
       });
 
       it('should handle baseURL without trailing slash', async () => {
@@ -3978,11 +4033,11 @@ describe('TokowakaClient', () => {
         };
         mockResponse.headers.get = () => null;
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        await client.checkEdgeOptimizeStatus(site, '/about');
+        await esmockClient.checkEdgeOptimizeStatus(site, '/about');
 
-        expect(fetchStub.firstCall.args[0]).to.equal('https://example.com/about');
+        expect(tracingFetchStub.firstCall.args[0]).to.equal('https://example.com/about');
       });
     });
 
@@ -4010,9 +4065,9 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        const result = await client.checkEdgeOptimizeStatus(site, '/');
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/');
 
         expect(result.edgeOptimizeEnabled).to.be.true;
       });
@@ -4028,9 +4083,9 @@ describe('TokowakaClient', () => {
           },
         };
 
-        fetchStub.resolves(mockResponse);
+        tracingFetchStub.resolves(mockResponse);
 
-        const result = await client.checkEdgeOptimizeStatus(site, '/error');
+        const result = await esmockClient.checkEdgeOptimizeStatus(site, '/error');
 
         expect(result).to.deep.equal({
           edgeOptimizeEnabled: true,