Tweak state loading/saving

nirinchev · nirinchev · commit a14ca33c3fc8 · 2025-04-11T13:17:17.000+02:00
diff --git a/.github/workflows/code_health.yaml b/.github/workflows/code_health.yaml
@@ -1,40 +1,44 @@
 ---
 name: Code Health
 on:
-    push:
-        branches:
-            - main
-    pull_request:
+  push:
+    branches:
+      - main
+  pull_request:
 jobs:
-    check-style:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: GitHubSecurityLab/actions-permissions/monitor@v1
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version-file: package.json
-                  cache: "npm"
-            - name: Install dependencies
-              run: npm ci
-            - name: Run style check
-              run: npm run check
+  check-style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Run style check
+        run: npm run check
 
-    run-tests:
-        runs-on: ubuntu-latest
-        steps:
-            - name: Install keyring deps
-              run: |
-                  sudo apt update -y
-                  sudo apt install -y gnome-keyring libdbus-1-dev
+  run-tests:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - name: Install keyring deps on Ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo apt update -y
+          sudo apt install -y gnome-keyring libdbus-1-dev
 
-            - uses: GitHubSecurityLab/actions-permissions/monitor@v1
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version-file: package.json
-                  cache: "npm"
-            - name: Install dependencies
-              run: npm ci
-            - name: Run tests
-              run: npm test
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -1,29 +1,29 @@
 ---
 name: Publish
 on:
-    push:
-        tags:
-            - v*
+  push:
+    tags:
+      - v*
 jobs:
-    publish:
-        runs-on: ubuntu-latest
-        environment: Production
-        steps:
-            - uses: GitHubSecurityLab/actions-permissions/monitor@v1
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version-file: package.json
-                  registry-url: "https://registry.npmjs.org"
-                  cache: "npm"
-            - name: Build package
-              run: |
-                  npm ci
-                  npm run build
-            - name: Publish to NPM
-              run: npm publish
-              env:
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-            - name: Publish Github release
-              run: |
-                  gh release create ${{ github.ref }} --title "${{ github.ref }}" --notes "Release ${{ github.ref }}" --generate-notes
+  publish:
+    runs-on: ubuntu-latest
+    environment: Production
+    steps:
+      - uses: GitHubSecurityLab/actions-permissions/monitor@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: package.json
+          registry-url: "https://registry.npmjs.org"
+          cache: "npm"
+      - name: Build package
+        run: |
+          npm ci
+          npm run build
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish Github release
+        run: |
+          gh release create ${{ github.ref }} --title "${{ github.ref }}" --notes "Release ${{ github.ref }}" --generate-notes
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -18,6 +18,13 @@
         "tabWidth": 2,
         "printWidth": 80
       }
+    },
+    {
+      "files": "*.yaml",
+      "options": {
+        "tabWidth": 2,
+        "printWidth": 80
+      }
     }
   ]
 }
