Quick pick API broken when quickpick.buttons option is set to true

[karrtikr]

THIS IS NOT A PYTHON EXTENSION ISSUE

This only happens starting from VSCode 1.51. 1.50 works fine. Process picker in the Python extension is broken because of this: microsoft/vscode-python#14678

Version: 1.52.0-insider (user setup)
OS: Windows_NT x64 10.0.19042

Steps to Reproduce:

1. Execute the following code to display quickpick

const refreshButton = {
    iconPath: 'getIcon(REFRESH_BUTTON_ICON)'
};
const quickPick = vscode.window.createQuickPick();
quickPick.items = [{ label: 'some label' }];
quickPick.buttons = [refreshButton];
quickPick.show();

2. No quickpick is displayed. Remove the .buttons assignment, or empty it.

const refreshButton = {
    iconPath: 'getIcon(REFRESH_BUTTON_ICON)'
};
const quickPick = vscode.window.createQuickPick();
quickPick.items = [{ label: 'some label' }];
quickPick.buttons = [];
quickPick.show();

Quickpick is displayed. The original code which failed is here.

3. Another workaround: Add another quickPick.show() line at the end.

const refreshButton = {
    iconPath: 'getIcon(REFRESH_BUTTON_ICON)'
};
const quickPick = vscode.window.createQuickPick();
quickPick.items = [{ label: 'some label' }];
quickPick.buttons = [refreshButton];
quickPick.show();
quickPick.show();

Quickpick is displayed. But refresh icon isn't displayed.

Does this issue occur when all extensions are disabled?: Yes

[chrmarti]

The iconPath must be a URI, the type has been like that since the introduction of QuickInputButton, our implementation happened to tolerate strings until recently. I'll add a fallback, but recommend to use Uri.file to convert the strings to URIs on the extension side to adhere to the vscode.d.ts. (This might have slipped through on your side because until recently ThemeIcon did not have any required properties, this changed with cb1dce0.)

[karrtikr]

Ok gotcha, thanks. Although I think that even if one of properties is invalid, the entire quickpick shouldn't fail to show. Instead that property should just be ignored. I would also like to point out that the fact it works when quickpick.show() is called for the second time is a bit strange too, and might reflect an underlying issue.

[karrtikr]

Interestingly iconPath property in almost other places does allows string: https://code.visualstudio.com/api/references/vscode-api
Perhaps this is something that can be improved.