Uploaded image for project: 'VS Code Extension'
  1. VS Code Extension
  2. VSCODE-435

Remove keytar usage, use VSCode's SecretStorage API

XMLWordPrintableJSON

    • Type: Icon: Task Task
    • Resolution: Done
    • Priority: Icon: Critical - P2 Critical - P2
    • 1.1.0
    • Affects Version/s: None
    • Component/s: Connectivity
    • None
    • 5
    • Iteration Edmontonia, Iteration Fukuiraptor
    • Not Needed

      Keytar is officially archived and not being maintained. VSCode is removing the keytar shim that we rely on for storing credentials. They have their own SecretStorage API we should switch over to. 

      We could alternatively bundle the keytar module with our extension but we'll have to publish a platform specific extension for all platforms and bundle the native module ourselves. Using the SecretStorage API is a more future safe approach.

      Technical design: https://docs.google.com/document/d/13HAIx1QFLnxiJUJrOKyoCbcAHFS_cnyXYyBj5ZXQMPI/edit

      Timeline

      The current plan is that the keytar shim will be removed from VS Code Insiders in early July which means that August 2023's stable release will be the first release without the shim.

      We should try and do this work early so we can release well before then.
      More info in GitHub issue: https://github.com/mongodb-js/vscode/issues/546

            Assignee:
            himanshu.singh@mongodb.com Himanshu Singh
            Reporter:
            rhys.howell@mongodb.com Rhys Howell
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: