@salesforce/cli-plugins-testkit 1.4.31 → 1.5.1

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.
 
+### [1.5.1](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.5.0...v1.5.1) (2022-01-08)
+
+## [1.5.0](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.4.33...v1.5.0) (2022-01-07)
+
+### Features
+
+- retries on session rmDir ([8632d5d](https://github.com/salesforcecli/cli-plugins-testkit/commit/8632d5dcde0fb1f2acee33ed26dd96a0983bb938))
+
+### [1.4.33](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.4.32...v1.4.33) (2022-01-03)
+
+### [1.4.32](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.4.31...v1.4.32) (2022-01-03)
+
 ### [1.4.31](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.4.30...v1.4.31) (2022-01-03)
 
 ### [1.4.30](https://github.com/salesforcecli/cli-plugins-testkit/compare/v1.4.29...v1.4.30) (2022-01-02)

package/lib/testSession.d.ts

@@ -1,3 +1,4 @@
+import { RetryConfig } from 'ts-retry-promise';
 import { AsyncOptionalCreatable } from '@salesforce/kit';
 import { AnyJson, Optional } from '@salesforce/ts-types';
 import * as shell from 'shelljs';
@@ -60,6 +61,7 @@ export declare class TestSession extends AsyncOptionalCreatable<TestSessionOptio
     homeDir: string;
     project?: TestProject;
     setup?: AnyJson[] | shell.ShellString;
+    rmRetryConfig: Partial<RetryConfig<void>>;
     private debug;
     private cwdStub?;
     private overriddenDir?;

package/lib/testSession.js

@@ -8,6 +8,7 @@ exports.TestSession = void 0;
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 const path = require("path");
+const ts_retry_promise_1 = require("ts-retry-promise");
 const debug_1 = require("debug");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
@@ -48,6 +49,8 @@ const hubAuth_1 = require("./hubAuth");
 class TestSession extends kit_1.AsyncOptionalCreatable {
     constructor(options = {}) {
         super(options);
+        // this is stored on the class so that tests can set it to something much lower than default
+        this.rmRetryConfig = { retries: 12, delay: 5000 };
         this.sandbox = sinon_1.createSandbox();
         this.orgs = [];
         this.shelljsExecOptions = {
@@ -183,16 +186,23 @@ class TestSession extends kit_1.AsyncOptionalCreatable {
     }
     async rmSessionDir() {
         // Delete the test session unless they overrode the test session dir
-        if (!this.overriddenDir) {
+        if (this.overriddenDir) {
+            return;
+        }
+        // this is wrapped in a promise because shelljs isn't async/await
+        return await ts_retry_promise_1.retry(() => new Promise((resolve, reject) => {
             this.debug(`Deleting test session dir: ${this.dir}`);
-            // Processes can hang on to files within the test session dir, preventing
-            // removal so we wait a bit before trying.
-            await this.sleep(kit_1.Duration.seconds(4));
             const rv = shell.rm('-rf', this.dir);
             if (rv.code !== 0) {
-                throw Error(`Deleting the test session failed due to: ${rv.stderr}`);
+                reject(`Deleting the test session failed due to: ${rv.stderr}`);
             }
-        }
+            resolve();
+        }), this.rmRetryConfig).catch((err) => {
+            if (err instanceof ts_retry_promise_1.RetryError) {
+                throw err.lastError;
+            }
+            throw err;
+        });
     }
     // Executes commands and keeps track of any orgs created.
     // Throws if any commands return a non-zero exitCode.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli-plugins-testkit",
   "description": "Provides test utilities to assist Salesforce CLI plug-in authors with writing non-unit tests (NUT).",
-  "version": "1.4.31",
+  "version": "1.5.1",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -48,11 +48,12 @@
     "archiver": "^5.2.0",
     "debug": "^4.3.1",
     "shelljs": "^0.8.4",
-    "strip-ansi": "6.0.1"
+    "strip-ansi": "6.0.1",
+    "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {
-    "@salesforce/dev-config": "^2.1.2",
-    "@salesforce/dev-scripts": "^1.0.2",
+    "@salesforce/dev-config": "^3.0.0",
+    "@salesforce/dev-scripts": "^2.0.0",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.18",
     "@types/archiver": "^5.1.0",
@@ -75,7 +76,7 @@
     "eslint-plugin-jsdoc": "^35.1.2",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^7.0.4",
-    "mocha": "^8.4.0",
+    "mocha": "^9.1.3",
     "nyc": "^15.1.0",
     "prettier": "^2.3.1",
     "pretty-quick": "^3.1.0",