Fix duplicate missing packages badge

[jmcphers]

Fixes #16311

Positron notebooks showed the "missing packages" badge twice in the toolbar. There are two badges registered on the same toolbar menu: one for scripts and one for notebooks. The script badge did not exclude notebooks, and the notebook toolbar renders that same menu, so both appeared. The script badge is now hidden when the active editor is a Positron notebook, so notebooks show only their own badge.

This also adds an e2e test that opens a notebook that imports a missing package, switches to another tab and back, and checks that exactly one badge is shown.

Release Notes

New Features

• N/A

Bug Fixes

• Fix the missing packages badge appearing twice in the Positron notebook toolbar when a script missing a package was also open (Notebooks: Notebook toolbar shows the missing packages badge twice #16311)

Validation Steps

@:packages-pane @:positron-notebooks

1. Enable Positron notebooks and open a notebook with a Python kernel that imports a package that isn't installed (e.g. import cowsay).
2. Check that the toolbar shows one "missing package" badge.
3. Switch to another editor tab and back, and check there is still only one badge.
4. Open a Python script that imports a missing package and check that its badge still shows.

[github-actions]

E2E Tests 🚀
This PR will run tests tagged with: @:critical @:packages-pane @:positron-notebooks

Why these tags?

Tag	Source
@:critical	Always runs (required)
@:packages-pane	PR description
@:positron-notebooks	PR description

More on automatic tags from changed files.

^{readme  valid tags}

[midleman]

Thanks for adding a test for this, and for tracing the cause.

Since the bug was just the script badge's when clause matching inside notebooks, could a unit test cover it instead of the e2e? The rule can be checked directly: register the badges, ask the widget registry which ones show for each active editor, and check the result. I tried it on your branch. It fails without your fix (both badges come back) and passes with it, in a couple of seconds:

/// <reference types="vitest/globals" />

import { MenuId } from '../../../../../platform/actions/common/actions.js';
import { IContextKeyService } from '../../../../../platform/contextkey/common/contextkey.js';
import { PositronActionBarWidgetRegistry } from '../../../../../platform/positronActionBar/browser/positronActionBarWidgetRegistry.js';
import { stubInterface } from '../../../../../test/vitest/stubInterface.js';
import { POSITRON_NOTEBOOK_EDITOR_ID } from '../../../positronNotebook/common/positronNotebookCommon.js';
import { MISSING_PACKAGES_SUPPORTED_KEY } from '../../browser/missingPackagesContextKey.js';
// Registers the badge widgets as a side effect.
import '../../browser/positronMissingPackages.contribution.js';

function badgesFor(activeEditor: string): string[] {
	const values: Record<string, unknown> = {
		activeEditor,
		[MISSING_PACKAGES_SUPPORTED_KEY.key]: true,
	};
	const contextKeyService = stubInterface<IContextKeyService>({
		contextMatchesRules: rules => !rules || rules.evaluate({ getValue: <T>(key: string) => values[key] as T }),
	});
	return PositronActionBarWidgetRegistry.getWidgets(MenuId.EditorActionsRight, contextKeyService)
		.map(w => w.id)
		.filter(id => id.startsWith('positronMissingPackages.'));
}

describe('missing packages badge registration', () => {
	it('shows only the notebook badge in a Positron notebook', () => {
		expect(badgesFor(POSITRON_NOTEBOOK_EDITOR_ID)).toEqual(['positronMissingPackages.notebookBadge']);
	});

	it('shows only the editor badge in a text editor', () => {
		expect(badgesFor('workbench.editors.files.textFileEditor')).toEqual(['positronMissingPackages.editorBadge']);
	});
});

The second case also covers your validation step 4, that scripts still get their badge. Not a blocker, just a suggestion. Let me know what you think!

[jmcphers]

@midleman thanks, replaced e2e with vitest in f74e0ac!

[midleman]

Thank you! :)