[pull] master from amtrack:master

.github/workflows/default.yml

@@ -15,30 +15,30 @@ jobs:
   default:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .node-version
       - name: Install dependencies
         run: |
           yarn install
-          yarn global add sfdx-cli@7.172.0
+          yarn global add @salesforce/cli@${SF_CLI_VERSION:-"latest"}
       - name: Run unit tests
         run: yarn test
       - name: Authenticate DevHub and create scratch org
         env:
           SFDX_AUTH_URL_DEVHUB: ${{ secrets.SFDX_AUTH_URL_DEVHUB }}
         run: |
-          sfdx auth:sfdxurl:store -d -a devhub -f /dev/stdin <<< "${SFDX_AUTH_URL_DEVHUB}"
+          sf org login sfdx-url -d -a devhub -f <(echo "${SFDX_AUTH_URL_DEVHUB}")
           yarn develop
       - name: Run end-to-end tests
         run: yarn test:e2e
       - name: Delete scratch org
         if: always()
         run: |
-          sfdx force:org:delete -p
+          sf org delete scratch -p
       - name: Release package
         run: npx semantic-release
         env:

.github/workflows/preview.yml

@@ -7,27 +7,27 @@ jobs:
   default:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version-file: .node-version
       - name: Install dependencies
         run: |
           yarn install
-          yarn global add sfdx-cli@7.172.0
+          yarn global add @salesforce/cli@${SF_CLI_VERSION:-"latest"}
       - name: Run unit tests
         run: yarn test
       - name: Authenticate DevHub and create scratch org
         env:
           SFDX_AUTH_URL_DEVHUB: ${{ secrets.SFDX_AUTH_URL_DEVHUB }}
         run: |
-          sfdx auth:sfdxurl:store -d -a devhub -f /dev/stdin <<< "${SFDX_AUTH_URL_DEVHUB}"
-          yarn develop release=preview
+          sf org login sfdx-url -d -a devhub -f <(echo "${SFDX_AUTH_URL_DEVHUB}")
+          yarn develop --release preview
       - name: Run end-to-end tests
         run: yarn test:e2e
       - name: Delete scratch org
         if: always()
         run: |
-          sfdx force:org:delete -p
+          sf org delete scratch -p

.node-version

@@ -1 +1 @@
-18
+20

CONTRIBUTING.md

@@ -50,9 +50,9 @@ Bravo 👏, you have just generated a working browserforce plugin!
 Create a scratch org and try it yourself:
 
 ```console
-sfdx force:org:create -f config/project-scratch-def.json -a browserforce-dev -s
-BROWSER_DEBUG=true ./bin/run browserforce:apply -f src/plugins/admins-can-log-in-as-any-user/enable.json -u browserforce-dev
-BROWSER_DEBUG=true ./bin/run browserforce:apply -f src/plugins/admins-can-log-in-as-any-user/disable.json -u browserforce-dev
+sf org create scratch -f config/project-scratch-def.json -a browserforce-dev -d
+BROWSER_DEBUG=true ./bin/run browserforce apply -f src/plugins/admins-can-log-in-as-any-user/enable.json -u browserforce-dev
+BROWSER_DEBUG=true ./bin/run browserforce apply -f src/plugins/admins-can-log-in-as-any-user/disable.json -u browserforce-dev
 ```
 
 Now it's your turn!
@@ -115,7 +115,7 @@ This allows to run multiple actions (from multiple plugins) using a single confi
 
 #### Implementation (`index.ts`)
 