diff --git a/src/state.ts b/src/state.ts
@@ -13,20 +13,21 @@ export class State {
     serviceProvider?: NodeDriverServiceProvider;
 
     public async persistCredentials(): Promise<void> {
-        await this.entry.setPassword(JSON.stringify(this.credentials));
+        try {
+            await this.entry.setPassword(JSON.stringify(this.credentials));
+        } catch (err) {
+            logger.error(mongoLogId(1_000_008), "state", `Failed to save state: ${err}`);
+        }
     }
 
-    public async loadCredentials(): Promise<boolean> {
+    public async loadCredentials(): Promise<void> {
         try {
             const data = await this.entry.getPassword();
             if (data) {
                 this.credentials = JSON.parse(data);
             }
-
-            return true;
         } catch (err: unknown) {
             logger.error(mongoLogId(1_000_007), "state", `Failed to load state: ${err}`);
-            return false;
         }
     }
 }
diff --git a/tests/integration/helpers.ts b/tests/integration/helpers.ts
@@ -4,11 +4,19 @@ import { Server } from "../../src/server.js";
 import runner, { MongoCluster } from "mongodb-runner";
 import path from "path";
 import fs from "fs/promises";
+import defaultState from "../../src/state.js";
 
 export async function setupIntegrationTest(): Promise<{
     client: Client;
     server: Server;
+    teardown: () => Promise<void>;
 }> {
+    // Mock the load/persist credentials method to avoid state loading/restore messing up with the tests
+    const loadCredentialsMock = jest.spyOn(defaultState, "loadCredentials").mockImplementation(() => Promise.resolve());
+    const saveCredentialsMock = jest
+        .spyOn(defaultState, "persistCredentials")
+        .mockImplementation(() => Promise.resolve());
+
     const clientTransport = new InMemoryTransport();
     const serverTransport = new InMemoryTransport();
 
@@ -35,6 +43,13 @@ export async function setupIntegrationTest(): Promise<{
     return {
         client,
         server,
+        teardown: async () => {
+            await client.close();
+            await server.close();
+
+            loadCredentialsMock.mockRestore();
+            saveCredentialsMock.mockRestore();
+        },
     };
 }
 
diff --git a/tests/integration/tools/mongodb/connect.test.ts b/tests/integration/tools/mongodb/connect.test.ts
@@ -9,18 +9,16 @@ import config from "../../../../src/config.js";
 describe("Connect tool", () => {
     let client: Client;
     let server: Server;
+    let serverClientTeardown: () => Promise<void>;
 
-    let loadCredentialsMock: jest.SpyInstance | undefined;
     let cluster: runner.MongoCluster;
 
     beforeAll(async () => {
         cluster = await runMongoDB();
     }, 60_000);
 
     afterEach(async () => {
-        loadCredentialsMock?.mockRestore();
-        await client?.close();
-        await server?.close();
+        await serverClientTeardown?.();
     });
 
     afterAll(async () => {
@@ -29,9 +27,7 @@ describe("Connect tool", () => {
 
     describe("with default config", () => {
         beforeEach(async () => {
-            loadCredentialsMock = jest.spyOn(defaultState, "loadCredentials").mockImplementation(async () => true);
-
-            ({ client, server } = await setupIntegrationTest());
+            ({ client, server, teardown: serverClientTeardown } = await setupIntegrationTest());
         });
 
         it("should have correct metadata", async () => {
@@ -92,7 +88,7 @@ describe("Connect tool", () => {
         beforeEach(async () => {
             config.connectionString = cluster.connectionString;
 
-            ({ client, server } = await setupIntegrationTest());
+            ({ client, server, teardown: serverClientTeardown } = await setupIntegrationTest());
         });
 
         it("uses the connection string from config", async () => {

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,13 @@`
`18`	`18`	`"tabWidth": 2,`
`19`	`19`	`"printWidth": 80`
`20`	`20`	`}`
	`21`	`+ },`
	`22`	`+ {`
	`23`	`+ "files": "*.yaml",`
	`24`	`+ "options": {`
	`25`	`+ "tabWidth": 2,`
	`26`	`+ "printWidth": 80`
	`27`	`+ }`
`21`	`28`	`}`
`22`	`29`	`]`
`23`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,20 +13,21 @@ export class State {`
`13`	`13`	`serviceProvider?: NodeDriverServiceProvider;`
`14`	`14`
`15`	`15`	`public async persistCredentials(): Promise<void> {`
`16`		`- await this.entry.setPassword(JSON.stringify(this.credentials));`
	`16`	`+ try {`
	`17`	`+ await this.entry.setPassword(JSON.stringify(this.credentials));`
	`18`	`+ } catch (err) {`
	`19`	+ logger.error(mongoLogId(1_000_008), "state", `Failed to save state: ${err}`);
	`20`	`+ }`
`17`	`21`	`}`
`18`	`22`
`19`		`- public async loadCredentials(): Promise<boolean> {`
	`23`	`+ public async loadCredentials(): Promise<void> {`
`20`	`24`	`try {`
`21`	`25`	`const data = await this.entry.getPassword();`
`22`	`26`	`if (data) {`
`23`	`27`	`this.credentials = JSON.parse(data);`
`24`	`28`	`}`
`25`		`-`
`26`		`- return true;`
`27`	`29`	`} catch (err: unknown) {`
`28`	`30`	logger.error(mongoLogId(1_000_007), "state", `Failed to load state: ${err}`);
`29`		`- return false;`
`30`	`31`	`}`
`31`	`32`	`}`
`32`	`33`	`}`