canopycms 0.7.1 → 0.8.0

package/dist/branch-workspace.js

@@ -1,8 +1,9 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import { BranchPathError, isSettingsBranchName, resolveBranchPath } from './paths/index.js';
+import { BranchPathError, isSettingsBranchName, parseBranchRef, resolveBranchPath } from './paths/index.js';
 import { buildInitialBranchMetadata, loadBranchContext } from './branch-metadata.js';
 import { BRANCH_META_DIR, BRANCH_META_FILE, readBranchMetadataFile } from './branch-metadata-file.js';
+import { shortNameOf } from './branch-param.js';
 import { BranchRegistry } from './branch-registry.js';
 import { BranchDirOccupiedError, BranchProvisioningBusyError, CREATE_RESIDUE_MIN_QUIET_MS, classifyFinalDir, removeLeftoverDir, lockBranchName, publishStaging, quietAgeMs, stageBranchWorkspace, } from './branch-provisioning.js';
 import { recordSparseCone, sparseConeFor } from './branch-sparse.js';
@@ -49,12 +50,17 @@ export class BranchWorkspaceManager {
         if (isSettingsBranchName(options.branchName, operatingStrategy(options.mode).getSettingsBranchName(this.config))) {
             throw new BranchPathError('Settings branches are not content branches');
         }
-        const { branchRoot, baseRoot, branchName: safeName } = resolveBranchPath(options);
+        // The name reaches git and branch.json as given; only the directory is sanitized.
+        const named = parseBranchRef(options.branchName);
+        if (!named.ok)
+            throw new BranchPathError(named.error);
+        const { branchRoot, baseRoot } = resolveBranchPath(options);
         const paths = {
             branchRoot,
             baseRoot,
             dirName: path.basename(branchRoot),
-            safeName,
+            ref: options.branchName,
+            shortName: shortNameOf({ ...this.config, mode: options.mode }, options.branchName),
         };
         const existing = await readBranchMetadataFile(branchRoot);
         if (existing) {
@@ -73,7 +79,7 @@ export class BranchWorkspaceManager {
         }
     }
     async provisionUnshared(options, paths) {
-        const { branchRoot, baseRoot, dirName } = paths;
+        const { branchRoot, baseRoot, dirName, shortName } = paths;
         await fs.mkdir(baseRoot, { recursive: true });
         // Resolve the fork point once so the clone and the recorded metadata agree, and the remote
         // before any clone is paid for.
@@ -93,7 +99,7 @@ export class BranchWorkspaceManager {
         });
         const metadata = buildInitialBranchMetadata({
             branch: {
-                name: paths.safeName,
+                name: paths.ref,
                 title: options.title,
                 description: options.description,
                 access: options.access,
@@ -107,7 +113,7 @@ export class BranchWorkspaceManager {
         if (state.kind === 'live' || state.kind === 'corrupt')
             return this.existing(paths);
         if (state.kind === 'protected')
-            throw new BranchProvisioningBusyError(dirName);
+            throw new BranchProvisioningBusyError(dirName, shortName);
         if (state.kind === 'foreign') {
             // dev's CLI sync builds a branch workspace by `git init` and real commits, with no
             // remote and no branch.json; it is adopted where it is.
@@ -116,7 +122,7 @@ export class BranchWorkspaceManager {
             return this.adoptInPlace(options, paths, baseBranch, metadata);
         }
         if (state.kind === 'residue' && (await this.recentlyActive(paths))) {
-            throw new BranchProvisioningBusyError(dirName);
+            throw new BranchProvisioningBusyError(dirName, shortName);
         }
         const sparseCone = sparseConeFor(this.config.contentRoot);
         await recordSparseCone(baseRoot, sparseCone).catch((err) => {
@@ -142,11 +148,11 @@ export class BranchWorkspaceManager {
         return outcome;
     }
     async stageAndPublish(paths, run) {
-        const { branchRoot, baseRoot, dirName } = paths;
+        const { branchRoot, baseRoot, dirName, shortName } = paths;
         const staged = await stageBranchWorkspace({
             baseRoot,
             dirName,
-            branchName: paths.safeName,
+            branchName: paths.ref,
             baseBranch: run.baseBranch,
             remoteUrl: run.remoteUrl,
             clone: {
@@ -166,6 +172,7 @@ export class BranchWorkspaceManager {
             published = await run.provisionLog.step('publish', () => publishStaging({
                 baseRoot,
                 dirName,
+                shortName,
                 stagingPath: staged.stagingPath,
                 writeId: staged.meta.writeId,
                 expectedRemoteUrl: run.remoteUrl,
@@ -186,16 +193,16 @@ export class BranchWorkspaceManager {
      * is, given branch.json under the branch's lock.
      */
     async adoptInPlace(options, paths, baseBranch, metadata) {
-        const { branchRoot, baseRoot, dirName } = paths;
+        const { branchRoot, baseRoot, dirName, shortName } = paths;
         const provisionLog = new ProvisionLog(dirName);
         let created = false;
         try {
-            const release = await provisionLog.step('lock', () => lockBranchName(baseRoot, dirName));
+            const release = await provisionLog.step('lock', () => lockBranchName(baseRoot, dirName, shortName));
             try {
                 if (!(await readBranchMetadataFile(branchRoot))) {
                     await GitManager.initializeWorkspace({
                         workspacePath: branchRoot,
-                        branchName: paths.safeName,
+                        branchName: paths.ref,
                         mode: options.mode,
                         baseBranch,
                         sourceRoot: this.config.sourceRoot,
@@ -231,7 +238,7 @@ export class BranchWorkspaceManager {
             return this.existing(paths);
         const meta = await readBranchMetadataFile(branchRoot);
         if (!meta)
-            throw new BranchProvisioningBusyError(dirName);
+            throw new BranchProvisioningBusyError(dirName, shortName);
         return { kind: 'created', context: { branch: meta.branch, branchRoot, baseRoot } };
     }
     /** Whether residue at the branch path may still belong to a live process. */
@@ -241,10 +248,10 @@ export class BranchWorkspaceManager {
             return true;
         return (await quietAgeMs(branchRoot)) < CREATE_RESIDUE_MIN_QUIET_MS;
     }
-    async existing({ branchRoot, baseRoot, dirName, }) {
+    async existing({ branchRoot, baseRoot, dirName, shortName, }) {
         const meta = await readBranchMetadataFile(branchRoot);
         if (!meta)
-            throw new BranchProvisioningBusyError(dirName);
+            throw new BranchProvisioningBusyError(dirName, shortName);
         return { kind: 'exists', context: { branch: meta.branch, branchRoot, baseRoot } };
     }
 }