add quick fix for 1.13.1

Author: Philip-Carneiro

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to the **kdb VS Code extension** are documented in this file.
 
+# v1.13.1
+
+### Fixes
+
+- Fixed issue with corrupted settings for VSCode
+
 # v1.13.0
 
 ### Enhancements

package-lock.json

@@ -3,7 +3,7 @@
   "displayName": "kdb",
   "description": "IDE support for kdb product suite including the q programming language",
   "publisher": "KX",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "engines": {
     "vscode": "^1.96.0"
   },

package.json

@@ -244,16 +244,20 @@ export async function getWorkspaceFolder(
   return undefined;
 }
 
-export function getServers(): Server | undefined {
+export function getServers(): Server {
   const servers = workspace.getConfiguration().get<Server>("kdb.servers");
 
+  if (!servers) {
+    updateServers({});
+  }
+
   return servers
     ? Object.fromEntries(
         Object.entries(servers).sort(([, a], [, b]) =>
           a.serverAlias.localeCompare(b.serverAlias),
         ),
       )
-    : servers;
+    : {};
 }
 
 // TODO: Remove this on 1.9.0 release
@@ -328,28 +332,36 @@ export function setOutputWordWrapper(): void {
   }
 }
 
-export function getInsights(): Insights | undefined {
+export function getInsights(): Insights {
   const configuration = workspace.getConfiguration();
   const insights = configuration.get<Insights>(
     "kdb.insightsEnterpriseConnections",
   );
 
-  const insightsList: Insights | undefined =
-    insights && Object.keys(insights).length > 0
-      ? insights
-      : configuration.get("kdb.insights");
-
-  if (!insightsList || Object.keys(insightsList).length === 0) {
-    return undefined;
-  }
-
-  return insightsList
-    ? Object.fromEntries(
+  if (insights && Object.keys(insights).length > 0) {
+    return Object.fromEntries(
+      Object.entries(insights).sort(([, a], [, b]) =>
+        a.alias.localeCompare(b.alias),
+      ),
+    );
+  } else {
+    const insightsList = configuration.get<Insights>("kdb.insights");
+    if (insightsList && Object.keys(insightsList).length > 0) {
+      updateInsights(insightsList);
+      configuration.update(
+        "kdb.insights",
+        undefined,
+        ConfigurationTarget.Global,
+      );
+      return Object.fromEntries(
         Object.entries(insightsList).sort(([, a], [, b]) =>
           a.alias.localeCompare(b.alias),
         ),
-      )
-    : insightsList;
+      );
+    }
+    updateInsights({});
+    return {};
+  }
 }
 
 export async function updateServers(servers: Server): Promise<void> {

src/utils/core.ts

@@ -361,13 +361,16 @@ describe("Utils", () => {
     });
 
     describe("getServers", () => {
-      let workspaceStub: sinon.SinonStub;
-      let _getConfigurationStub: sinon.SinonStub;
-      let getStub: sinon.SinonStub;
+      let workspaceStub,
+        _getConfigurationStub,
+        getStub,
+        updateServersStub: sinon.SinonStub;
 
       beforeEach(() => {
         getStub = sinon.stub();
-        _getConfigurationStub = sinon.stub().returns({ get: getStub });
+        _getConfigurationStub = sinon
+          .stub()
+          .returns({ get: getStub, update: sinon.stub() });
         workspaceStub = sinon
           .stub(vscode.workspace, "getConfiguration")
           .returns({
@@ -403,18 +406,19 @@ describe("Utils", () => {
               throw new Error("Function not implemented.");
             },
           });
+        updateServersStub = sinon.stub(coreUtils, "updateServers").resolves();
       });
 
       afterEach(() => {
         sinon.restore();
       });
 
-      it("should return undefined when no servers are configured", () => {
-        getStub.returns(undefined);
-
+      it("should return an empty object when no servers are configured", () => {
+        getStub.returns({});
         const result = coreUtils.getServers();
 
-        assert.strictEqual(result, undefined);
+        assert.ok(typeof result === "object");
+        assert.strictEqual(Object.keys(result).length, 0);
         assert.ok(getStub.calledWith("kdb.servers"));
       });
 
@@ -580,7 +584,7 @@ describe("Utils", () => {
 
         coreUtils.getServers();
 
-        assert.ok(workspaceStub.calledOnce);
+        assert.ok(workspaceStub.calledTwice);
         assert.ok(workspaceStub.calledWith());
       });
 
@@ -595,13 +599,16 @@ describe("Utils", () => {
     });
 
     describe("getInsights", () => {
-      let workspaceStub: sinon.SinonStub;
-      let _getConfigurationStub: sinon.SinonStub;
-      let getStub: sinon.SinonStub;
+      let workspaceStub,
+        _getConfigurationStub,
+        getStub,
+        updateInsightsStub: sinon.SinonStub;
 
       beforeEach(() => {
         getStub = sinon.stub();
-        _getConfigurationStub = sinon.stub().returns({ get: getStub });
+        _getConfigurationStub = sinon
+          .stub()
+          .returns({ get: getStub, update: sinon.stub() });
         workspaceStub = sinon
           .stub(vscode.workspace, "getConfiguration")
           .returns({
@@ -625,18 +632,9 @@ describe("Utils", () => {
               | undefined {
               throw new Error("Function not implemented.");
             },
-            update: function (
-              _section: string,
-              _value: any,
-              _configurationTarget?:
-                | vscode.ConfigurationTarget
-                | boolean
-                | null,
-              _overrideInLanguage?: boolean,
-            ): Thenable<void> {
-              throw new Error("Function not implemented.");
-            },
+            update: sinon.stub(),
           });
+        updateInsightsStub = sinon.stub(coreUtils, "updateInsights").resolves();
       });
 
       afterEach(() => {
@@ -651,7 +649,8 @@ describe("Utils", () => {
 
         const result = coreUtils.getInsights();
 
-        assert.strictEqual(result, undefined);
+        assert.ok(typeof result === "object");
+        assert.strictEqual(Object.keys(result).length, 0);
         assert.ok(getStub.calledWith("kdb.insightsEnterpriseConnections"));
         assert.ok(getStub.calledWith("kdb.insights"));
       });
@@ -767,13 +766,14 @@ describe("Utils", () => {
         assert.ok(getStub.calledWith("kdb.insights"));
       });
 
-      it("should return undefined when both sources are empty", () => {
+      it("should return empty object when both sources are empty", () => {
         getStub.withArgs("kdb.insightsEnterpriseConnections").returns({});
         getStub.withArgs("kdb.insights").returns({});
 
         const result = coreUtils.getInsights();
 
-        assert.strictEqual(result, undefined);
+        assert.ok(typeof result === "object");
+        assert.strictEqual(Object.keys(result).length, 0);
         assert.ok(getStub.calledWith("kdb.insightsEnterpriseConnections"));
         assert.ok(getStub.calledWith("kdb.insights"));
       });
@@ -913,7 +913,7 @@ describe("Utils", () => {
 
         coreUtils.getInsights();
 
-        assert.ok(workspaceStub.calledOnce);
+        assert.ok(workspaceStub.calledTwice);
         assert.ok(workspaceStub.calledWith());
       });