feat: replace keyar with vscode SecretStorage (#1600)

JohnstonCode · Jun 22, 2023 · 715171d · 715171d
1 parent 00eabfe
commit 715171d
Show file tree

Hide file tree

Showing 10 changed files with 51 additions and 94 deletions.
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
     "version": "2.16.1",
     "publisher": "johnstoncode",
     "engines": {
-        "vscode": "^1.44.0"
+        "vscode": "^1.53.0"
     },
     "private": true,
     "enableProposedApi": false,
@@ -61,7 +61,7 @@
         "@types/node": "^12.11.7",
         "@types/semver": "^7.3.8",
         "@types/tmp": "0.2.1",
-        "@types/vscode": "1.44.0",
+        "@types/vscode": "1.53.0",
         "@types/xml2js": "^0.4.9",
         "@typescript-eslint/eslint-plugin": "^4.29.0",
         "@typescript-eslint/parser": "^4.29.0",

diff --git a/src/extension.ts b/src/extension.ts
@@ -27,7 +27,7 @@ import { tempSvnFs } from "./temp_svn_fs";
 import { SvnFileSystemProvider } from "./svnFileSystemProvider";
 
 async function init(
-  _context: ExtensionContext,
+  extensionContext: ExtensionContext,
   outputChannel: OutputChannel,
   disposables: Disposable[]
 ) {
@@ -38,7 +38,8 @@ async function init(
   const svn = new Svn({ svnPath: info.path, version: info.version });
   const sourceControlManager = await new SourceControlManager(
     svn,
-    ConstructorPolicy.Async
+    ConstructorPolicy.Async,
+    extensionContext
   );
 
   registerCommands(sourceControlManager, disposables);

diff --git a/src/historyView/branchChangesProvider.ts b/src/historyView/branchChangesProvider.ts
@@ -27,10 +27,12 @@ export class BranchChangesProvider
       ),
       commands.registerCommand(
         "svn.branchchanges.refresh",
-        () => this._onDidChangeTreeData.fire(),
+        () => this._onDidChangeTreeData.fire(undefined),
         this
       ),
-      this.model.onDidChangeRepository(() => this._onDidChangeTreeData.fire())
+      this.model.onDidChangeRepository(() =>
+        this._onDidChangeTreeData.fire(undefined)
+      )
     );
   }
 

diff --git a/src/historyView/repoLogProvider.ts b/src/historyView/repoLogProvider.ts
@@ -196,7 +196,7 @@ export class RepoLogProvider
       return;
     }
     this.logCache.set(repoName, item);
