Merge pull request #4653 from JoeRobich/fix-goto-metadata

Pull Metadata document if it isn't present in client

Author: JoeRobich

src/features/definitionMetadataDocumentProvider.ts

@@ -9,7 +9,7 @@ import { IDisposable } from '../Disposable';
 
 export default class DefinitionMetadataDocumentProvider implements TextDocumentContentProvider, IDisposable {
     readonly scheme = "omnisharp-metadata";
-    private _registration : IDisposable;
+    private _registration: IDisposable;
     private _documents: Map<string, MetadataResponse>;
     private _documentClosedSubscription: IDisposable;
 
@@ -18,36 +18,41 @@ export default class DefinitionMetadataDocumentProvider implements TextDocumentC
         this._documentClosedSubscription = workspace.onDidCloseTextDocument(this.onTextDocumentClosed, this);
     }
 
-    private onTextDocumentClosed(document: TextDocument) : void {
+    private onTextDocumentClosed(document: TextDocument): void {
         this._documents.delete(document.uri.toString());
     }
 
-    public dispose() : void {
+    public dispose(): void {
         this._registration.dispose();
         this._documentClosedSubscription.dispose();
         this._documents.clear();
     }
 
-    public addMetadataResponse(metadataResponse: MetadataResponse) : Uri {
+    public addMetadataResponse(metadataResponse: MetadataResponse): Uri {
         const uri = this.createUri(metadataResponse.SourceName);
         this._documents.set(uri.toString(), metadataResponse);
 
         return uri;
     }
 
-    public getExistingMetadataResponseUri(sourceName: string) : Uri {
+    public getExistingMetadataResponseUri(sourceName: string): Uri {
         return this.createUri(sourceName);
     }
 
-    public register() : void {
+    public hasMetadataDocument(sourceName: string): boolean {
+        const uri = this.createUri(sourceName);
+        return this._documents.has(uri.toString());
+    }
+
+    public register(): void {
         this._registration = workspace.registerTextDocumentContentProvider(this.scheme, this);
     }
 
-    public provideTextDocumentContent(uri: Uri) : string {
-        return this._documents.get(uri.toString()).Source;
+    public provideTextDocumentContent(uri: Uri): string {
+        return this._documents.get(uri.toString())?.Source;
     }
 
-    private createUri(sourceName: string) : Uri {
+    private createUri(sourceName: string): Uri {
         return Uri.parse(this.scheme + "://" +
             sourceName.replace(/\\/g, "/").replace(/(.*)\/(.*)/g, "$1/[metadata] $2"));
     }

src/features/definitionProvider.ts

@@ -34,16 +34,22 @@ export default class CSharpDefinitionProvider extends AbstractSupport implements
             if (gotoDefinitionResponse && gotoDefinitionResponse.Definitions) {
 
                 for (const definition of gotoDefinitionResponse.Definitions) {
-                    if (definition.Location.FileName.startsWith("$metadata$")) {
-                        // if it is part of an already used metadata file, retrieve its uri instead of going to the physical file
-                        const uri = this.definitionMetadataDocumentProvider.getExistingMetadataResponseUri(definition.Location.FileName);
-                        const vscodeRange = toRange3(definition.Location.Range);
-                        locations.push(new Location(uri, vscodeRange));
-                    } else if (definition.MetadataSource) {
+                    if (definition.MetadataSource) {
                         // the definition is in metadata
                         const metadataSource: MetadataSource = definition.MetadataSource;
 
-                        // go to metadata endpoint for more information
+                        // Do we already have a document for this metadata reference?
+                        if (definition.Location.FileName.startsWith("$metadata$") &&
+                            this.definitionMetadataDocumentProvider.hasMetadataDocument(definition.Location.FileName)) {
+
+                            // if it is part of an already used metadata file, retrieve its uri instead of going to the physical file
+                            const uri = this.definitionMetadataDocumentProvider.getExistingMetadataResponseUri(definition.Location.FileName);
+                            const vscodeRange = toRange3(definition.Location.Range);
+                            locations.push(new Location(uri, vscodeRange));
+                            continue;
+                        }
+
+                        // We need to go to the metadata endpoint for more information
                         const metadataResponse = await serverUtils.getMetadata(this._server, <MetadataRequest>{
                             Timeout: 5000,
                             AssemblyName: metadataSource.AssemblyName,