@akash-chowdhury-24/deployhub 2.0.11 → 2.0.14

package/src/utils/docker-image.js

@@ -2,53 +2,27 @@
  * Shared Docker image naming for pipeline builds and deploy.
  */
 
-import { execFileSync } from 'child_process';
+import { resolveUniqueBuildStamp, highResBuildStamp } from './build-id.js';
 
-/** @typedef {'explicit'|'git'|'ci'|'timestamp'} ImageTagSource */
+/** @typedef {'explicit'|'git'|'ci'|'timestamp'|'buildId'} ImageTagSource */
 
 export const EXPLICIT_IMAGE_TAG_WARNING =
   'DOCKER_IMAGE_TAG is set — reusing the same tag across deploys can leave Kubernetes pods on a stale image (imagePullPolicy defaults to IfNotPresent) unless imagePullPolicy is Always or a rollout restart runs.';
 
-/**
- * High-resolution timestamp for image tags only (artifact versioning keeps getDateVersion()).
- * Minute prefix matches getDateVersion(); seconds+ms avoid collisions in fast rebuild loops.
- * @param {Date} [now]
- * @returns {string}
- */
+/** @deprecated use highResBuildStamp from build-id.js — kept for existing imports/tests */
 export function highResImageTagFallback(now = new Date()) {
-  const y = now.getFullYear();
-  const m = String(now.getMonth() + 1).padStart(2, '0');
-  const d = String(now.getDate()).padStart(2, '0');
-  const h = String(now.getHours()).padStart(2, '0');
-  const min = String(now.getMinutes()).padStart(2, '0');
-  const sec = String(now.getSeconds()).padStart(2, '0');
-  const ms = String(now.getMilliseconds()).padStart(3, '0');
-  return `${y}.${m}.${d}.${h}${min}-${sec}${ms}`;
+  return highResBuildStamp(now);
 }
 
 /**
- * @returns {string|null}
- */
-function defaultGetGitShortSha() {
-  try {
-    const sha = execFileSync('git', ['rev-parse', '--short', 'HEAD'], {
-      encoding: 'utf8',
-      stdio: ['ignore', 'pipe', 'ignore'],
-    }).trim();
-    return sha || null;
-  } catch {
-    return null;
-  }
-}
-
-/**
- * Resolve image tag when DOCKER_IMAGE_TAG is unset: git SHA → CI id → high-res timestamp.
- * Does not use config.version (static package versions would prevent redeploys).
+ * Resolve image tag when DOCKER_IMAGE_TAG is unset: prefer config.buildId (same
+ * pipeline identity as the artifact), else git SHA → CI id → high-res timestamp.
  *
  * @param {Record<string, string|undefined>} [env]
  * @param {{
  *   getGitShortSha?: () => string|null,
  *   now?: () => Date,
+ *   buildId?: string,
  * }} [options]
  * @returns {{ imageTag: string, tagSource: ImageTagSource }}
  */
@@ -58,32 +32,21 @@ export function resolveImageTag(env = process.env, options = {}) {
     return { imageTag: explicit, tagSource: 'explicit' };
   }
 
-  const getGitShortSha = options.getGitShortSha || defaultGetGitShortSha;
-  const gitSha = getGitShortSha();
-  if (gitSha) {
-    return { imageTag: gitSha, tagSource: 'git' };
+  if (options.buildId) {
+    return { imageTag: options.buildId, tagSource: 'buildId' };
   }
 
-  const ciTag =
-    (env.GITHUB_SHA && String(env.GITHUB_SHA).slice(0, 7)) ||
-    env.GITHUB_RUN_ID ||
-    env.CI_COMMIT_SHORT_SHA ||
-    env.CI_PIPELINE_ID;
-  if (ciTag) {
-    return { imageTag: String(ciTag), tagSource: 'ci' };
-  }
-
-  const now = options.now ? options.now() : new Date();
-  return { imageTag: highResImageTagFallback(now), tagSource: 'timestamp' };
+  const { stamp, source } = resolveUniqueBuildStamp(env, options);
+  return { imageTag: stamp, tagSource: source };
 }
 
 /**
+ * Same repository naming as resolveDockerImageRef, with an explicit tag.
+ * Ignores DOCKER_IMAGE_TAG / git / CI — used when restoring a known buildId.
+ *
  * @param {import('../core/config.js').DeployHubConfig} config
  * @param {Record<string, string|undefined>} [env]
- * @param {{
- *   getGitShortSha?: () => string|null,
- *   now?: () => Date,
- * }} [options]
+ * @param {string} imageTag
  * @returns {{
  *   imageName: string,
  *   imageTag: string,
@@ -93,9 +56,8 @@ export function resolveImageTag(env = process.env, options = {}) {
  *   tagSource: ImageTagSource,
  * }}
  */