-    this._onDidChangeTreeData.fire();
+    this._onDidChangeTreeData.fire(undefined);
   }
 
   public addRepolikeGui() {

diff --git a/src/repository.ts b/src/repository.ts
@@ -7,6 +7,7 @@ import {
   EventEmitter,
   ProgressLocation,
   scm,
+  SecretStorage,
   SourceControl,
   SourceControlInputBox,
   TextDocument,
@@ -53,7 +54,6 @@ import {
 } from "./util";
 import { match, matchAll } from "./util/globMatch";
 import { RepositoryFilesWatcher } from "./watchers/repositoryFilesWatcher";
-import { keytar } from "./vscodeModules";
 
 function shouldShowProgress(operation: Operation): boolean {
   switch (operation) {
@@ -184,7 +184,10 @@ export class Repository implements IRemoteRepository {
     this.repository.password = password;
   }
 
-  constructor(public repository: BaseRepository) {
+  constructor(
+    public repository: BaseRepository,
+    private secrets: SecretStorage
+  ) {
     this._fsWatcher = new RepositoryFilesWatcher(repository.root);
     this.disposables.push(this._fsWatcher);
 
@@ -1007,24 +1010,36 @@ export class Repository implements IRemoteRepository {
       await this.lastPromptAuth;
     }
 
-    try {
-      return keytar.findCredentials(this.getCredentialServiceName());
-    } catch (error) {
+    const secret = await this.secrets.get(this.getCredentialServiceName());
+
+    if (typeof secret === "undefined") {
       return [];
     }
+
+    const credentials = JSON.parse(secret) as Array<IStoredAuth>;
+
+    return credentials;
   }
 
   public async saveAuth(): Promise<void> {
     if (this.canSaveAuth && this.username && this.password) {
-      try {
-        await keytar.setPassword(
-          this.getCredentialServiceName(),
-          this.username,
-          this.password
-        );
-      } catch (error) {
-        console.log(error);
+      const secret = await this.secrets.get(this.getCredentialServiceName());
+      let credentials: Array<IStoredAuth> = [];
+
+      if (typeof secret === "string") {
+        credentials = JSON.parse(secret) as Array<IStoredAuth>;
       }
+
+      credentials.push({
+        account: this.username,
+        password: this.password
+      });
+
+      await this.secrets.store(
+        this.getCredentialServiceName(),
+        JSON.stringify(credentials)
+      );
+
       this.canSaveAuth = false;
     }
   }

diff --git a/src/source_control_manager.ts b/src/source_control_manager.ts
@@ -5,6 +5,7 @@ import {
   Disposable,
   Event,
   EventEmitter,
+  ExtensionContext,
   Uri,
   window,
   workspace,
@@ -94,7 +95,11 @@ export class SourceControlManager implements IDisposable {
     return this._svn;
   }
 
-  constructor(private _svn: Svn, policy: ConstructorPolicy) {
+  constructor(
+    private _svn: Svn,
+    policy: ConstructorPolicy,
+    private extensionContact: ExtensionContext
+  ) {
     if (policy !== ConstructorPolicy.Async) {
       throw new Error("Unsopported policy");
     }
@@ -288,7 +293,8 @@ export class SourceControlManager implements IDisposable {
         const repositoryRoot = await this.svn.getRepositoryRoot(path);
 
         const repository = new Repository(
-          await this.svn.open(repositoryRoot, path)
+          await this.svn.open(repositoryRoot, path),
+          this.extensionContact.secrets
         );
 
         this.open(repository);

diff --git a/src/treeView/dataProviders/svnProvider.ts b/src/treeView/dataProviders/svnProvider.ts
@@ -31,7 +31,7 @@ export default class SvnProvider
   }
 
   public refresh(): void {
-    this._onDidChangeTreeData.fire();
+    this._onDidChangeTreeData.fire(undefined);
   }
 
   public getTreeItem(element: RepositoryNode): TreeItem {

diff --git a/src/types/keytar.d.ts b/src/types/keytar.d.ts
diff --git a/src/vscodeModules.ts b/src/vscodeModules.ts
@@ -33,8 +33,6 @@ function getNodeModule<T>(moduleName: string, showError = true): T | undefined {
   return undefined;
 }
 
-export const keytar = getNodeModule("keytar", false) as typeof import("keytar");
-
 let iconv_lite = getNodeModule(
   "iconv-lite-umd",
   false

diff --git a/yarn.lock b/yarn.lock
@@ -389,10 +389,10 @@
   resolved "https://registry.yarnpkg.com/@types/tmp/-/tmp-0.2.1.tgz#83ecf4ec22a8c218c71db25f316619fe5b986011"
   integrity sha512-7cTXwKP/HLOPVgjg+YhBdQ7bMiobGMuoBmrGmqwIWJv8elC6t1DfVc/mn4fD9UE1IjhwmhaQ5pGVXkmXbH0rhg==
 
-"@types/vscode@1.44.0":
-  version "1.44.0"
-  resolved "https://registry.yarnpkg.com/@types/vscode/-/vscode-1.44.0.tgz#62ecfe3d0e38942fce556574da54ee1013c775b7"
-  integrity sha512-WJZtZlinE3meRdH+I7wTsIhpz/GLhqEQwmPGeh4s1irWLwMzCeTV8WZ+pgPTwrDXoafVUWwo1LiZ9HJVHFlJSQ==
+"@types/vscode@1.53.0":
+  version "1.53.0"
+  resolved "https://registry.yarnpkg.com/@types/vscode/-/vscode-1.53.0.tgz#47b53717af6562f2ad05171bc9c8500824a3905c"
+  integrity sha512-XjFWbSPOM0EKIT2XhhYm3D3cx3nn3lshMUcWNy1eqefk+oqRuBq8unVb6BYIZqXy9lQZyeUl7eaBCOZWv+LcXQ==
 
 "@types/xml2js@^0.4.9":
   version "0.4.9"