Skip to content

Aggressive caching with Open Current File as Release Notes #205846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexr00 merged 1 commit into from
Feb 21, 2024
Merged

Aggressive caching with Open Current File as Release Notes #205846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions src/vs/workbench/contrib/update/browser/releaseNotesEditor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ export class ReleaseNotesManager {
private readonly disposables = new DisposableStore();

public constructor(
private readonly _useCurrentFile: boolean,
@IEnvironmentService private readonly _environmentService: IEnvironmentService,
@IKeybindingService private readonly _keybindingService: IKeybindingService,
@ILanguageService private readonly _languageService: ILanguageService,
Expand Down Expand Up @@ -81,8 +80,8 @@ export class ReleaseNotesManager {
}
}

public async show(version: string): Promise<boolean> {
const releaseNoteText = await this.loadReleaseNotes(version);
public async show(version: string, useCurrentFile: boolean): Promise<boolean> {
const releaseNoteText = await this.loadReleaseNotes(version, useCurrentFile);
this._lastText = releaseNoteText;
const html = await this.renderBody(releaseNoteText);
const title = nls.localize('releaseNotesInputName', "Release Notes: {0}", version);
Expand Down Expand Up @@ -137,7 +136,7 @@ export class ReleaseNotesManager {
return true;
}

private async loadReleaseNotes(version: string): Promise<string> {
private async loadReleaseNotes(version: string, useCurrentFile: boolean): Promise<string> {
const match = /^(\d+\.\d+)\./.exec(version);
if (!match) {
throw new Error('not found');
Expand Down Expand Up @@ -199,7 +198,12 @@ export class ReleaseNotesManager {
const fetchReleaseNotes = async () => {
let text;
try {
text = this._useCurrentFile ? this._codeEditorService.getActiveCodeEditor()?.getModel()?.getValue() : await asTextOrError(await this._requestService.request({ url }, CancellationToken.None));
if (useCurrentFile) {
const file = this._codeEditorService.getActiveCodeEditor()?.getModel()?.getValue();
text = file ? file.substring(file.indexOf('#')) : undefined;
} else {
text = await asTextOrError(await this._requestService.request({ url }, CancellationToken.None));
}
} catch {
throw new Error('Failed to fetch release notes');
}
Expand All @@ -211,6 +215,10 @@ export class ReleaseNotesManager {
return patchKeybindings(text);
};

// Don't cache the current file
if (useCurrentFile) {
return fetchReleaseNotes();
}
if (!this._releaseNotesCache.has(version)) {
this._releaseNotesCache.set(version, (async () => {
try {
Expand Down
4 changes: 2 additions & 2 deletions src/vs/workbench/contrib/update/browser/update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ let releaseNotesManager: ReleaseNotesManager | undefined = undefined;

export function showReleaseNotesInEditor(instantiationService: IInstantiationService, version: string, useCurrentFile: boolean) {
if (!releaseNotesManager) {
releaseNotesManager = instantiationService.createInstance(ReleaseNotesManager, useCurrentFile);
releaseNotesManager = instantiationService.createInstance(ReleaseNotesManager);
}

return releaseNotesManager.show(version);
return releaseNotesManager.show(version, useCurrentFile);
}

async function openLatestReleaseNotesInBrowser(accessor: ServicesAccessor) {
Expand Down