@oclif/plugin-update 2.0.0 → 2.1.3

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.1.3](https://github.com/oclif/plugin-update/compare/v2.1.2...v2.1.3) (2021-12-09)
+
+### [2.1.2](https://github.com/oclif/plugin-update/compare/v2.1.1...v2.1.2) (2021-12-08)
+
+
+### Bug Fixes
+
+* bump deps-main ([#343](https://github.com/oclif/plugin-update/issues/343)) ([8f110df](https://github.com/oclif/plugin-update/commit/8f110dfe7a69931466cd30510014c99eee624e50))
+
+### [2.1.1](https://github.com/oclif/plugin-update/compare/v2.1.0...v2.1.1) (2021-12-02)
+
+
+### Bug Fixes
+
+* apply v2 deps ([#342](https://github.com/oclif/plugin-update/issues/342)) ([ea1abfa](https://github.com/oclif/plugin-update/commit/ea1abfab9840523636dbf55f183cbf8b6e46d501))
+
+## [2.1.0](https://github.com/oclif/plugin-update/compare/v2.0.0...v2.1.0) (2021-11-23)
+
+
+### Features
+
+* remove legacy update logic ([#314](https://github.com/oclif/plugin-update/issues/314)) ([5241c20](https://github.com/oclif/plugin-update/commit/5241c20dc4eea215bfdedfccecc2e4acf3d3465b))
+
 ## [1.5.0](https://github.com/oclif/plugin-update/compare/v1.4.0...v1.5.0) (2021-08-05)
 
 ## [1.4.0](https://github.com/oclif/plugin-update/compare/v1.4.0-3...v1.4.0) (2021-08-05)

package/README.md

@@ -2,10 +2,10 @@
 ====================
 
 [![Version](https://img.shields.io/npm/v/@oclif/plugin-update.svg)](https://npmjs.org/package/@oclif/plugin-update)
-[![CircleCI](https://circleci.com/gh/oclif/plugin-update/tree/master.svg?style=shield)](https://circleci.com/gh/oclif/plugin-update/tree/master)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-update?branch=master&svg=true)](https://ci.appveyor.com/project/oclif/plugin-update/branch/master)
+[![CircleCI](https://circleci.com/gh/oclif/plugin-update/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/plugin-update/tree/main)
+[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/plugin-update?branch=main&svg=true)](https://ci.appveyor.com/project/oclif/plugin-update/branch/main)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/plugin-update.svg)](https://npmjs.org/package/@oclif/plugin-update)
-[![License](https://img.shields.io/npm/l/@oclif/plugin-update.svg)](https://github.com/oclif/plugin-update/blob/master/package.json)
+[![License](https://img.shields.io/npm/l/@oclif/plugin-update.svg)](https://github.com/oclif/plugin-update/blob/main/package.json)
 
 <!-- toc -->
 * [Usage](#usage)
@@ -33,5 +33,5 @@ DESCRIPTION
   update the oclif-example CLI
 ```
 
-_See code: [src/commands/update.ts](https://github.com/oclif/plugin-update/blob/v2.0.0/src/commands/update.ts)_
+_See code: [src/commands/update.ts](https://github.com/oclif/plugin-update/blob/v2.1.3/src/commands/update.ts)_
 <!-- commandsstop -->

package/lib/commands/update.d.ts

@@ -9,28 +9,8 @@ export default class UpdateCommand extends Command {
         autoupdate: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'from-local': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
-    private autoupdate;
     private channel;
-    private currentVersion?;
-    private updatedVersion;
     private readonly clientRoot;
     private readonly clientBin;
     run(): Promise<void>;
-    private fetchManifest;
-    private downloadAndExtract;
-    private update;
-    private updateToExistingVersion;
-    private skipUpdate;
-    private determineChannel;
-    private determineCurrentVersion;
-    private s3ChannelManifestKey;
-    private setChannel;
-    private logChop;
-    private mtime;
-    private debounce;
-    private tidy;
-    private touch;
-    private reexec;
-    private createBin;
-    private ensureClientDir;
 }

package/lib/commands/update.js

@@ -1,14 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const color_1 = require("@oclif/color");
 const core_1 = require("@oclif/core");
 const cli_ux_1 = require("cli-ux");
-const spawn = require("cross-spawn");
-const fs = require("fs-extra");
-const _ = require("lodash");
 const path = require("path");
-const tar_1 = require("../tar");
-const util_1 = require("../util");
+const update_1 = require("../update");
+async function getPinToVersion() {
+    return cli_ux_1.default.prompt('Enter a version to update to');
+}
 class UpdateCommand extends core_1.Command {
     constructor() {
         super(...arguments);
@@ -17,334 +15,8 @@ class UpdateCommand extends core_1.Command {
     }
     async run() {
         const { args, flags } = await this.parse(UpdateCommand);
-        this.autoupdate = Boolean(flags.autoupdate);
-        if (this.autoupdate)
-            await this.debounce();
-        this.channel = args.channel || await this.determineChannel();
-        if (flags['from-local']) {
-            await this.ensureClientDir();
-            this.debug(`Looking for locally installed versions at ${this.clientRoot}`);
-            // Do not show known non-local version folder names, bin and current.
-            const versions = fs.readdirSync(this.clientRoot).filter(dirOrFile => dirOrFile !== 'bin' && dirOrFile !== 'current');
-            if (versions.length === 0)
-                throw new Error('No locally installed versions found.');
-            this.log(`Found versions: \n${versions.map(version => `     ${version}`).join('\n')}\n`);
-            const pinToVersion = await cli_ux_1.default.prompt('Enter a version to update to');
-            if (!versions.includes(pinToVersion))
-                throw new Error(`Version ${pinToVersion} not found in the locally installed versions.`);
-            if (!await fs.pathExists(path.join(this.clientRoot, pinToVersion))) {
-                throw new Error(`Version ${pinToVersion} is not already installed at ${this.clientRoot}.`);
-            }
-            cli_ux_1.default.action.start(`${this.config.name}: Updating CLI`);
-            this.debug(`switching to existing version ${pinToVersion}`);
-            this.updateToExistingVersion(pinToVersion);
-            this.log();
-            this.log(`Updating to an already installed version will not update the channel. If autoupdate is enabled, the CLI will eventually be updated back to ${this.channel}.`);
-        }
-        else {
-            cli_ux_1.default.action.start(`${this.config.name}: Updating CLI`);
-            await this.config.runHook('preupdate', { channel: this.channel });
-            const manifest = await this.fetchManifest();
-            this.currentVersion = await this.determineCurrentVersion();
-            this.updatedVersion = manifest.sha ? `${manifest.version}-${manifest.sha}` : manifest.version;
-            const reason = await this.skipUpdate();
-            if (reason)
-                cli_ux_1.default.action.stop(reason || 'done');
-            else
-                await this.update(manifest);
-            this.debug('tidy');
-            await this.tidy();
-            await this.config.runHook('update', { channel: this.channel });
-        }
-        this.debug('done');
-        cli_ux_1.default.action.stop();
-    }
-    async fetchManifest() {
-        const http = require('http-call').HTTP;
-        cli_ux_1.default.action.status = 'fetching manifest';
-        if (!this.config.scopedEnvVarTrue('USE_LEGACY_UPDATE')) {
-            try {
-                const newManifestUrl = this.config.s3Url(this.s3ChannelManifestKey(this.config.bin, this.config.platform, this.config.arch, this.config.pjson.oclif.update.s3.folder));
-                const { body } = await http.get(newManifestUrl);
-                if (typeof body === 'string') {
-                    return JSON.parse(body);
-                }
-                return body;
-            }
-            catch (error) {
-                this.debug(error.message);
-            }
-        }
-        try {
-            const url = this.config.s3Url(this.config.s3Key('manifest', {
-                channel: this.channel,
-                platform: this.config.platform,
-                arch: this.config.arch,
-            }));
-            const { body } = await http.get(url);
-            // in case the content-type is not set, parse as a string
-            // this will happen if uploading without `oclif-dev publish`
-            if (typeof body === 'string') {
-                return JSON.parse(body);
-            }
-            return body;
-        }
-        catch (error) {
-            if (error.statusCode === 403)
-                throw new Error(`HTTP 403: Invalid channel ${this.channel}`);
-            throw error;
-        }
-    }
-    async downloadAndExtract(output, manifest, channel) {
-        const { version } = manifest;
-        const filesize = (n) => {
-            const [num, suffix] = require('filesize')(n, { output: 'array' });
-            return num.toFixed(1) + ` ${suffix}`;
-        };
-        const http = require('http-call').HTTP;
-        const gzUrl = manifest.gz || this.config.s3Url(this.config.s3Key('versioned', {
-            version,
-            channel,
-            bin: this.config.bin,
-            platform: this.config.platform,
-            arch: this.config.arch,
-            ext: 'gz',
-        }));
-        const { response: stream } = await http.stream(gzUrl);
-        stream.pause();
-        const baseDir = manifest.baseDir || this.config.s3Key('baseDir', {
-            version,
-            channel,
-            bin: this.config.bin,
-            platform: this.config.platform,
-            arch: this.config.arch,
-        });
-        const extraction = (0, tar_1.extract)(stream, baseDir, output, manifest.sha256gz);
-        // to-do: use cli.action.type
-        if (cli_ux_1.default.action.frames) {
-            // if spinner action
-            const total = parseInt(stream.headers['content-length'], 10);
-            let current = 0;
-            const updateStatus = _.throttle((newStatus) => {
-                cli_ux_1.default.action.status = newStatus;
-            }, 250, { leading: true, trailing: false });
-            stream.on('data', data => {
-                current += data.length;
-                updateStatus(`${filesize(current)}/${filesize(total)}`);
-            });
-        }
-        stream.resume();
-        await extraction;
-    }
-    async update(manifest, channel = 'stable') {
-        const { channel: manifestChannel } = manifest;
-        if (manifestChannel)
-            channel = manifestChannel;
-        cli_ux_1.default.action.start(`${this.config.name}: Updating CLI from ${color_1.default.green(this.currentVersion)} to ${color_1.default.green(this.updatedVersion)}${channel === 'stable' ? '' : ' (' + color_1.default.yellow(channel) + ')'}`);
-        await this.ensureClientDir();
-        const output = path.join(this.clientRoot, this.updatedVersion);
-        if (!await fs.pathExists(output)) {
-            await this.downloadAndExtract(output, manifest, channel);
-        }
-        await this.setChannel();
-        await this.createBin(this.updatedVersion);
-        await this.touch();
-        await this.reexec();
-    }
-    async updateToExistingVersion(version) {
-        await this.createBin(version);
-        await this.touch();
-    }
-    async skipUpdate() {
-        if (!this.config.binPath) {
-            const instructions = this.config.scopedEnvVar('UPDATE_INSTRUCTIONS');
-            if (instructions)
-                this.warn(instructions);
-            return 'not updatable';
-        }
-        if (this.currentVersion === this.updatedVersion) {
-            if (this.config.scopedEnvVar('HIDE_UPDATED_MESSAGE'))
-                return 'done';
-            return `already on latest version: ${this.currentVersion}`;
-        }
-        return false;
-    }
-    async determineChannel() {
-        const channelPath = path.join(this.config.dataDir, 'channel');
-        if (fs.existsSync(channelPath)) {
-            const channel = await fs.readFile(channelPath, 'utf8');
-            return String(channel).trim();
-        }
-        return this.config.channel || 'stable';
-    }
-    async determineCurrentVersion() {
-        try {
-            const currentVersion = await fs.readFile(this.clientBin, 'utf8');
-            const matches = currentVersion.match(/\.\.[/|\\](.+)[/|\\]bin/);
-            return matches ? matches[1] : this.config.version;
-        }
-        catch (error) {
-            this.debug(error);
-        }
-        return this.config.version;
-    }
-    s3ChannelManifestKey(bin, platform, arch, folder) {
-        let s3SubDir = folder || '';
-        if (s3SubDir !== '' && s3SubDir.slice(-1) !== '/')
-            s3SubDir = `${s3SubDir}/`;
-        return path.join(s3SubDir, 'channels', this.channel, `${bin}-${platform}-${arch}-buildmanifest`);
-    }
-    async setChannel() {
-        const channelPath = path.join(this.config.dataDir, 'channel');
-        fs.writeFile(channelPath, this.channel, 'utf8');
-    }
-    async logChop() {
-        try {
-            this.debug('log chop');
-            const logChopper = require('log-chopper').default;
-            await logChopper.chop(this.config.errlog);
-        }
-        catch (error) {
-            this.debug(error.message);
-        }
-    }
-    async mtime(f) {
-        const { mtime } = await fs.stat(f);
-        return mtime;
-    }
-    // when autoupdating, wait until the CLI isn't active
-    async debounce() {
-        let output = false;
-        const lastrunfile = path.join(this.config.cacheDir, 'lastrun');
-        const m = await this.mtime(lastrunfile);
-        m.setHours(m.getHours() + 1);
-        if (m > new Date()) {
-            const msg = `waiting until ${m.toISOString()} to update`;
-            if (output) {
-                this.debug(msg);
-            }
-            else {
-                await cli_ux_1.default.log(msg);
-                output = true;
-            }
-            await (0, util_1.wait)(60 * 1000); // wait 1 minute
-            return this.debounce();
-        }
-        cli_ux_1.default.log('time to update');
-    }
-    // removes any unused CLIs
-    async tidy() {
-        try {
-            const root = this.clientRoot;
-            if (!await fs.pathExists(root))
-                return;
-            const files = await (0, util_1.ls)(root);
-            const promises = files.map(async (f) => {
-                if (['bin', 'current', this.config.version].includes(path.basename(f.path)))
-                    return;
-                const mtime = f.stat.mtime;
-                mtime.setHours(mtime.getHours() + (42 * 24));
-                if (mtime < new Date()) {
-                    await fs.remove(f.path);
-                }
-            });
-            for (const p of promises)
-                await p; // eslint-disable-line no-await-in-loop
-            await this.logChop();
-        }
-        catch (error) {
-            cli_ux_1.default.warn(error);
-        }
-    }
-    async touch() {
-        // touch the client so it won't be tidied up right away
-        try {
-            const p = path.join(this.clientRoot, this.config.version);
-            this.debug('touching client at', p);
-            if (!await fs.pathExists(p))
-                return;
-            await fs.utimes(p, new Date(), new Date());
-        }
-        catch (error) {
-            this.warn(error);
-        }
-    }
-    async reexec() {
-        cli_ux_1.default.action.stop();
-        return new Promise((_, reject) => {
-            this.debug('restarting CLI after update', this.clientBin);
-            spawn(this.clientBin, ['update'], {
-                stdio: 'inherit',
-                env: Object.assign(Object.assign({}, process.env), { [this.config.scopedEnvVarKey('HIDE_UPDATED_MESSAGE')]: '1' }),
-            })
-                .on('error', reject)
-                .on('close', (status) => {
-                try {
-                    if (status > 0)
-                        this.exit(status);
-                }
-                catch (error) {
-                    reject(error);
-                }
-            });
-        });
-    }
-    async createBin(version) {
-        const dst = this.clientBin;
-        const { bin } = this.config;
-        const binPathEnvVar = this.config.scopedEnvVarKey('BINPATH');
-        const redirectedEnvVar = this.config.scopedEnvVarKey('REDIRECTED');
-        if (this.config.windows) {
-            const body = `@echo off
-setlocal enableextensions
-set ${redirectedEnvVar}=1
-set ${binPathEnvVar}=%~dp0${bin}
-"%~dp0..\\${version}\\bin\\${bin}.cmd" %*
-`;
-            await fs.outputFile(dst, body);
-        }
-        else {
-            /* eslint-disable no-useless-escape */
-            const body = `#!/usr/bin/env bash
-set -e
-get_script_dir () {
-  SOURCE="\${BASH_SOURCE[0]}"
-  # While $SOURCE is a symlink, resolve it
-  while [ -h "$SOURCE" ]; do
-    DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
-    SOURCE="$( readlink "$SOURCE" )"
-    # If $SOURCE was a relative symlink (so no "/" as prefix, need to resolve it relative to the symlink base directory
-    [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
-  done
-  DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
-  echo "$DIR"
-}
-DIR=$(get_script_dir)
-${binPathEnvVar}="\$DIR/${bin}" ${redirectedEnvVar}=1 "$DIR/../${version}/bin/${bin}" "$@"
-`;
-            /* eslint-enable no-useless-escape */
-            await fs.remove(dst);
-            await fs.outputFile(dst, body);
-            await fs.chmod(dst, 0o755);
-            await fs.remove(path.join(this.clientRoot, 'current'));
-            await fs.symlink(`./${version}`, path.join(this.clientRoot, 'current'));
-        }
-    }
-    async ensureClientDir() {
-        try {
-            await fs.mkdirp(this.clientRoot);
-        }
-        catch (error) {
-            if (error.code === 'EEXIST') {
-                // for some reason the client directory is sometimes a file
-                // if so, this happens. Delete it and recreate
-                await fs.remove(this.clientRoot);
-                await fs.mkdirp(this.clientRoot);
-            }
-            else {
-                throw error;
-            }
-        }
+        const updateCli = new update_1.default({ channel: args.channel, autoUpdate: flags.autoupdate, fromLocal: flags['from-local'], config: this.config, exit: this.exit, getPinToVersion: getPinToVersion });
+        return updateCli.runUpdate();
     }
 }
 exports.default = UpdateCommand;

package/lib/tar.js

@@ -5,6 +5,19 @@ const fs = require("fs-extra");
 const path = require("path");
 const util_1 = require("./util");
 const debug = require('debug')('oclif-update');
+const ignore = (_, header) => {
+    switch (header.type) {
+        case 'directory':
+        case 'file':
+            if (process.env.OCLIF_DEBUG_UPDATE_FILES)
+                debug(header.name);
+            return false;
+        case 'symlink':
+            return true;
+        default:
+            throw new Error(header.type);
+    }
+};
 async function extract(stream, basename, output, sha) {
     const getTmp = () => `${output}.partial.${Math.random().toString().split('.')[1].slice(0, 5)}`;
     let tmp = getTmp();
@@ -36,19 +49,6 @@ async function extract(stream, basename, output, sha) {
             }
             else
                 shaValidated = true;
-            const ignore = (_, header) => {
-                switch (header.type) {
-                    case 'directory':
-                    case 'file':
-                        if (process.env.OCLIF_DEBUG_UPDATE_FILES)
-                            debug(header.name);
-                        return false;
-                    case 'symlink':
-                        return true;
-                    default:
-                        throw new Error(header.type);
-                }
-            };
             const extract = tar.extract(tmp, { ignore });
             extract.on('error', reject);
             extract.on('finish', () => {

package/lib/update.d.ts

@@ -0,0 +1,36 @@
+import { Config } from '@oclif/core';
+export interface UpdateCliOptions {
+    channel?: string;
+    autoUpdate: boolean;
+    fromLocal: boolean;
+    config: Config;
+    exit: any;
+    getPinToVersion: () => Promise<string>;
+}
+export default class UpdateCli {
+    private options;
+    private channel;
+    private currentVersion?;
+    private updatedVersion;
+    private readonly clientRoot;
+    private readonly clientBin;
+    constructor(options: UpdateCliOptions);
+    runUpdate(): Promise<void>;
+    private fetchManifest;
+    private downloadAndExtract;
+    private update;
+    private updateToExistingVersion;
+    private skipUpdate;
+    private determineChannel;
+    private determineCurrentVersion;
+    private s3ChannelManifestKey;
+    private setChannel;
+    private logChop;
+    private mtime;
+    private debounce;
+    private tidy;
+    private touch;
+    private reexec;
+    private createBin;
+    private ensureClientDir;
+}

package/lib/update.js

@@ -0,0 +1,331 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const color_1 = require("@oclif/color");
+const cli_ux_1 = require("cli-ux");
+const spawn = require("cross-spawn");
+const fs = require("fs-extra");
+const _ = require("lodash");
+const path = require("path");
+const tar_1 = require("./tar");
+const util_1 = require("./util");
+class UpdateCli {
+    constructor(options) {
+        this.options = options;
+        this.clientRoot = this.options.config.scopedEnvVar('OCLIF_CLIENT_HOME') || path.join(this.options.config.dataDir, 'client');
+        this.clientBin = path.join(this.clientRoot, 'bin', this.options.config.windows ? `${this.options.config.bin}.cmd` : this.options.config.bin);
+    }
+    async runUpdate() {
+        if (this.options.autoUpdate)
+            await this.debounce();
+        this.channel = this.options.channel || await this.determineChannel();
+        if (this.options.fromLocal) {
+            await this.ensureClientDir();
+            cli_ux_1.default.debug(`Looking for locally installed versions at ${this.clientRoot}`);
+            // Do not show known non-local version folder names, bin and current.
+            const versions = fs.readdirSync(this.clientRoot).filter(dirOrFile => dirOrFile !== 'bin' && dirOrFile !== 'current');
+            if (versions.length === 0)
+                throw new Error('No locally installed versions found.');
+            cli_ux_1.default.log(`Found versions: \n${versions.map(version => `     ${version}`).join('\n')}\n`);
+            const pinToVersion = await this.options.getPinToVersion();
+            if (!versions.includes(pinToVersion))
+                throw new Error(`Version ${pinToVersion} not found in the locally installed versions.`);
+            if (!await fs.pathExists(path.join(this.clientRoot, pinToVersion))) {
+                throw new Error(`Version ${pinToVersion} is not already installed at ${this.clientRoot}.`);
+            }
+            cli_ux_1.default.action.start(`${this.options.config.name}: Updating CLI`);
+            cli_ux_1.default.debug(`switching to existing version ${pinToVersion}`);
+            this.updateToExistingVersion(pinToVersion);
+            cli_ux_1.default.log();
+            cli_ux_1.default.log(`Updating to an already installed version will not update the channel. If autoupdate is enabled, the CLI will eventually be updated back to ${this.channel}.`);
+        }
+        else {
+            cli_ux_1.default.action.start(`${this.options.config.name}: Updating CLI`);
+            await this.options.config.runHook('preupdate', { channel: this.channel });
+            const manifest = await this.fetchManifest();
+            this.currentVersion = await this.determineCurrentVersion();
+            this.updatedVersion = manifest.sha ? `${manifest.version}-${manifest.sha}` : manifest.version;
+            const reason = await this.skipUpdate();
+            if (reason)
+                cli_ux_1.default.action.stop(reason || 'done');
+            else
+                await this.update(manifest);
+            cli_ux_1.default.debug('tidy');
+            await this.tidy();
+            await this.options.config.runHook('update', { channel: this.channel });
+        }
+        cli_ux_1.default.debug('done');
+        cli_ux_1.default.action.stop();
+    }
+    async fetchManifest() {
+        const http = require('http-call').HTTP;
+        cli_ux_1.default.action.status = 'fetching manifest';
+        try {
+            const url = this.options.config.s3Url(this.options.config.s3Key('manifest', {
+                channel: this.channel,
+                platform: this.options.config.platform,
+                arch: this.options.config.arch,
+            }));
+            const { body } = await http.get(url);
+            // in case the content-type is not set, parse as a string
+            // this will happen if uploading without `oclif-dev publish`
+            if (typeof body === 'string') {
+                return JSON.parse(body);
+            }
+            return body;
+        }
+        catch (error) {
+            if (error.statusCode === 403)
+                throw new Error(`HTTP 403: Invalid channel ${this.channel}`);
+            throw error;
+        }
+    }
+    async downloadAndExtract(output, manifest, channel) {
+        const { version, gz, sha256gz } = manifest;
+        const filesize = (n) => {
+            const [num, suffix] = require('filesize')(n, { output: 'array' });
+            return num.toFixed(1) + ` ${suffix}`;
+        };
+        const http = require('http-call').HTTP;
+        const gzUrl = gz || this.options.config.s3Url(this.options.config.s3Key('versioned', {
+            version,
+            channel,
+            bin: this.options.config.bin,
+            platform: this.options.config.platform,
+            arch: this.options.config.arch,
+            ext: 'gz',
+        }));
+        const { response: stream } = await http.stream(gzUrl);
+        stream.pause();
+        const baseDir = manifest.baseDir || this.options.config.s3Key('baseDir', {
+            version,
+            channel,
+            bin: this.options.config.bin,
+            platform: this.options.config.platform,
+            arch: this.options.config.arch,
+        });
+        const extraction = (0, tar_1.extract)(stream, baseDir, output, sha256gz);
+        // to-do: use cli.action.type
+        if (cli_ux_1.default.action.frames) {
+            // if spinner action
+            const total = Number.parseInt(stream.headers['content-length'], 10);
+            let current = 0;
+            const updateStatus = _.throttle((newStatus) => {
+                cli_ux_1.default.action.status = newStatus;
+            }, 250, { leading: true, trailing: false });
+            stream.on('data', data => {
+                current += data.length;
+                updateStatus(`${filesize(current)}/${filesize(total)}`);
+            });
+        }
+        stream.resume();
+        await extraction;
+    }
+    async update(manifest, channel = 'stable') {
+        cli_ux_1.default.action.start(`${this.options.config.name}: Updating CLI from ${color_1.default.green(this.currentVersion)} to ${color_1.default.green(this.updatedVersion)}${channel === 'stable' ? '' : ' (' + color_1.default.yellow(channel) + ')'}`);
+        await this.ensureClientDir();
+        const output = path.join(this.clientRoot, this.updatedVersion);
+        if (!await fs.pathExists(output)) {
+            await this.downloadAndExtract(output, manifest, channel);
+        }
+        await this.setChannel();
+        await this.createBin(this.updatedVersion);
+        await this.touch();
+        await this.reexec();
+    }
+    async updateToExistingVersion(version) {
+        await this.createBin(version);
+        await this.touch();
+    }
+    async skipUpdate() {
+        if (!this.options.config.binPath) {
+            const instructions = this.options.config.scopedEnvVar('UPDATE_INSTRUCTIONS');
+            if (instructions)
+                cli_ux_1.default.warn(instructions);
+            return 'not updatable';
+        }
+        if (this.currentVersion === this.updatedVersion) {
+            if (this.options.config.scopedEnvVar('HIDE_UPDATED_MESSAGE'))
+                return 'done';
+            return `already on latest version: ${this.currentVersion}`;
+        }
+        return false;
+    }
+    async determineChannel() {
+        const channelPath = path.join(this.options.config.dataDir, 'channel');
+        if (fs.existsSync(channelPath)) {
+            const channel = await fs.readFile(channelPath, 'utf8');
+            return String(channel).trim();
+        }
+        return this.options.config.channel || 'stable';
+    }
+    async determineCurrentVersion() {
+        try {
+            const currentVersion = await fs.readFile(this.clientBin, 'utf8');
+            const matches = currentVersion.match(/\.\.[/\\|](.+)[/\\|]bin/);
+            return matches ? matches[1] : this.options.config.version;
+        }
+        catch (error) {
+            cli_ux_1.default.debug(error);
+        }
+        return this.options.config.version;
+    }
+    s3ChannelManifestKey(bin, platform, arch, folder = '') {
+        let s3SubDir = folder || '';
+        if (s3SubDir !== '' && s3SubDir.slice(-1) !== '/')
+            s3SubDir = `${s3SubDir}/`;
+        return path.join(s3SubDir, 'channels', this.channel, `${bin}-${platform}-${arch}-buildmanifest`);
+    }
+    async setChannel() {
+        const channelPath = path.join(this.options.config.dataDir, 'channel');
+        fs.writeFile(channelPath, this.channel, 'utf8');
+    }
+    async logChop() {
+        try {
+            cli_ux_1.default.debug('log chop');
+            const logChopper = require('log-chopper').default;
+            await logChopper.chop(this.options.config.errlog);
+        }
+        catch (error) {
+            cli_ux_1.default.debug(error.message);
+        }
+    }
+    async mtime(f) {
+        const { mtime } = await fs.stat(f);
+        return mtime;
+    }
+    // when autoupdating, wait until the CLI isn't active
+    async debounce() {
+        let output = false;
+        const lastrunfile = path.join(this.options.config.cacheDir, 'lastrun');
+        const m = await this.mtime(lastrunfile);
+        m.setHours(m.getHours() + 1);
+        if (m > new Date()) {
+            const msg = `waiting until ${m.toISOString()} to update`;
+            if (output) {
+                cli_ux_1.default.debug(msg);
+            }
+            else {
+                await cli_ux_1.default.log(msg);
+                output = true;
+            }
+            await (0, util_1.wait)(60 * 1000); // wait 1 minute
+            return this.debounce();
+        }
+        cli_ux_1.default.log('time to update');
+    }
+    // removes any unused CLIs
+    async tidy() {
+        try {
+            const root = this.clientRoot;
+            if (!await fs.pathExists(root))
+                return;
+            const files = await (0, util_1.ls)(root);
+            const promises = files.map(async (f) => {
+                if (['bin', 'current', this.options.config.version].includes(path.basename(f.path)))
+                    return;
+                const mtime = f.stat.mtime;
+                mtime.setHours(mtime.getHours() + (42 * 24));
+                if (mtime < new Date()) {
+                    await fs.remove(f.path);
+                }
+            });
+            for (const p of promises)
+                await p; // eslint-disable-line no-await-in-loop
+            await this.logChop();
+        }
+        catch (error) {
+            cli_ux_1.default.warn(error);
+        }
+    }
+    async touch() {
+        // touch the client so it won't be tidied up right away
+        try {
+            const p = path.join(this.clientRoot, this.options.config.version);
+            cli_ux_1.default.debug('touching client at', p);
+            if (!await fs.pathExists(p))
+                return;
+            await fs.utimes(p, new Date(), new Date());
+        }
+        catch (error) {
+            cli_ux_1.default.warn(error);
+        }
+    }
+    async reexec() {
+        cli_ux_1.default.action.stop();
+        return new Promise((_, reject) => {
+            cli_ux_1.default.debug('restarting CLI after update', this.clientBin);
+            spawn(this.clientBin, ['update'], {
+                stdio: 'inherit',
+                env: Object.assign(Object.assign({}, process.env), { [this.options.config.scopedEnvVarKey('HIDE_UPDATED_MESSAGE')]: '1' }),
+            })
+                .on('error', reject)
+                .on('close', (status) => {
+                try {
+                    if (status > 0)
+                        this.options.exit(status);
+                }
+                catch (error) {
+                    reject(error);
+                }
+            });
+        });
+    }
+    async createBin(version) {
+        const dst = this.clientBin;
+        const { bin, windows } = this.options.config;
+        const binPathEnvVar = this.options.config.scopedEnvVarKey('BINPATH');
+        const redirectedEnvVar = this.options.config.scopedEnvVarKey('REDIRECTED');
+        if (windows) {
+            const body = `@echo off
+setlocal enableextensions
+set ${redirectedEnvVar}=1
+set ${binPathEnvVar}=%~dp0${bin}
+"%~dp0..\\${version}\\bin\\${bin}.cmd" %*
+`;
+            await fs.outputFile(dst, body);
+        }
+        else {
+            /* eslint-disable no-useless-escape */
+            const body = `#!/usr/bin/env bash
+set -e
+get_script_dir () {
+  SOURCE="\${BASH_SOURCE[0]}"
+  # While $SOURCE is a symlink, resolve it
+  while [ -h "$SOURCE" ]; do
+    DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
+    SOURCE="$( readlink "$SOURCE" )"
+    # If $SOURCE was a relative symlink (so no "/" as prefix, need to resolve it relative to the symlink base directory
+    [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE"
+  done
+  DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
+  echo "$DIR"
+}
+DIR=$(get_script_dir)
+${binPathEnvVar}="\$DIR/${bin}" ${redirectedEnvVar}=1 "$DIR/../${version}/bin/${bin}" "$@"
+`;
+            /* eslint-enable no-useless-escape */
+            await fs.remove(dst);
+            await fs.outputFile(dst, body);
+            await fs.chmod(dst, 0o755);
+            await fs.remove(path.join(this.clientRoot, 'current'));
+            await fs.symlink(`./${version}`, path.join(this.clientRoot, 'current'));
+        }
+    }
+    async ensureClientDir() {
+        try {
+            await fs.mkdirp(this.clientRoot);
+        }
+        catch (error) {
+            if (error.code === 'EEXIST') {
+                // for some reason the client directory is sometimes a file
+                // if so, this happens. Delete it and recreate
+                await fs.remove(this.clientRoot);
+                await fs.mkdirp(this.clientRoot);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+}
+exports.default = UpdateCli;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.0.0","commands":{"update":{"id":"update","description":"update the <%= config.bin %> CLI","strict":true,"pluginName":"@oclif/plugin-update","pluginAlias":"@oclif/plugin-update","pluginType":"core","aliases":[],"flags":{"autoupdate":{"name":"autoupdate","type":"boolean","hidden":true,"allowNo":false},"from-local":{"name":"from-local","type":"boolean","description":"interactively choose an already installed version","allowNo":false}},"args":[{"name":"channel"}]}}}
+{"version":"2.1.3","commands":{"update":{"id":"update","description":"update the <%= config.bin %> CLI","strict":true,"pluginName":"@oclif/plugin-update","pluginAlias":"@oclif/plugin-update","pluginType":"core","aliases":[],"flags":{"autoupdate":{"name":"autoupdate","type":"boolean","hidden":true,"allowNo":false},"from-local":{"name":"from-local","type":"boolean","description":"interactively choose an already installed version","allowNo":false}},"args":[{"name":"channel"}]}}}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@oclif/plugin-update",
-  "version": "2.0.0",
-  "author": "Jeff Dickey @jdxcode",
+  "version": "2.1.3",
+  "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-update/issues",
   "dependencies": {
-    "@oclif/color": "^0.1.0",
-    "@oclif/core": "^0.5.39",
+    "@oclif/color": "^1.0.0",
+    "@oclif/core": "1.0.10",
     "@types/semver": "^7.3.4",
-    "cli-ux": "^5.5.1",
+    "cli-ux": "6.0.6",
     "cross-spawn": "^7.0.3",
     "debug": "^4.3.1",
     "filesize": "^6.1.0",
@@ -19,27 +19,28 @@
     "tar-fs": "^2.1.1"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.26.0",
-    "@oclif/plugin-help": "^5.1.0",
-    "@oclif/test": "^1.2.8",
+    "@oclif/plugin-help": "5.1.9",
+    "@oclif/test": "^2.0.2",
     "@types/chai": "^4.2.15",
     "@types/cross-spawn": "^6.0.2",
     "@types/execa": "^0.9.0",
     "@types/fs-extra": "^8.0.1",
     "@types/glob": "^7.1.3",
     "@types/lodash": "^4.14.168",
-    "@types/mocha": "^8.2.2",
+    "@types/mocha": "^9",
     "@types/node": "^14.14.31",
     "@types/supports-color": "^7.2.0",
     "@types/write-json-file": "^3.2.1",
     "chai": "^4.3.4",
-    "eslint": "^7.21.0",
-    "eslint-config-oclif": "^3.1.0",
-    "eslint-config-oclif-typescript": "^0.2.0",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.2",
     "globby": "^11.0.2",
-    "mocha": "^8.3.2",
-    "oclif": "^2.0.0-main.5",
+    "mocha": "^9",
+    "nock": "^13.2.1",
+    "oclif": "2.0.0-main.19",
     "qqjs": "^0.3.11",
+    "sinon": "^12.0.1",
     "ts-node": "^9.1.1",
     "tslib": "^2.1.0",
     "typescript": "4.4.3"