feat/deep copy - #2990
Draft
Vincent Biret (baywet) wants to merge 3 commits into
Draft
Conversation
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
Code Coverage OverviewLanguages: C# C# / code-coverage/dotnetThe overall coverage in commit 27be67d in the Show a code coverage summary of the most impacted files.
|
![github-advanced-security[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| }; | ||
| Add(source, target); | ||
| target.Definitions = CopyMap(source.Definitions); | ||
| if (source is IOpenApiSchemaMissingProperties missing) |
| IOpenApiLink link => (T)Copy(link), | ||
| IOpenApiCallback callback => (T)Copy(callback), | ||
| IOpenApiPathItem pathItem => (T)Copy(pathItem), | ||
| OpenApiServer server => (T)(object)Copy(server), |
| IOpenApiCallback callback => (T)Copy(callback), | ||
| IOpenApiPathItem pathItem => (T)Copy(pathItem), | ||
| OpenApiServer server => (T)(object)Copy(server), | ||
| OpenApiServerVariable serverVariable => (T)(object)Copy(serverVariable), |
| IOpenApiPathItem pathItem => (T)Copy(pathItem), | ||
| OpenApiServer server => (T)(object)Copy(server), | ||
| OpenApiServerVariable serverVariable => (T)(object)Copy(serverVariable), | ||
| OpenApiSecurityRequirement securityRequirement => (T)(object)Copy(securityRequirement), |
| OpenApiServer server => (T)(object)Copy(server), | ||
| OpenApiServerVariable serverVariable => (T)(object)Copy(serverVariable), | ||
| OpenApiSecurityRequirement securityRequirement => (T)(object)Copy(securityRequirement), | ||
| OpenApiEncoding encoding => (T)(object)Copy(encoding), |
| OpenApiServerVariable serverVariable => (T)(object)Copy(serverVariable), | ||
| OpenApiSecurityRequirement securityRequirement => (T)(object)Copy(securityRequirement), | ||
| OpenApiEncoding encoding => (T)(object)Copy(encoding), | ||
| RuntimeExpressionAnyWrapper wrapper => (T)(object)Copy(wrapper), |
| OpenApiSecurityRequirement securityRequirement => (T)(object)Copy(securityRequirement), | ||
| OpenApiEncoding encoding => (T)(object)Copy(encoding), | ||
| RuntimeExpressionAnyWrapper wrapper => (T)(object)Copy(wrapper), | ||
| OpenApiTag tag => (T)(object)Copy(tag), |
| OpenApiEncoding encoding => (T)(object)Copy(encoding), | ||
| RuntimeExpressionAnyWrapper wrapper => (T)(object)Copy(wrapper), | ||
| OpenApiTag tag => (T)(object)Copy(tag), | ||
| OpenApiTagReference tagReference => (T)(object)Copy(tagReference), |
There was a problem hiding this comment.
Pull request overview
This PR introduces an experimental deep-copy API across the OpenAPI.NET object model, providing a way to clone an OpenApiDocument (and many model elements) into an independent object graph while remapping references to the copied host document.
Changes:
- Adds
IDeepCopyable<T>andCreateDeepCopy()implementations across many OpenAPI model and reference-holder types (marked[Experimental("OPENAPI001")]). - Introduces
OpenApiDeepCopyContextto perform graph-aware cloning (cycle handling + reference remapping via host-document rewriting). - Adds unit tests validating deep-copy behavior (graph independence, JsonNode cloning, reference host remap, and ordered tag set preservation).
Reviewed changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/Microsoft.OpenApi.Tests/Models/OpenApiDeepCopyTests.cs | Adds tests covering deep-copy behavior (graph independence, JSON node cloning, host-document remap, ordered tags). |
| src/Microsoft.OpenApi/Services/ReferenceHostDocumentSetter.cs | Adds an overwrite mode so deep-copy can force references to point at the copied document. |
| src/Microsoft.OpenApi/PublicAPI.Unshipped.txt | Declares new experimental public surface for IDeepCopyable<T> and CreateDeepCopy() APIs. |
| src/Microsoft.OpenApi/Models/OpenApiDeepCopyContext.cs | New graph-copy engine that clones documents/models, handles cycles, and rewrites reference host documents. |
| src/Microsoft.OpenApi/Interfaces/IDeepCopyable.cs | New experimental interface defining CreateDeepCopy(). |
| src/Microsoft.OpenApi/Attributes/ExperimentalAttribute.cs | Adds an internal polyfill for ExperimentalAttribute on pre-.NET8 TFMs. |
| src/Microsoft.OpenApi/Models/BaseOpenApiReference.cs | Adds SetHostDocument to support overwriting host document during deep copy. |
| src/Microsoft.OpenApi/Microsoft.OpenApi.csproj | Suppresses OPENAPI001 in the library build. |
| src/Microsoft.OpenApi/Models/OpenApiDocument.cs | Adds experimental CreateDeepCopy() entry point for documents. |
| src/Microsoft.OpenApi/Models/OpenApiComponents.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiInfo.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiContact.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiLicense.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiExternalDocs.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiServer.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiServerVariable.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiPaths.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiPathItem.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiOperation.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiResponses.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiResponse.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiParameter.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiMediaType.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiEncoding.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiExample.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiLink.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiCallback.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiSecurityScheme.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiSecurityRequirement.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiOAuthFlow.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiOAuthFlows.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiSchema.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiDiscriminator.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiTag.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/OpenApiXml.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/RuntimeExpressionAnyWrapper.cs | Adds experimental CreateDeepCopy(). |
| src/Microsoft.OpenApi/Models/References/OpenApiSchemaReference.cs | Adds experimental CreateDeepCopy() for schema reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiResponseReference.cs | Adds experimental CreateDeepCopy() for response reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiRequestBodyReference.cs | Adds experimental CreateDeepCopy() for request-body reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiParameterReference.cs | Adds experimental CreateDeepCopy() for parameter reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiMediaTypeReference.cs | Adds experimental CreateDeepCopy() for media-type reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiHeaderReference.cs | Adds experimental CreateDeepCopy() for header reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiExampleReference.cs | Adds experimental CreateDeepCopy() for example reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiLinkReference.cs | Adds experimental CreateDeepCopy() for link reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiCallbackReference.cs | Adds experimental CreateDeepCopy() for callback reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiPathItemReference.cs | Adds experimental CreateDeepCopy() for path-item reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiSecuritySchemeReference.cs | Adds experimental CreateDeepCopy() for security-scheme reference holders. |
| src/Microsoft.OpenApi/Models/References/OpenApiTagReference.cs | Adds experimental CreateDeepCopy() for tag reference holders. |
| .vscode/settings.json | Adds “Xunit” to cSpell dictionary. |
|
|
||
| var target = new OpenApiDocument | ||
| { | ||
| Workspace = source.Workspace?.BaseUrl != null ? new(source.Workspace.BaseUrl) : source.Workspace != null ? new OpenApiWorkspace() : null, |
Comment on lines
+893
to
+898
| private IOpenApiExtension CopyExtension(IOpenApiExtension source) => source switch | ||
| { | ||
| JsonNodeExtension jsonNodeExtension => new JsonNodeExtension(CopyJsonNode(jsonNodeExtension.Node)), | ||
| IDeepCopyable<IOpenApiExtension> deepCopyableExtension => deepCopyableExtension.CreateDeepCopy(), | ||
| _ => source | ||
| }; |
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
partial #2967