Skip to content

Move current unevaluated* traversal basic logic up to Blaze #1637

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

Merged
merged 1 commit into from
May 1, 2025
Merged

Move current unevaluated* traversal basic logic up to Blaze #1637

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
208 changes: 0 additions & 208 deletions src/core/jsonschema/frame.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1244,211 +1244,3 @@ auto SchemaFrame::references_to(const Pointer &pointer) const -> std::vector<
}

} // namespace sourcemeta::core

// TODO: Rephrase all this logic on top of framing by keeping track of all
// keyword inter-dependencies?

namespace {
using namespace sourcemeta::core;

// TODO: Extract all of this into a public utility to traverse
// adjacent subschemas
auto find_adjacent_dependencies(
const JSON::String &current, const JSON &schema, const SchemaFrame &frame,
const SchemaWalker &walker, const SchemaResolver &resolver,
const std::set<JSON::String> &keywords, const SchemaFrame::Location &root,
const SchemaFrame::Location &entry, const bool is_static,
SchemaUnevaluatedEntry &result) -> void {
const auto &subschema{get(schema, entry.pointer)};
if (!subschema.is_object()) {
return;
}

const auto subschema_vocabularies{
vocabularies(subschema, resolver, entry.dialect)};

for (const auto &property : subschema.as_object()) {
if (property.first == current && entry.pointer == root.pointer) {
continue;
} else if (keywords.contains(property.first)) {
// In 2019-09, `additionalItems` takes no effect without `items`
if (subschema_vocabularies.contains(
"https://json-schema.org/draft/2019-09/vocab/applicator") &&
property.first == "additionalItems" && !subschema.defines("items")) {
continue;
}

auto pointer{entry.pointer.concat({property.first})};
if (is_static) {
result.static_dependencies.emplace(std::move(pointer));
} else {
result.dynamic_dependencies.emplace(std::move(pointer));
}

continue;
}

switch (walker(property.first, subschema_vocabularies).type) {
// References
case SchemaKeywordType::Reference: {
const auto reference{frame.dereference(entry, {property.first})};
if (reference.first == SchemaReferenceType::Static &&
reference.second.has_value()) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
reference.second.value().get(), is_static, result);
} else if (reference.first == SchemaReferenceType::Dynamic) {
result.unresolved = true;
}

break;
}

// Static
case SchemaKeywordType::ApplicatorElementsInPlace:
for (std::size_t index = 0; index < property.second.size(); index++) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
frame.traverse(entry, {property.first, index}), is_static,
result);
}

break;

// Dynamic
case SchemaKeywordType::ApplicatorElementsInPlaceSome:
if (property.second.is_array()) {
for (std::size_t index = 0; index < property.second.size(); index++) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
frame.traverse(entry, {property.first, index}), false, result);
}
}

break;
case SchemaKeywordType::ApplicatorValueTraverseAnyItem:
[[fallthrough]];
case SchemaKeywordType::ApplicatorValueTraverseParent:
[[fallthrough]];
case SchemaKeywordType::ApplicatorValueInPlaceMaybe:
if (is_schema(property.second)) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
frame.traverse(entry, {property.first}), false, result);
}

break;
case SchemaKeywordType::ApplicatorValueOrElementsInPlace:
if (property.second.is_array()) {
for (std::size_t index = 0; index < property.second.size(); index++) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
frame.traverse(entry, {property.first, index}), false, result);
}
} else if (is_schema(property.second)) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
frame.traverse(entry, {property.first}), false, result);
}

break;
case SchemaKeywordType::ApplicatorMembersInPlaceSome:
if (property.second.is_object()) {
for (const auto &pair : property.second.as_object()) {
find_adjacent_dependencies(
current, schema, frame, walker, resolver, keywords, root,
frame.traverse(entry, {property.first, pair.first}), false,
result);
}
}

break;

// Anything else does not contribute to the dependency list
default:
break;
}
}
}

} // namespace

