@adobe/spacecat-shared-tokowaka-client 1.4.1 → 1.4.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.4.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.4.1...@adobe/spacecat-shared-tokowaka-client-v1.4.2) (2025-12-12)
+
+
+### Bug Fixes
+
+* use preview key instead of site api key in Edge Preview API ([#1228](https://github.com/adobe/spacecat-shared/issues/1228)) ([8e0c1a9](https://github.com/adobe/spacecat-shared/commit/8e0c1a9c228a740de66c29bf2480042d29aa88a6))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.4.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.4.0...@adobe/spacecat-shared-tokowaka-client-v1.4.1) (2025-12-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {

package/src/index.js

@@ -700,11 +700,11 @@ class TokowakaClient {
    */
   async previewSuggestions(site, opportunity, suggestions, options = {}) {
     // Get site's forwarded host for preview
-    const { forwardedHost, apiKey } = site.getConfig()?.getTokowakaConfig() || {};
+    const { forwardedHost } = site.getConfig()?.getTokowakaConfig() || {};
 
-    if (!hasText(forwardedHost) || !hasText(apiKey)) {
+    if (!hasText(forwardedHost)) {
       throw this.#createError(
-        'Site does not have a Tokowaka API key or forwarded host configured. '
+        'Site does not have a Tokowaka forwarded host configured. '
         + 'Please onboard the site to Tokowaka first.',
         HTTP_BAD_REQUEST,
       );
@@ -720,6 +720,15 @@ class TokowakaClient {
       );
     }
 
+    // TOKOWAKA_PREVIEW_API_KEY is mandatory for preview
+    const tokowakaPreviewApiKey = this.env.TOKOWAKA_PREVIEW_API_KEY;
+    if (!hasText(tokowakaPreviewApiKey)) {
+      throw this.#createError(
+        'TOKOWAKA_PREVIEW_API_KEY is required for preview functionality',
+        HTTP_INTERNAL_SERVER_ERROR,
+      );
+    }
+
     // TOKOWAKA_EDGE_URL is mandatory for preview
     const tokowakaEdgeUrl = this.env.TOKOWAKA_EDGE_URL;
     if (!hasText(tokowakaEdgeUrl)) {
@@ -817,7 +826,7 @@ class TokowakaClient {
       // Fetch original HTML (without preview)
       originalHtml = await fetchHtmlWithWarmup(
         previewUrl,
-        apiKey,
+        tokowakaPreviewApiKey,
         forwardedHost,
         tokowakaEdgeUrl,
         this.log,
@@ -827,7 +836,7 @@ class TokowakaClient {
       // Then fetch optimized HTML (with preview)
       optimizedHtml = await fetchHtmlWithWarmup(
         previewUrl,
-        apiKey,
+        tokowakaPreviewApiKey,
         forwardedHost,
         tokowakaEdgeUrl,
         this.log,

package/src/utils/custom-html-utils.js

@@ -89,7 +89,7 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
  * Fetches HTML content from Tokowaka edge with warmup call and retry logic
  * Makes an initial warmup call, waits, then makes the actual call with retries
  * @param {string} url - Full URL to fetch
- * @param {string} apiKey - Tokowaka API key
+ * @param {string} previewApiKey - Tokowaka preview API key (internal)
  * @param {string} forwardedHost - Host to forward in x-forwarded-host header
  * @param {string} tokowakaEdgeUrl - Tokowaka edge URL
  * @param {boolean} isOptimized - Whether to fetch optimized HTML (with preview param)
@@ -103,7 +103,7 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
  */
 export async function fetchHtmlWithWarmup(
   url,
-  apiKey,
+  previewApiKey,
   forwardedHost,
   tokowakaEdgeUrl,
   log,
@@ -115,8 +115,8 @@ export async function fetchHtmlWithWarmup(
     throw new Error('URL is required for fetching HTML');
   }
 
-  if (!hasText(apiKey)) {
-    throw new Error('Tokowaka API key is required for fetching HTML');
+  if (!hasText(previewApiKey)) {
+    throw new Error('Tokowaka preview API key is required for fetching HTML');
   }
 
   if (!hasText(forwardedHost)) {
@@ -143,7 +143,7 @@ export async function fetchHtmlWithWarmup(
 
   const headers = {
     'x-forwarded-host': forwardedHost,
-    'x-tokowaka-api-key': apiKey,
+    'x-tokowaka-preview-api-key': previewApiKey,
     'x-tokowaka-url': urlPath,
   };
 

package/test/index.test.js

@@ -64,8 +64,7 @@ describe('TokowakaClient', () => {
       getBaseURL: () => 'https://example.com',
       getConfig: () => ({
         getTokowakaConfig: () => ({
-          forwardedHost: 'example.com',
-          apiKey: 'test-api-key',
+          forwardedHost: 'www.example.com',
         }),
       }),
     };
@@ -1698,14 +1697,16 @@ describe('TokowakaClient', () => {
       // Stub fetchConfig to return null by default (no existing config)
       sinon.stub(client, 'fetchConfig').resolves(null);
 
-      // Add TOKOWAKA_EDGE_URL to env
+      // Add TOKOWAKA_EDGE_URL and TOKOWAKA_PREVIEW_API_KEY to env
       client.env.TOKOWAKA_EDGE_URL = 'https://edge-dev.tokowaka.now';
+      client.env.TOKOWAKA_PREVIEW_API_KEY = 'internal-preview-key-123';
     });
 
     afterEach(() => {
       // fetchStub will be restored by global afterEach sinon.restore()
       // Just clean up env changes
       delete client.env.TOKOWAKA_EDGE_URL;
+      delete client.env.TOKOWAKA_PREVIEW_API_KEY;
     });
 
     it('should preview suggestions successfully with HTML', async () => {
@@ -1734,6 +1735,18 @@ describe('TokowakaClient', () => {
       expect(s3Client.send).to.have.been.calledOnce;
     });
 
+    it('should throw error if TOKOWAKA_PREVIEW_API_KEY is not configured', async () => {
+      delete client.env.TOKOWAKA_PREVIEW_API_KEY;
+
+      try {
+        await client.previewSuggestions(mockSite, mockOpportunity, mockSuggestions);
+        expect.fail('Should have thrown error');
+      } catch (error) {
+        expect(error.message).to.include('TOKOWAKA_PREVIEW_API_KEY is required for preview');
+        expect(error.status).to.equal(500);
+      }
+    });
+
     it('should preview prerender-only suggestions with no patches', async () => {
       // Update fetchConfig to return existing config with deployed patches
       client.fetchConfig.resolves({
@@ -1813,7 +1826,7 @@ describe('TokowakaClient', () => {
         await client.previewSuggestions(mockSite, mockOpportunity, mockSuggestions);
         expect.fail('Should have thrown error');
       } catch (error) {
-        expect(error.message).to.include('Site does not have a Tokowaka API key or forwarded host configured');
+        expect(error.message).to.include('Site does not have a Tokowaka forwarded host configured');
         expect(error.status).to.equal(400);
       }
     });
@@ -1827,7 +1840,7 @@ describe('TokowakaClient', () => {
         await client.previewSuggestions(mockSite, mockOpportunity, mockSuggestions);
         expect.fail('Should have thrown error');
       } catch (error) {
-        expect(error.message).to.include('Site does not have a Tokowaka API key or forwarded host configured');
+        expect(error.message).to.include('Site does not have a Tokowaka forwarded host configured');
         expect(error.status).to.equal(400);
       }
     });

package/test/utils/html-utils.test.js

@@ -54,7 +54,7 @@ describe('HTML Utils', () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
-          'api-key',
+          'preview-api-key',
           '',
           'edge-url',
           log,
@@ -70,7 +70,7 @@ describe('HTML Utils', () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
-          'api-key',
+          'preview-api-key',
           'host',
           '',
           log,
@@ -82,7 +82,7 @@ describe('HTML Utils', () => {
       }
     });
 
-    it('should throw error when apiKey is missing', async () => {
+    it('should throw error when preview API key is missing', async () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
@@ -94,7 +94,7 @@ describe('HTML Utils', () => {
         );
         expect.fail('Should have thrown error');
       } catch (error) {
-        expect(error.message).to.equal('Tokowaka API key is required for fetching HTML');
+        expect(error.message).to.equal('Tokowaka preview API key is required for fetching HTML');
       }
     });
 
@@ -111,7 +111,7 @@ describe('HTML Utils', () => {
 
       const html = await fetchHtmlWithWarmup(
         'https://example.com/page',
-        'api-key',
+        'preview-api-key',
         'host',
         'https://edge.example.com',
         log,
@@ -136,7 +136,7 @@ describe('HTML Utils', () => {
 
       const html = await fetchHtmlWithWarmup(
         'https://example.com/page?param=value',
-        'api-key',
+        'preview-api-key',
         'host',
         'https://edge.example.com',
         log,
@@ -178,7 +178,7 @@ describe('HTML Utils', () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
-          'api-key',
+          'preview-api-key',
           'host',
           'https://edge.example.com',
           log,
@@ -208,7 +208,7 @@ describe('HTML Utils', () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
-          'api-key',
+          'preview-api-key',
           'host',
           'https://edge.example.com',
           log,
@@ -239,7 +239,7 @@ describe('HTML Utils', () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
-          'api-key',
+          'preview-api-key',
           'host',
           'https://edge.example.com',
           log,
@@ -319,7 +319,7 @@ describe('HTML Utils', () => {
 
       const html = await fetchHtmlWithWarmup(
         'https://example.com/page',
-        'api-key',
+        'preview-api-key',
         'host',
         'https://edge.example.com',
         log,
@@ -375,7 +375,7 @@ describe('HTML Utils', () => {
       try {
         await fetchHtmlWithWarmup(
           'https://example.com/page',
-          'api-key',
+          'preview-api-key',
           'host',
           'https://edge.example.com',
           log,
@@ -416,7 +416,7 @@ describe('HTML Utils', () => {
 
       const html = await fetchHtmlWithWarmup(
         'https://example.com/page',
-        'api-key',
+        'preview-api-key',
         'host',
         'https://edge.example.com',
         log,