Environment info cache class

[kimadeline]

Note that this impacts #14020.

• Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR).
• Title summarizes what is changing.
• Has a news entry file (remember to thank yourself!).
• Appropriate comments and documentation strings in the code.
• Has sufficient logging.
• Has telemetry for enhancements.
• Unit tests & system/integration tests are added/updated.
• Test plan is updated as appropriate.
• package-lock.json has been regenerated by running npm install (if dependencies have changed).
• The wiki is updated with any design decisions/details.

[codecov-commenter]

Codecov Report

Merging #14065 into main will increase coverage by 0.00%.
The diff coverage is 67.64%.

@@           Coverage Diff           @@
##             main   #14065   +/-   ##
=======================================
  Coverage   59.94%   59.95%           
=======================================
  Files         705      706    +1     
  Lines       39101    39135   +34     
  Branches     5667     5674    +7     
=======================================
+ Hits        23440    23462   +22     
- Misses      14429    14438    +9     
- Partials     1232     1235    +3     

Impacted Files	Coverage Δ
src/client/pythonEnvironments/index.ts	15.78% <ø> (ø)
.../pythonEnvironments/common/externalDependencies.ts	56.66% <22.22%> (-14.77%)	⬇️
src/client/pythonEnvironments/base/envsCache.ts	84.00% <84.00%> (ø)
src/client/common/utils/platform.ts	68.00% <0.00%> (-4.00%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6332b81...d67a118. Read the comment docs.

[karrtikr]

Some changes can depend on the resolution of https://github.com/microsoft/vscode-python/pull/14020/files#r493894442

[ericsnowcurrently]

Looks pretty good. I've left a variety of comments, some potentially related to correctness. I'd be glad to discuss any of it.

[kimadeline]

No idea why some of the PR checks are still failing 🤷‍♀️ Not related to this PR since I only added unit tests.

[ericsnowcurrently]

LGTM

Thanks for being so diligent about addressing the review comments!

[karrtikr]

LGTM

[karrtikr]

IPersistentStateFactory is not specific to python environments, why're we moving it?

[kimadeline]

When calling cache.initialize() inside the python environments initialization it needs access to the persistent state factory, however the latter was being added to the service manager later in the process, causing the entire extension initialization to fail.

[kimadeline]

Seems like it is causing all the other tests to fail though.

An alternative could be to not initialize the cache when calling the python envs initialization method, and let the cache locator deal with that.

Another alternative could be to add a "post-activate" call after activateComponents, where stuff like the envs cache would be initialized.

/cc @ericsnowcurrently

[karrtikr]

however the latter was being added to the service manager later in the process

I think that should be changed. We need to ensure that we do all the registrations before initializing the python envs component. Basically time to do the TODO item,

vscode-python/src/client/extensionActivation.ts

Lines 82 to 87 in 5690392

	// tslint:disable-next-line:no-suspicious-comment
	// TODO: Gradually move simple initialization
	// and DI registration currently in this function over
	// to initializeComponents(). Likewise with complex
	// init and activation: move them to activateComponents().
	// See https://github.com/microsoft/vscode-python/issues/10454.

Put them all before line 43 here,

vscode-python/src/client/extensionInit.ts

Lines 38 to 45 in 6bad0ef

	export function initializeComponents(
	_context: IExtensionContext,
	serviceManager: IServiceManager,
	serviceContainer: IServiceContainer
	) {
	activatePythonEnvironments(serviceManager, serviceContainer);
	// We will be pulling code over from activateLegacy().
	}

[kimadeline]

This change is going to touch a couple of moving parts so to wrap up this PR I will revert the last activation changes I made and not initialize the cache. I'll set up a separate PR to move activation of what the cache needs to initializeComponents, and re-add cache initialization.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
0.0% Duplication

[kimadeline]

OMG

Using up all my good karma for the day and merging it 💨