-Plugins are written in [Typescript](https://www.typescriptlang.org), just like `sfdx` and most of the available sfdx plugins.
+Plugins are written in [Typescript](https://www.typescriptlang.org), just like `sf` and most of the available sf plugins.
 
 [Puppeteer](https://pptr.dev) is being used as a library for browser automation.
 If you need more inspiration regarding Puppeteer, checkout [this curated list](https://github.com/transitive-bullshit/awesome-puppeteer) of awesome Puppeteer resources.
@@ -167,7 +167,7 @@ To run the **end to end tests**, you might want to create a new **default scratc
 > Note: Your default scratch org will be used in the tests!
 
 ```console
-sfdx force:org:create -f config/project-scratch-def.json --setdefaultusername
+sf org create scratch -f config/project-scratch-def.json -d
 ```
 
 ```console

README.md

@@ -5,22 +5,22 @@
 [![Actions Status](https://github.com/amtrack/sfdx-browserforce-plugin/workflows/Test%20and%20Release/badge.svg)](https://github.com/amtrack/sfdx-browserforce-plugin/actions)
 
 Unlike the [Scratch Org Definition Configuration](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm) which can only be used **on the creation of a scratch org** (`sfdx force:org:create -f config/scratch-def.json`),
-the _Browserforce Configuration_ allows to "shape" **any org**, (e.g. scratch org, sandbox or production org) with **similar preferences and unofficial preferences** that are not (yet) available in the _Scratch Org Definition Configuration_ or as _Metadata_ (`sfdx browserforce:apply -f config/setup-admin-login-as-any.json -u [email protected]`).
+the _Browserforce Configuration_ allows to "shape" **any org**, (e.g. scratch org, sandbox or production org) with **similar preferences and unofficial preferences** that are not (yet) available in the _Scratch Org Definition Configuration_ or as _Metadata_ (`sf browserforce apply -f config/setup-admin-login-as-any.json -u [email protected]`).
 
 Further benefits:
 
 - comfortable configuration using JSON Schema (similar to the [Scratch Org Definition Configuration](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm))
 - idempotency of the `apply` command only applies what's necessary and allows re-execution (concept similar to [terraform](https://www.terraform.io/docs/commands/apply.html))
-- browser automation powered by [Puppeteer](https://github.com/GoogleChrome/puppeteer) (Chromium)
+- browser automation powered by Puppeteer and "Chrome for Testing", [learn more about Puppeteer and Browserforce](#puppeteer)
 - implement your own custom preferences (a.k.a. plugins; to be improved)
 
 # Installation
 
 There are several different methods to install `sfdx-browserforce-plugin`:
 
 ```console
-# as an sfdx plugin globally
-sfdx plugins:install sfdx-browserforce-plugin
+# as an sf plugin globally
+sf plugins install sfdx-browserforce-plugin
 
 # or standalone globally
 npm install --global sfdx-browserforce-plugin
@@ -34,8 +34,8 @@ npm install --save-dev sfdx-browserforce-plugin
 Depending on your choice of installation, you can find the `browserforce` namespace:
 
 ```console
-# globally in the sfdx cli
-sfdx browserforce
+# globally in the sf cli
+sf browserforce
 
 # globally in the sfdx-browserforce-plugin executable
 sfdx-browserforce-plugin browserforce
@@ -49,14 +49,14 @@ $ sfdx-browserforce browserforce -h
 browser automation
 
 USAGE
-  $ sfdx-browserforce-plugin browserforce:COMMAND
+  $ sfdx-browserforce-plugin browserforce COMMAND
 
 COMMANDS
-  browserforce:apply  apply a plan from a definition file
-  browserforce:plan   retrieve state and generate plan file
+  browserforce apply  apply a plan from a definition file
+  browserforce plan   retrieve state and generate plan file
 ```
 
-Both the `browserforce:apply` and `browserforce:plan` commands expect a config file and a target username or alias for the org.
+Both the `browserforce apply` and `browserforce plan` commands expect a config file and a target username or alias for the org.
 
 # Example
 
@@ -80,7 +80,7 @@ Tip: If you use _Visual Studio Code_, you can leverage tab completion to build t
 Next apply the config:
 
 ```console
-$ sfdx browserforce:apply -f ./config/setup-admin-login-as-any.json --targetusername [email protected]
+$ sf browserforce apply -f ./config/setup-admin-login-as-any.json --target-org [email protected]
   logging in... done
   Applying definition file ./config/setup-admin-login-as-any.json to org [email protected]
   [Security] retrieving state... done
@@ -162,6 +162,31 @@ Here is a full blown example showing most of the supported settings in action:
 - `BROWSERFORCE_RETRY_MAX_RETRIES`: number of retries on failures opening a page (default: `4`)
 - `BROWSERFORCE_RETRY_TIMEOUT_MS`: initial time between retries in exponential mode (default: `4000`)
 
+# Puppeteer
+
+We use [Puppeteer](https://github.com/puppeteer/puppeteer) for browser automation which comes with its own "Chrome for Testing" browser.
+
+The puppeteer [installation doc](https://github.com/puppeteer/puppeteer#installation) describes how this works:
+
+> When you install Puppeteer, it automatically downloads a recent version of
+> [Chrome for Testing](https://goo.gle/chrome-for-testing) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
+> work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
+> with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
+> by default (starting with Puppeteer v19.0.0).
+
+In most of the cases this just works! If you still want to skip the download and use another browser installation, you can do this as follows:
+
+```console
+export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
+sf plugins install sfdx-browserforce-plugin
+export PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser
+sf browserforce:apply ...
+```
+
+Troubleshooting:
+
+- The installation is triggered via the `postinstall` hook of npm/yarn. If you've disabled running scripts with npm (`--ignore-scripts` or via config file), it will not download the browser.
+
 # Contributing
 
 Please see [CONTRIBUTING.md](CONTRIBUTING.md) for getting started.

_templates/plugin/new/index.e2e-spec.ejs.t

@@ -2,59 +2,32 @@
 to: src/plugins/<%= h.changeCase.paramCase(name) %>/index.e2e-spec.ts
 ---
 import assert from 'assert';
-import * as child from 'child_process';
-import * as path from 'path';
-import { <%= h.changeCase.pascalCase(name) %> } from '.';
+import { type Config, <%= h.changeCase.pascalCase(name) %> } from '.';
 
 describe(<%= h.changeCase.pascalCase(name) %>.name, function() {
-  this.slow('30s');
-  this.timeout('2m');
-  it('should enable', () => {
-    const enableCmd = child.spawnSync(path.resolve('bin', 'run'), [
-      'browserforce:apply',
-      '-f',
-      path.resolve(path.join(__dirname, 'enable.json'))
-    ]);
-    assert.deepStrictEqual(enableCmd.status, 0, enableCmd.output.toString());
-    assert.ok(
-      /to 'true'/.test(enableCmd.output.toString()),
-      enableCmd.output.toString()
-    );
+  let plugin: <%= h.changeCase.pascalCase(name) %>;
+  before(() => {
+    plugin = new <%= h.changeCase.pascalCase(name) %>(global.bf);
   });
-  it('should already be enabled', () => {
-    const enableCmd = child.spawnSync(path.resolve('bin', 'run'), [
-      'browserforce:apply',
-      '-f',
-      path.join(__dirname, 'enable.json')
-    ]);
-    assert.deepStrictEqual(enableCmd.status, 0, enableCmd.output.toString());
-    assert.ok(
-      /no action necessary/.test(enableCmd.output.toString()),
-      enableCmd.output.toString()
-    );
+
+  const configEnabled: Config = {
+    enabled: true
+  };
+  const configDisabled: Config = {
+    enabled: true
+  };
+  it('should enable', async () => {
+    await plugin.run(configEnabled);
+  });
+  it('should already be enabled', async () => {
+    const res = await plugin.run(configEnabled);
+    assert.deepStrictEqual(res, { message: 'no action necessary' });
   });
-  it('should disable', () => {
-    const disableCmd = child.spawnSync(path.resolve('bin', 'run'), [
-      'browserforce:apply',
-      '-f',
-      path.resolve(path.join(__dirname, 'disable.json'))
-    ]);
-    assert.deepStrictEqual(disableCmd.status, 0, disableCmd.output.toString());
-    assert.ok(
-      /to 'false'/.test(disableCmd.output.toString()),
-      disableCmd.output.toString()
-    );
+  it('should disable', async () => {
+    await plugin.run(configDisabled);
   });
-  it('should already be disabled', () => {
-    const disableCmd = child.spawnSync(path.resolve('bin', 'run'), [
-      'browserforce:apply',
-      '-f',
-      path.join(__dirname, 'disable.json')
-    ]);
-    assert.deepStrictEqual(disableCmd.status, 0, disableCmd.output.toString());
-    assert.ok(
-      /no action necessary/.test(disableCmd.output.toString()),
-      disableCmd.output.toString()
-    );
+  it('should already be disabled', async () => {
+    const res = await plugin.run(configDisabled);
+    assert.deepStrictEqual(res, { message: 'no action necessary' });
   });
 });

_templates/plugin/new/index.ejs.t

@@ -13,7 +13,7 @@ const SELECTORS = {
   SAVE_BUTTON: 'input[id$=":save"]'
 };
 
-type Config = {
+export type Config = {
   enabled: boolean;
 };
 
@@ -27,6 +27,7 @@ export class <%= h.changeCase.pascalCase(name) %> extends BrowserforcePlugin {
         (el: HTMLInputElement) => el.checked
       )
     };
+    await page.close();
     return response;
   }
 
@@ -44,5 +45,6 @@ export class <%= h.changeCase.pascalCase(name) %> extends BrowserforcePlugin {
       page.waitForSelector(SELECTORS.CONFIRM_MESSAGE),
       page.click(SELECTORS.SAVE_BUTTON)
     ]);
+    await page.close();
   }
 }

package.json

@@ -8,20 +8,21 @@
   },
   "dependencies": {
     "@mdapi-issues/listmetadata-standardvalueset": "2.0.3",
-    "@salesforce/command": "5.2.16",
-    "json-merge-patch": "1.0.2",
+    "@salesforce/sf-plugins-core": "4.1.1",
     "p-retry": "4.6.2",
-    "puppeteer": "19.2.0",
-    "tslib": "2.4.0"
+    "puppeteer": "21.5.1"
   },
   "devDependencies": {
-    "@types/mocha": "10.0.1",
-    "@types/node": "18.16.8",
+    "@salesforce/dev-config": "4.1.0",
+    "@salesforce/prettier-config": "0.0.3",
+    "@types/mocha": "10.0.4",
+    "@types/node": "20.9.0",
     "mocha": "10.2.0",
     "nyc": "15.1.0",
-    "oclif": "3.9.0",
+    "oclif": "4.0.3",
+    "prettier": "3.1.0",
     "ts-node": "10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": ">=14.0.0"
@@ -39,7 +40,8 @@
   ],
   "license": "MIT",
   "oclif": {
-    "bin": "sfdx-browserforce-plugin",
+    "bin": "sf",
+    "topicSeparator": " ",
     "commands": "./lib/commands",
     "topics": {
       "browserforce": {
@@ -58,7 +60,7 @@
     "generate:plugin": "npx hygen plugin new",
     "prepack": "yarn build",
     "prepare": "yarn build",
-    "test": "nyc --reporter=lcov --reporter=text mocha --require ts-node/register \"test/**/*.test.ts\" \"src/**/*.test.ts\"",
-    "test:e2e": "mocha --require ts-node/register \"test/**/*.e2e-spec.ts\" \"src/**/*.e2e-spec.ts\""
+    "test": "tsc -p test && nyc --reporter=lcov --reporter=text mocha --require ts-node/register \"test/**/*.test.ts\" \"src/**/*.test.ts\"",
+    "test:e2e": "tsc -p test && mocha --require ts-node/register --slow 30s --timeout 2m --file test/e2e-setup.ts \"test/**/*.e2e-spec.ts\" \"src/**/*.e2e-spec.ts\""
   }
 }

prettier.config.js

@@ -0,0 +1,6 @@
+const salesforcePrettierConfig = require('@salesforce/prettier-config');
+
+module.exports = {
+  ...salesforcePrettierConfig,
+  trailingComma: 'none'
+};

scripts/develop.sh

@@ -33,12 +33,12 @@ _help() {
 _main() {
   alias="${alias:-${DEFAULT_ALIAS}}"
   # shellcheck disable=SC2068
-  sfdx force:org:create -f config/project-scratch-def.json \
+  sf org create scratch -f config/project-scratch-def.json \
     -a "$alias" \
-    -s \
-    description="${alias}" ${POSITIONAL_ARGS[@]}
-  sfdx force:org:display -u "$alias"
-  sfdx force:source:push -u "$alias"
+    -d \
+    ${POSITIONAL_ARGS[@]}
+  sf org display -o "$alias"
+  sf project deploy start -o "$alias"
 }
 
 if [[ "$0" == "${BASH_SOURCE[0]}" ]]; then