oclif 4.22.80 → 4.22.82-qa.0

package/lib/commands/promote.js

@@ -73,6 +73,7 @@ class Promote extends core_1.Command {
         this.log(`Promoting v${flags.version} (${flags.sha}) to ${flags.channel} channel\n`);
         const buildConfig = await Tarballs.buildConfig(flags.root, { targets: flags?.targets?.split(',') });
         const { config, s3Config } = buildConfig;
+        const keys = (0, upload_util_1.s3Keys)(config, s3Config, { bin: config.bin, sha: flags.sha, version: flags.version });
         const indexDefaults = {
             maxAge: `max-age=${flags['max-age']}`,
             s3Config,
@@ -90,90 +91,67 @@ class Promote extends core_1.Command {
         const cloudChannelKey = (shortKey) => node_path_1.default.posix.join((0, upload_util_1.channelAWSDir)(flags.channel, s3Config), shortKey);
         // copy tarballs manifests
         const promoteManifest = async (target) => {
-            const manifest = (0, upload_util_1.templateShortKey)('manifest', {
-                arch: target.arch,
-                bin: config.bin,
-                platform: target.platform,
-                sha: flags.sha,
-                version: flags.version,
-            });
-            // strip version & sha so update/scripts can point to a static channel manifest
-            const unversionedManifest = manifest.replace(`-v${flags.version}-${flags.sha}`, '');
+            const sourceKey = keys.cloudKey(keys.manifest({ arch: target.arch, platform: target.platform }));
+            const destKey = keys.channelManifest({ arch: target.arch, platform: target.platform }, flags.channel);
             await aws_1.default.s3.copyObject({
                 ...awsDefaults,
-                CopySource: cloudBucketCommitKey(manifest),
-                Key: cloudChannelKey(unversionedManifest),
+                CopySource: node_path_1.default.posix.join(s3Config.bucket, sourceKey),
+                Key: destKey,
             }, {
                 dryRun: flags['dry-run'],
                 ignoreMissing: flags['ignore-missing'],
-                namespace: unversionedManifest,
+                namespace: node_path_1.default.basename(destKey),
             });
         };
         const promoteGzTarballs = async (target) => {
-            const versionedTarGzName = (0, upload_util_1.templateShortKey)('versioned', {
-                arch: target.arch,
-                bin: config.bin,
-                ext: '.tar.gz',
-                platform: target.platform,
-                sha: flags.sha,
-                version: flags.version,
-            });
-            const versionedTarGzKey = cloudBucketCommitKey(versionedTarGzName);
-            // strip version & sha so update/scripts can point to a static channel tarball
-            const unversionedTarGzName = versionedTarGzName.replace(`-v${flags.version}-${flags.sha}`, '');
-            const unversionedTarGzKey = cloudChannelKey(unversionedTarGzName);
+            const targetOpts = { arch: target.arch, platform: target.platform };
+            const sourceKey = keys.cloudKey(keys.versioned('.tar.gz', targetOpts));
+            const destKey = keys.channelTarball('.tar.gz', targetOpts, flags.channel);
+            const copySource = node_path_1.default.posix.join(s3Config.bucket, sourceKey);
             await Promise.all([
                 aws_1.default.s3.copyObject({
                     ...awsDefaults,
-                    CopySource: versionedTarGzKey,
-                    Key: unversionedTarGzKey,
+                    CopySource: copySource,
+                    Key: destKey,
                 }, {
                     dryRun: flags['dry-run'],
                     ignoreMissing: flags['ignore-missing'],
-                    namespace: unversionedTarGzName,
+                    namespace: keys.indexFilename('.tar.gz', targetOpts, flags.channel),
                 }),
                 ...(flags.indexes
                     ? [
                         (0, version_indexes_1.appendToIndex)({
                             ...indexDefaults,
                             dryRun: flags['dry-run'],
-                            filename: unversionedTarGzName,
-                            originalUrl: versionedTarGzKey,
+                            filename: keys.indexFilename('.tar.gz', targetOpts, flags.channel),
+                            originalUrl: copySource,
                         }),
                     ]
                     : []),
             ]);
         };
         const promoteXzTarballs = async (target) => {
-            const versionedTarXzName = (0, upload_util_1.templateShortKey)('versioned', {
-                arch: target.arch,
-                bin: config.bin,
-                ext: '.tar.xz',
-                platform: target.platform,
-                sha: flags.sha,
-                version: flags.version,
-            });
-            const versionedTarXzKey = cloudBucketCommitKey(versionedTarXzName);
-            // strip version & sha so update/scripts can point to a static channel tarball
-            const unversionedTarXzName = versionedTarXzName.replace(`-v${flags.version}-${flags.sha}`, '');
-            const unversionedTarXzKey = cloudChannelKey(unversionedTarXzName);
+            const targetOpts = { arch: target.arch, platform: target.platform };
+            const sourceKey = keys.cloudKey(keys.versioned('.tar.xz', targetOpts));
+            const destKey = keys.channelTarball('.tar.xz', targetOpts, flags.channel);
+            const copySource = node_path_1.default.posix.join(s3Config.bucket, sourceKey);
             await Promise.all([
                 aws_1.default.s3.copyObject({
                     ...awsDefaults,
-                    CopySource: versionedTarXzKey,
-                    Key: unversionedTarXzKey,
+                    CopySource: copySource,
+                    Key: destKey,
                 }, {
                     dryRun: flags['dry-run'],
                     ignoreMissing: flags['ignore-missing'],
-                    namespace: unversionedTarXzName,
+                    namespace: keys.indexFilename('.tar.xz', targetOpts, flags.channel),
                 }),
                 ...(flags.indexes
                     ? [
                         (0, version_indexes_1.appendToIndex)({
                             ...indexDefaults,
                             dryRun: flags['dry-run'],
-                            filename: unversionedTarXzName,
-                            originalUrl: versionedTarXzKey,
+                            filename: keys.indexFilename('.tar.xz', targetOpts, flags.channel),
+                            originalUrl: copySource,
                         }),
                     ]
                     : []),

package/lib/commands/upload/tarballs.js

@@ -62,15 +62,10 @@ class UploadTarballs extends core_1.Command {
             xz: flags.xz,
         });
         const { config, dist, s3Config, xz } = buildConfig;
+        const keys = (0, upload_util_1.s3Keys)(config, s3Config, { bin: config.bin, sha: buildConfig.gitSha, version: config.version });
         // fail early if targets are not built
         for (const target of buildConfig.targets) {
-            const tarball = dist((0, upload_util_1.templateShortKey)('versioned', {
-                bin: config.bin,
-                ext: '.tar.gz',
-                sha: buildConfig.gitSha,
-                version: config.version,
-                ...target,
-            }));
+            const tarball = dist(keys.versioned('.tar.gz', { arch: target.arch, platform: target.platform }));
             if (!fs.existsSync(tarball))
                 this.error(`Cannot find a tarball ${tarball} for ${target.platform}-${target.arch}`, {
                     suggestions: [`Run "oclif pack --target ${target.platform}-${target.arch}" before uploading`],
@@ -81,18 +76,15 @@ class UploadTarballs extends core_1.Command {
             Bucket: s3Config.bucket,
         };
         const uploadTarball = async (options) => {
-            const shortKeyInputs = {
+            const target = {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain
                 arch: options?.arch,
-                bin: config.bin,
                 // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain
                 platform: options?.platform,
-                sha: buildConfig.gitSha,
-                version: config.version,
             };
             const releaseTarballs = async (ext) => {
-                const localKey = (0, upload_util_1.templateShortKey)('versioned', { ...shortKeyInputs, ext });
-                const cloudKey = `${(0, upload_util_1.commitAWSDir)(config.version, buildConfig.gitSha, s3Config)}/${localKey}`;
+                const localKey = keys.versioned(ext, target);
+                const cloudKey = keys.cloudKey(localKey);
                 await aws_1.default.s3.uploadFile(dist(localKey), {
                     ...S3Options,
                     CacheControl: 'max-age=604800',
@@ -103,8 +95,8 @@ class UploadTarballs extends core_1.Command {
                 });
             };
             const maybeUploadManifest = async () => {
-                const manifest = (0, upload_util_1.templateShortKey)('manifest', shortKeyInputs);
-                const cloudKey = `${(0, upload_util_1.commitAWSDir)(config.version, buildConfig.gitSha, s3Config)}/${manifest}`;
+                const manifest = keys.manifest(target);
+                const cloudKey = keys.cloudKey(manifest);
                 const local = dist(manifest);
                 (0, log_1.log)(`checking for buildmanifest at ${local}`);
                 if (fs.existsSync(local)) {

package/lib/tarballs/build.js

@@ -195,8 +195,8 @@ const buildTarget = async (target, c, options) => {
     const { arch, platform } = target;
     const { bin, version } = c.config;
     const { gitSha: sha } = c;
-    const templateShortKeyCommonOptions = { arch, bin, platform, sha, version };
-    const [gzLocalKey, xzLocalKey] = ['.tar.gz', '.tar.xz'].map((ext) => (0, upload_util_1.templateShortKey)('versioned', { ...templateShortKeyCommonOptions, ext }));
+    const keys = (0, upload_util_1.s3Keys)(c.config, c.s3Config, { bin, sha, version });
+    const [gzLocalKey, xzLocalKey] = ['.tar.gz', '.tar.xz'].map((ext) => keys.versioned(ext, { arch, platform }));
     const base = node_path_1.default.basename(gzLocalKey);
     (0, log_1.log)(`building target ${base}`);
     (0, log_1.log)('copying workspace', c.workspace(), workspace);
@@ -225,8 +225,8 @@ const buildTarget = async (target, c, options) => {
     if (!c.updateConfig.s3?.host)
         return;
     const rollout = typeof c.updateConfig.autoupdate === 'object' && c.updateConfig.autoupdate.rollout;
-    const gzCloudKey = `${(0, upload_util_1.commitAWSDir)(version, sha, c.updateConfig.s3)}/${gzLocalKey}`;
-    const xzCloudKey = `${(0, upload_util_1.commitAWSDir)(version, sha, c.updateConfig.s3)}/${xzLocalKey}`;
+    const gzCloudKey = keys.cloudKey(gzLocalKey);
+    const xzCloudKey = keys.cloudKey(xzLocalKey);
     const [sha256gz, sha256xz] = await Promise.all([
         (0, util_1.hash)('sha256', c.dist(gzLocalKey)),
         ...(c.xz ? [(0, util_1.hash)('sha256', c.dist(xzLocalKey))] : []),
@@ -245,6 +245,7 @@ const buildTarget = async (target, c, options) => {
         version,
         xz: c.xz ? c.config.s3Url(xzCloudKey) : undefined,
     };
-    const manifestFilepath = c.dist((0, upload_util_1.templateShortKey)('manifest', templateShortKeyCommonOptions));
+    const manifestFilepath = c.dist(keys.manifest({ arch, platform }));
+    await (0, promises_1.mkdir)(node_path_1.default.dirname(manifestFilepath), { recursive: true });
     await (0, fs_extra_1.writeJSON)(manifestFilepath, manifest, { spaces: 2 });
 };

package/lib/upload-util.d.ts

@@ -11,6 +11,23 @@ type TemplateOptions = Interfaces.Config.s3Key.Options | {
     versionShaRevision?: string;
 };
 export declare function templateShortKey(type: 'deb' | 'macos' | 'win32' | keyof Interfaces.S3Templates, options?: TemplateOptions): string;
+type TargetOptions = {
+    arch: Interfaces.ArchTypes;
+    platform: Interfaces.PlatformTypes;
+};
+export declare function s3Keys(config: Interfaces.Config, s3Config: TarballConfig['s3Config'], options: {
+    bin: string;
+    sha: string;
+    version: string;
+}): {
+    channelManifest(target: TargetOptions, channel: string): string;
+    channelTarball(ext: ".tar.gz" | ".tar.xz", target: TargetOptions, channel: string): string;
+    cloudKey(localKey: string): string;
+    /** Returns the filename suitable for use in version index files. */
+    indexFilename(ext: ".tar.gz" | ".tar.xz", target: TargetOptions, channel: string): string;
+    manifest(target: TargetOptions): string;
+    versioned(ext: ".tar.gz" | ".tar.xz", target: TargetOptions): string;
+};
 export type DebArch = 'amd64' | 'arm64' | 'armel' | 'i386';
 export declare function debArch(arch: Interfaces.ArchTypes): DebArch;
 export declare function debVersion(buildConfig: TarballConfig): string;

package/lib/upload-util.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.commitAWSDir = commitAWSDir;
 exports.channelAWSDir = channelAWSDir;
 exports.templateShortKey = templateShortKey;
+exports.s3Keys = s3Keys;
 exports.debArch = debArch;
 exports.debVersion = debVersion;
 const ejs_1 = require("ejs");
@@ -39,6 +40,43 @@ function templateShortKey(type, options) {
     };
     return (0, ejs_1.render)(templates[type], { ...options });
 }
+function s3Keys(config, s3Config, options) {
+    const hasCustom = Boolean(config.pjson.oclif?.update?.s3?.templates);
+    return {
+        channelManifest(target, channel) {
+            if (hasCustom) {
+                return config.s3Key('manifest', { ...target, channel });
+            }
+            const manifest = templateShortKey('manifest', { ...options, ...target });
+            const unversionedManifest = manifest.replace(`-v${options.version}-${options.sha}`, '');
+            return `${channelAWSDir(channel, s3Config)}/${unversionedManifest}`;
+        },
+        channelTarball(ext, target, channel) {
+            return hasCustom
+                ? config.s3Key('unversioned', ext, { ...target, channel })
+                : `${channelAWSDir(channel, s3Config)}/${templateShortKey('unversioned', { ...options, ...target, ext })}`;
+        },
+        cloudKey(localKey) {
+            return hasCustom ? localKey : `${commitAWSDir(options.version, options.sha, s3Config)}/${localKey}`;
+        },
+        /** Returns the filename suitable for use in version index files. */
+        indexFilename(ext, target, channel) {
+            return hasCustom
+                ? config.s3Key('unversioned', ext, { ...target, channel })
+                : templateShortKey('unversioned', { ...options, ...target, ext });
+        },
+        manifest(target) {
+            return hasCustom
+                ? config.s3Key('manifest', target)
+                : templateShortKey('manifest', { ...options, ...target });
+        },
+        versioned(ext, target) {
+            return hasCustom
+                ? config.s3Key('versioned', ext, target)
+                : templateShortKey('versioned', { ...options, ...target, ext });
+        },
+    };
+}
 function debArch(arch) {
     if (arch === 'x64')
         return 'amd64';

package/oclif.manifest.json

@@ -1195,5 +1195,5 @@
       ]
     }
   },
-  "version": "4.22.80"
+  "version": "4.22.82-qa.0"
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.22.80",
+  "version": "4.22.82-qa.0",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
   },
   "bugs": "https://github.com/oclif/oclif/issues",
   "dependencies": {
-    "@aws-sdk/client-cloudfront": "^3.990.0",
+    "@aws-sdk/client-cloudfront": "^3.995.0",
     "@aws-sdk/client-s3": "^3.995.0",
     "@inquirer/confirm": "^3.1.22",
     "@inquirer/input": "^2.2.4",