[DART] Add standard generated classes as reserved #8975

sbu-WBT · 2021-03-15T15:39:13Z

A friend create a specification with a model named ApiClient which resulted for me in two classes with the same name which doesn't compile. So I thought it might be handy to mark the default included classes also as reserved.

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master, 5.1.x, 6.0.x
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@swipesight (2018/09) @jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12)

kuhnroyal · 2021-03-15T15:45:18Z

.../openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractDartCodegen.java

@@ -164,7 +164,8 @@ public AbstractDartCodegen() {
                "File",
                "Client",
                "Future",
-                "Response"
+                "Response",
+                "StreamedRequest"


This should also go to the normal dart client as it is part of the http package and not used in the dio generator?

This change is in AbstractDartCodegen.java so it affects all dart clients, including dartdio.

Yea so it should also go to DartClientCodegen.

I thought of this, too. But then I saw Response which is also a http class (If I'm not wrong) so I thought I put it there. I have no problem to put it in the other set

Yea, I added Response here because it also exists in Dio (a different class but same name). Same goes for Client.
I think it doesn't hurt here as the http package can basically be considered part of Dart.

agilob · 2021-03-15T15:58:12Z

...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartClientCodegen.java

@@ -37,6 +38,18 @@
    public DartClientCodegen() {
        super();

+        additionalReservedWords.addAll(
+                Sets.newHashSet(


Thinking about the opposite problem. I don't generate ApiClient class, I would generate only models. This makes ApiClient a non-reserved word, thus produces unexpected results.

The problem exists, but I'm not convinced this is the right solution here.

I think this is the correct solution, doing this as well in the dio generator. You may have a couple false positives but that is ok I'd say.

There is the option to only generate the models? Then just add the classes to the set only if the parameter is not set. Do you mind telling me the option name?

Or if you have another idea just tell us, I'm open to better solutions

Or if you have another idea just tell us, I'm open to better solutions

Well, no. It would have to be conditionally added increasing complexity of such solution. I would prefer to see global PR for this problem rather than each generator doing it on their own.

@wing328 is there any DefaultCodeGen solution for this? A set of potentially used keywords like ApiClient to prevent generated files collide with project files. It would have to be managed independently by each code generator and their cmd options.

Looks like big effort to handle some small cases, but correctness of the output should be priority(?).

is there any DefaultCodeGen solution for this? A set of potentially used keywords like ApiClient to prevent generated files collide with project files. It would have to be managed independently by each code generator and their cmd options.

The problem is that most other generators/languages have a concept of absolute/fq imports but Dart does not.
So in other generators you can use the import mapping which can be configured as cmd parameters or in the generator class. The dart generators basically miss uses the import mapping, meaning we HAVE TO use it differently due to the absence of the absolute/fq imports concept.

The additionalReservedWords is just something I came up with for the dio generator to solve this in a simple manner.

Well that is also not fully correct. Dart has named imports import "package:foo:foo.dart" as bar; but I tried this and it fails with a lot of builders/build_runner (json_serializable, built_value).

agilob · 2021-03-15T16:54:21Z

Im happy to approve it after @kuhnroyal approves it. I think the problem in other comments needs a wider planning for all generators, making it out of scope for your problem @sbu-WBT

agilob · 2021-03-15T21:59:47Z

@sbu-WBT re-run the tests

wing328 · 2021-03-22T05:59:27Z

@sbu-WBT thanks for the PR, which has been included in the v5.1.0 release: https://twitter.com/oas_generator/status/1373636654024380423

kuhnroyal reviewed Mar 15, 2021

View reviewed changes

agilob reviewed Mar 15, 2021

View reviewed changes

kuhnroyal approved these changes Mar 15, 2021

View reviewed changes

agilob approved these changes Mar 15, 2021

View reviewed changes

sbu-WBT added 2 commits March 15, 2021 23:40

[DART] Add standard generated classes as reserved

6ece68f

Move StreamedRequest into dart client

316bb76

sbu-WBT force-pushed the dart-default-classes-reserved branch from eacc7f8 to 316bb76 Compare March 15, 2021 22:40

wing328 added Client: Dart Enhancement: General labels Mar 17, 2021

wing328 added this to the 5.1.0 milestone Mar 17, 2021

wing328 merged commit e9f3b09 into OpenAPITools:master Mar 17, 2021

sbu-WBT deleted the dart-default-classes-reserved branch March 18, 2021 21:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DART] Add standard generated classes as reserved #8975

[DART] Add standard generated classes as reserved #8975

sbu-WBT commented Mar 15, 2021 •

edited

Loading

kuhnroyal Mar 15, 2021

agilob Mar 15, 2021

kuhnroyal Mar 15, 2021

sbu-WBT Mar 15, 2021

kuhnroyal Mar 15, 2021

agilob Mar 15, 2021

kuhnroyal Mar 15, 2021

sbu-WBT Mar 15, 2021 •

edited

Loading

agilob Mar 15, 2021

kuhnroyal Mar 15, 2021

kuhnroyal Mar 15, 2021

agilob commented Mar 15, 2021

agilob commented Mar 15, 2021

wing328 commented Mar 22, 2021

[DART] Add standard generated classes as reserved #8975

[DART] Add standard generated classes as reserved #8975

Conversation

sbu-WBT commented Mar 15, 2021 • edited Loading

PR checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbu-WBT Mar 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agilob commented Mar 15, 2021

agilob commented Mar 15, 2021

wing328 commented Mar 22, 2021

sbu-WBT commented Mar 15, 2021 •

edited

Loading

sbu-WBT Mar 15, 2021 •

edited

Loading