-export function resolveDockerImageRef(config, env = process.env, options = {}) {
+export function resolveDockerImageRefForTag(config, env = process.env, imageTag) {
   const imageName = env.DOCKER_IMAGE_NAME || config.project;
-  const { imageTag, tagSource } = resolveImageTag(env, options);
   const registryUrl = env.DOCKER_REGISTRY_URL || '';
 
   const repository =
@@ -109,6 +71,47 @@ export function resolveDockerImageRef(config, env = process.env, options = {}) {
     fullImage: `${repository}:${imageTag}`,
     latestImage: `${repository}:latest`,
     legacyLatestImage: `${config.project}:latest`,
+    tagSource: 'buildId',
+  };
+}
+
+/**
+ * Replace the tag portion of a docker image ref (handles registry:port/name:tag).
+ * @param {string} imageRef
+ * @param {string} newTag
+ */
+export function replaceDockerImageTag(imageRef, newTag) {
+  const lastSlash = imageRef.lastIndexOf('/');
+  const lastColon = imageRef.lastIndexOf(':');
+  if (lastColon > lastSlash) {
+    return `${imageRef.slice(0, lastColon)}:${newTag}`;
+  }
+  return `${imageRef}:${newTag}`;
+}
+
+/**
+ * @param {import('../core/config.js').DeployHubConfig} config
+ * @param {Record<string, string|undefined>} [env]
+ * @param {{
+ *   getGitShortSha?: () => string|null,
+ *   now?: () => Date,
+ * }} [options]
+ * @returns {{
+ *   imageName: string,
+ *   imageTag: string,
+ *   fullImage: string,
+ *   latestImage: string,
+ *   legacyLatestImage: string,
+ *   tagSource: ImageTagSource,
+ * }}
+ */
+export function resolveDockerImageRef(config, env = process.env, options = {}) {
+  const { imageTag, tagSource } = resolveImageTag(env, {
+    ...options,
+    buildId: /** @type {{ buildId?: string }} */ (config).buildId,
+  });
+  return {
+    ...resolveDockerImageRefForTag(config, env, imageTag),
     tagSource,
   };
 }
@@ -251,6 +254,8 @@ export function describeInterpretedBackendGap(framework) {
 
 export default {
   resolveDockerImageRef,
+  resolveDockerImageRefForTag,
+  replaceDockerImageTag,
   resolveImageTag,
   highResImageTagFallback,
   EXPLICIT_IMAGE_TAG_WARNING,

package/src/utils/github-actions.js

@@ -259,19 +259,23 @@ function applyKubernetesWorkflowEnv(deployEnvironments, environments, envVars) {
   envVars.add('KUBECONFIG: ${{ github.workspace }}/.kube/config');
 }
 
+export const DEPLOY_WORKFLOW_FILENAME = 'deployhub.yml';
+export const ROLLBACK_WORKFLOW_FILENAME = 'deployhub-rollback.yml';
+
 /**
+ * Shared env entries for deploy and rollback workflows (same secret resolution).
+ * Uses getDeploymentWorkflowSecretKeys(env.type) — no separate rollback list.
+ *
  * @param {string[]} storageProviders
  * @param {string[]} deployEnvironments
  * @param {Record<string, { type: string }>} environments
- * @param {string} [cliSource]
  * @param {import('../core/config.js').DeployHubConfig} [config]
- * @returns {string}
+ * @returns {Set<string>}
  */
-export function generateWorkflowYaml(
+export function buildWorkflowEnvEntries(
   storageProviders,
   deployEnvironments,
   environments,
-  cliSource = DEFAULT_NPM_CLI_SOURCE,
   config = null
 ) {
   /** @type {Set<string>} */
@@ -295,10 +299,65 @@ export function generateWorkflowYaml(
   }
 
   applyKubernetesWorkflowEnv(deployEnvironments, environments, envVars);
+  return envVars;
+}
 
-  const envBlock = Array.from(envVars)
-    .map((line) => `          ${line}`)
+/**
+ * @param {Set<string>} envVars
+ * @param {string} [indent]
+ */
+function formatWorkflowEnvBlock(envVars, indent = '          ') {
+  return Array.from(envVars)
+    .map((line) => `${indent}${line}`)
     .join('\n');
+}
+
+/**
+ * Shell command to run deployhub rollback from the installed scoped package.
+ * @returns {string}
+ */
+export function getCliRollbackCommand() {
+  return `node ./node_modules/${NPM_PACKAGE}/src/cli/index.js rollback`;
+}
+
+/**
+ * Collect secret names referenced as ${{ secrets.NAME }} in workflow YAML.
+ * @param {string} yaml
+ * @returns {string[]}
+ */
+export function extractWorkflowSecretKeys(yaml) {
+  /** @type {Set<string>} */
+  const keys = new Set();
+  const re = /\$\{\{\s*secrets\.([A-Z0-9_]+)\s*\}\}/g;
+  let match;
+  while ((match = re.exec(yaml)) !== null) {
+    keys.add(match[1]);
+  }
+  return [...keys].sort();
+}
+
+/**
+ * @param {string[]} storageProviders
+ * @param {string[]} deployEnvironments
+ * @param {Record<string, { type: string }>} environments
+ * @param {string} [cliSource]
+ * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @returns {string}
+ */
+export function generateWorkflowYaml(
+  storageProviders,
+  deployEnvironments,
+  environments,
+  cliSource = DEFAULT_NPM_CLI_SOURCE,
+  config = null
+) {
+  const envVars = buildWorkflowEnvEntries(
+    storageProviders,
+    deployEnvironments,
+    environments,
+    config
+  );
+  const envBlock = formatWorkflowEnvBlock(envVars);
 
   const installSpec = getCliInstallSpec(cliSource);
   const backendSteps = getBackendSetupSteps(config);
@@ -340,6 +399,71 @@ ${envBlock}
   return workflow;
 }
 
+/**
+ * Manual rollback via Actions tab / gh workflow run (workflow_dispatch only).
+ *
+ * @param {string[]} storageProviders
+ * @param {string[]} deployEnvironments
+ * @param {Record<string, { type: string }>} environments
+ * @param {string} [cliSource]
+ * @param {import('../core/config.js').DeployHubConfig} [config]
+ * @returns {string}
+ */
+export function generateRollbackWorkflowYaml(
+  storageProviders,
+  deployEnvironments,
+  environments,
+  cliSource = DEFAULT_NPM_CLI_SOURCE,
+  config = null
+) {
+  const envVars = buildWorkflowEnvEntries(
+    storageProviders,
+    deployEnvironments,
+    environments,
+    config
+  );
+  const envBlock = formatWorkflowEnvBlock(envVars);
+
+  const installSpec = getCliInstallSpec(cliSource);
+  const githubGitConfigStep = isGithubCliSource(cliSource)
+    ? `${getGithubGitConfigStep()}\n`
+    : '';
+  const kubernetesSteps = hasKubernetesDeploy(deployEnvironments, environments)
+    ? `${getKubernetesSetupSteps()}\n`
+    : '';
+
+  const rollbackCmd = getCliRollbackCommand();
+
+  return `${getWorkflowHeaderComment()}name: DeployHub Rollback
+on:
+  workflow_dispatch:
+    inputs:
+      buildId:
+        description: 'Exact buildId to restore (leave blank = previous build)'
+        required: false
+        type: string
+jobs:
+  rollback:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+${kubernetesSteps}${githubGitConfigStep}      - name: Install DeployHub CLI
+        run: npm install ${installSpec} --no-save
+      - name: Rollback
+        env:
+${envBlock}
+        run: |
+          if [ -n "\${{ inputs.buildId }}" ]; then
+            ${rollbackCmd} "\${{ inputs.buildId }}"
+          else
+            ${rollbackCmd}
+          fi
+`;
+}
+
 /**
  * @param {import('../core/config.js').DeployHubConfig} [config]
  * @returns {string}
@@ -373,6 +497,8 @@ function getInstallDepsCommand(config) {
 }
 
 /**
+ * Write deployhub.yml and deployhub-rollback.yml from the same secret/env helpers.
+ *
  * @param {string[]} storageProviders
  * @param {string[]} deployEnvironments
  * @param {Record<string, { type: string }>} environments
@@ -390,14 +516,55 @@ export async function writeWorkflowFile(
 ) {
   const workflowDir = path.join(cwd, '.github', 'workflows');
   await fs.ensureDir(workflowDir);
-  const content = generateWorkflowYaml(
+
+  const deployContent = generateWorkflowYaml(
     storageProviders,
     deployEnvironments,
     environments,
     cliSource,
     config
   );
-  await fs.writeFile(path.join(workflowDir, 'deployhub.yml'), content);
+  const rollbackContent = generateRollbackWorkflowYaml(
+    storageProviders,
+    deployEnvironments,
+    environments,
+    cliSource,
+    config
+  );
+
+  await fs.writeFile(path.join(workflowDir, DEPLOY_WORKFLOW_FILENAME), deployContent);
+  await fs.writeFile(path.join(workflowDir, ROLLBACK_WORKFLOW_FILENAME), rollbackContent);
+}
+
+/**
+ * Doctor helper: informational status for the rollback workflow file.
+ * Returns null when the check does not apply (no storage/deploy configured).
+ *
+ * @param {string} cwd
+ * @param {{ storage?: string[], deploy?: string[] }} config
+ * @returns {Promise<null | { name: string, pass: boolean, message: string }>}
+ */
+export async function getRollbackWorkflowDoctorCheck(cwd, config) {
+  const hasStorage = (config.storage || []).length > 0;
+  const hasDeploy = (config.deploy || []).length > 0;
+  if (!hasStorage || !hasDeploy) return null;
+
+  const rollbackPath = path.join(cwd, '.github', 'workflows', ROLLBACK_WORKFLOW_FILENAME);
+  if (await fs.pathExists(rollbackPath)) {
+    return {
+      name: 'Rollback workflow',
+      pass: true,
+      message: `Workflow file exists at .github/workflows/${ROLLBACK_WORKFLOW_FILENAME}`,
+    };
+  }
+
+  return {
+    name: 'Rollback workflow',
+    pass: true,
+    message:
+      `Missing .github/workflows/${ROLLBACK_WORKFLOW_FILENAME} — ` +
+      'run deployhub sync-workflows to add CI rollback (workflow_dispatch)',
+  };
 }
 
 /**

package/src/utils/rollback/engine.js

@@ -1,7 +1,11 @@
-import { downloadFromFirst } from '../../storage/index.js';
+import { downloadArtifactEntry, loadArtifactHistory } from '../../storage/index.js';
 import { getDeploymentProvider } from '../../deployment/index.js';
 import { extractArtifact } from '../../artifact/engine.js';
 import { createLogger } from '../../logger/index.js';
+import {
+  formatAmbiguousRollbackMatches,
+  resolveRollbackTarget,
+} from '../artifact-history.js';
 import fs from 'fs-extra';
 import path from 'path';
 
@@ -9,8 +13,9 @@ import path from 'path';
  * @param {import('../../core/config.js').DeployHubConfig} config
  * @param {string} artifactDir
  * @param {string} envName
+ * @param {{ buildId: string, semver: string, remoteKey: string }} meta
  */
-async function rollbackTarget(config, artifactDir, envName) {
+async function rollbackTarget(config, artifactDir, envName, meta) {
   const envConfig = config.environments[envName];
   if (!envConfig) {
     throw new Error(`Environment "${envName}" not found in config`);
@@ -20,50 +25,68 @@ async function rollbackTarget(config, artifactDir, envName) {
   log.info(`Rolling back ${envName} (${envConfig.type || 'server'})...`);
 
   const provider = getDeploymentProvider(envConfig.type, config, envName);
-  await provider.rollback(artifactDir);
+  await provider.rollback(artifactDir, meta);
 }
 
 /**
  * @param {import('../../core/config.js').DeployHubConfig} config
- * @param {string} version
+ * @param {string} [versionOrBuildId]
  * @param {string} [cwd]
  */
-export async function rollbackToVersion(config, version, cwd = process.cwd()) {
+export async function rollbackToVersion(config, versionOrBuildId, cwd = process.cwd()) {
   const log = createLogger('rollback');
-  const remoteKey = `${config.project}/v${version}/artifact.zip`;
-  const restoreDir = path.join(cwd, '.deployhub-restore', `v${version}`);
+  const providers = config.storage || [];
+  if (providers.length === 0) {
+    throw new Error('No storage providers configured — cannot download artifact for rollback');
+  }
+
+  const { entries: history } = await loadArtifactHistory(providers, config.project);
+  const resolved = resolveRollbackTarget(history, versionOrBuildId);
+
+  if (!resolved.ok) {
+    if (resolved.reason === 'ambiguous' && resolved.matches) {
+      throw new Error(
+        `${resolved.message}\n${formatAmbiguousRollbackMatches(resolved.matches)}`
+      );
+    }
+    throw new Error(resolved.message);
+  }
+
+  const entry = resolved.entry;
+  const restoreDir = path.join(cwd, '.deployhub-restore', `v${entry.buildId}`);
   const artifactDir = path.join(restoreDir, 'artifact');
 
-  log.info(`Downloading artifact v${version}...`);
+  log.info(`Downloading artifact buildId=${entry.buildId} (semver=${entry.semver})...`);
   await fs.emptyDir(restoreDir);
   await fs.ensureDir(artifactDir);
 
   const zipPath = path.join(artifactDir, 'artifact.zip');
-  await downloadFromFirst(config.storage, remoteKey, zipPath);
+  await downloadArtifactEntry(providers, config, entry, zipPath);
 
+  // Extract into artifactDir itself so layout matches a normal build artifact:
+  // top-level contents (k8s/, dist/, metadata.json, …) alongside artifact.zip.
   log.info('Extracting artifact for rollback...');
-  const extractedDir = path.join(artifactDir, '_extracted');
-  await fs.emptyDir(extractedDir);
-  await extractArtifact(artifactDir, extractedDir);
-
-  const extractedDeployment = path.join(extractedDir, 'deployment.json');
-  if (await fs.pathExists(extractedDeployment)) {
-    await fs.copy(extractedDeployment, path.join(artifactDir, 'deployment.json'));
-  }
+  await extractArtifact(artifactDir, artifactDir);
 
   const targets = config.deploy || [];
   if (targets.length === 0) {
     log.warn('No deployment targets configured');
-    return artifactDir;
+    return { artifactDir, entry };
   }
 
+  const meta = {
+    buildId: entry.buildId,
+    semver: entry.semver,
+    remoteKey: entry.remoteKey,
+  };
+
   log.info('Redeploying previous artifact to server targets...');
   for (const envName of targets) {
-    await rollbackTarget(config, artifactDir, envName);
+    await rollbackTarget(config, artifactDir, envName, meta);
   }
 
-  log.success(`Rollback to v${version} complete`);
-  return artifactDir;
+  log.success(`Rollback to buildId=${entry.buildId} complete`);
+  return { artifactDir, entry };
 }
 
 export default { rollbackToVersion };