Skip to content
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.

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

refactor(language-core): decouple from filename format #86

Merged
merged 7 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"--extensionDevelopmentPath=${workspaceRoot}/packages/labs"
],
"outFiles": [
"${workspaceRoot}/*/*/out/**/*.js"
"${workspaceRoot}/extensions/labs/dist/**/*.js"
],
},
],
Expand Down
3 changes: 2 additions & 1 deletion extensions/labs/scripts/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

require('esbuild').context({
entryPoints: {
extension: './src/extension.js',
extension: './src/extension.ts',
},
sourcemap: true,
bundle: true,
metafile: process.argv.includes('--metafile'),
outdir: './dist',
Expand Down
8 changes: 4 additions & 4 deletions extensions/labs/src/views/virtualFilesView.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,25 @@ export function activate(context: vscode.ExtensionContext) {
getTreeItem(element) {
if ('virtualFile' in element) {

const uri = vscode.Uri.file(element.virtualFile.fileName).with({ scheme: element.client.name.replace(/ /g, '_').toLowerCase() });
const uri = vscode.Uri.parse(element.virtualFile.id).with({ scheme: element.client.name.replace(/ /g, '_').toLowerCase() });
virtualUriToSourceUri.set(uri.toString(), element.sourceDocumentUri);

const virtualFileUris = sourceUriToVirtualUris.get(element.sourceDocumentUri) ?? new Set<string>();
virtualFileUris.add(uri.toString());
sourceUriToVirtualUris.set(element.sourceDocumentUri, virtualFileUris);

let label = path.basename(element.virtualFile.fileName);
let label = path.basename(element.virtualFile.id);
const version = (element.virtualFile as any).version;
label += ` (kind: ${element.virtualFile.kind}, version: ${version})`;
return {
iconPath: element.client.clientOptions.initializationOptions.codegenStack ? new vscode.ThemeIcon('debug-breakpoint') : new vscode.ThemeIcon('file'),
label,
collapsibleState: element.virtualFile.embeddedFiles.length ? vscode.TreeItemCollapsibleState.Expanded : vscode.TreeItemCollapsibleState.None,
resourceUri: vscode.Uri.file(element.virtualFile.fileName),
resourceUri: vscode.Uri.parse(element.virtualFile.id),
command: {
command: '_volar.action.openVirtualFile',
title: '',
arguments: [vscode.Uri.file(element.virtualFile.fileName).with({ scheme: element.client.name.replace(/ /g, '_').toLowerCase() })],
arguments: [vscode.Uri.parse(element.virtualFile.id).with({ scheme: element.client.name.replace(/ /g, '_').toLowerCase() })],
},
};
}
Expand Down
2 changes: 1 addition & 1 deletion packages/kit/lib/createChecker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function createTypeScriptCheckerWorker(
};

const projectHost = getTypeScriptProjectHost(env);
const project = createTypeScriptProject(projectHost, languages, resolveCommonLanguageId);
const project = createTypeScriptProject(languages, projectHost, env.fileNameToUri, resolveCommonLanguageId);
const service = createLanguageService(
{ typescript: ts as any },
services,
Expand Down
3 changes: 1 addition & 2 deletions packages/kit/lib/createFormatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ export function createFormatter(
) {

let fakeUri = 'file:///dummy.txt';
let fakeFileName = '/dummy.txt';
let settings = {};

const env = createServiceEnvironment(() => settings);
Expand All @@ -36,7 +35,7 @@ export function createFormatter(

async function format(content: string, languageId: string, options: FormattingOptions): Promise<string> {

fileProvider.updateSource(fakeFileName, ts.ScriptSnapshot.fromString(content), languageId);
fileProvider.updateSourceFile(fakeUri, ts.ScriptSnapshot.fromString(content), languageId);

const document = service.context.getTextDocument(fakeUri)!;
const edits = await service.format(fakeUri, options, undefined, undefined);
Expand Down
90 changes: 36 additions & 54 deletions packages/language-core/lib/createFileProvider.ts
Original file line number Diff line number Diff line change
@@ -1,36 +1,32 @@
import { SourceMap } from '@volar/source-map';
import type * as ts from 'typescript/lib/tsserverlibrary';
import { MirrorMap } from './mirrorMap';
import type { FileRangeCapabilities, Language, VirtualFile } from './types';

export interface Source {
fileName: string;
languageId: string;
snapshot: ts.IScriptSnapshot;
root?: VirtualFile;
language?: Language;
}
import type { FileRangeCapabilities, Language, SourceFile, VirtualFile } from './types';

const caseSensitive = false; // TODO: use ts.sys.useCaseSensitiveFileNames

export function createFileProvider(languages: Language[], sync: () => void) {

const sourceFiles = new Map<string, Source>();
const virtualFiles = new Map<string, { virtualFile: VirtualFile, source: Source; }>();
const sourceFileRegistry = new Map<string, SourceFile>();
const virtualFileRegistry = new Map<string, { virtualFile: VirtualFile, source: SourceFile; }>();
const virtualFileMaps = new WeakMap<ts.IScriptSnapshot, Map<string, [ts.IScriptSnapshot, SourceMap<FileRangeCapabilities>]>>();
const virtualFileToMirrorMap = new WeakMap<ts.IScriptSnapshot, MirrorMap | undefined>();
const normalizeId = caseSensitive
? (id: string) => id
: (id: string) => id.toLowerCase();

return {
getAllSources() {
getAllSourceFiles() {
sync();
return sourceFiles;
return sourceFileRegistry.values();
},
updateSource(fileName: string, snapshot: ts.IScriptSnapshot, languageId: string): VirtualFile | undefined {
const key = normalizePath(fileName);
const value = sourceFiles.get(key);
updateSourceFile(id: string, snapshot: ts.IScriptSnapshot, languageId: string): VirtualFile | undefined {
const value = sourceFileRegistry.get(normalizeId(id));
if (value) {
if (value.languageId !== languageId) {
// languageId changed
this.deleteSource(fileName);
return this.updateSource(fileName, snapshot, languageId);
this.deleteSourceFile(id);
return this.updateSourceFile(id, snapshot, languageId);
}
else if (value.snapshot !== snapshot) {
value.snapshot = snapshot;
Expand All @@ -46,24 +42,23 @@ export function createFileProvider(languages: Language[], sync: () => void) {
}
}
for (const language of languages) {
const virtualFile = language.createVirtualFile(fileName, snapshot, languageId);
const virtualFile = language.createVirtualFile(id, languageId, snapshot);
if (virtualFile) {
const source: Source = { fileName, languageId, snapshot, root: virtualFile, language };
sourceFiles.set(key, source);
const source: SourceFile = { id: id, languageId, snapshot, root: virtualFile, language };
sourceFileRegistry.set(normalizeId(id), source);
updateVirtualFiles(source);
return virtualFile; // created
}
}
sourceFiles.set(key, { fileName, languageId, snapshot });
sourceFileRegistry.set(normalizeId(id), { id: id, languageId, snapshot });
},
deleteSource(fileName: string) {
const key = normalizePath(fileName);
const value = sourceFiles.get(key);
deleteSourceFile(id: string) {
const value = sourceFileRegistry.get(normalizeId(id));
if (value) {
if (value.language && value.root) {
value.language.deleteVirtualFile?.(value.root);
}
sourceFiles.delete(key); // deleted
sourceFileRegistry.delete(normalizeId(id)); // deleted
deleteVirtualFiles(value);
}
},
Expand All @@ -79,62 +74,53 @@ export function createFileProvider(languages: Language[], sync: () => void) {
virtualFileMaps.set(virtualFile.snapshot, new Map());
}

updateVirtualFileMaps(virtualFile, sourceFileName => {
if (sourceFileName) {
const source = sourceFiles.get(normalizePath(sourceFileName))!;
return [sourceFileName, source.snapshot];
updateVirtualFileMaps(virtualFile, sourceId => {
if (sourceId) {
const sourceFile = sourceFileRegistry.get(normalizeId(sourceId))!;
return [sourceId, sourceFile.snapshot];
}
else {
const source = virtualFiles.get(normalizePath(virtualFile.fileName))!.source;
return [source.fileName, source.snapshot];
const source = virtualFileRegistry.get(normalizeId(virtualFile.id))!.source;
return [source.id, source.snapshot];
}
}, virtualFileMaps.get(virtualFile.snapshot));

return virtualFileMaps.get(virtualFile.snapshot)!;
},
getSource(fileName: string) {
sync();
const key = normalizePath(fileName);
return sourceFiles.get(key);
},
hasSource(fileName: string) {
getSourceFile(id: string) {
sync();
return sourceFiles.has(normalizePath(fileName));
return sourceFileRegistry.get(normalizeId(id));
},
hasVirtualFile(fileName: string) {
getVirtualFile(id: string) {
sync();
return !!virtualFiles.get(normalizePath(fileName));
},
getVirtualFile(fileName: string) {
sync();
const sourceAndVirtual = virtualFiles.get(normalizePath(fileName));
const sourceAndVirtual = virtualFileRegistry.get(normalizeId(id));
if (sourceAndVirtual) {
return [sourceAndVirtual.virtualFile, sourceAndVirtual.source] as const;
}
return [undefined, undefined] as const;
},
};

function deleteVirtualFiles(source: Source) {
function deleteVirtualFiles(source: SourceFile) {
if (source.root) {
forEachEmbeddedFile(source.root, file => {
virtualFiles.delete(normalizePath(file.fileName));
virtualFileRegistry.delete(normalizeId(file.id));
});
}
}

function updateVirtualFiles(source: Source) {
function updateVirtualFiles(source: SourceFile) {
if (source.root) {
forEachEmbeddedFile(source.root, file => {
virtualFiles.set(normalizePath(file.fileName), { virtualFile: file, source });
virtualFileRegistry.set(normalizeId(file.id), { virtualFile: file, source });
});
}
}
}

export function updateVirtualFileMaps(
virtualFile: VirtualFile,
getSourceSnapshot: (source: string | undefined) => [string, ts.IScriptSnapshot] | undefined,
getSourceSnapshot: (sourceUri: string | undefined) => [string, ts.IScriptSnapshot] | undefined,
map: Map<string, [ts.IScriptSnapshot, SourceMap<FileRangeCapabilities>]> = new Map(),
) {

Expand Down Expand Up @@ -165,7 +151,3 @@ export function forEachEmbeddedFile(file: VirtualFile, cb: (embedded: VirtualFil
forEachEmbeddedFile(embeddedFile, cb);
}
}

function normalizePath(fileName: string) {
return fileName.replace(/\\/g, '/').toLowerCase();
}
19 changes: 11 additions & 8 deletions packages/language-core/lib/createTypeScriptProject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,20 @@ import { Language, TypeScriptProjectHost, Project } from './types';
import type * as ts from 'typescript/lib/tsserverlibrary';

export function createTypeScriptProject(
projectHost: TypeScriptProjectHost,
languages: Language<any>[],
getLanguageId: (fileName: string) => string,
projectHost: TypeScriptProjectHost,
fileNameToId: (fileName: string) => string,
getLanguageId: (fileName: string) => string
): Project {

for (const language of languages) {
if (language.resolveTypeScriptProjectHost) {
projectHost = language.resolveTypeScriptProjectHost(projectHost);
if (language.typescript?.resolveProjectHost) {
projectHost = language.typescript.resolveProjectHost(projectHost);
}
}

let lastRootFiles = new Map<string, ts.IScriptSnapshot | undefined>();
let lastProjectVersion: number | string | undefined;
let lastProjectVersion: string | undefined;

const fileProvider = createFileProvider(languages, () => {

Expand All @@ -34,17 +35,19 @@ export function createTypeScriptProject(
for (const [fileName, snapshot] of newRootFiles) {
remainRootFiles.delete(fileName);
if (lastRootFiles.get(fileName) !== newRootFiles.get(fileName)) {
const id = fileNameToId(fileName);
if (snapshot) {
fileProvider.updateSource(fileName, snapshot, getLanguageId(fileName));
fileProvider.updateSourceFile(id, snapshot, getLanguageId(fileName));
}
else {
fileProvider.deleteSource(fileName);
fileProvider.deleteSourceFile(id);
}
}
}

for (const fileName of remainRootFiles) {
fileProvider.deleteSource(fileName);
const id = fileNameToId(fileName);
fileProvider.deleteSourceFile(id);
}

lastRootFiles = newRootFiles;
Expand Down
27 changes: 21 additions & 6 deletions packages/language-core/lib/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,12 @@ export enum FileKind {
TypeScriptHostFile = 1,
}

export interface VirtualFile {
fileName: string,
snapshot: ts.IScriptSnapshot,
languageId: string,
export interface SourceFile extends BaesFile {
root?: VirtualFile;
language?: Language;
}

export interface VirtualFile extends BaesFile {
kind: FileKind,
capabilities: FileCapabilities,
mappings: Mapping<FileRangeCapabilities>[],
Expand All @@ -87,11 +89,24 @@ export interface VirtualFile {
embeddedFiles: VirtualFile[],
}

export interface BaesFile {
/**
* for language-server, kit, monaco, this is uri
*
* for typescript server plugin, tsc, this is fileName
*/
id: string,
languageId: string,
snapshot: ts.IScriptSnapshot,
}

export interface Language<T extends VirtualFile = VirtualFile> {
createVirtualFile(fileName: string, snapshot: ts.IScriptSnapshot, languageId: string): T | undefined;
createVirtualFile(id: string, languageId: string, snapshot: ts.IScriptSnapshot): T | undefined;
updateVirtualFile(virtualFile: T, snapshot: ts.IScriptSnapshot): void;
deleteVirtualFile?(virtualFile: T): void;
resolveTypeScriptProjectHost?<T extends TypeScriptProjectHost>(host: T): T;
typescript?: {
resolveProjectHost?<T extends TypeScriptProjectHost>(host: T): T;
};
}

export interface TypeScriptProjectHost extends Pick<
Expand Down
7 changes: 3 additions & 4 deletions packages/language-server/lib/project/simpleProject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ export async function createSimpleServerProject(
let shouldUpdate = true;
let lastSnapshots = new Map<string, ts.IScriptSnapshot | undefined>();

const { uriToFileName } = context.server.runtimeEnv;
const config = await getConfig(context, plugins, serviceEnv, undefined);

context.workspaces.documents.onDidChangeContent(() => {
Expand Down Expand Up @@ -55,16 +54,16 @@ export async function createSimpleServerProject(
const newSnapshot = snapshot?.getSnapshot();
if (lastSnapshots.get(uri) !== snapshot) {
if (snapshot && newSnapshot) {
fileProvider.updateSource(uriToFileName(uri), newSnapshot, snapshot.languageId);
fileProvider.updateSourceFile(uri, newSnapshot, snapshot.languageId);
}
else {
fileProvider.deleteSource(uriToFileName(uri));
fileProvider.deleteSourceFile(uri);
}
}
}

for (const uri of remain) {
fileProvider.deleteSource(uriToFileName(uri));
fileProvider.deleteSourceFile(uri);
}

const _newSnapshots = new Map<string, ts.IScriptSnapshot | undefined>();
Expand Down
3 changes: 2 additions & 1 deletion packages/language-server/lib/project/typescriptProject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,9 @@ export async function createTypeScriptServerProject(
Object.values(config.services ?? {}),
serviceEnv,
createTypeScriptProject(
typescriptProjectHost,
Object.values(config.languages ?? {}),
typescriptProjectHost,
serviceEnv.fileNameToUri,
fileName => context.workspaces.documents.data.pathGet(fileName)?.languageId ?? resolveCommonLanguageId(fileName),
),
);
Expand Down
Loading
Loading