feat!: ESM + Node 18 by mdonnalley · Pull Request #643 · oclif/plugin-update

mdonnalley · 2023-10-06T19:41:25Z

Migrate to ESM
Node 18 minimum
Repo clean up (prettier, linting, etc...)
Adds integration test

@W-14259714@

Closes #610

BREAKING CHANGES: node 18 minimum, ESM exports

git2gus · 2023-10-09T15:24:12Z

This issue has been linked to a new work item: W-14259714

mshanemc · 2023-10-09T21:29:01Z

-    "@oclif/core": "^2.11.8",
-    "chalk": "^4",
+    "@oclif/core": "^3.0.3",
+    "chalk": "^5",


any interesting learnings from the chalk/inquirer changes?

mshanemc · 2023-10-09T21:40:41Z

-  const clientRoot = this.config.scopedEnvVar('OCLIF_CLIENT_HOME') || path.join(this.config.dataDir, 'client')
+
+  const {config, error: throwError} = this
+  const binPath = config.binPath || config.bin


can this go into the eslint rules.

Suggested change

const binPath = config.binPath || config.bin

const binPath = config.binPath ?? config.bin

mshanemc · 2023-10-09T21:42:04Z

    } catch (error: any) {
-      if (error.code !== 'ENOENT') ux.error(error.stack)
+      if (error.code !== 'ENOENT') throwError(error.stack)
      if ((global as any).testing) return false


where's the global and how is it being set? And is there a cleaner way to do this?

I'll just remove it - I'm assuming it was added at some point for testing but I don't see anything setting it anymore

mshanemc · 2023-10-09T21:46:44Z

-const debug = require('debug')('oclif-update')
+import {touch} from './util.js'
+const debug = makeDebug('oclif-update')
+import crypto from 'node:crypto'


here's an example of a great place to defer via dynamic imports so that we only load crypto when it's needed (in extract when there is a sha

mshanemc · 2023-10-09T21:48:09Z

  constructor(private config: Config) {
-    this.clientRoot = config.scopedEnvVar('OCLIF_CLIENT_HOME') || path.join(config.dataDir, 'client')
-    this.clientBin = path.join(this.clientRoot, 'bin', config.windows ? `${config.bin}.cmd` : config.bin)
+    this.clientRoot = config.scopedEnvVar('OCLIF_CLIENT_HOME') || join(config.dataDir, 'client')


Suggested change

this.clientRoot = config.scopedEnvVar('OCLIF_CLIENT_HOME') || join(config.dataDir, 'client')

this.clientRoot = config.scopedEnvVar('OCLIF_CLIENT_HOME') ?? join(config.dataDir, 'client')

mshanemc · 2023-10-09T21:49:26Z

+      if (typeof body === 'string') {
+        return JSON.parse(body)
+      }
+
+      return body


Suggested change

if (typeof body === 'string') {

return JSON.parse(body)

}

return body

return typeof body === 'string' ? JSON.parse(body) : body

mshanemc · 2023-10-09T21:52:06Z

-        throw error
-      }
+    if (windows) {
+      const body = `@echo off


tidyness: put the shell scripts in separate files that export the value, and then import that?

mshanemc · 2023-10-09T21:57:46Z

+  let stableVersion: string
+  let sf: string
+
+  const versionToUpdateTo = '2.12.7-esm.0'


we'll have to be careful to keep this around forever?

I'll update it to always grab the version just before the current nightly, which will likely always exist

mshanemc · 2023-10-09T22:00:06Z

+  const tarball =
+    process.platform === 'win32'
+      ? `https://developer.salesforce.com/media/salesforce-cli/sf/channels/${channel}/sf-win32-x64.tar.gz`
+      : `https://developer.salesforce.com/media/salesforce-cli/sf/channels/${channel}/sf-linux-x64.tar.gz`


Suggested change

const tarball =

process.platform === 'win32'

? `https://developer.salesforce.com/media/salesforce-cli/sf/channels/${channel}/sf-win32-x64.tar.gz`

: `https://developer.salesforce.com/media/salesforce-cli/sf/channels/${channel}/sf-linux-x64.tar.gz`

const platform = process.platform === 'win32' ? 'win32' : 'linux'

const tarball = `https://developer.salesforce.com/media/salesforce-cli/sf/channels/${channel}/sf-${platform}-x64.tar.gz`

mshanemc · 2023-10-09T22:02:24Z

+    console.log('Success!')
+
+    console.log('Linking plugin-update...')
+    // Running `plugins link` is very slow on github-action's windows runners. Writing this file


will you change this since oclif/plugin-plugins#679 merged?

mshanemc · 2023-10-10T13:11:06Z

QA notes:

using @salesforce/cli/2.13.6 darwin-x64 node-v18.15.0 which is ESM, plus this plugin via plugins:link

❌ every command warns about the linked plugin. Seems fine, unless you run a command with --json at which point it's still showing in the terminal output instead of in json result.warnings.

 ›   Warning: @oclif/plugin-update is a linked ESM module and cannot be auto-transpiled. Existing compiled source will 
 ›   be used instead.

✅ sf update (no-op), then run some commands with that version

sf org list
sf org open -o [org]
sf data query -t -q "SELECT MemberType, MemberName, IsNameObsolete, RevisionCounter FROM SourceMember" -o[org]
sf data query -t -q "SELECT MemberType, MemberName, IsNameObsolete, RevisionCounter FROM SourceMember" -o[org] --json [this is where I found the json problem for linked esm plugins]

❌ sf update stable => @salesforce/cli: Updating CLI from 2.13.6-9ea464d to 2.11.8-c9872b8
Should I interpret this as, "you can't update the CLI below the ESM line?"

(node:22163) [ERR_UNKNOWN_FILE_EXTENSION] TypeError Plugin: @oclif/plugin-update [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for /Users/shane.mclaughlin/eng/oclif-repos/plugin-update/src/commands/update.ts
module: @oclif/core@2.15.0
task: toCached
plugin: @oclif/plugin-update
root: /Users/shane.mclaughlin/eng/oclif-repos/plugin-update
See more details with DEBUG=*
(Use `node --trace-warnings ...` to show where the warning was created)

✅ release notes happen as expected
❌ sf org list works, but with the same ERR_UNKNOWN_FILE_EXTENSION in the terminal output (it goes to stderr)

❌ now the user can't update back across the line to the esm version (because the update command isn't available)
➜ plugin-update git:(sm/qa-kit-esm) ✗ sf update nightly
(node:22764) [ERR_UNKNOWN_FILE_EXTENSION] TypeError Plugin: @oclif/plugin-update [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for /Users/shane.mclaughlin/eng/oclif-repos/plugin-update/src/commands/update.ts
module: @oclif/core@2.15.0
task: toCached
plugin: @oclif/plugin-update
root: /Users/shane.mclaughlin/eng/oclif-repos/plugin-update
See more details with DEBUG=*
(Use node --trace-warnings ... to show where the warning was created)
› Warning: update nightly is not a sf command.
Did you mean data query? [y/n]: ^C

got back to a good state by uninstalling the linked plugin.

mdonnalley · 2023-10-10T17:18:14Z

❌ every command warns about the linked plugin. Seems fine, unless you run a command with --json at which point it's still showing in the terminal output instead of in json result.warnings.

Confirmed that warning goes to stderr:

~/repos/oclif/plugin-update (mdonnalley/esm*) » sf version
 ›   Warning: @oclif/plugin-update is a linked ESM module and cannot be auto-transpiled. Existing compiled source will be used
 ›   instead.
@salesforce/cli/2.12.7-esm.0 darwin-arm64 node-v18.15.0

// silence stderr
~/repos/oclif/plugin-update (mdonnalley/esm*) » sf version 2> /dev/null
@salesforce/cli/2.12.7-esm.0 darwin-arm64 node-v18.15.0

// silence stdout
~/repos/oclif/plugin-update (mdonnalley/esm*) » sf version 1> /dev/null
 ›   Warning: @oclif/plugin-update is a linked ESM module and cannot be auto-transpiled. Existing compiled source will be used
 ›   instead.

mshanemc · 2023-10-12T14:46:05Z

since linked plugins are sketchy, QA round 2 will use an installed qa release `3.2.4-qa.0

sf update nightly

@salesforce/cli: Updating CLI from 2.13.8-01c9e90 to 2.14.0-6c406ae (nightly)... ⣾ 58.3 MB/58.8 MB

sf update stable (down below ESM line) 2.14.0-6c406ae to 2.12.9-007e29c
✅ works. shows RN as expected

sf update available does what you'd expect. That list is getting pretty large

downgrade a long way via --interactive

? Select a version to update to 2.2.0
@salesforce/cli: Updating CLI from 2.12.9-007e29c to 2.2.0-4aecedc... ⡿ 20.1 MB/63.1 MB

the old org list table is so ugly. Let's get back to nightly

✅ looks great. 🚢

Installed CLIs live in directories named "<version>-<sha>" (e.g. "1.2.3-abc1234"), but `this.config.version` is plain semver ("1.2.3"). Two guards meant to stop the running CLI from deleting itself both failed for sha-suffixed installs: - `tidy()`'s `isNotSpecial` used an exact-match `includes(version)` check, so "1.2.3-abc1234" was never recognized as the active version and lost its name-based protection. The `startsWith` guard that originally handled this (ca57247, oclif#621) was dropped in the ESM refactor (oclif#643); oclif#1290 later restored only the bin/current protection via the arg-swap fix, not the startsWith semantics. - `touch()` joined the bare `config.version`, producing a path that does not exist on disk, so it silently no-op'd and never refreshed the active dir's mtime. With both guards failing, once a CLI stayed on the latest version for 42+ days, `tidy()` deleted the directory the `current` symlink points to, leaving `current` dangling and the CLI broken. Restore the `startsWith` guard in `isNotSpecial` and resolve the real "<version>-<sha>" directory in `touch()` via a shared `resolveActiveDir` helper. Add regression tests covering both the tidy guard and the touch backstop for sha-suffixed installs. fixes: oclif#1361

Installed CLIs live in directories named "<version>-<sha>" (e.g. "1.2.3-abc1234"), but `this.config.version` is plain semver ("1.2.3"). Two guards meant to stop the running CLI from deleting itself both failed for sha-suffixed installs: - `tidy()`'s `isNotSpecial` used an exact-match `includes(version)` check, so "1.2.3-abc1234" was never recognized as the active version and lost its name-based protection. The `startsWith` guard that originally handled this (ca57247, #621) was dropped in the ESM refactor (#643); #1290 later restored only the bin/current protection via the arg-swap fix, not the startsWith semantics. - `touch()` joined the bare `config.version`, producing a path that does not exist on disk, so it silently no-op'd and never refreshed the active dir's mtime. With both guards failing, once a CLI stayed on the latest version for 42+ days, `tidy()` deleted the directory the `current` symlink points to, leaving `current` dangling and the CLI broken. Restore the `startsWith` guard in `isNotSpecial` and resolve the real "<version>-<sha>" directory in `touch()` via a shared `resolveActiveDir` helper. Add regression tests covering both the tidy guard and the touch backstop for sha-suffixed installs. fixes: #1361

mshanemc and others added 28 commits August 15, 2023 08:30

test: normal watcher

757da69

feat: standard fs in most places, node16

959dc93

ci: standardized actions

18dd545

refactor: ensure dst dir exists on windows

de690c8

chore(release): 4.0.1-qa.0 [skip ci]

76bf617

feat!: migrate to ESM

339c0fa

BREAKING CHANGES: node 18 minimum, ESM exports

chore: update deps

e28e018

chore: update deps and add configs

5ade863

chore: all the nice updates

9ef3e32

chore: update eslintignore

c7f6336

test: remove helper

c78862f

fix: use cp

d28a20f

chore: remove fs-extra

15cf4bf

test: sf integration

140561a

Merge branch 'main' into mdonnalley/esm

c77fa64

chore: increase timeout

d753a39

chore: use cross-spawn again

19a1277

fix: cross-spawn import

787cb53

test: avoid plugins link

9eccb68

test: use gz

22b354e

test: use .cmd on windows

3f8f23a

test: mixed up scripts

af4abb9

test: maybe it will pass on windows now

4bc1bd6

test: maybe it will pass on windows now

06b06e2

test: maybe it will pass on windows now

0ce44c8

test: maybe it will pass on windows now

81b3cdc

chore: clean up

43584ef

Merge branch 'main' into mdonnalley/esm

34e7e90

mdonnalley added the enhancement label Oct 9, 2023

fix: use latest eslint-config-oclif-typescript

84d12a3

mshanemc reviewed Oct 9, 2023

View reviewed changes

mshanemc mentioned this pull request Oct 9, 2023

feat: esm and cjs forcedotcom/kit#280

Closed

mdonnalley added 3 commits October 10, 2023 12:55

chore: code review

a884b36

chore: remove old badges

38b728e

chore: update dev scripts

28bd0f1

mshanemc previously approved these changes Oct 11, 2023

View reviewed changes

chore(release): 3.2.4-qa.0 [skip ci]

9c9253a

svc-cli-bot dismissed mshanemc’s stale review via 9c9253a October 12, 2023 14:35

mshanemc approved these changes Oct 12, 2023

View reviewed changes

mshanemc merged commit be87bf6 into main Oct 12, 2023

mshanemc deleted the mdonnalley/esm branch October 12, 2023 14:48

khaled4vokalz mentioned this pull request Jun 30, 2026

tidy() deletes the active version directory for sha-suffixed installs (<version>-<sha>), breaking the CLI #1361

Closed

khaled4vokalz mentioned this pull request Jun 30, 2026

fix: preserve sha-suffixed active version dir in tidy() #1362

Merged

	const binPath = config.binPath \|\| config.bin
	const binPath = config.binPath ?? config.bin

	this.clientRoot = config.scopedEnvVar('OCLIF_CLIENT_HOME') \|\| join(config.dataDir, 'client')
	this.clientRoot = config.scopedEnvVar('OCLIF_CLIENT_HOME') ?? join(config.dataDir, 'client')

Uh oh!

Conversation

mdonnalley commented Oct 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

git2gus Bot commented Oct 9, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mshanemc commented Oct 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mdonnalley commented Oct 10, 2023

Uh oh!

mshanemc commented Oct 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mdonnalley commented Oct 6, 2023 •

edited

Loading

mshanemc commented Oct 10, 2023 •

edited

Loading