source control quickDiffProvider has become experimental, breaking existing usages

[mjcrouch]

Does this issue occur when all extensions are disabled?: N/A - issue with extension API

• VS Code Version: 1.76.0
• OS Version: Reproduced on MacOS 13.2.1, Ubuntu 22.10

Steps to Reproduce:

1. Create an extension using the SourceControl API's quickDiffProvider
2. Observe that an error is thrown when setting the SourceControl's quickDiffProvider attribute (edit: to an object with a label prop) e.g.

Error: Extension 'mjcrouch.perforce' CANNOT use API proposal: quickDiffProvider.
Its package.json#enabledApiProposals-property declares: [] but NOT quickDiffProvider.
 The missing proposal MUST be added and you must start in extension development mode or use the following command line switch: --enable-proposed-api mjcrouch.perforce

I can see that #169012 adds support for quickDiffProvider from various extensions, however it seems like it has also been marked as experimental within the existing source control usage which breaks my extension that uses the longstanding public API.

[joaomoreno]

This is unfortunate:

1. The classic Source Control QuickDiffProvider API doesn't have a label prop:

   vscode/src/vscode-dts/vscode.d.ts

   Lines 14259 to 14270 in 8dcf90c

   	interface QuickDiffProvider {
   	/**
   	* Provide a {@link Uri} to the original resource of any given resource uri.
   	*
   	* @param uri The uri of the resource open in a text editor.
   	* @param token A cancellation token.
   	* @return A thenable that resolves to uri of the matching original resource.
   	*/
   	provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
   	}

2. New QuickDiffProvider instances have it (but not required 🤔):

   vscode/src/vscode-dts/vscode.proposed.quickDiffProvider.d.ts

   Lines 14 to 17 in 8dcf90c

   	interface QuickDiffProvider {
   	label?: string;
   	}
   	}

3. So the proposed API check tests against that:

   vscode/src/vs/workbench/api/common/extHostSCM.ts

   Lines 491 to 493 in 8dcf90c

   	if (quickDiffProvider?.label) {
   	checkProposedApiEnabled(this._extension, 'quickDiffProvider');
   	}

@alexr00 since the prop is even optional in the new QuickDiffProvider type, I suggest to just remove the proposed API check in extHostSCM.

Marking as candidate to raise awareness: #175888

[mjcrouch]

I see, to clarify my initial post then, must be because my extension uses an object that happens to have a label prop rather than just any usage of the quick diff provider!

[mjcrouch]

just a note that I updated my extension - just added a simple object to use as a quickDiffProvider, that wraps around provideOriginalResource and doesn't have a label. This is a simple workaround and resolved the issue for my extension.

This will of course still be an issue for users of other extensions, such as the original slevesque.perforce extension that my extension is forked from, but the info may be useful for others!

[alexr00]

To verify:

1. Open the source control extension sample from https://github.com/microsoft/vscode-extension-samples/tree/main/source-control-sample
2. Modify fiddleRepository.ts to have a public string label in the FiddleRepository (https://github.com/microsoft/vscode-extension-samples/blob/d7dd9da34a9849396719408716d468512b5e5abb/source-control-sample/src/fiddleRepository.ts#L25-L26).
3. npm install and npm run watch
4. F5 to run the extension
5. Open the chrome dev tools so you can watch for API proposal errors.
6. Run the command Open JS Fiddle and go through all the prompt
   a. JSFiddle ID can be anything
   b. Choose the current folder that you have open
   c. Don't delete any files
7. Verify that you don't get any API proposal errors in the dev tools