openapi_first 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47dffdd527985dd188f08ea57ff1104f3e51203746175cf4a964c757af8ebd6e
-  data.tar.gz: c67d1e706d644caadd9397bfdb2eef046317e2c4ac86bfd8e261b60ad7136bf7
+  metadata.gz: dc1e6456e7c11e5079255b24e6407f61d9e94677fe07bef54000c26fe1174e05
+  data.tar.gz: 313d87080b433ca45defd7a47a811f6f2a91b93804a6655b9121b86d95c2e2f7
 SHA512:
-  metadata.gz: e5e16ce4c6c4756517e9bff345eb7182937b239be36a038444680f61b169790aef3c5d10c3c1d8b2be0e3332b72784a3722ba3ea99de0e7712f4c1e48284c0ec
-  data.tar.gz: fa631d3327bbcf640645d2b762d00ac8baa4bf5c87276c9c00cc280e58d1985a419a64ccd4b8521f411f9d5f47442ae9efc31f0bf959b5a8d4f24fb8205de7a7
+  metadata.gz: 6a04433e95586c8cc5ad34f791e1a2fc598584be5e23c7e7518c5eb9bd04d77c96fb3b1fe9330a16e4a9060b119b835e42863a11a1abb77c8f5b2cbba246fdcc
+  data.tar.gz: bb8a46ea7aaf083819cac30ede78fe6f560f339f2d8282d727e111b3e504dab42aa0a7b82d1372bd060a5217818f694cadad11f71085e15baed7a10c48f5578e

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 4.0.1
+
+- Fix: Reduced memory usage with large API descriptions. Schemas no longer each deep-copy (stringify keys) the whole OAD to build a root schema. This is a json_schemer specific optimization.
+
 ## 4.0.0
 
 This release has no stricter or less strict request validation. It changes mostly internal stuff and adds a Sinatra integration. It's a major version, but it should be safe to upgrade.

data/lib/openapi_first/file_loader.rb

@@ -26,12 +26,20 @@ module OpenapiFirst
           if extname == '.json'
             ::JSON.parse(body)
           elsif ['.yaml', '.yml'].include?(extname)
-            YAML.unsafe_load(body)
+            load_yaml(body, file_path)
           else
             body
           end
         end
       end
     end
+
+    private
+
+    def load_yaml(body, file_path)
+      Utils.deep_stringify_keys(YAML.unsafe_load(body))
+    rescue ::JSON::GeneratorError => e
+      raise Error, "Could not load #{file_path.inspect}: #{e.message}"
+    end
   end
 end

data/lib/openapi_first/ref_resolver.rb

@@ -184,6 +184,17 @@ module OpenapiFirst
         vocabulary: { 'https://json-schema.org/draft/2020-12/vocab/core' => true }
       )
 
+      # This class is here to monkey-patch JSONSchemer::Schema when we are passing
+      # an instance to sub-schemas. It skips stringifying all keys of the passed object to
+      # allocate fewer objects. We don't have to stringify the keys, because they are already stringified upstream.
+      # @visibility private
+      class DocumentRootSchema < JSONSchemer::Schema
+        private
+
+        def deep_stringify_keys(value) = value
+      end
+      private_constant :DocumentRootSchema
+
       def initialize(value:, context:, base_uri:, options:)
         @value = value
         @context = context
@@ -197,7 +208,7 @@ module OpenapiFirst
 
       def schema
         @schema ||= begin
-          root_schema = JSONSchemer::Schema.new(context, base_uri:, **options, meta_schema: DOCUMENT_META_SCHEMA)
+          root_schema = DocumentRootSchema.new(context, base_uri:, **options, meta_schema: DOCUMENT_META_SCHEMA)
           apply_dialect(root_schema)
           JSONSchemer::Schema.new(value, nil, root_schema, base_uri:, **options)
         end

data/lib/openapi_first/utils.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  # @visibility private
+  module Utils
+    module_function
+
+    def deep_stringify_keys(contents) = ::JSON.parse(::JSON.generate(contents))
+  end
+end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '4.0.0'
+  VERSION = '4.0.1'
 end

data/lib/openapi_first.rb

@@ -4,6 +4,7 @@ require_relative 'openapi_first/json'
 require_relative 'openapi_first/file_loader'
 require_relative 'openapi_first/errors'
 require_relative 'openapi_first/registry'
+require_relative 'openapi_first/utils'
 require_relative 'openapi_first/configuration'
 require_relative 'openapi_first/child_configuration'
 require_relative 'openapi_first/definition'
@@ -82,7 +83,7 @@ module OpenapiFirst
   # @return [Definition]
   # TODO: This needs to work with unresolved contents as well
   def self.parse(contents, only: nil, filepath: nil, path_prefix: nil, &)
-    contents = ::JSON.parse(::JSON.generate(contents)) # Deeply stringify keys, because of YAML. See https://github.com/ahx/openapi_first/issues/367
+    contents = Utils.deep_stringify_keys(contents) # Deeply stringify keys, because of YAML. See https://github.com/ahx/openapi_first/issues/367
     contents['paths'].filter!(&->(key, _) { only.call(key) }) if only
     Definition.new(contents, filepath, path_prefix, &)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Andreas Haller
@@ -154,6 +154,7 @@ files:
 - lib/openapi_first/test/observe.rb
 - lib/openapi_first/test/observer_middleware.rb
 - lib/openapi_first/test/plain_helpers.rb
+- lib/openapi_first/utils.rb
 - lib/openapi_first/validated_request.rb
 - lib/openapi_first/validated_response.rb
 - lib/openapi_first/validators/multipart_request_body.rb