fix: error output when configstore dir not accessible. (#1512)

fix: #1510
streetsidesoftware · Aug 13, 2021 · 68a63d1 · 68a63d1
1 parent 6a44e26
commit 68a63d1
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 9 deletions.
diff --git a/packages/cspell-lib/package-lock.json b/packages/cspell-lib/package-lock.json
diff --git a/packages/cspell-lib/package.json b/packages/cspell-lib/package.json
@@ -77,10 +77,12 @@
     "@cspell/dict-python": "^1.0.37",
     "@types/configstore": "^5.0.1",
     "@types/fs-extra": "^9.0.12",
+    "@types/jest": "^27.0.1",
     "@types/node": "^16.6.0",
     "cspell-dict-nl-nl": "^1.1.2",
     "jest": "^27.0.6",
     "lorem-ipsum": "^2.0.3",
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.0.4"
   }
 }
diff --git a/packages/cspell-lib/src/Settings/GlobalSettings.test.ts b/packages/cspell-lib/src/Settings/GlobalSettings.test.ts
@@ -1,5 +1,5 @@
-import { getGlobalConfigPath, getRawGlobalSettings, writeRawGlobalSettings } from './GlobalSettings';
 import Configstore from 'configstore';
+import { mocked } from 'ts-jest/utils';
 // eslint-disable-next-line jest/no-mocks-import
 import {
     clearData as clearConfigstore,
@@ -8,17 +8,18 @@ import {
     mockAll,
     mockSetData,
 } from '../__mocks__/configstore';
+import { getGlobalConfigPath, getRawGlobalSettings, writeRawGlobalSettings } from './GlobalSettings';
 
-const mockLog = jest.fn();
-console.log = mockLog;
-jest.mock('configstore');
-
-const mockConfigstore = Configstore as jest.Mock<Configstore>;
+const mockLog = jest.spyOn(console, 'log').mockImplementation();
+const mockError = jest.spyOn(console, 'error').mockImplementation();
+const mockConfigstore = mocked(Configstore, true);
 
 describe('Validate GlobalSettings', () => {
     beforeEach(() => {
         mockConfigstore.mockClear();
         mockLog.mockClear();
+        mockError.mockClear();
+        mockAll.mockClear();
         clearMocks();
         clearConfigstore();
     });
@@ -84,4 +85,25 @@ describe('Validate GlobalSettings', () => {
         const error2 = writeRawGlobalSettings(updated);
         expect(error2).toBeInstanceOf(Error);
     });
+
+    test('No Access to global settings files', () => {
+        mockAll.mockImplementation(() => {
+            throw new SystemLikeError('permission denied', 'EACCES');
+        });
+        const s = getRawGlobalSettings();
+        expect(mockError).toHaveBeenCalledTimes(0);
+        expect(mockLog).toHaveBeenCalledTimes(0);
+        expect(s).toEqual({
+            source: {
+                name: 'CSpell Configstore',
+                filename: undefined,
+            },
+        });
+    });
 });
+
+class SystemLikeError extends Error {
+    constructor(msg: string, readonly code: string) {
+        super(msg);
+    }
+}
diff --git a/packages/cspell-lib/src/Settings/GlobalSettings.ts b/packages/cspell-lib/src/Settings/GlobalSettings.ts
@@ -1,6 +1,6 @@
 import { CSpellSettings, CSpellSettingsWithSourceTrace } from '@cspell/cspell-types';
-import { logError } from '../util/logger';
 import ConfigStore from 'configstore';
+import { logError } from '../util/logger';
 
 const packageName = 'cspell';
 
@@ -34,7 +34,9 @@ export function getRawGlobalSettings(): GlobalSettingsWithSource {
             };
         }
     } catch (error) {
-        logError(error);
+        if (!['ENOENT', 'EACCES', 'ENOTDIR', 'EISDIR'].includes(error.code)) {
+            logError(error);
+        }
     }
 
     return globalConf;

diff --git a/packages/cspell-lib/src/types.d.ts b/packages/cspell-lib/src/types.d.ts
@@ -0,0 +1,5 @@
+// https://github.com/facebook/jest/issues/11640
+declare namespace NodeJS {
+    // eslint-disable-next-line @typescript-eslint/no-empty-interface
+    interface Global {}
+}