ruby-sdk/test/mcp/tool/schema_test.rb
Koichi ITO 9d4dcbf1a4 Speed Up Tool::Schema Validation by 5x to 100x
## Motivation and Context

`MCP::Tool::Schema` previously used the pure-Ruby `json-schema` gem for
both construction-time metaschema validation and runtime argument /
result validation. For deep schemas this cost ~32-100ms per
construction (see issue #364).

`json_schemer` (https://rubygems.org/gems/json_schemer, v2.5.0) is
an actively maintained alternative that is much faster on this workload.
Switching reduces cold-start warming pressure in horizontally scaled
multi-tenant deployments (the scenario raised in #364) and brings
runtime data validation down to sub-millisecond per call once
the per-instance schemer is memoized.

The implementation preserves the legacy behavior of the `json-schema`
based code. Metaschema is pinned to draft-04 (`meta_schema:` option);
the `$schema` dialect URI is still emitted in `to_h` as 2020-12
but runtime validation continues to use draft-04, exactly as before.
Moving the runtime validator itself to 2020-12 is out of scope for
this PR and warrants its own discussion. `format` keywords are not enforced
(`format: false` option), matching what `json-schema`'s draft-04 path did.
Malformed schemas (e.g. an invalid `pattern` regex) continue to
surface as `ArgumentError, "Invalid JSON Schema: ..."`;
the `RegexpError` `json_schemer` raises during construction is wrapped.
`Symbol` values in argument data are coerced to strings inside
the internal `stringify` helper so they validate against `type: "string"`
the same way they did before.

The public `Schema#schema` accessor is dropped. It was a refactor
artifact from #198 (the consolidation of `InputSchema`'s
`properties` / `required` readers into a single hash) with no callers
in `lib/`; tests that needed the merged hash now read it through
`to_h`. The accessor's only remaining role would have been to expose
a mutation path that could desynchronize the memoized `@schemer`,
which this change removes.

Runtime dependency delta: drops `json-schema` (and `addressable`),
adds `json_schemer`, `hana`, `regexp_parser`, and `simpleidn`. Each added
gem is a single-purpose library tied to JSON Schema spec compliance.

Closes #364.

## How Has This Been Tested?

Side-by-side benchmark on representative schemas (simple, with `$ref` /
`additionalProperties`, nested, depth 20, depth 40):
construction-time metaschema validation is 4.7x to ~100x faster;
runtime data validation with the memoized schemer is sub-millisecond
across all sizes.

Four existing tests had their stub targets or message assertions updated
to track the new validator while preserving the original test intent.
The "unexpected errors bubble up" tests in `input_schema_test.rb`
and `output_schema_test.rb` now stub `JSONSchemer::Schema#validate`
instead of `JSON::Validator.fully_validate`. The cache tests in
`schema_test.rb` now stub `JSONSchemer::Schema#validate_schema`.
The two "detailed error message" tests in `tool_test.rb` switched from
asserting `json-schema`'s exact wording to format-agnostic substrings
(`"properties/count/minimum"`, `"number"`). The "required arguments are
converted to strings" test in `input_schema_test.rb` now reads the result
through `to_h[:required]` instead of the removed `schema` accessor.

Regression tests added for the legacy-behavior preservations above:
`format` keyword is not enforced, invalid `pattern` raises `ArgumentError`
(not `RegexpError`), and `Symbol` values validate against `type: "string"`.

## Breaking Changes

`Schema#schema` is no longer a public method. The accessor had no callers
outside the test suite, but anyone reading the internal representation
directly (rather than through `to_h`) will need to switch.
`Schema` / `InputSchema` / `OutputSchema` otherwise keep
their constructor signatures, `to_h` output, `ValidationError` /
`ArgumentError` raise points, and the `$schema` dialect emission.
The validator error message wording inside `ArgumentError` and
`ValidationError` now comes from `json_schemer` and still includes
the JSON pointer path and a description of the mismatch.
2026-06-01 21:47:30 +09:00

95 lines
3.1 KiB
Ruby

# frozen_string_literal: true
require "test_helper"
module MCP
class Tool
class SchemaTest < ActiveSupport::TestCase
setup do
Schema::VALIDATION_CACHE.clear
end
test "validates a schema once and reuses the result for identical schemas" do
JSONSchemer::Schema.any_instance.expects(:validate_schema).once.returns([])
schema = { properties: { validates_once: { type: "string" } } }
InputSchema.new(schema)
InputSchema.new(schema)
end
test "validates distinct schemas separately" do
JSONSchemer::Schema.any_instance.expects(:validate_schema).twice.returns([])
InputSchema.new(properties: { distinct_a: { type: "string" } })
InputSchema.new(properties: { distinct_b: { type: "string" } })
end
test "a cache hit still yields a usable, validated schema" do
schema = { properties: { cache_hit: { type: "string" } }, required: ["cache_hit"] }
InputSchema.new(schema)
cached = InputSchema.new(schema)
assert_equal(
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
type: "object",
properties: { cache_hit: { type: "string" } },
required: ["cache_hit"],
},
cached.to_h,
)
assert_nil(cached.validate_arguments(cache_hit: "value"))
assert_raises(InputSchema::ValidationError) do
cached.validate_arguments(cache_hit: 123)
end
end
test "an invalid schema raises every time and is not cached" do
invalid = { properties: { not_cached: { type: "invalid_type" } } }
assert_raises(ArgumentError) { InputSchema.new(invalid) }
assert_raises(ArgumentError) { InputSchema.new(invalid) }
end
test "a schema at the normalization depth limit is cached without a nesting error" do
# The deepest schema the initializer can still normalize via JSON.dump/parse.
# The cache key must tolerate the same depth; the default JSON.generate
# nesting limit (100) is stricter than normalization and would raise here.
schema = { properties: { leaf: { type: "string" } } }
loop do
candidate = { properties: { child: schema } }
JSON.parse(JSON.dump(candidate))
schema = candidate
rescue JSON::NestingError
break
end
JSONSchemer::Schema.any_instance.stubs(:validate_schema).returns([])
assert_nothing_raised do
InputSchema.new(schema)
InputSchema.new(schema)
end
end
test "ValidationCache evicts the oldest entry beyond its max size" do
cache = Schema::ValidationCache.new(max_size: 2)
cache.store("a")
cache.store("b")
cache.store("c")
refute cache.validated?("a")
assert cache.validated?("b")
assert cache.validated?("c")
end
test "ValidationCache#clear empties the cache" do
cache = Schema::ValidationCache.new
cache.store("a")
cache.clear
refute cache.validated?("a")
end
end
end
end