Skip unrecognized JSON files when loading models #1846
Merged
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
mtdowling
force-pushed
the
ignore-unrecognized-json-files
branch
from
794eb0a to
c2113f1
Compare
kstich
requested changes
Jul 5, 2023
smithy-model/src/main/java/software/amazon/smithy/model/loader/ModelLoader.java
Outdated
Show resolved
Hide resolved
smithy-model/src/test/java/software/amazon/smithy/model/JarUtils.java
Outdated
Show resolved
Hide resolved
smithy-model/src/test/java/software/amazon/smithy/model/JarUtils.java
Outdated
Show resolved
Hide resolved
mtdowling
force-pushed
the
ignore-unrecognized-json-files
branch
from
c2113f1 to
61fcec8
Compare
kstich
reviewed
Jul 6, 2023
smithy-model/src/test/java/software/amazon/smithy/model/loader/ModelAssemblerTest.java
Outdated
Show resolved
Hide resolved
mtdowling
force-pushed
the
ignore-unrecognized-json-files
branch
from
61fcec8 to
9937a40
Compare
This commit updates the model loading process so that JSON files that are not objects or that don't contain a top-level "smithy" key are skipped. This can be useful when loading directories that contain Smithy models mixed with other JSON files. JAR files that contain Smithy models are not permitted to refer to unrecognized JSON files that lack a valid "smithy" version key/value pair. This commit also only creates InputStreams for files that Smithy can actually load or attempt to load. Smithy would previously open an InputStream for all recursive files in a directory even if it was unable to load the file based on the filename. It now only creates an InputStream when the file has a .json, .smithy, or no file extension. Closes #1841
mtdowling
force-pushed
the
ignore-unrecognized-json-files
branch
from
9937a40 to
328c955
Compare
kstich
approved these changes
Jul 6, 2023
|
@mtdowling do you have a timeline for the next release? This and #1838 would be really nice to have for my team. |
|
We're planning for a Monday release |
|
awesome, thanks! |
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.
Issue #, if available: #1841
Description of changes:
This commit updates the model loading process so that JSON files that are not objects or that don't contain a top-level "smithy" key are skipped. This can be useful when loading directories that contain Smithy models mixed with other JSON files. JAR files that contain Smithy models are not permitted to refer to unrecognized JSON files that lack a valid "smithy" version key/value pair.
This commit also only creates InputStreams for files that Smithy can actually load or attempt to load. Smithy would previously open an InputStream for all recursive files in a directory even if it was unable to load the file based on the filename. It now only creates an InputStream when the file has a .json, .smithy, or no file extension.
Closes #1841
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.