fix: prevent empty version folders from being created #67
Conversation
|
|
gablaxian
force-pushed
the
fix/compile-redundant-folders
branch
from
562f643
to
9a91bfb
Compare
| @@ -457,7 +457,7 @@ | |||
| } | |||
| }, | |||
| "x-snyk-api-resource": "hello-world", | |||
| "x-snyk-api-version": "2021-06-01" | |||
| "x-snyk-api-version": "2021-06-01~experimental" | |||
There was a problem hiding this comment.
This is somewhat puzzling to me as I'd expect this to be 2021-06-04~experimental
There was a problem hiding this comment.
/examples/hello-world/{id} in this version comes from 2021-06-01~experimental. This version exists because of the projects addition in 2021-06-04~experimental.
There was a problem hiding this comment.
Below you'll find that the projects path has extensions reflecting its introduction:
"x-snyk-api-resource": "projects",
"x-snyk-api-version": "2021-06-04~experimental"
So with this change, there will be at least one path at the version of the compiled spec. Other paths in the file may be older and/or of greater stability -- it's a snapshot of "what versions are effective at this version".
|
cc @Todai88 I believe this would address https://github.com/snyk/v3-go-libs/blob/main/oas_router/oas_router.go#L244-L249 correct my if I'm mistaken @gablaxian @cmars ? |
I'm not totally sure. What this PR is fixing, is this error which you see on registry startup: which occurs because folders for all stabilities are created per version, regardless of whether the endpoint exists at that stability level. So when you first start creating endoints, you are going to end up with a lot of redundant folders. And when we scan to get all the spec files, we error because we expect a file in every folder. I think the issue you linked to is something else and, if I am not mistaken, is intended? |
gablaxian
force-pushed
the
fix/compile-redundant-folders
branch
2 times, most recently
from
5ebba63
to
3e54824
Compare
|
The current method to creating the version spec files involved looping over all identified versions and then over the stabilities and creating folders for all, regardless of whether a spec file was necessary. While not a problem, per se, it conflicted with the mapping of those versions within Registry when looping over the compiled versions and checking for their existence. In that respect, if a folder is found with no file, then that should be a legitimate error. The solution, simply, is to only create folders for which spec files exist.
gablaxian
force-pushed
the
fix/compile-redundant-folders
branch
from
3e54824
to
a3b2cae
Compare
The current method to creating the version spec files involved looping over all identified versions and then over the stabilities and creating folders for all, regardless of whether a spec file was necessary.
While not a problem, per se, it conflicted with the mapping of those versions within Registry when looping over the compiled versions and checking for their existence. In that respect, if a folder is found with no file, then that should be a legitimate error.
The solution, simply, is to only create folders for which spec files exist.