[Generator] Add support of deepObject style in query params #538

kstefanou52 · 2024-03-07T13:22:05Z

Motivation

The generator changes for:
apple/swift-openapi-generator

Depends on apple/swift-openapi-runtime#100
landing first and getting released, and the version dependency being bumped here.

Modifications

Added deepObject style to serializer & parser in order to support nested keys on query parameters.

Result

Support nested keys on query parameters.

Test Plan

Adapted snippet tests (SnippetBasedReferenceTests)

simonjbeaumont · 2024-03-07T15:50:12Z

Thanks @kstefanou52 for taking the time to tackle this. We'll park this PR review until we land the runtime PR.

czechboy0 · 2024-04-16T09:56:51Z

@kstefanou52 Ok please bump the runtime dependency to 1.4.0 in Package.swift and you should be able to finish the generator changes.

kstefanou52 · 2024-04-16T13:45:38Z

@czechboy0 Done! I have created some tests, but I'm not sure if you would like to add more. Could you please suggest any additional tests you think might be necessary? Thank you!

czechboy0

One code change suggested, and regarding the extra tests - you're right 🙂

Start by adding a similar parameter like you did in the snippet tests, but this time to petstore.yaml, which makes it available in generated form in PetstoreConsumerTests. There, please extend one client and one server unit test to verify that the serialization/deserialization is correctly piped through all the way. The relevant test classes are Test_Client and Test_Server.

Sources/_OpenAPIGeneratorCore/Translator/Parameters/TypedParameter.swift

simonjbeaumont · 2024-05-21T20:34:08Z

Just checking in on this one. Is it ready for review again? (Thanks for the effort here!)

kstefanou52 · 2024-05-25T11:34:21Z

Hi @simonjbeaumont! Unfortunately some tests are failing, I'll work on this on weekend and I'll let you know. Cheers!

czechboy0 · 2024-07-22T14:21:51Z

Hi @kstefanou52 - do you expect to be able to come back to finish this? 🙂 It's also okay if you can't and someone else will pick up where you left off.

kstefanou52 · 2024-09-04T09:00:51Z

@czechboy0 I'm apologising for my late response. I'll try to catch up and complete the PR by the end of the week.

czechboy0 · 2024-10-03T07:33:13Z

Hi @kstefanou52 - let us know if you need any help with this? I think it just needs to be updated from the main branch and a conflict resolved, but otherwise might be good to go?

apple#259 ~Depends on apple/swift-openapi-runtime#100 landing first and getting released, and the version dependency being bumped here.~ Added `deepObject` style to serializer & parser in order to support nested keys on query parameters. Support nested keys on query parameters. Adapted snippet tests (SnippetBasedReferenceTests)

Tests/PetstoreConsumerTests/Test_Server.swift

kstefanou52 · 2024-10-26T13:06:44Z

Hello @czechboy0 and @arthurcro, I've made some progress, but I'm facing an issue with one of the unit tests. The code appears to work as expected, but I suspect there may be a problem with the runtime library. I’d appreciate your thoughts on this; more details can be found here.

czechboy0 · 2024-10-26T15:27:49Z

~~Can you elaborate? The link doesn't really say what the issue is - what are you seeing and what are you expecting?~~

Never mind, found your other comment.

Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift

Tests/PetstoreConsumerTests/Test_Server.swift

…s.swift Co-authored-by: Honza Dvorsky <honza@apple.com>

### Motivation As discussed in [[Generator] Add support of deepObject style in query params #538](apple/swift-openapi-generator#538 (comment)), there is a misimplementation of the `decodeRootIfPresent` method in `URIValueFromNodeDecoder`. When using the `deepObject` style, the node for `rootValue` is correctly empty, containing only the sub-objects. Without this PR, the tests for [Add support of deepObject style in query params #538](apple/swift-openapi-generator#538) are failing. ### Modifications - Updated the `decodeRootIfPresent(_ type:) throws -> T` method to ignore whether `currentElementAsArray` is empty or not. ### Result - Enables the tests in the [Generator part of the PR](apple/swift-openapi-generator#538) to pass successfully. ### Test Plan This PR includes unit tests that validate the change to `decodeRootIfPresent(_ type:) throws -> T` within `Test_Converter+Server` as well as in `Test_serverConversionExtensions`.

kstefanou52 · 2024-10-29T09:27:51Z

Hey @czechboy0, I just opened the runtime PR. Please let me know if there are any additional tests we should add. Thanks!

czechboy0

Sorry it took longer than expected, the deepObject improvements landed in runtime 1.7.0, so you should be able to bring this branch up to speed again. Added a few suggestions

czechboy0 · 2024-11-25T14:57:35Z

Package.swift