namespace sourcemeta::core {

// TODO: Refactor this entire function using `SchemaFrame`'s new `Instances`
// mode. We can loop over every subschema that defines `unevaluatedProperties`
// or `unevaluatedItems`, find all other subschemas with the same unresolved
// instance location (static dependency) or conditional equivalent unresolved
// instance location (dynamic dependency) and see if those ones define any of
// the dependent keywords.
auto unevaluated(const JSON &schema, const SchemaFrame &frame,
const SchemaWalker &walker, const SchemaResolver &resolver)
-> SchemaUnevaluatedEntries {
SchemaUnevaluatedEntries result;

for (const auto &entry : frame.locations()) {
if (entry.second.type != SchemaFrame::LocationType::Subschema &&
entry.second.type != SchemaFrame::LocationType::Resource) {
continue;
}

const auto &subschema{get(schema, entry.second.pointer)};
assert(is_schema(subschema));
if (!subschema.is_object()) {
continue;
}

const auto subschema_vocabularies{
frame.vocabularies(entry.second, resolver)};
for (const auto &pair : subschema.as_object()) {
const auto keyword_uri{frame.uri(entry.second, {pair.first})};
SchemaUnevaluatedEntry unevaluated;
if ((subschema_vocabularies.contains(
"https://json-schema.org/draft/2020-12/vocab/unevaluated") &&
subschema_vocabularies.contains(
"https://json-schema.org/draft/2020-12/vocab/applicator")) &&
pair.first == "unevaluatedProperties") {
find_adjacent_dependencies(
pair.first, schema, frame, walker, resolver,
{"properties", "patternProperties", "additionalProperties",
"unevaluatedProperties"},
entry.second, entry.second, true, unevaluated);
result.emplace(keyword_uri, std::move(unevaluated));
} else if (
(subschema_vocabularies.contains(
"https://json-schema.org/draft/2020-12/vocab/unevaluated") &&
subschema_vocabularies.contains(
"https://json-schema.org/draft/2020-12/vocab/applicator")) &&
pair.first == "unevaluatedItems") {
find_adjacent_dependencies(
pair.first, schema, frame, walker, resolver,
{"prefixItems", "items", "contains", "unevaluatedItems"},
entry.second, entry.second, true, unevaluated);
result.emplace(keyword_uri, std::move(unevaluated));
} else if (subschema_vocabularies.contains(
"https://json-schema.org/draft/2019-09/vocab/"
"applicator") &&
pair.first == "unevaluatedProperties") {
find_adjacent_dependencies(
pair.first, schema, frame, walker, resolver,
{"properties", "patternProperties", "additionalProperties",
"unevaluatedProperties"},
entry.second, entry.second, true, unevaluated);
result.emplace(keyword_uri, std::move(unevaluated));
} else if (subschema_vocabularies.contains(
"https://json-schema.org/draft/2019-09/vocab/"
"applicator") &&
pair.first == "unevaluatedItems") {
find_adjacent_dependencies(
pair.first, schema, frame, walker, resolver,
{"items", "additionalItems", "unevaluatedItems"}, entry.second,
entry.second, true, unevaluated);
result.emplace(keyword_uri, std::move(unevaluated));
}
}
}

return result;
}

} // namespace sourcemeta::core
55 changes: 0 additions & 55 deletions src/core/jsonschema/include/sourcemeta/core/jsonschema_frame.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,61 +254,6 @@ SOURCEMETA_CORE_JSONSCHEMA_EXPORT
auto operator<<(std::ostream &stream, const SchemaFrame &frame)
-> std::ostream &;

// TODO: Eventually generalize this to detecting cross-keyword dependencies as
// part of framing

/// @ingroup jsonschema
struct SchemaUnevaluatedEntry {
/// The absolute pointers of the static keyword dependencies
std::set<Pointer> static_dependencies;
/// The absolute pointers of the static keyword dependencies
std::set<Pointer> dynamic_dependencies;
/// Whether the entry cannot be fully resolved, which means
/// there might be unknown dynamic dependencies
bool unresolved{false};
};

