Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: 0.19.0 #359

Merged
merged 59 commits into from
Jan 1, 2025
Merged

WIP: 0.19.0 #359

merged 59 commits into from
Jan 1, 2025

Conversation

daveshanley
Copy link
Member

@daveshanley daveshanley commented Dec 23, 2024

Adds a ton of changes, without breaking anything! There are no know breaking changes in this release, a lot of changes but nothing will break by upgrading.

Lots of updates to fix glitches and improve support for non OpenAPI files in the rolodex.

Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.62%. Comparing base (f79329e) to head (643b503).
Report is 59 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #359    +/-   ##
========================================
  Coverage   99.61%   99.62%            
========================================
  Files         165      165            
  Lines       21145    21537   +392     
========================================
+ Hits        21064    21456   +392     
  Misses         76       76            
  Partials        5        5            
Flag Coverage Δ
unittests 99.62% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

useful for hashing nodes consistently.
not an exhaustive list, but covers a decent footprint.
This is not technically allowed according to the spec, however it’s super common. It’s also confusing the doctor when rendering the graph. Refs cannot be rendered in a tree, however it was doing so previously.
`StorageRoot` is not a part of the OpenAPI schema. It has no effect on resolving, or the rolodex. It is used by the OpenAPI doctor to determine where a document should live, when it’s a part of a larger network. It may be used by tool developers for their own purpose if required, but it has no effect on the model.
`SkipDocumentCheck` is now honors when looking up a component.
Was throwing race condition issues, locks now prevent this from happening, Also fixed the JSON `camelCase` from `snake_case`.
I should always assume that everything, can always be a nil pointer. Always.
now, if the document cannot be parsed, and we have enabled a bypass, then we still pack up the content into a YAML node and return it.

This allows non YAML/JSON content to be collected by the rolodex, required for things like markdown, or source code.
`ReferenceMapped` can now be renredered and will do so using custom marshaling code. tags have been added also, but are ignored when marshaling.

Also added a nodeMapLock to the index model.
Ensure that a schema cannot be rendered if it has a circular reference. Regardless of the type. This is a hard no for rendering inline.
Required to pull in references that are not JSON or YAML docs, like code samples or markdown.
Allows more effective lookups to be added. Also roll back the keyNode when performing a lookup.
I realized that `FindNodeOrigin` was insufficient when locating nodes at the start of fragments that are all identical. There is no way to determine if two files that both start with ‘post’ at 1:1 are the same or not, without also hashing the value.

That is what this method does, using a hashing mechanism that runs as fast as possible.
Depending on how the rolodex has been used, it may miss circular references attached to index resolvers. Now this method will bubble up those results.
@daveshanley daveshanley merged commit d298a3a into main Jan 1, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant