@adobe/aem-cli 16.7.10 → 16.7.11

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [16.7.11](https://github.com/adobe/helix-cli/compare/v16.7.10...v16.7.11) (2024-10-05)
+
+
+### Bug Fixes
+
+* **deps:** update dependency cookie to v0.7.1 ([4f10a00](https://github.com/adobe/helix-cli/commit/4f10a00143df39df69dfa2f4dd2fe6d692718de2))
+
 ## [16.7.10](https://github.com/adobe/helix-cli/compare/v16.7.9...v16.7.10) (2024-09-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/aem-cli",
-  "version": "16.7.10",
+  "version": "16.7.11",
   "description": "AEM CLI",
   "main": "index.js",
   "type": "module",
@@ -42,12 +42,12 @@
     "@adobe/helix-log": "6.0.4",
     "@adobe/helix-shared-config": "11.0.1",
     "@adobe/helix-shared-git": "3.0.14",
-    "@adobe/helix-shared-indexer": "2.1.5",
+    "@adobe/helix-shared-indexer": "2.1.6",
     "camelcase": "8.0.0",
     "chalk-template": "1.1.0",
     "chokidar": "4.0.1",
     "compression": "1.7.4",
-    "cookie": "0.6.0",
+    "cookie": "0.7.1",
     "cookie-parser": "1.4.6",
     "dotenv": "16.4.5",
     "express": "4.21.0",
@@ -76,7 +76,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.7",
-    "@adobe/helix-shared-dom": "2.0.7",
+    "@adobe/helix-shared-dom": "2.0.8",
     "@adobe/helix-testutils": "0.4.17",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",

package/src/fetch-utils.js

@@ -35,6 +35,7 @@ const httpProxyHandler = {
         : new HttpProxyAgent(proxyUrl);
       // eslint-disable-next-line no-console
       console.debug(`using proxy ${proxyUrl}`);
+      // we need to use `node-fetch` directly to pass the agent. adobe-fetch does not support it.
       return nodeFetch(url, {
         ...init,
         agent,

package/src/git-utils.js

@@ -23,6 +23,8 @@ import git from 'isomorphic-git';
 const cache = {};
 
 export default class GitUtils {
+  static DEFAULT_BRANCH = 'main';
+
   /**
    * Determines whether the working tree directory contains uncommitted or unstaged changes.
    *
@@ -141,7 +143,7 @@ export default class GitUtils {
    * @param {string} fallback fallback value if no branch or tag is found
    * @returns {Promise<string>} current branch or tag
    */
-  static async getBranch(dir, fallback = 'main') {
+  static async getBranch(dir, fallback = this.DEFAULT_BRANCH) {
     // current commit sha
     const rev = await git.resolveRef({ fs, dir, ref: 'HEAD' });
     // reverse-lookup tag from commit sha

package/src/import.cmd.js

@@ -14,6 +14,7 @@ import path from 'path';
 import chalk from 'chalk-template';
 import git from 'isomorphic-git';
 import http from 'isomorphic-git/http/node/index.js';
+import GitUtils from './git-utils.js';
 import { HelixImportProject } from './server/HelixImportProject.js';
 import pkgJson from './package.cjs';
 import { AbstractServerCommand } from './abstract-server.cmd.js';
@@ -36,7 +37,20 @@ export default class ImportCommand extends AbstractServerCommand {
   }
 
   withUIRepo(value) {
-    this._uiRepo = value;
+    this._uiBranch = GitUtils.DEFAULT_BRANCH;
+    try {
+      const url = new URL(value);
+      if (url.hash) {
+        this._uiBranch = url.hash.substring(1);
+      }
+      // Ensure a dangling hash does not create an invalid uiRepo.
+      url.hash = '';
+      this._uiRepo = url.href;
+    } catch (e) {
+      this.log.error(`Could not process UI Repo correctly: ${value} - ${e.message}`);
+      throw e;
+    }
+
     return this;
   }
 
@@ -45,6 +59,27 @@ export default class ImportCommand extends AbstractServerCommand {
     return this;
   }
 
+  /**
+   * Ensure the UI branch the caller specified (or defaulted to) is the one being used.
+   * @param uiFolder
+   * @returns {Promise<void>}
+   */
+  async handleUIBranch(uiFolder) {
+    const branch = await GitUtils.getBranch(uiFolder);
+
+    if (branch !== this._uiBranch) {
+      this.log.info(
+        chalk`AEM Importer UI was on branch {yellow ${branch}}. Switching to {green ${this._uiBranch}}.`,
+      );
+      await git.checkout({
+        fs: fse,
+        http,
+        dir: uiFolder,
+        ref: this._uiBranch,
+      });
+    }
+  }
+
   async setupImporterUI() {
     const importerFolder = path.join(this.directory, this._importerSubPath);
     await fse.ensureDir(importerFolder);
@@ -54,32 +89,41 @@ export default class ImportCommand extends AbstractServerCommand {
     const exists = await fse.pathExists(uiFolder);
     if (!exists) {
       this.log.info('AEM Importer UI needs to be installed.');
-      this.log.info(`Cloning ${this._uiRepo} in ${importerFolder}.`);
+      this.log.info(`Cloning ${this._uiRepo} (branch: ${this._uiBranch}) in ${importerFolder}.`);
       // clone the ui project
-      await git.clone({
-        fs: fse,
-        http,
-        dir: uiFolder,
-        url: this._uiRepo,
-        depth: 1,
-        singleBranch: true,
-      });
-      this.log.info(`AEM Importer UI is ready. v${await getUIVersion()}`);
+      try {
+        await git.clone({
+          fs: fse,
+          http,
+          dir: uiFolder,
+          url: this._uiRepo,
+          ref: this._uiBranch,
+          depth: 1,
+        });
+
+        this.log.info(`AEM Importer UI is ready. v${await getUIVersion()} (branch: ${this._uiBranch})`);
+      } catch (e) {
+        this.log.error(`AEM Importer UI clone failed: ${e.message}`);
+        throw e;
+      }
     } else {
       this.log.info('Fetching latest version of the AEM Importer UI...');
-      // clone the ui project
+      await this.handleUIBranch(uiFolder);
+
+      // Pull the ui project
       await git.pull({
         fs: fse,
         http,
         dir: uiFolder,
         url: this._uiRepo,
+        ref: this._uiBranch,
         depth: 1,
         singleBranch: true,
         author: {
           name: 'hlx import',
         },
       });
-      this.log.info(`AEM Importer UI is up-to-date. v${await getUIVersion()}`);
+      this.log.info(`AEM Importer UI is up-to-date. v${await getUIVersion()} (branch: ${this._uiBranch})`);
     }
   }
 

package/src/import.js

@@ -29,7 +29,7 @@ export default function up() {
         })
         .option('ui-repo', {
           alias: 'uiRepo',
-          describe: 'Git repository for the AEM Importer UI',
+          describe: 'Git repository for the AEM Importer UI. A fragment may be used to indicated a branch other than main.',
           type: 'string',
           default: 'https://github.com/adobe/helix-importer-ui',
         })