fix: STRF-13624 Fix intermintment failing for webdav content (#1324)

Author: jairo-bc

lib/utils/asyncUtils.js

@@ -1,6 +1,9 @@
 /**
- * @module Contains helpers functions for working with async stuff and streams
+ * @module Contains helpers functions for working with streams
  */
+
+import { PassThrough } from 'stream';
+
 /**
  * WARNING! Can be used with text content only. Binary data (e.g. images) will get broken!
  *
@@ -14,7 +17,38 @@ async function readFromStream(stream) {
     }
     return result;
 }
-export { readFromStream };
+
+function readStream(stream) {
+    return new Promise((resolve, reject) => {
+        let data = '';
+        stream.on('data', (chunk) => {
+            data += chunk;
+        });
+        stream.on('end', () => {
+            resolve(data);
+        });
+        stream.on('error', reject);
+    });
+}
+
+function tapStream(originalStream, onData) {
+    const tee = new PassThrough();
+    originalStream.pipe(tee);
+
+    let data = '';
+    tee.on('data', (chunk) => {
+        data += chunk;
+    });
+    tee.on('end', () => {
+        onData(data);
+    });
+
+    return tee; // Use this stream for downstream consumers
+}
+
+export { readFromStream, tapStream, readStream };
 export default {
     readFromStream,
+    tapStream,
+    readStream,
 };

lib/utils/asyncUtils.spec.js

@@ -0,0 +1,28 @@
+import { Readable } from 'stream';
+import { readStream, tapStream } from './asyncUtils';
+
+describe('readStream', () => {
+    it('should read all data from a stream and resolve with the result', async () => {
+        const readable = Readable.from(['hello', ' ', 'world']);
+        const result = await readStream(readable);
+        expect(result).toBe('hello world');
+    });
+});
+
+describe('tapStream', () => {
+    it('should tap into a stream and call onData with the full data', () => {
+        const readable = Readable.from(['foo', 'bar']);
+        return new Promise((resolve, reject) => {
+            const tapped = tapStream(readable, (data) => {
+                try {
+                    expect(data).toBe('foobar');
+                    resolve();
+                } catch (err) {
+                    reject(err);
+                }
+            });
+            // Consume the tapped stream to trigger data flow
+            tapped.resume();
+        });
+    });
+});

server/plugins/renderer/renderer.module.js

@@ -9,7 +9,7 @@ import langAssembler from '../../../lib/lang-assembler.js';
 import { RawResponse, RedirectResponse, PencilResponse } from './responses/index.js';
 import templateAssembler from '../../../lib/template-assembler.js';
 import { int2uuid, stripDomainFromCookies, normalizeRedirectUrl } from '../../lib/utils.js';
-import { readFromStream } from '../../../lib/utils/asyncUtils.js';
+import { readFromStream, readStream, tapStream } from '../../../lib/utils/asyncUtils.js';
 import NetworkUtils from '../../../lib/utils/NetworkUtils.js';
 import contentApiClient from '../../../lib/content-api-client.js';
 import { getPageType } from '../../lib/page-type-util.js';
@@ -114,9 +114,17 @@ internals.getResponse = async (request) => {
     // (5xx will be just thrown by axios)
     const contentType = response.headers['content-type'] || '';
     const isResponseJson = contentType.toLowerCase().includes('application/json');
-    const bcAppData = isResponseJson
-        ? JSON.parse(await readFromStream(response.data))
-        : response.data;
+    const isWebDavRequest = request.path.startsWith('/content');
+    let bcAppData = response.data;
+
+    if (isResponseJson) {
+        bcAppData = JSON.parse(await readFromStream(response.data));
+    } else if (isWebDavRequest) {
+        const tappedStream = tapStream(response.data, (body) => {
+            return body;
+        });
+        bcAppData = await readStream(tappedStream);
+    }
     // cache response
     cache.put(
         requestSignature,

server/plugins/renderer/renderer.module.spec.js

@@ -3,6 +3,7 @@ import MockAdapter from 'axios-mock-adapter';
 import path from 'path';
 import fs from 'fs';
 import { jest } from '@jest/globals';
+import { PassThrough } from 'stream';
 import Server from '../../index.js';
 import ThemeConfig from '../../../lib/theme-config.js';
 import { readFromStream } from '../../../lib/utils/asyncUtils.js';
@@ -242,7 +243,7 @@ describe('Renderer Plugin', () => {
     describe('when the storefront server response is Success and content-type is "image"', () => {
         const browserRequest = {
             method: 'get',
-            url: '/content/cat_and_dog.jpeg',
+            url: '/images/cat_and_dog.jpeg',
         };
         const testImage = fs.readFileSync('./test/assets/cat_and_dog.jpeg');
         const storefrontResponseHeaders = {
@@ -275,4 +276,21 @@ describe('Renderer Plugin', () => {
             expect(localServerResponse.rawPayload).toEqual(testImage);
         });
     });
+
+    describe('WebDav /content requests', () => {
+        it('should return plain text response for /content path', async () => {
+            const browserRequest = {
+                method: 'GET',
+                url: '/content/test.txt',
+            };
+            const testString = 'webdav test content';
+            // Simulate a stream response for /content path
+            const stream = new PassThrough();
+            stream.end(testString);
+            axiosMock.onGet().reply(200, stream, { 'content-type': 'text/plain' });
+            const localServerResponse = await server.inject(browserRequest);
+            expect(localServerResponse.statusCode).toEqual(200);
+            expect(localServerResponse.payload).toEqual(testString);
+        });
+    });
 });