Serialize configuration and tspCodeModel from swagger by ArcturusZhang · Pull Request #5289 · Azure/autorest.csharp

ArcturusZhang · 2025-04-10T07:57:00Z

Description

Add your description here!

Checklist

To ensure a quick review and merge, please ensure:

The PR has a understandable title and description explaining the why and what.
The PR is opened in draft if not ready for review yet.
- If opened in draft, please allocate sufficient time (24 hours) after moving out of draft for review
The branch is recent enough to not have merge conflicts upon creation.

Ready to Land?

Build is completely green
- Submissions with test failures require tracking issue and approval of a CODEOWNER
At least one +1 review by a CODEOWNER
All -1 reviews are confirmed resolved by the reviewer
- Override/Marking reviews stale must be discussed with CODEOWNERS first

ArcturusZhang · 2025-04-11T07:57:00Z

src/AutoRest.CSharp/AzurePlugin/AzurePluginTarget.cs

        {
-            // TODO: serialize configuration.json and serialize inputNamespace to tspCodeModel.json
+            // normalize the output folder
+            var outputFolder = NormalizeOutputFolder(Configuration.OutputFolder);


this should be unnecessary, I will resolve this when the majority feature of this is done

live1206

Overall, it LGTM, what's the goal of this PR?
I think we don't have to implement all the details of serialization within this single PR.

live1206 · 2025-04-14T09:15:33Z

src/AutoRest.CSharp/Common/Input/InputTypes/InputEnumTypeValue.cs

 namespace AutoRest.CSharp.Common.Input;

-internal record InputEnumTypeValue(string Name, object Value, string? Summary, string? Doc)
+internal abstract record InputEnumTypeValue(string Name, object Value, string? Summary, string? Doc)


think we should take this change to MTG to avoid instantiation of this.

yep - this part is done in a really messy way, as well as in MTG.
I think I would like to figure it out in MTG in the same time.

and to clarify, I think "using the input library from MTG" should not be part of our plan - it will be a huge change and we might encounter various of issues. At least in short time, we do not need to consider to use the types from MTG - having these types defined in this library actually has its advantages.

live1206 · 2025-04-14T09:44:15Z

src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputDateTimeTypeConverter.cs

+            writer.WriteStartObject();
+
+            // kind
+            writer.WriteString("kind", UtcDateTimeKind); // TODO -- currently the two different kinds have exactly the same properties, therefore here we no longer have the ability to distinguish


what's the plan for this?

it is possible that we make this class abstract, and make UtcDateTimeType and OffsetDateTimeType to derive from it, like what we have done for InputType.

And I think we should also do the same in MTG.

ArcturusZhang · 2025-04-15T02:53:53Z

Overall, it LGTM, what's the goal of this PR? I think we don't have to implement all the details of serialization within this single PR.

Yeah it might be too much of code changes if I do all of them. But if I did not do all of them, we do not have a way to test it.
I would be fine if I just stop right now - because in the current state of this PR, everything other than the clients has been serialized.

src/AutoRest.CSharp/AzurePlugin/AzurePluginTarget.cs

m-nash · 2025-04-16T00:31:47Z

src/AutoRest.CSharp/AzurePlugin/AzurePluginTarget.cs

+            var outputFolder = NormalizeOutputFolder(Configuration.OutputFolder);
+            // write the configuration.json
+            var configurationFilepath = Path.Combine(outputFolder, "Configuration.json");
+            await File.WriteAllTextAsync(configurationFilepath, Configuration.SaveConfiguration());


Let's create a tracking item to track converting the configuration. Some configuration settings aren't valid in MTG. There are also some renames like library-name changed to package-name.

Here: #5293

m-nash · 2025-04-16T00:35:28Z

src/AutoRest.CSharp/AzurePlugin/AzurePluginTarget.cs

        public static async Task ExecuteAsync(GeneratedCodeWorkspace project, InputNamespace inputNamespace)
        {
-            // TODO: serialize configuration.json and serialize inputNamespace to tspCodeModel.json
+            // normalize the output folder


Lets update the signature to take in a codemodel and do this conversion code here https://github.com/Azure/autorest.csharp/pull/5289/files#diff-42f99a04ab6ed3698d0a6aa3834bdf524f9d13d31aaaef67ab8476ade2c8927eR49-R54 inside the target itself

m-nash · 2025-04-16T00:38:13Z

src/AutoRest.CSharp/AzurePlugin/AzurePluginTarget.cs

        {
-            // TODO: serialize configuration.json and serialize inputNamespace to tspCodeModel.json
+            // normalize the output folder
+            var outputFolder = NormalizeOutputFolder(Configuration.OutputFolder);


On this line of code here https://github.com/Azure/autorest.csharp/pull/5289/files#diff-42f99a04ab6ed3698d0a6aa3834bdf524f9d13d31aaaef67ab8476ade2c8927eR51 we will need to call dataplane if its dataplane and mgmt if its mgmt.

m-nash · 2025-04-16T00:39:36Z

src/AutoRest.CSharp/Common/Input/CodeModelConverter.cs

-                Summary: string.Empty,
-                Doc: choiceValue.Language.Default.Description,
-                Value: value!);
+            var name = choiceValue.Language.Default.Name;


Lets consider making this a singleton

Created this issue to track: #5295

m-nash · 2025-04-16T00:46:59Z

src/AutoRest.CSharp/Common/Input/InputTypes/Serialization/TypeSpecInputDateTimeTypeConverter.cs

            return dateTimeType;
        }
+
+        public override void Write(Utf8JsonWriter writer, InputDateTimeType value, JsonSerializerOptions options)


Lets add a tracking item to consider using the MTG.Input library instead of having its own.

Here: #5292

…lator

microsoft-github-policy-service · 2025-06-20T07:22:42Z

Hi @@ArcturusZhang. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

microsoft-github-policy-service · 2025-06-30T01:24:09Z

Hi @@ArcturusZhang. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing "/reopen" if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the "no-recent-activity" label; otherwise, this is likely to be closed again with the next cleanup pass.

ArcturusZhang added 2 commits April 10, 2025 15:56

modify comment

cd7b119

add code to write those files

7525fe6

ArcturusZhang changed the title ~~Serialize tspCodeModel from swagger~~ Serialize configuration and tspCodeModel from swagger Apr 11, 2025

ArcturusZhang added 5 commits April 11, 2025 12:10

Merge branch 'main' into feature/swagger-translator

52054ac

now it could write those files

b8bd696

clean up

61f45e2

write the enums

396a04c

finish the models writing

9826b6f

ArcturusZhang commented Apr 11, 2025

View reviewed changes

ArcturusZhang added 3 commits April 11, 2025 17:03

more progress

ec493e6

unify the way of writing object or a reference

41295f8

add more types to serialize

ce508f5

live1206 reviewed Apr 14, 2025

View reviewed changes

fix issues

8fed7e9

m-nash reviewed Apr 16, 2025

View reviewed changes

ArcturusZhang added 4 commits April 21, 2025 10:39

Merge remote-tracking branch 'origin/main' into feature/swagger-trans…

ad45ace

…lator

rename the target

42a3b3d

remove the normalization of output folder

9644c07

convert the enum value

4247cf4

microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Jun 20, 2025

microsoft-github-policy-service bot closed this Jun 30, 2025

Conversation

ArcturusZhang commented Apr 10, 2025

Description

Checklist

Ready to Land?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

live1206 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArcturusZhang Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArcturusZhang commented Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

microsoft-github-policy-service bot commented Jun 20, 2025

Uh oh!

microsoft-github-policy-service bot commented Jun 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ArcturusZhang Apr 15, 2025 •

edited

Loading

ArcturusZhang commented Apr 15, 2025 •

edited

Loading