[dart][dart-dio] Prevent name clashes with existing dart types #8198
Conversation
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
|
👍 Thanks for opening this issue! The team will review the labels and make any necessary changes. |
9 tasks
Can not use dart import aliases for now as this is not supported by built_value. This means we need to add potentially clashing names/classes to an `additionalReservedWords` exclusion list. Starting with a basic list of some http/io classes. Correctly use `importMapping` and `defaultIncludes` this time around. Improve reserved word checking. This now successfully generates `ModelList`, `ModelFile` and `ModelClient` models which previously were not generated at all or were wrong types.
kuhnroyal
force-pushed
the
dart/type-conflicts
branch
from
a7b97a3 to
93fb48a
Compare
agilob
reviewed
Dec 15, 2020
| @@ -73,6 +73,10 @@ | |||
| protected String apiTestPath = "test" + File.separator; | |||
| protected String modelTestPath = "test" + File.separator; | |||
|
|
|||
| // Names that must not be used as model names because they clash with existing | |||
| // default imports (dart:io, dart:async, package:http etc.) but are not basic dataTypes. | |||
| protected Set<String> additionalReservedWords = new HashSet<>(); | |||
There was a problem hiding this comment.
Can we initialize this once in constructor? No need for a HashSet constructor there when it's in DartClientCodegen() already
There was a problem hiding this comment.
this would also make sure children of DartClientCodegen make sure to call super() which is what we want I think
josh-burton
approved these changes
Dec 15, 2020
agilob
approved these changes
Dec 15, 2020
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.
Can not use dart import aliases for now as this is not supported by built_value. This means we need to add potentially clashing names/classes to an
additionalReservedWordsexclusion list. Starting with a basic list of some http/io classes.Correctly use
importMappinganddefaultIncludesthis time around. Improve reserved word checking.This now successfully generates
ModelList,ModelFileandModelClientmodels which previously were not generated at all or were wrong types.Also add some more test cases for correct model name generation.
This is a huge step as this fixes some of the last remaining problems in the dart-dio generator mentioned here: #8179
PR checklist
./bin/generate-samples.shto update all Petstore samples related to your fix. 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.masterCC @swipesight (2018/09) @jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12)