Feature/533/optional default providers (#534)

* (#533) Move clipboard provider into dedicated package * (#533) Extend provider registry with checks for providers, disable loading of default clipboard provider via env var * (#533) Add safety checks when accessing providers to avoid errors before being able to load alternatives * (#533) Extend constants and provider registry to disable loading of other native providers as well. Preparing for further refactorings * (#533) Update sonar action
nut-tree · Sep 23, 2023 · 6a76103 · 6a76103
1 parent 722150e
commit 6a76103
Show file tree

Hide file tree

Showing 12 changed files with 188 additions and 83 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -46,7 +46,7 @@ jobs:
           npm run coverage:merge
           npm run coverage:merge-report
       - name: Send results to SonarCloud
-        uses: SonarSource/sonarcloud-github-action@v1.6
+        uses: SonarSource/sonarcloud-github-action@v2.0.2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

diff --git a/lib/constants.ts b/lib/constants.ts
@@ -0,0 +1,12 @@
+export const DISABLE_DEFAULT_PROVIDERS_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_PROVIDERS";
+export const DISABLE_DEFAULT_CLIPBOARD_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_CLIPBOARD_PROVIDER";
+export const DISABLE_DEFAULT_KEYBOARD_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_KEYBOARD_PROVIDER";
+export const DISABLE_DEFAULT_MOUSE_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_MOUSE_PROVIDER";
+export const DISABLE_DEFAULT_SCREEN_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_SCREEN_PROVIDER";
+export const DISABLE_DEFAULT_WINDOW_PROVIDER_ENV_VAR =
+  "NUT_JS_DISABLE_DEFAULT_WINDOW_PROVIDER";
diff --git a/lib/expect/jest.matcher.function.ts b/lib/expect/jest.matcher.function.ts
@@ -10,6 +10,7 @@ declare global {
     interface Matchers<R> {
       toBeAt: (position: Point) => ReturnType<typeof toBeAt>;
       toBeIn: (region: Region) => ReturnType<typeof toBeIn>;
+      // @ts-ignore
       toShow: (
         needle: FindInput,
         confidence?: number

diff --git a/lib/keyboard.class.spec.ts b/lib/keyboard.class.spec.ts
@@ -20,6 +20,9 @@ const providerRegistryMock = mockPartial<ProviderRegistry>({
       setKeyboardDelay: jest.fn(),
     });
   },
+  hasKeyboard(): boolean {
+    return true;
+  },
 });
 
 describe("Keyboard", () => {

diff --git a/lib/keyboard.class.ts b/lib/keyboard.class.ts
@@ -34,9 +34,11 @@ export class KeyboardClass {
    * @param providerRegistry
    */
   constructor(private providerRegistry: ProviderRegistry) {
-    this.providerRegistry
-      .getKeyboard()
-      .setKeyboardDelay(this.config.autoDelayMs);
+    if (this.providerRegistry.hasKeyboard()) {
+      this.providerRegistry
+        .getKeyboard()
+        .setKeyboardDelay(this.config.autoDelayMs);
+    }
   }
 
   /**

diff --git a/lib/mouse.class.spec.ts b/lib/mouse.class.spec.ts
@@ -19,6 +19,9 @@ const providerRegistryMock = mockPartial<ProviderRegistry>({
       setMouseDelay: jest.fn(),
     });
   },
+  hasMouse(): boolean {
+    return true;
+  },
 });
 
 describe("Mouse class", () => {

diff --git a/lib/mouse.class.ts b/lib/mouse.class.ts
@@ -37,7 +37,9 @@ export class MouseClass {
    * @param providerRegistry
    */
   constructor(private providerRegistry: ProviderRegistry) {
-    this.providerRegistry.getMouse().setMouseDelay(0);
+    if (this.providerRegistry.hasMouse()) {
+      this.providerRegistry.getMouse().setMouseDelay(0);
+    }
   }
 
   /**

diff --git a/lib/provider/native/clipboardy-clipboard.class.spec.ts b/lib/provider/native/clipboardy-clipboard.class.spec.ts
diff --git a/lib/provider/native/clipboardy-clipboard.class.ts b/lib/provider/native/clipboardy-clipboard.class.ts