Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete extension context secrets if we get an error when getting them. #5426

Merged
merged 1 commit into from
Apr 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions news/2 Fixes/5419.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Delete extension context secrets if we get an error when getting them.
Small fixes on error handling.
12 changes: 9 additions & 3 deletions src/client/common/application/encryptedStorage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,14 @@ export class EncryptedStorage implements IEncryptedStorage {
if (IS_REMOTE_NATIVE_TEST && this.extensionContext.extensionMode !== ExtensionMode.Production) {
return this.testingState.get(`${service}#${key}`);
}
// eslint-disable-next-line
const val = await this.extensionContext.secrets.get(`${service}.${key}`);
return val;
try {
// eslint-disable-next-line
const val = await this.extensionContext.secrets.get(`${service}.${key}`);
return val;
} catch (e) {
// If we get an error trying to get a secret, it might be corrupted. So we delete it.
await this.extensionContext.secrets.delete(`${service}.${key}`);
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to this issue microsoft/vscode#120558, an encryption change in Windows requires us to re enter every secret.

I checked and this is the only place in the repo where .get() gets called. So if we get an error while getting, we can delete and then enter the secret again as usual.

Thanks @IanMatthewHuff for the help.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We considered what other secret could be affected by this, but it looks like its only the remote uri's.

return;
}
}
}
4 changes: 3 additions & 1 deletion src/client/common/errors/errorUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ export function getLastFrameFromPythonTraceback(
}
// File "/Users/donjayamanne/miniconda3/envs/env3/lib/python3.7/site-packages/appnope/_nope.py", line 38, in C

const lastFrame = traceback
// This parameter might be either a string or a string array
const fixedTraceback: string = Array.isArray(traceback) ? traceback[0] : traceback;
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes more sense to change the parameter type, but the issue is that JS allows it to be either an array or a string. This works for both cases.

const lastFrame = fixedTraceback
.split('\n')
.map((item) => item.trim().toLowerCase())
.filter((item) => item.length)
Expand Down
8 changes: 6 additions & 2 deletions src/client/common/errors/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,12 @@ const taggers = [
];
export function getErrorTags(stdErrOrStackTrace: string) {
const tags: string[] = [];
stdErrOrStackTrace = stdErrOrStackTrace.toLowerCase();
taggers.forEach((tagger) => tagger(stdErrOrStackTrace, tags));

// This parameter might be either a string or a string array
let stdErrOrStackTraceLowered = Array.isArray(stdErrOrStackTrace)
? stdErrOrStackTrace[0].toLowerCase()
: stdErrOrStackTrace.toLowerCase();
taggers.forEach((tagger) => tagger(stdErrOrStackTraceLowered, tags));

return Array.from(new Set(tags)).join(',');
}
Expand Down