Skip to content

Commit

Permalink
Fix SQL/Notebook editors opening as plaintext (#16442) (#16456)
Browse files Browse the repository at this point in the history 
* Register overrides at startup

* Always wait for extensions

* Fix compile errors

(cherry picked from commit 2d8e0d6)
  • Loading branch information
@Charles-Gagnon
Charles-Gagnon committed Jul 28, 2021
1 parent ce93729 commit 65fb22c
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 80 deletions.
77 changes: 39 additions & 38 deletions src/sql/workbench/contrib/notebook/browser/notebook.contribution.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -677,47 +677,48 @@ export class NotebookEditorOverrideContribution extends Disposable implements IW
@IModeService private _modeService: IModeService
) {
super();
this.registerEditorOverride();
}

private registerEditorOverride(): void {
this.registerEditorOverrides();
// Refresh the editor overrides whenever the languages change so we ensure we always have
// the latest up to date list of extensions for each language
this._modeService.onLanguagesMaybeChanged(() => {
this._registeredOverrides.clear();
// List of language IDs to associate the query editor for. These are case sensitive.
NotebookEditorInputAssociation.languages.map(lang => {
const langExtensions = this._modeService.getExtensions(lang);
if (langExtensions.length === 0) {
return;
this.registerEditorOverrides();
});
}

private registerEditorOverrides(): void {
this._registeredOverrides.clear();
// List of language IDs to associate the query editor for. These are case sensitive.
NotebookEditorInputAssociation.languages.map(lang => {
const langExtensions = this._modeService.getExtensions(lang);
if (langExtensions.length === 0) {
return;
}
// Create the selector from the list of all the language extensions we want to associate with the
// notebook editor (filtering out any languages which didn't have any extensions registered yet)
const selector = `*{${langExtensions.join(',')}}`;
this._registeredOverrides.add(this._editorOverrideService.registerContributionPoint(
selector,
{
id: NotebookEditor.ID,
label: NotebookEditor.LABEL,
describes: (currentEditor) => currentEditor instanceof FileNotebookInput,
priority: ContributedEditorPriority.builtin
},
{},
(resource, options, group) => {
const fileInput = this._editorService.createEditorInput({
resource: resource
}) as FileEditorInput;
// Try to convert the input, falling back to just a plain file input if we're unable to
const newInput = this.tryConvertInput(fileInput, lang) ?? fileInput;
return { editor: newInput, options: options, group: group };
},
(diffEditorInput, options, group) => {
// Try to convert the input, falling back to the original input if we're unable to
const newInput = this.tryConvertInput(diffEditorInput, lang) ?? diffEditorInput;
return { editor: newInput, options: options, group: group };
}
// Create the selector from the list of all the language extensions we want to associate with the
// notebook editor (filtering out any languages which didn't have any extensions registered yet)
const selector = `*{${langExtensions.join(',')}}`;
this._registeredOverrides.add(this._editorOverrideService.registerContributionPoint(
selector,
{
id: NotebookEditor.ID,
label: NotebookEditor.LABEL,
describes: (currentEditor) => currentEditor instanceof FileNotebookInput,
priority: ContributedEditorPriority.builtin
},
{},
(resource, options, group) => {
const fileInput = this._editorService.createEditorInput({
resource: resource
}) as FileEditorInput;
// Try to convert the input, falling back to just a plain file input if we're unable to
const newInput = this.tryConvertInput(fileInput, lang) ?? fileInput;
return { editor: newInput, options: options, group: group };
},
(diffEditorInput, options, group) => {
// Try to convert the input, falling back to the original input if we're unable to
const newInput = this.tryConvertInput(diffEditorInput, lang) ?? diffEditorInput;
return { editor: newInput, options: options, group: group };
}
));
});
));
});
}

Expand All @@ -733,4 +734,4 @@ export class NotebookEditorOverrideContribution extends Disposable implements IW
}

Registry.as<IWorkbenchContributionsRegistry>(WorkbenchExtensions.Workbench)
.registerWorkbenchContribution(NotebookEditorOverrideContribution, LifecyclePhase.Restored);
.registerWorkbenchContribution(NotebookEditorOverrideContribution, LifecyclePhase.Starting);
74 changes: 37 additions & 37 deletions src/sql/workbench/contrib/query/browser/query.contribution.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,47 +510,47 @@ export class QueryEditorOverrideContribution extends Disposable implements IWork
) {
super();
this.registerEditorOverrides();
}

