schema_version_cache 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2964a9300650a903cb5b554d4a97cfdcb03fb49740de6472b39da28b219f4654
+  data.tar.gz: dd535bfdc5f9effba7ba2e71018ec29ef7bc8e84850e634f3616c54452cef978
+SHA512:
+  metadata.gz: d22e2597033c6b4c0ed0c5c47215fee6f9b16f9cd276d8d60989b60a246b67b752e026160f3d7eb217aebd9acc94761d22ac2b4e55a70923485e85ecb22cf180
+  data.tar.gz: aca41f12fa024ec20fa6f5df15d3bab30211e8633a4021973dfc5a881c477bc3f19bda665bc88ad3ef80ee95ba8a6f35323903f36071dd7c9b672b462f18e0ad

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,91 @@
+# SchemaVersionCache
+
+[![concourse.odeko.com](https://concourse.odeko.com/api/v1/teams/main/pipelines/schema-version-cache-main/jobs/test/badge)](https://concourse.odeko.com/teams/main/pipelines/schema-version-cache-main)
+
+Make Avro schema version queries fast and easy.
+
+## Installation
+
+Add to the application's Gemfile:
+```ruby
+gem "schema_version_cache", source: "https://gem.odeko.com/"
+```
+
+## Usage
+
+Initialize a schema registry client and a cache:
+```ruby
+# config/initializers/kafka.rb
+
+require "avro_turf/messaging"
+
+registry = AvroTurf::ConfluentSchemaRegistry.new(
+  ENV["CONFLUENT_SCHEMA_REGISTRY_URL"],
+  user: ENV["CONFLUENT_SCHEMA_REGISTRY_USER"],
+  password: ENV["CONFLUENT_SCHEMA_REGISTRY_PASSWORD"]
+)
+AvroSchemaVersionCache = SchemaVersionCache.new(registry)
+```
+
+Optionally, preload the cache on startup:
+```ruby
+# config/racecar.rb
+
+Racecar.configure do |config|
+  # ...
+  AvroSchemaVersionCache.preload(
+    [
+      "com.odeko.foo_service.Foo_value",
+      "com.odeko.bar_service.Bar_value"
+    ]
+  )
+end
+```
+
+Run schema queries as needed:
+```ruby
+subject = "com.odeko.foo_service.Foo_value"
+schema_id = AvroSchemaVersionCache.get_current_id(subject:)
+version = AvroSchemaVersionCache.get_version_number(subject:, schema_id:)
+schema_json = AvroSchemaVersionCache.get_schema_json(subject:, version:)
+versions = AvroSchemaVersionCache.get_version_numbers(subject:)
+
+# Find compatible version using Avro parsing and validator:
+compatible_version = AvroSchemaVersionCache.find_compatible_version(
+  subject:,
+  data: {color: "red", bright: true}
+)
+
+# Find compatible version using custom parsing and validator:
+custom_compatible_version = AvroSchemaVersionCache.find_compatible_version(
+  subject:,
+  data: {color: "red", bright: true},
+  schema_parser: ->(string) { MySchemaParser.parse(string) },
+  validator: ->(schema, data) { MyValidator.valid?(schema, data) }
+)
+```
+
+## Development
+
+Prerequisites: Ruby and bundler.
+
+Install project dependencies:
+```console
+$ bin/setup
+```
+
+Run the test-suite:
+```console
+$ bin/ci-test
+```
+
+Run the linter:
+```console
+$ bin/lint
+```
+
+Note that we have a development dependency on sorbet for static type-checking,
+and we declare a public interface RBI file in the `rbi/` directory to aid with
+type-checking in projects that use this gem. We avoid placing type annotations
+directly in `lib/schema_version_cache.rb` or enabling runtime type-checking.
+This allows applications to use our gem regardless of whether they use sorbet.

data/lib/schema_version_cache.rb

@@ -0,0 +1,137 @@
+# typed: true
+
+require "avro"
+
+class SchemaVersionCache
+  SchemaNotFound = Class.new(StandardError)
+  SubjectLookupError = Class.new(StandardError)
+
+  # Registry is expected to provide the following methods:
+  # - subject_versions: Given a subject, return an array of version numbers.
+  # - subject_version: Given a subject and version number, return a hash of
+  #   schema data including schema ID under key "id" and schema JSON string
+  #   under key "schema".
+  #
+  # In practice, we use AvroTurf::ConfluentSchemaRegistry, but for flexibility
+  # and ease of testing, any object providing the necessary methods will work.
+  def initialize(registry)
+    @registry = registry
+    @by_version = {}
+    @by_id = {}
+  end
+
+  def preload(subjects)
+    subjects.each { |subject| add_subject_to_cache(subject) }
+  end
+
+  def get_version_numbers(subject:)
+    if @by_version.key?(subject) && @by_version.fetch(subject).keys.any?
+      return @by_version.fetch(subject).keys
+    end
+
+    add_subject_to_cache(subject)
+    @by_version.fetch(subject, {}).keys
+  end
+
+  def get_version_number(subject:, schema_id:)
+    if @by_id.key?(subject) && @by_id.fetch(subject).key?(schema_id)
+      return @by_id.fetch(subject).fetch(schema_id).version
+    end
+
+    add_subject_to_cache(subject)
+    @by_id.dig(subject, schema_id)&.version || schema_not_found(subject:, schema_id:)
+  end
+
+  def get_current_id(subject:)
+    if @by_id.key?(subject) && @by_id.fetch(subject).keys.any?
+      return @by_id.fetch(subject).keys.max
+    end
+
+    add_subject_to_cache(subject)
+    @by_id.fetch(subject, {}).keys.max || schema_not_found(subject:)
+  end
+
+  def get_schema_id(subject:, version:)
+    if @by_version.key?(subject) && @by_version.fetch(subject).key?(version)
+      return @by_version.fetch(subject).fetch(version).id
+    end
+
+    add_subject_to_cache(subject)
+    @by_version.dig(subject, version)&.id || schema_not_found(subject:, version:)
+  end
+
+  def get_schema_json(subject:, version:)
+    if @by_version.key?(subject) && @by_version.fetch(subject).key?(version)
+      return @by_version.fetch(subject).fetch(version).schema
+    end
+
+    add_subject_to_cache(subject)
+    @by_version.dig(subject, version)&.schema || schema_not_found(subject:, version:)
+  end
+
+  def find_compatible_version(subject:, data:, schema_parser: nil, validator: nil)
+    version = newest_compatible_version(subject:, data:, schema_parser:, validator:)
+    return version if version
+
+    add_subject_to_cache(subject)
+    newest_compatible_version(subject:, data:, schema_parser:, validator:) ||
+      schema_not_found(subject:)
+  end
+
+  private
+
+  def newest_compatible_version(subject:, data:, schema_parser:, validator:)
+    get_version_numbers(subject:).reverse.find do |version|
+      json = get_schema_json(subject:, version:)
+      schema = schema_parser ? schema_parser.call(json) : avro_parse(json)
+      validator ? validator.call(schema, data) : avro_valid?(schema, data)
+    end
+  end
+
+  def avro_parse(json)
+    ::Avro::Schema.parse(json)
+  end
+
+  def avro_valid?(schema, data)
+    ::Avro::SchemaValidator.validate!(
+      schema,
+      data,
+      recursive: true,
+      encoded: false,
+      fail_on_extra_fields: true
+    )
+    true
+  rescue Avro::SchemaValidator::ValidationError
+    false
+  end
+
+  Entry = Struct.new(:subject, :version, :id, :schema, keyword_init: true)
+
+  def add_subject_to_cache(subject)
+    entries = @registry.subject_versions(subject).sort.map do |version|
+      data = @registry.subject_version(subject, version)
+      id = data.fetch("id")
+      schema = data.fetch("schema")
+      Entry.new(subject:, version:, id:, schema:)
+    end
+
+    @by_version[subject] = entries.reduce({}) do |hash, entry|
+      hash.merge!(entry.version => entry)
+    end
+    @by_id[subject] = entries.reduce({}) do |hash, entry|
+      hash.merge!(entry.id => entry)
+    end
+  rescue => e
+    raise SubjectLookupError, <<~ERR.chomp
+      Could not lookup versions for subject "#{subject}": #{e}
+    ERR
+  end
+
+  def schema_not_found(**attributes)
+    raise SchemaNotFound, <<~ERR.chomp
+      Could not find schema with attributes: #{
+        attributes.map { |key, val| "#{key}=#{val}" }.join(", ")
+      }
+    ERR
+  end
+end

data/rbi/schema_version_cache.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+class SchemaVersionCache
+  SchemaNotFound = Class.new(StandardError)
+  SubjectLookupError = Class.new(StandardError)
+
+  sig { params(registry: T.untyped).void }
+  def initialize(registry); end
+
+  sig { params(subjects: T::Array[String]).void }
+  def preload(subjects); end
+
+  sig { params(subject: String).returns(T::Array[Integer]) }
+  def get_version_numbers(subject:); end
+
+  sig { params(subject: String, schema_id: Integer).returns(Integer) }
+  def get_version_number(subject:, schema_id:); end
+
+  sig { params(subject: String).returns(Integer) }
+  def get_current_id(subject:); end
+
+  sig { params(subject: String, version: Integer).returns(Integer) }
+  def get_schema_id(subject:, version:); end
+
+  sig { params(subject: String, version: Integer).returns(String) }
+  def get_schema_json(subject:, version:); end
+
+  sig do
+    params(
+      subject: String,
+      data: T.untyped,
+      schema_parser: T.nilable(
+        T.proc.params(json: String).returns(T.untyped)
+      ),
+      validator: T.nilable(
+        T.proc.params(schema: T.untyped, data: T.untyped).returns(T::Boolean)
+      )
+    ).returns(
+      Integer
+    )
+  end
+  def find_compatible_version(subject:, data:, schema_parser: nil, validator: nil); end
+
+  sig do
+    params(
+      subject: T.untyped,
+      data: T.untyped,
+      schema_parser: T.nilable(
+        T.proc.params(json: String).returns(T.untyped)
+      ),
+      validator: T.nilable(
+        T.proc.params(schema: T.untyped, data: T.untyped).returns(T::Boolean)
+      )
+    ).returns(
+      T.nilable(Integer)
+    )
+  end
+  def newest_compatible_version(subject:, data:, schema_parser:, validator:); end
+
+  sig { params(json: String).returns(::Avro::Schema) }
+  def avro_parse(json); end
+
+  sig { params(schema: ::Avro::Schema, data: T.untyped).returns(T::Boolean) }
+  def avro_valid?(schema, data); end
+
+  sig { params(subject: String).void }
+  def add_subject_to_cache(subject); end
+
+  sig { params(attributes: T.untyped).returns(T.noreturn) }
+  def schema_not_found(**attributes); end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: schema_version_cache
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Odeko Developers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: avro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Schema version cache, e.g. for Avro schemas
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/schema_version_cache.rb
+- rbi/schema_version_cache.rbi
+homepage: https://github.com/OdekoTeam/schema_version_cache
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Schema version cache
+test_files: []