@@ -60,7 +60,7 @@ let package = Package(
        // Tests-only: Runtime library linked by generated code, and also
        // helps keep the runtime library new enough to work with the generated
        // code.
-        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.3.2"),
+        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.5.0"),


Please bump this to 1.7.0 now

czechboy0 · 2024-11-25T14:58:06Z

Tests/OpenAPIGeneratorReferenceTests/Resources/Docs/petstore.yaml

+              id:
+                type: string
+              name:
+                type: string


Please make one of them required, just to test both

czechboy0 · 2024-11-25T15:00:37Z

Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift

+                        option1:
+                          type: string
+                        option2:
+                          type: string


Please add one more parameter here, one that is required and has one of the object properties required as well. I want to see that the default parameter is working correctly below.

kstefanou52 mentioned this pull request Mar 7, 2024

Support deepObject style for query params #259

Open

simonjbeaumont added the status/blocked Waiting for another issue. label Mar 7, 2024

Raedalmalki250 mentioned this pull request Mar 11, 2024

### Motivation Raedalmalki250/ipa#3

Open

czechboy0 removed the status/blocked Waiting for another issue. label Apr 16, 2024

czechboy0 requested changes Apr 16, 2024

View reviewed changes

Sources/_OpenAPIGeneratorCore/Translator/Parameters/TypedParameter.swift Outdated Show resolved Hide resolved

czechboy0 mentioned this pull request Oct 3, 2024

[Docs] Update supported parameter styles #643

Draft

czechboy0 mentioned this pull request Oct 25, 2024

[Generator] Add support of deepObject style in query params #659

Draft

kstefanou52 added 3 commits October 26, 2024 13:05

Update SwiftOpenAPIRuntime library dependency

0e8371f

Update petstore.yaml with deepObject parameter

7c84475

kstefanou52 force-pushed the feature/deep_object_style branch from 4d6f297 to 7c84475 Compare October 26, 2024 10:05

Add Unite tests for DeepObject.

adfa77e

kstefanou52 commented Oct 26, 2024

View reviewed changes

Tests/PetstoreConsumerTests/Test_Server.swift Show resolved Hide resolved

czechboy0 reviewed Oct 26, 2024

View reviewed changes

Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift Outdated Show resolved Hide resolved

Tests/PetstoreConsumerTests/Test_Server.swift Show resolved Hide resolved

Update Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTest…

acd6984

…s.swift Co-authored-by: Honza Dvorsky <honza@apple.com>

kstefanou52 mentioned this pull request Oct 29, 2024

Update URIValueFromNodeDecoder for DeepObject. apple/swift-openapi-runtime#125

Closed

czechboy0 requested changes Nov 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Generator] Add support of deepObject style in query params #538

[Generator] Add support of deepObject style in query params #538

kstefanou52 commented Mar 7, 2024 •

edited

Loading

simonjbeaumont commented Mar 7, 2024

czechboy0 commented Apr 16, 2024

kstefanou52 commented Apr 16, 2024

czechboy0 left a comment

simonjbeaumont commented May 21, 2024

kstefanou52 commented May 25, 2024

czechboy0 commented Jul 22, 2024

kstefanou52 commented Sep 4, 2024

czechboy0 commented Oct 3, 2024

kstefanou52 commented Oct 26, 2024

czechboy0 commented Oct 26, 2024 •

edited

Loading

kstefanou52 commented Oct 29, 2024

czechboy0 left a comment

czechboy0 Nov 25, 2024

czechboy0 Nov 25, 2024

czechboy0 Nov 25, 2024

[Generator] Add support of deepObject style in query params #538

Are you sure you want to change the base?

[Generator] Add support of deepObject style in query params #538

Conversation

kstefanou52 commented Mar 7, 2024 • edited Loading

Motivation

Modifications

Result

Test Plan

simonjbeaumont commented Mar 7, 2024

czechboy0 commented Apr 16, 2024

kstefanou52 commented Apr 16, 2024

czechboy0 left a comment

Choose a reason for hiding this comment

simonjbeaumont commented May 21, 2024

kstefanou52 commented May 25, 2024

czechboy0 commented Jul 22, 2024

kstefanou52 commented Sep 4, 2024

czechboy0 commented Oct 3, 2024

kstefanou52 commented Oct 26, 2024

czechboy0 commented Oct 26, 2024 • edited Loading

kstefanou52 commented Oct 29, 2024

czechboy0 left a comment

Choose a reason for hiding this comment

czechboy0 Nov 25, 2024

Choose a reason for hiding this comment

czechboy0 Nov 25, 2024

Choose a reason for hiding this comment

czechboy0 Nov 25, 2024

Choose a reason for hiding this comment

kstefanou52 commented Mar 7, 2024 •

edited

Loading

czechboy0 commented Oct 26, 2024 •

edited

Loading