@adobe/aem-cli 16.0.6 → 16.0.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [16.0.8](https://github.com/adobe/helix-cli/compare/v16.0.7...v16.0.8) (2023-11-17)
+
+
+### Bug Fixes
+
+* don't respond when headers already sent ([#2278](https://github.com/adobe/helix-cli/issues/2278)) ([6be2f00](https://github.com/adobe/helix-cli/commit/6be2f00c9bf540433eb7836af7a1b7dcfbc174b4)), closes [#2276](https://github.com/adobe/helix-cli/issues/2276)
+
+## [16.0.7](https://github.com/adobe/helix-cli/compare/v16.0.6...v16.0.7) (2023-11-16)
+
+
+### Bug Fixes
+
+* defer loading of head.html to allow inclusion of request cookie  ([1a8d2ac](https://github.com/adobe/helix-cli/commit/1a8d2ac65af58f07e2ad8911f8e9c3619f83ac7b)), closes [#2274](https://github.com/adobe/helix-cli/issues/2274)
+
 ## [16.0.6](https://github.com/adobe/helix-cli/compare/v16.0.5...v16.0.6) (2023-11-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/aem-cli",
-  "version": "16.0.6",
+  "version": "16.0.8",
   "description": "AEM CLI",
   "main": "index.js",
   "type": "module",
@@ -74,7 +74,7 @@
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.4",
+    "@adobe/eslint-config-helix": "2.0.5",
     "@adobe/helix-shared-dom": "2.0.1",
     "@adobe/helix-testutils": "0.4.15",
     "@semantic-release/changelog": "6.0.3",

package/src/server/HeadHtmlSupport.js

@@ -81,6 +81,7 @@ export default class HeadHtmlSupport {
     this.remoteStatus = 0;
     this.localHtml = '';
     this.localStatus = 0;
+    this.cookie = '';
     this.url = new URL(proxyUrl);
     this.url.pathname = '/head.html';
     this.filePath = resolve(directory, 'head.html');
@@ -89,8 +90,13 @@ export default class HeadHtmlSupport {
 
   async loadRemote() {
     // load head from server
+    const headers = {};
+    if (this.cookie) {
+      headers.cookie = this.cookie;
+    }
     const resp = await getFetch()(this.url, {
       cache: 'no-store',
+      headers,
     });
     this.remoteStatus = resp.status;
     if (resp.ok) {
@@ -103,6 +109,18 @@ export default class HeadHtmlSupport {
     }
   }
 
+  setCookie(cookie) {
+    if (this.cookie !== cookie) {
+      this.log.trace('registering head-html cookie to ', cookie);
+      this.cookie = cookie;
+      this.remoteStatus = 0;
+    }
+  }
+
+  invalidateLocal() {
+    this.localStatus = 0;
+  }
+
   async loadLocal() {
     try {
       this.localHtml = (await fs.readFile(this.filePath, 'utf-8')).trim();
@@ -114,7 +132,7 @@ export default class HeadHtmlSupport {
     }
   }
 
-  async init() {
+  async update() {
     if (!this.localStatus) {
       await this.loadLocal();
     }
@@ -127,6 +145,7 @@ export default class HeadHtmlSupport {
   }
 
   async replace(source) {
+    await this.update();
     if (!this.isModified) {
       this.log.trace('head.html ignored: not modified locally.');
       return source;

package/src/server/HelixProject.js

@@ -78,15 +78,13 @@ export class HelixProject extends BaseProject {
         log: this.log,
         proxyUrl: this.proxyUrl,
       });
-      await this._headHtml.init();
 
       // register local head in live-reload
       if (this.liveReload) {
         this.liveReload.registerFiles([this._headHtml.filePath], '/');
         this.liveReload.on('modified', async (modified) => {
           if (modified.indexOf('/') >= 0) {
-            await this._headHtml.loadLocal();
-            await this._headHtml.init();
+            this._headHtml.invalidateLocal();
           }
         });
       }

package/src/server/HelixServer.js

@@ -42,6 +42,7 @@ export class HelixServer extends BaseServer {
   async handleProxyModeRequest(req, res) {
     const sendFile = promisify(res.sendFile).bind(res);
     const ctx = new RequestContext(req, this._project);
+    const { id } = ctx;
     const { log } = this;
     const proxyUrl = new URL(this._project.proxyUrl);
 
@@ -56,10 +57,19 @@ export class HelixServer extends BaseServer {
     if (liveReload) {
       liveReload.startRequest(ctx.requestId, ctx.path);
     }
+    const pfx = log.level === 'silly' ? `[${id}] ` : '';
+
+    if (log.level === 'silly') {
+      log.trace(`${pfx}>>>--------------------------`);
+      log.trace(`${pfx}> ${req.method} ${req.url}`);
+      Object.entries(req.headers).forEach(([name, value]) => {
+        log.trace(`${pfx}> ${name}: ${value}`);
+      });
+      log.trace(`[${id}]`);
+    }
 
     // try to serve static
     try {
-      log.debug('trying to serve local file', filePath);
       await sendFile(filePath, {
         dotfiles: 'allow',
         headers: {
@@ -69,9 +79,13 @@ export class HelixServer extends BaseServer {
       if (liveReload) {
         liveReload.registerFile(ctx.requestId, filePath);
       }
+      log.debug(`${pfx}served local file ${filePath}`);
       return;
     } catch (e) {
-      log.debug(`Error while delivering resource ${ctx.path} - ${e.stack || e}`);
+      log.debug(`${pfx}unable to deliver local file ${ctx.path} - ${e.stack || e}`);
+      if (res.headersSent) {
+        return;
+      }
     } finally {
       if (liveReload) {
         liveReload.endRequest(ctx.requestId);
@@ -92,7 +106,7 @@ export class HelixServer extends BaseServer {
         file404html: this._project.file404html,
       });
     } catch (err) {
-      log.error(`Failed to proxy AEM request ${ctx.path}: ${err.message}`);
+      log.error(`${pfx}failed to proxy AEM request ${ctx.path}: ${err.message}`);
       res.status(502).send(`Failed to proxy AEM request: ${err.message}`);
     }
 

package/src/server/RequestContext.js

@@ -12,6 +12,8 @@
 import { parse } from 'url';
 import utils from './utils.js';
 
+let id = 0;
+
 /**
  * Context that is used during request handling.
  *
@@ -26,6 +28,8 @@ export default class RequestContext {
     const { url } = req;
     this._cfg = cfg || {};
     this._url = url;
+    // eslint-disable-next-line no-plusplus
+    this._id = id++;
     const purl = parse(url);
     this._path = purl.pathname || '/';
     this._queryString = purl.search || '';
@@ -74,6 +78,14 @@ export default class RequestContext {
     this._resourcePath = relPath;
   }
 
+  /**
+   * returns the request id / counter
+   * @return {*|number}
+   */
+  get id() {
+    return this._id;
+  }
+
   /**
    * the original request url
    */

package/src/server/utils.js

@@ -215,7 +215,8 @@ window.LiveReloadOptions = {
    * @return {Promise} A promise that resolves when the stream is done.
    */
   async proxyRequest(ctx, url, req, res, opts = {}) {
-    ctx.log.debug(`Proxy ${req.method} request to ${url}`);
+    const { id } = ctx;
+    ctx.log.debug(`[${id}] Proxy ${req.method} request to ${url}`);
 
     if (opts.cacheDirectory) {
       const cached = await utils.getFromCache(url, opts.cacheDirectory, ctx.log);
@@ -263,7 +264,7 @@ window.LiveReloadOptions = {
     });
     const contentType = ret.headers.get('content-type') || 'text/plain';
     const level = utils.status2level(ret.status, true);
-    ctx.log[level](`Proxy ${req.method} request to ${url}: ${ret.status} (${contentType})`);
+    ctx.log[level](`[${id}] Proxy ${req.method} request to ${url}: ${ret.status} (${contentType})`);
 
     // because fetch decodes the response, we need to reset content encoding and length
     const respHeaders = Object.fromEntries(ret.headers.entries());
@@ -271,11 +272,12 @@ window.LiveReloadOptions = {
     delete respHeaders['content-length'];
     delete respHeaders['x-frame-options'];
     delete respHeaders['content-security-policy'];
+    delete respHeaders.connection;
     respHeaders['access-control-allow-origin'] = '*';
     respHeaders.via = `${ret.httpVersion ?? '1.0'} ${new URL(url).hostname}`;
 
     if (ret.status === 404 && contentType.indexOf('text/html') === 0 && opts.file404html) {
-      ctx.log.debug('serve local 404.html', opts.file404html);
+      ctx.log.debug(`[${id}] serve local 404.html ${opts.file404html}`);
       let textBody = await fs.readFile(opts.file404html, 'utf-8');
       if (opts.injectLiveReload) {
         textBody = utils.injectLiveReloadScript(textBody, ctx.config.server);
@@ -289,39 +291,25 @@ window.LiveReloadOptions = {
 
     const isHTML = ret.status === 200 && contentType.indexOf('text/html') === 0;
     const livereload = isHTML && opts.injectLiveReload;
-    const replaceHead = isHTML && opts.headHtml && opts.headHtml.isModified;
+    const replaceHead = isHTML && opts.headHtml;
     const doIndex = isHTML && opts.indexer && url.indexOf('.plain.html') < 0;
 
+    if (ctx.log.level === 'silly') {
+      ctx.log.trace(`[${id}] -----------------------------`);
+      ctx.log.trace(`[${id}] < http/${ret.httpVersion} ${ret.status} ${ret.statusText}`);
+      Object.entries(ret.headers.raw()).forEach(([name, value]) => {
+        ctx.log.trace(`[${id}] < ${name}: ${value}`);
+      });
+    }
+
     if (isHTML) {
-      let respBody;
-      let textBody;
-      if (contentType.startsWith('text/')) {
-        textBody = await ret.text();
-      } else {
-        respBody = await ret.buffer();
-      }
-      const lines = ['----------------------------->'];
+      let textBody = await ret.text();
       if (ctx.log.level === 'silly') {
-        lines.push(`${req.method} ${url}`);
-        Object.entries(headers).forEach(([name, value]) => {
-          lines.push(`${name}: ${value}`);
-        });
-        lines.push('');
-        lines.push('<-----------------------------');
-        lines.push('');
-        lines.push(`http/${ret.httpVersion} ${ret.status} ${ret.statusText}`);
-        ret.headers.forEach((name, value) => {
-          lines.push(`${name}: ${value}`);
-        });
-        lines.push('');
-        if (respBody) {
-          lines.push(`<binary ${respBody.length} bytes>`);
-        } else {
-          lines.push(textBody);
-        }
-        ctx.log.trace(lines.join('\n'));
+        ctx.log.trace(textBody);
+        ctx.log.trace(`[${id}] <<<--------------------------`);
       }
       if (replaceHead) {
+        await opts.headHtml.setCookie(req.headers.cookie);
         textBody = await opts.headHtml.replace(textBody);
       }
       if (livereload) {
@@ -343,7 +331,7 @@ window.LiveReloadOptions = {
           url,
           opts.cacheDirectory,
           {
-            body: respBody || textBody,
+            body: textBody,
             headers: respHeaders,
             status: ret.status,
           },
@@ -352,12 +340,16 @@ window.LiveReloadOptions = {
       }
 
       res
-        .status(ret.status)
         .set(respHeaders)
-        .send(respBody || textBody);
+        .status(ret.status)
+        .send(textBody);
       return;
     }
 
+    if (ctx.log.level === 'silly') {
+      ctx.log.trace(`[${id}] <<<--------------------------`);
+    }
+
     if (opts.cacheDirectory) {
       const buffer = await ret.buffer();
       await utils.writeToCache(

package/src/up.cmd.js

@@ -119,7 +119,9 @@ export default class UpCommand extends AbstractServerCommand {
     const resp = await getFetch()(fstabUrl);
     await resp.buffer();
     if (!resp.ok) {
-      if (ref === 'main') {
+      if (resp.status === 401) {
+        this.log.warn(chalk`Unable to verify {yellow ${ref}} branch via {blue ${fstabUrl}} for authenticated sites.`);
+      } else if (ref === 'main') {
         this.log.warn(chalk`Unable to verify {yellow main} branch via {blue ${fstabUrl}} (${resp.status}). Maybe not pushed yet?`);
       } else {
         this.log.warn(chalk`Unable to verify {yellow ${ref}} branch on {blue ${fstabUrl}} (${resp.status}). Fallback to {yellow main} branch.`);