Ensure that search location is stored as a string. #20106

karthiknadig · 2022-10-28T00:21:47Z

For #20104

The Cause: The workspaceFolder field is set using an internal field searchLocation. searchLocation is what gets saved to Memento as Uri. when we read it back it looks like this:

Interim Solution:

Reading (broken case): Since there are already existing cases where this is broken. The surgical fix is to read bad value, extract the scheme and path, use that to re-create the URI.
Reading/Writing (new case): Make sure that we convert Uri to string before writing and parse back the Uri when reading.

Long term solution:
Object written to memento needs to be serialized using a custom serializer that validates all values before writing and after reading.

karrtikr · 2022-10-28T06:31:57Z

src/client/pythonEnvironments/index.ts

+
+function putIntoStorage(storage: IPersistentStorage<PythonEnvInfo[]>, envs: PythonEnvInfo[]): Promise<void> {
+ storage.set(
+ envs.map((e) => {


We need to clone envs otherwise it'll overwrite e.searchLocation of the existing environment object.

Yes. I agree.

-------------------- Commit message for microsoft/vscode-python@b32ca0a: Putting new properties in GDPR (microsoft/vscode-python#20111) Co-authored-by: Luciana Abud <[email protected]> -------------------- Commit message for microsoft/vscode-python@f0ce532: Only return local environments from the currently opened workspace folders in environments api (microsoft/vscode-python#20108) Closes microsoft/vscode-python#20068 Fixes microsoft/vscode-python#20105 -------------------- Commit message for microsoft/vscode-python@43c059e: Resolve conda environments without relying on the updated list of conda envs (microsoft/vscode-python#20112) Closes microsoft/vscode-python#20069 Closes microsoft/vscode-python#20110 Closes microsoft/vscode-python#20070 -------------------- Commit message for microsoft/vscode-python@1db65b8: Ensure that search location is stored as a string (microsoft/vscode-python#20106) For microsoft/vscode-python#20104 The Cause: The `workspaceFolder` field is set using an internal field `searchLocation`. `searchLocation` is what gets saved to Memento as `Uri`. when we read it back it looks like this: ![image](https://user-images.githubusercontent.com/3840081/198420406-fb4c9b87-1276-4717-8043-69d95dcdba48.png) Interim Solution: * Reading (broken case): Since there are already existing cases where this is broken. The surgical fix is to read bad value, extract the `scheme` and `path`, use that to re-create the URI. * Reading/Writing (new case): Make sure that we convert Uri to string before writing and parse back the Uri when reading. Long term solution: Object written to memento needs to be serialized using a custom serializer that validates all values before writing and after reading. -------------------- Commit message for microsoft/vscode-python@83fff4f: Fix for env creation errors (microsoft/vscode-python#20075) 1. We ensure that non-zero error codes are handled 2. We show error message, with got to logs, and select interpreter. 3. Uses conda base environment to find base python. Fixes: microsoft/vscode-python#20072 Fixes: microsoft/vscode-python#20062 -------------------- Commit message for microsoft/vscode-python@654fd19: Add to release notes (microsoft/vscode-python#19943) Adding clarity to release notes which I found helpful after going through the process myself. Currently a draft PR as I will make more changes Wednesday after next steps in process -------------------- Commit message for microsoft/vscode-python@2d53622: Bump actions/checkout from 2 to 3 (microsoft/vscode-python#20059) Bumps [actions/checkout](https:/actions/checkout) from 2 to 3. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https:/actions/checkout/releases">actions/checkout's releases</a>.</em></p> <blockquote> <h2>v3.0.0</h2> <ul> <li>Updated to the node16 runtime by default <ul> <li>This requires a minimum <a href="https:/actions/runner/releases/tag/v2.285.0">Actions Runner</a> version of v2.285.0 to run, which is by default available in GHES 3.4 or later.</li> </ul> </li> </ul> <h2>v2.5.0</h2> <h2>What's Changed</h2> <ul> <li>Update <code>@actions/core</code> to 1.10.0 by <a href="https:/rentziass"><code>@rentziass</code></a> in <a href="https://github-redirect.dependabot.com/actions/checkout/pull/962">actions/checkout#962</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https:/actions/checkout/compare/v2...v2.5.0">https:/actions/checkout/compare/v2...v2.5.0</a></p> <h2>v2.4.2</h2> <h2>What's Changed</h2> <ul> <li>Add set-safe-directory input to allow customers to take control. (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/770">#770</a>) by <a href="https:/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://github-redirect.dependabot.com/actions/checkout/pull/776">actions/checkout#776</a></li> <li>Prepare changelog for v2.4.2. by <a href="https:/TingluoHuang"><code>@TingluoHuang</code></a> in <a href="https://github-redirect.dependabot.com/actions/checkout/pull/778">actions/checkout#778</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https:/actions/checkout/compare/v2...v2.4.2">https:/actions/checkout/compare/v2...v2.4.2</a></p> <h2>v2.4.1</h2> <ul> <li>Fixed an issue where checkout failed to run in container jobs due to the new git setting <code>safe.directory</code></li> </ul> <h2>v2.4.0</h2> <ul> <li>Convert SSH URLs like <code>org-<ORG_ID>@github.com:</code> to <code>https:/</code> - <a href="https://github-redirect.dependabot.com/actions/checkout/pull/621">pr</a></li> </ul> <h2>v2.3.5</h2> <p>Update dependencies</p> <h2>v2.3.4</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/379">Add missing <code>await</code>s</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/360">Swap to Environment Files</a></li> </ul> <h2>v2.3.3</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/345">Remove Unneeded commit information from build logs</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/326">Add Licensed to verify third party dependencies</a></li> </ul> <h2>v2.3.2</h2> <p><a href="https://github-redirect.dependabot.com/actions/checkout/pull/320">Add Third Party License Information to Dist Files</a></p> <h2>v2.3.1</h2> <p><a href="https://github-redirect.dependabot.com/actions/checkout/pull/284">Fix default branch resolution for .wiki and when using SSH</a></p> <h2>v2.3.0</h2> <p><a href="https://github-redirect.dependabot.com/actions/checkout/pull/278">Fallback to the default branch</a></p> <h2>v2.2.0</h2> <p><a href="https://github-redirect.dependabot.com/actions/checkout/pull/258">Fetch all history for all tags and branches when fetch-depth=0</a></p> <h2>v2.1.1</h2> <p>Changes to support GHES (<a href="https://github-redirect.dependabot.com/actions/checkout/pull/236">here</a> and <a href="https://github-redirect.dependabot.com/actions/checkout/pull/248">here</a>)</p>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https:/actions/checkout/blob/main/CHANGELOG.md">actions/checkout's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <h2>v3.1.0</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/939">Use <code>@actions/core</code> <code>saveState</code> and <code>getState</code></a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/922">Add <code>github-server-url</code> input</a></li> </ul> <h2>v3.0.2</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/770">Add input <code>set-safe-directory</code></a></li> </ul> <h2>v3.0.1</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/762">Fixed an issue where checkout failed to run in container jobs due to the new git setting <code>safe.directory</code></a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/744">Bumped various npm package versions</a></li> </ul> <h2>v3.0.0</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/689">Update to node 16</a></li> </ul> <h2>v2.3.1</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/284">Fix default branch resolution for .wiki and when using SSH</a></li> </ul> <h2>v2.3.0</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/278">Fallback to the default branch</a></li> </ul> <h2>v2.2.0</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/258">Fetch all history for all tags and branches when fetch-depth=0</a></li> </ul> <h2>v2.1.1</h2> <ul> <li>Changes to support GHES (<a href="https://github-redirect.dependabot.com/actions/checkout/pull/236">here</a> and <a href="https://github-redirect.dependabot.com/actions/checkout/pull/248">here</a>)</li> </ul> <h2>v2.1.0</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/191">Group output</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/199">Changes to support GHES alpha release</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/184">Persist core.sshCommand for submodules</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/163">Add support ssh</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/179">Convert submodule SSH URL to HTTPS, when not using SSH</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/157">Add submodule support</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/144">Follow proxy settings</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/141">Fix ref for pr closed event when a pr is merged</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/128">Fix issue checking detached when git less than 2.22</a></li> </ul> <h2>v2.0.0</h2> <ul> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/108">Do not pass cred on command line</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/107">Add input persist-credentials</a></li> <li><a href="https://github-redirect.dependabot.com/actions/checkout/pull/104">Fallback to REST API to download repo</a></li> </ul>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https:/actions/checkout/commit/93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8"><code>93ea575</code></a> Prepare release v3.1.0 (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/940">#940</a>)</li> <li><a href="https:/actions/checkout/commit/6a84743051be17cee477b0a26bd866b5dba996e4"><code>6a84743</code></a> Bump <code>@actions/core</code> to 1.10.0 (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/939">#939</a>)</li> <li><a href="https:/actions/checkout/commit/e6d535c99c374d0c3f6d8cd8086a57b43c6c700a"><code>e6d535c</code></a> Inject GitHub host to be able to clone from another GitHub instance (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/922">#922</a>)</li> <li><a href="https:/actions/checkout/commit/2541b1294d2704b0964813337f33b291d3f8596b"><code>2541b12</code></a> Prepare changelog for v3.0.2. (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/777">#777</a>)</li> <li><a href="https:/actions/checkout/commit/0ffe6f9c5599e73776da5b7f113e994bc0a76ede"><code>0ffe6f9</code></a> Add set-safe-directory input to allow customers to take control. (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/770">#770</a>)</li> <li><a href="https:/actions/checkout/commit/dcd71f646680f2efd8db4afa5ad64fdcba30e748"><code>dcd71f6</code></a> Enforce safe directory (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/762">#762</a>)</li> <li><a href="https:/actions/checkout/commit/add3486cc3b55d4a5e11c8045058cef96538edc7"><code>add3486</code></a> Patch to fix the dependbot alert. (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/744">#744</a>)</li> <li><a href="https:/actions/checkout/commit/5126516654c75f76bca1de45dd82a3006d8890f9"><code>5126516</code></a> Bump minimist from 1.2.5 to 1.2.6 (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/741">#741</a>)</li> <li><a href="https:/actions/checkout/commit/d50f8ea76748df49594d9b109b614f3b4db63c71"><code>d50f8ea</code></a> Add v3.0 release information to changelog (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/740">#740</a>)</li> <li><a href="https:/actions/checkout/commit/2d1c1198e79c30cca5c3957b1e3b65ce95b5356e"><code>2d1c119</code></a> update test workflows to checkout v3 (<a href="https://github-redirect.dependabot.com/actions/checkout/issues/709">#709</a>)</li> <li>Additional commits viewable in <a href="https:/actions/checkout/compare/v2...v3">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/checkout&package-manager=github_actions&previous-version=2&new-version=3)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> -------------------- Commit message for microsoft/vscode-python@a074e8b: Updating package.json for Create Env tile (microsoft/vscode-python#20066) Updated package.json to include a Create Environment tile in the Python Getting Started walkthrough if there is a workspace open. If there is no workspace open, it will default to the normal Getting Started walkthrough with the Select Interpreter tile. This also incorporates the new walkthrough artwork. Co-authored-by: Kartik Raj <[email protected]> Co-authored-by: Luciana Abud <[email protected]> Lead-authored-by: Kartik Raj <[email protected]> Co-authored-by: Heejae Chang <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Eleanor Boyd <[email protected]> Co-authored-by: Jonathan McPherson <[email protected]> Co-authored-by: Karthik Nadig <[email protected]>

Ensure that search location is stored as a string.

5cb0642

karthiknadig added the bug Issue identified by VS Code Team member as probable bug label Oct 28, 2022

karthiknadig self-assigned this Oct 28, 2022

karthiknadig requested a review from karrtikr October 28, 2022 00:23

karrtikr approved these changes Oct 28, 2022

View reviewed changes

karrtikr marked this pull request as ready for review October 28, 2022 05:12

karrtikr enabled auto-merge (squash) October 28, 2022 05:13

karrtikr added the skip tests Updates to tests unnecessary label Oct 28, 2022

karrtikr merged commit 1db65b8 into microsoft:main Oct 28, 2022

karrtikr reviewed Oct 28, 2022

View reviewed changes

karthiknadig deleted the uri-issue branch November 2, 2022 19:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure that search location is stored as a string. #20106

Ensure that search location is stored as a string. #20106

karthiknadig commented Oct 28, 2022 •

edited by karrtikr

Loading

karrtikr Oct 28, 2022

karthiknadig Oct 28, 2022

Ensure that search location is stored as a string. #20106

Ensure that search location is stored as a string. #20106

Conversation

karthiknadig commented Oct 28, 2022 • edited by karrtikr Loading

karrtikr Oct 28, 2022

Choose a reason for hiding this comment

karthiknadig Oct 28, 2022

Choose a reason for hiding this comment

karthiknadig commented Oct 28, 2022 •

edited by karrtikr

Loading