Cherry-pick b94324c from 8.x to 7.x: Provide async APIs for CsdlWriter and SchemaWriter (#3006) #3060
Conversation
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
* Add corresponding async methods for syncronous methods of EdmModelCsdlSchemaJsonWriter * Implemented asynchronous counterparts for synchronous virtual and abstract methods for EdmModelCsdlSchemaWriter class * Added asynchronous implementations for the synchronous methods in EdmModelCsdlSchemaXmlWriter * Added corresponding asynchronous methods for EdmModelReferenceElementsJsonVisitor, EdmModelCsdlSerializationVisitor and EdmModelReferenceElementsXmlVisitor * Added asynchronous counterparts for csdl writer methods * Added async corresponding sync methods for EdmModelVisitor * Fix WriteStartElementAsync prefix and namespace missing * Added csdl async/await and functional tests for csdl writer async methods * Added async APIs to net48 public API * Fixed comments to add ConfigureAwait(false) * Added configureAwait(false) to await tests * Elude await/async in BeginElementAsync method Func<TElement, Task> params * Rewrite the doc string of the async methods to add <returns> and provide correct summary * Rewrite WriteSchemata to WriteSchema * Move the asynhronous tests to .Async partial classes * Added ContextUrlWriterReaderTests.Async partial class with async tests and fix asynhronous equal true when writing xml * Added doc string for <params></params> * Resolve missing spaces * Added Returns Documentation string for WriteCsdlAsync * Remove unnecessary 'else' * Added WriteMetadataDocumentAsync methods and tests * Rename test functions for WriteMetadataDocumentAsync * Renaming WriteSchema to WriteSchemas and WriteSchemaAsync to WriteSchemasAsync * Provide the correct file in copyright for the added files * Rename partial class OasisActionsFunctionsRelationshipChangesAcceptanceTests to OasisActionsFunctionsRelationshipChangesAcceptanceTest to reuse the methods used in main class OasisActionsFunctionsRelationshipChangesAcceptanceTest
WanjohiSammy
changed the title
habbes
reviewed
Sep 10, 2024
habbes
reviewed
Sep 10, 2024
habbes
reviewed
Sep 10, 2024
habbes
reviewed
Sep 10, 2024
habbes
requested changes
Sep 10, 2024
…ing ConfigureAwait(false)
xuzhg
reviewed
Sep 19, 2024
| /// <param name="error">The error instance to write.</param> | ||
| /// <param name="includeDebugInformation">A flag indicating whether error details should be written (in debug mode only) or not.</param> | ||
| /// <param name="maxInnerErrorDepth">The maximum number of nested inner errors to allow.</param> | ||
| internal static async Task WriteXmlErrorAsync(XmlWriter writer, ODataError error, bool includeDebugInformation, int maxInnerErrorDepth) |
There was a problem hiding this comment.
Do we still write the XML payload?
I don't think so, we only output the JSON payload exception the CSDL, right?
If that's the case, why do we need to implement the XML related async methods?
xuzhg
reviewed
Sep 19, 2024
| @@ -12,6 +12,7 @@ | |||
| using System.Linq; | |||
| using System.Text; | |||
| using System.Text.Json; | |||
| using System.Threading.Tasks; | |||
There was a problem hiding this comment.
Maybe it's better to add a new file and put all new added 'async' methods into this new file and leave the existing file unchanged?
xuzhg
approved these changes
Sep 19, 2024
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.
Issues
This pull request fixes #xxx.
Description
Main Changes
Provide APIs for writing
CSDLasynchronously:Checklist (Uncheck if it is not completed)
Additional work necessary
If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.