Change format of requests to show module sources #12351
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Bicep.Core.Diagnostics; | ||
| using Bicep.Core.FileSystem; | ||
| using Bicep.Core.Registry; | ||
| using Bicep.Core.Registry.Oci; | ||
| using Bicep.Core.SourceCode; | ||
| using MediatR; | ||
| using OmniSharp.Extensions.JsonRpc; | ||
|
|
||
| namespace Bicep.LanguageServer.Handlers | ||
| { | ||
| [Method(BicepExternalSourceRequestHandler.BicepExternalSourceLspMethodName, Direction.ClientToServer)] | ||
| public record BicepExternalSourceParams( | ||
| string Target // The module reference to display sources for | ||
| ) : IRequest<BicepExternalSourceResponse>; | ||
|
|
||
| public record BicepExternalSourceResponse(string Content); | ||
|
|
||
| /// <summary> | ||
| /// Handles textDocument/bicepExternalSource LSP requests. These are sent by clients that are resolving contents of document URIs using the bicep-extsrc: scheme. | ||
| /// The BicepDefinitionHandler returns such URIs when definitions are inside modules that reside in the local module cache. | ||
| /// </summary> | ||
| public class BicepExternalSourceRequestHandler : IJsonRpcRequestHandler<BicepExternalSourceParams, BicepExternalSourceResponse> | ||
| { | ||
| public const string BicepExternalSourceLspMethodName = "textDocument/bicepExternalSource"; | ||
|
|
||
| private readonly IModuleDispatcher moduleDispatcher; | ||
| private readonly IFileResolver fileResolver; | ||
|
|
||
| public BicepExternalSourceRequestHandler(IModuleDispatcher moduleDispatcher, IFileResolver fileResolver) | ||
| { | ||
| this.moduleDispatcher = moduleDispatcher; | ||
| this.fileResolver = fileResolver; | ||
| } | ||
|
|
||
| public Task<BicepExternalSourceResponse> Handle(BicepExternalSourceParams request, CancellationToken cancellationToken) | ||
| { | ||
| // If any of the following paths result in an exception being thrown (and surfaced client-side to the user), | ||
| // it indicates a code defect client or server-side. | ||
| // In normal operation, the user should never see them regardless of how malformed their code is. | ||
|
|
||
| if (!moduleDispatcher.TryGetArtifactReference(ArtifactType.Module, request.Target, new Uri("file:https:///no-parent-file-is-available")).IsSuccess(out var moduleReference)) | ||
| { | ||
| throw new InvalidOperationException( | ||
| $"The client specified an invalid module reference '{request.Target}'."); | ||
| } | ||
|
|
||
| if (!moduleReference.IsExternal) | ||
| { | ||
| throw new InvalidOperationException( | ||
| $"The specified module reference '{request.Target}' refers to a local module which is not supported by {BicepExternalSourceLspMethodName} requests."); | ||
| } | ||
|
|
||
| if (this.moduleDispatcher.GetArtifactRestoreStatus(moduleReference, out _) != ArtifactRestoreStatus.Succeeded) | ||
| { | ||
| throw new InvalidOperationException( | ||
| $"The module '{moduleReference.FullyQualifiedReference}' has not yet been successfully restored."); | ||
| } | ||
|
|
||
| if (!moduleDispatcher.TryGetLocalArtifactEntryPointUri(moduleReference).IsSuccess(out var uri)) | ||
| { | ||
| throw new InvalidOperationException( | ||
| $"Unable to obtain the entry point URI for module '{moduleReference.FullyQualifiedReference}'."); | ||
| } | ||
|
|
||
| if (moduleDispatcher.TryGetModuleSources(moduleReference) is SourceArchive sourceArchive) | ||
| { | ||
| // TODO: For now, we just proffer the main source file | ||
| var entrypointFile = sourceArchive.SourceFiles.Single(f => f.Path == sourceArchive.EntrypointRelativePath); | ||
| return Task.FromResult(new BicepExternalSourceResponse(entrypointFile.Contents)); | ||
| } | ||
|
|
||
| // No sources available, just retrieve the JSON source | ||
| if (!this.fileResolver.TryRead(uri).IsSuccess(out var contents, out var failureBuilder)) | ||
| { | ||
| var message = failureBuilder(DiagnosticBuilder.ForDocumentStart()).Message; | ||
| throw new InvalidOperationException($"Unable to read file '{uri}'. {message}"); | ||
| } | ||
|
|
||
| return Task.FromResult(new BicepExternalSourceResponse(contents)); | ||
| } | ||
|
|
||
| /// <summary> | ||
|
|
||
| /// Creates a bicep-extsrc: URI for a given module's source file to give to the client to use as a document URI. (Client will then | ||
| /// ask for us the source code via a textDocument/externalSource request). | ||
| /// </summary> | ||
| /// <param name="reference">The module reference</param> | ||
| /// <param name="sourceArchive">The source archive for the module, if sources are available</param> | ||
| /// <returns>A bicep-extsrc: URI</returns> | ||
| public static Uri GetExternalSourceLinkUri(OciArtifactReference reference, SourceArchive? sourceArchive) | ||
| { | ||
| string entrypoint; | ||
| string? requestedSourceFile; | ||
|
|
||
| if (sourceArchive is { }) | ||
| { | ||
| // We have Bicep source code available. | ||
| entrypoint = sourceArchive.EntrypointRelativePath; | ||
| requestedSourceFile = entrypoint; | ||
| } | ||
| else | ||
| { | ||
| // Just showing the main.json | ||
| entrypoint = "main.json"; | ||
| requestedSourceFile = null; | ||
| } | ||
|
|
||
| var fullyQualifiedReference = reference.FullyQualifiedReference; | ||
| var version = reference.Tag is string ? $":{reference.Tag}" : $"@{reference.Digest}"; | ||
|
|
||
| var shortDocumentTitle = $"{entrypoint} ({Path.GetFileName(reference.Repository)}{version})"; | ||
| var fullDocumentTitle = $"{reference.Scheme}:{reference.Registry}/{reference.Repository}{version}/{shortDocumentTitle}"; | ||
|
|
||
| // Encode the module reference as a query and the file to retrieve as a fragment. | ||
| // Vs Code will strip the fragment and query and use the main part of the uri as the document title. | ||
| // The Bicep extension will use the fragment to make a call to use via textDocument/bicepExternalSource request (see BicepExternalSourceHandler) | ||
| // to get the actual source code contents to display. | ||
| // | ||
| // Example: | ||
| // | ||
| // source available (will be encoded): | ||
| // bicep-extsrc:br:myregistry.azurecr.io/myrepo:main.bicep (v1)?br:myregistry.azurecr.io/myrepo:v1#main.bicep | ||
| // | ||
| // source not available, showing just JSON (will be encoded) | ||
| // bicep-extsrc:br:myregistry.azurecr.io/myrepo:main.json (v1)?br:myregistry.azurecr.io/myrepo:v1 | ||
| // | ||
| var uri = new UriBuilder($"bicep-extsrc:{Uri.EscapeDataString(fullDocumentTitle)}"); | ||
| uri.Query = Uri.EscapeDataString(fullyQualifiedReference); | ||
| uri.Fragment = requestedSourceFile is null ? null : Uri.EscapeDataString(requestedSourceFile); | ||
| return uri.Uri; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
most of this file same as renamed file except name changes