private registerEditorOverrides(): void {
// Refresh the editor overrides whenever the languages change so we ensure we always have
// the latest up to date list of extensions for each language
this._modeService.onLanguagesMaybeChanged(() => {
this._registeredOverrides.clear();
// List of language IDs to associate the query editor for. These are case sensitive.
QueryEditorLanguageAssociation.languages.map(lang => {
const langExtensions = this._modeService.getExtensions(lang);
if (langExtensions.length === 0) {
return;
}
// Create the selector from the list of all the language extensions we want to associate with the
// query editor (filtering out any languages which didn't have any extensions registered yet)
const selector = `*{${langExtensions.join(',')}}`;
this._registeredOverrides.add(this._editorOverrideService.registerContributionPoint(
selector,
{
id: QueryEditor.ID,
label: QueryEditor.LABEL,
describes: (currentEditor) => currentEditor instanceof FileQueryEditorInput,
priority: ContributedEditorPriority.builtin
},
{},
(resource, options, group) => {
const fileInput = this._editorService.createEditorInput({
resource: resource
}) as FileEditorInput;
const langAssociation = languageAssociationRegistry.getAssociationForLanguage(lang);
const queryEditorInput = langAssociation?.syncConvertinput?.(fileInput);
if (!queryEditorInput) {
this._logService.warn('Unable to create input for overriding editor ', resource);
return undefined;
}
return { editor: queryEditorInput, options: options, group: group };
this.registerEditorOverrides();
});
}

private registerEditorOverrides(): void {
this._registeredOverrides.clear();
// List of language IDs to associate the query editor for. These are case sensitive.
QueryEditorLanguageAssociation.languages.map(lang => {
const langExtensions = this._modeService.getExtensions(lang);
if (langExtensions.length === 0) {
return;
}
// Create the selector from the list of all the language extensions we want to associate with the
// query editor (filtering out any languages which didn't have any extensions registered yet)
const selector = `*{${langExtensions.join(',')}}`;
this._registeredOverrides.add(this._editorOverrideService.registerContributionPoint(
selector,
{
id: QueryEditor.ID,
label: QueryEditor.LABEL,
describes: (currentEditor) => currentEditor instanceof FileQueryEditorInput,
priority: ContributedEditorPriority.builtin
},
{},
(resource, options, group) => {
const fileInput = this._editorService.createEditorInput({
resource: resource
}) as FileEditorInput;
const langAssociation = languageAssociationRegistry.getAssociationForLanguage(lang);
const queryEditorInput = langAssociation?.syncConvertinput?.(fileInput);
if (!queryEditorInput) {
this._logService.warn('Unable to create input for overriding editor ', resource);
return undefined;
}
));
});
return { editor: queryEditorInput, options: options, group: group };
}
));
});
}
}

workbenchRegistry.registerWorkbenchContribution(QueryEditorOverrideContribution, LifecyclePhase.Restored);
workbenchRegistry.registerWorkbenchContribution(QueryEditorOverrideContribution, LifecyclePhase.Starting);
14 changes: 9 additions & 5 deletions src/vs/workbench/services/editor/browser/editorOverrideService.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export class EditorOverrideService extends Disposable implements IEditorOverride

private _contributionPoints: Map<string | glob.IRelativePattern, ContributionPoints> = new Map<string | glob.IRelativePattern, ContributionPoints>();
private static readonly overrideCacheStorageID = 'editorOverrideService.cache';
private cache: Set<string> | undefined;
// private cache: Set<string> | undefined; {{SQL CARBON EDIT}} Remove unused

constructor(
@IEditorGroupsService private readonly editorGroupService: IEditorGroupsService,
Expand All @@ -56,7 +56,7 @@ export class EditorOverrideService extends Disposable implements IEditorOverride
) {
super();
// Read in the cache on statup
this.cache = new Set<string>(JSON.parse(this.storageService.get(EditorOverrideService.overrideCacheStorageID, StorageScope.GLOBAL, JSON.stringify([]))));
// this.cache = new Set<string>(JSON.parse(this.storageService.get(EditorOverrideService.overrideCacheStorageID, StorageScope.GLOBAL, JSON.stringify([])))); {{SQL CARBON EDIT}} Remove unused
this.storageService.remove(EditorOverrideService.overrideCacheStorageID, StorageScope.GLOBAL);

this._register(this.storageService.onWillSaveState(() => {
Expand All @@ -65,16 +65,18 @@ export class EditorOverrideService extends Disposable implements IEditorOverride
}));

// When extensions have registered we no longer need the cache
/* {{SQL CARBON EDIT}} Remove unused
this.extensionService.onDidRegisterExtensions(() => {
this.cache = undefined;
});
*/
}

async resolveEditorOverride(editor: IEditorInput, options: IEditorOptions | ITextEditorOptions | undefined, group: IEditorGroup): Promise<IEditorInputWithOptionsAndGroup | undefined> {
// If it was an override before we await for the extensions to activate and then proceed with overriding or else they won't be registered
if (this.cache && editor.resource && this.resourceMatchesCache(editor.resource)) {
await this.extensionService.whenInstalledExtensionsRegistered();
}
//if (this.cache && editor.resource && this.resourceMatchesCache(editor.resource)) { // {{SQL CARBON EDIT}} Always wait for extensions so that our language-based overrides (SQL/Notebooks) will always have those registered
await this.extensionService.whenInstalledExtensionsRegistered();
//}

if (options?.override === EditorOverride.DISABLED) {
throw new Error(`Calling resolve editor override when override is explicitly disabled!`);
Expand Down Expand Up @@ -547,6 +549,7 @@ export class EditorOverrideService extends Disposable implements IEditorOverride
this.storageService.store(EditorOverrideService.overrideCacheStorageID, JSON.stringify(Array.from(cacheStorage)), StorageScope.GLOBAL, StorageTarget.MACHINE);
}

/* {{SQL CARBON EDIT}} Remove unused
private resourceMatchesCache(resource: URI): boolean {
if (!this.cache) {
return false;
Expand All @@ -559,6 +562,7 @@ export class EditorOverrideService extends Disposable implements IEditorOverride
}
return false;
}
*/
}

registerSingleton(IEditorOverrideService, EditorOverrideService);

0 comments on commit 65fb22c

Please sign in to comment.