Skip to content

feat: resolve $dynamicRef against the dynamic scope #504

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.

Sign up for GitHub

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

Open
aqeelat wants to merge 1 commit into
base: release/7_0
Choose a base branch
from
Open

feat: resolve $dynamicRef against the dynamic scope #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 86 additions & 20 deletions Sources/OpenAPIKit/Schema Object/DereferencedJSONSchema.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,10 @@ extension DereferencedJSONSchema {
internal init(
_ arrayContext: JSONSchema.ArrayContext,
resolvingIn components: OpenAPI.Components,
following references: Set<AnyHashable>
following references: Set<AnyHashable>,
dynamicScope: [String: JSONSchema] = [:]
) throws {
items = try arrayContext.items.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil) }
items = try arrayContext.items.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope) }
maxItems = arrayContext.maxItems
_minItems = arrayContext._minItems
_uniqueItems = arrayContext._uniqueItems
Expand Down Expand Up @@ -401,17 +402,18 @@ extension DereferencedJSONSchema {
internal init(
_ objectContext: JSONSchema.ObjectContext,
resolvingIn components: OpenAPI.Components,
following references: Set<AnyHashable>
following references: Set<AnyHashable>,
dynamicScope: [String: JSONSchema] = [:]
) throws {
properties = try objectContext.properties.mapValues { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil) }
patternProperties = try objectContext.patternProperties.mapValues { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil) }
properties = try objectContext.properties.mapValues { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope) }
patternProperties = try objectContext.patternProperties.mapValues { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope) }
maxProperties = objectContext.maxProperties
_minProperties = objectContext._minProperties
switch objectContext.additionalProperties {
case .a(let bool):
additionalProperties = .a(bool)
case .b(let schema):
additionalProperties = .b(try schema._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil))
additionalProperties = .b(try schema._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope))
case nil:
additionalProperties = nil
}
Expand Down Expand Up @@ -477,6 +479,23 @@ extension JSONSchema: LocallyDereferenceable {
in components: OpenAPI.Components,
following references: Set<AnyHashable>,
dereferencedFromComponentNamed name: String?
) throws -> DereferencedJSONSchema {
try _dereferenced(in: components, following: references, dereferencedFromComponentNamed: name, dynamicScope: [:])
}