/// @ingroup jsonschema
/// The flattened set of unevaluated cases in the schema by absolute URI
using SchemaUnevaluatedEntries = std::map<JSON::String, SchemaUnevaluatedEntry>;

/// @ingroup jsonschema
///
/// This function performs a static analysis pass on `unevaluatedProperties` and
/// `unevaluatedItems` occurences throughout the entire schema (if any).
///
/// For example:
///
/// ```cpp
/// #include <sourcemeta/core/json.h>
/// #include <sourcemeta/core/jsonschema.h>
/// #include <cassert>
///
/// const sourcemeta::core::JSON document =
/// sourcemeta::core::parse_json(R"JSON({
/// "$schema": "https://json-schema.org/draft/2020-12/schema",
/// "unevaluatedProperties": false
/// })JSON");
///
/// sourcemeta::core::SchemaFrame
/// frame{sourcemeta::core::SchemaFrame::Mode::References};
///
/// frame.analyse(document,
/// sourcemeta::core::schema_official_walker,
/// sourcemeta::core::schema_official_resolver);
/// const auto result{sourcemeta::core::unevaluated(
/// schema, frame,
/// sourcemeta::core::schema_official_walker,
/// sourcemeta::core::schema_official_resolver)};
///
/// assert(result.contains("#/unevaluatedProperties"));
/// assert(!result.at("#/unevaluatedProperties").dynamic);
/// assert(result.at("#/unevaluatedProperties").dependencies.empty());
/// ```
auto SOURCEMETA_CORE_JSONSCHEMA_EXPORT unevaluated(
const JSON &schema, const SchemaFrame &frame, const SchemaWalker &walker,
const SchemaResolver &resolver) -> SchemaUnevaluatedEntries;

} // namespace sourcemeta::core

#endif
2 changes: 0 additions & 2 deletions test/jsonschema/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ sourcemeta_googletest(NAMESPACE sourcemeta PROJECT core NAME jsonschema
jsonschema_frame_draft1_test.cc
jsonschema_frame_draft0_test.cc
jsonschema_frame_test.cc
jsonschema_unevaluated_2020_12_test.cc
jsonschema_unevaluated_2019_09_test.cc
jsonschema_bundle_2020_12_test.cc
jsonschema_bundle_2019_09_test.cc
jsonschema_bundle_draft7_test.cc
Expand Down
28 changes: 0 additions & 28 deletions test/jsonschema/jsonschema_test_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,34 +291,6 @@
expected_pointer, expected_uri, expected_base, \
expected_fragment)

#define EXPECT_UNEVALUATED_STATIC(keywords, expected_pointer, \
expected_dependencies_size) \
EXPECT_EQ(keywords.at(expected_pointer).static_dependencies.size(), \
expected_dependencies_size);

#define EXPECT_UNEVALUATED_DYNAMIC(keywords, expected_pointer, \
expected_dependencies_size) \
EXPECT_EQ(keywords.at(expected_pointer).dynamic_dependencies.size(), \
expected_dependencies_size);

#define EXPECT_UNEVALUATED_UNRESOLVED(keywords, expected_pointer) \
EXPECT_TRUE(keywords.at(expected_pointer).unresolved);

#define EXPECT_UNEVALUATED_RESOLVED(keywords, expected_pointer) \
EXPECT_FALSE(keywords.at(expected_pointer).unresolved);

#define EXPECT_UNEVALUATED_STATIC_DEPENDENCY(keywords, expected_pointer, \
expected_destination) \
EXPECT_TRUE( \
keywords.at(expected_pointer) \
.static_dependencies.contains(TO_POINTER(expected_destination)));

#define EXPECT_UNEVALUATED_DYNAMIC_DEPENDENCY(keywords, expected_pointer, \
expected_destination) \
EXPECT_TRUE( \
keywords.at(expected_pointer) \
.dynamic_dependencies.contains(TO_POINTER(expected_destination)));

#define __EXPECT_OFFICIAL_WALKER_ENTRY( \
entries, index, expected_schema_location, expected_parent_location, \
expected_dialect, expected_base_dialect, expected_instance_location, \
Expand Down
Loading