/// Scope-aware dereferencing.
///
/// `dynamicScope` maps a `$dynamicAnchor` name to the **outermost** schema
/// resource bearing that anchor on the current resolution path (first-wins
/// insertion). A `$dynamicRef` is resolved against this scope per JSON
/// Schema 2020-12 dynamic-scope rules: the outermost matching anchor wins.
/// Non-recursive targets are inlined; recursive or unresolvable dynamic
/// references throw (a `DereferencedJSONSchema` must not contain references).
internal func _dereferenced(
in components: OpenAPI.Components,
following references: Set<AnyHashable>,
dereferencedFromComponentNamed name: String?,
dynamicScope outerDynamicScope: [String: JSONSchema]
) throws -> DereferencedJSONSchema {
func addComponentNameExtension<T>(to context: CoreContext<T>) -> CoreContext<T> {
var extensions = context.vendorExtensions
Expand All @@ -486,12 +505,32 @@ extension JSONSchema: LocallyDereferenceable {
return context.with(vendorExtensions: extensions)
}

// Seed the dynamic scope with this schema's own `$dynamicAnchor` and any
// declared in its `$defs` (the JSON Schema "generics" pattern). First-wins
// keeps the outermost resource's anchor, per the dynamic-scope rules.
var dynamicScope = outerDynamicScope
if let anchor = self.dynamicAnchor, dynamicScope[anchor] == nil {
dynamicScope[anchor] = self
}
for (_, def) in self.defs {
if let defAnchor = def.dynamicAnchor, dynamicScope[defAnchor] == nil {
dynamicScope[defAnchor] = def
}
}

switch value {
case .null(let coreContext):
return .null(addComponentNameExtension(to: coreContext))
case .reference(let reference, let context):
var dereferenced = try reference
._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil)
// Thread the dynamic scope across the `$ref` boundary (outermost-wins).
var newReferences = references
let (inserted, _) = newReferences.insert(reference)
guard inserted else {
throw OpenAPI.Components.ReferenceCycleError(ref: reference.absoluteString)
}
var dereferenced = try components
.lookup(reference)
._dereferenced(in: components, following: newReferences, dereferencedFromComponentNamed: reference.name, dynamicScope: dynamicScope)

if !context.required {
dereferenced = dereferenced.optionalSchemaObject()
Expand All @@ -508,27 +547,54 @@ extension JSONSchema: LocallyDereferenceable {
dereferenced = dereferenced.with(vendorExtensions: extensions)

return dereferenced
case .dynamicReference(let reference, _):
// A `DereferencedJSONSchema` must not contain references. Dynamic-scope
// resolution is not yet implemented (see #359), so a `$dynamicRef`
// cannot be inlined; dereferencing fails rather than retaining the
// reference and breaking the `Dereferenced...` invariant.
case .dynamicReference(let reference, let context):
// Resolve `$dynamicRef` against the dynamic scope. Only plain anchor
// references participate; component/path/external dynamic refs have no
// matching dynamic anchor and throw.
if case .internal(.anchor(let anchorName)) = reference.jsonReference,
let target = dynamicScope[anchorName] {
let cycleKey = AnyHashable("dynamicRef:#\(anchorName)")
if references.contains(cycleKey) {
// Recursive dynamic reference: cannot inline without retaining a
// reference, so fail -- consistent with static `$ref` cycles.
throw OpenAPI.Components.ReferenceCycleError(ref: reference.absoluteString)
}
var newReferences = references
newReferences.insert(cycleKey)
var dereferenced = try target
._dereferenced(in: components, following: newReferences, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope)

if !context.required {
dereferenced = dereferenced.optionalSchemaObject()
}
if let refDescription = context.description {
dereferenced = dereferenced.with(description: refDescription)
}

var extensions = dereferenced.vendorExtensions
if let name {
extensions[OpenAPI.Components.componentNameExtension] = .init(name)
}
dereferenced = dereferenced.with(vendorExtensions: extensions)

return dereferenced
}
throw GenericError(
subjectName: "JSONSchema",
details: "Cannot dereference `$dynamicRef` ('\(reference.absoluteString)'): dynamic references are not resolved by local dereferencing.",
details: "Cannot dereference `$dynamicRef` ('\(reference.absoluteString)'): no matching `$dynamicAnchor` found in dynamic scope.",
codingPath: []
)
case .boolean(let context):
return .boolean(addComponentNameExtension(to: context))
case .object(let coreContext, let objectContext):
return try .object(
addComponentNameExtension(to: coreContext),
DereferencedJSONSchema.ObjectContext(objectContext, resolvingIn: components, following: references)
DereferencedJSONSchema.ObjectContext(objectContext, resolvingIn: components, following: references, dynamicScope: dynamicScope)
)
case .array(let coreContext, let arrayContext):
return try .array(
addComponentNameExtension(to: coreContext),
DereferencedJSONSchema.ArrayContext(arrayContext, resolvingIn: components, following: references)
DereferencedJSONSchema.ArrayContext(arrayContext, resolvingIn: components, following: references, dynamicScope: dynamicScope)
)
case .number(let coreContext, let numberContext):
return .number(addComponentNameExtension(to: coreContext), numberContext)
Expand All @@ -537,16 +603,16 @@ extension JSONSchema: LocallyDereferenceable {
case .string(let coreContext, let stringContext):
return .string(addComponentNameExtension(to: coreContext), stringContext)
case .all(of: let jsonSchemas, core: let coreContext):
let schemas = try jsonSchemas.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil) }
let schemas = try jsonSchemas.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope) }
return .all(of: schemas, core: addComponentNameExtension(to: coreContext))
case .one(of: let jsonSchemas, core: let coreContext):
let schemas = try jsonSchemas.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil) }
let schemas = try jsonSchemas.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope) }
return .one(of: schemas, core: addComponentNameExtension(to: coreContext))
case .any(of: let jsonSchemas, core: let coreContext):
let schemas = try jsonSchemas.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil) }
let schemas = try jsonSchemas.map { try $0._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope) }
return .any(of: schemas, core: addComponentNameExtension(to: coreContext))
case .not(let jsonSchema, core: let coreContext):
return .not(try jsonSchema._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil), core: addComponentNameExtension(to: coreContext))
return .not(try jsonSchema._dereferenced(in: components, following: references, dereferencedFromComponentNamed: nil, dynamicScope: dynamicScope), core: addComponentNameExtension(to: coreContext))
case .fragment(let context):
return .fragment(addComponentNameExtension(to: context))
}
Expand Down
Loading