ruby-object-framework 1.0.0

data/lib/object_framework/http2/hpack_tables.rb

@@ -0,0 +1,333 @@
+# frozen_string_literal: true
+
+# Protocol tables from RFC 7541, Appendices A and B.
+# Copyright (c) 2015 IETF Trust and the persons identified as the document authors.
+# See THIRD_PARTY_NOTICES.md for the applicable Simplified BSD license.
+module ObjectFramework
+  module HTTP2
+    module HPACK
+      STATIC_TABLE = [
+        [":authority", ""].freeze,
+        [":method", "GET"].freeze,
+        [":method", "POST"].freeze,
+        [":path", "/"].freeze,
+        [":path", "/index.html"].freeze,
+        [":scheme", "http"].freeze,
+        [":scheme", "https"].freeze,
+        [":status", "200"].freeze,
+        [":status", "204"].freeze,
+        [":status", "206"].freeze,
+        [":status", "304"].freeze,
+        [":status", "400"].freeze,
+        [":status", "404"].freeze,
+        [":status", "500"].freeze,
+        ["accept-charset", ""].freeze,
+        ["accept-encoding", "gzip, deflate"].freeze,
+        ["accept-language", ""].freeze,
+        ["accept-ranges", ""].freeze,
+        ["accept", ""].freeze,
+        ["access-control-allow-origin", ""].freeze,
+        ["age", ""].freeze,
+        ["allow", ""].freeze,
+        ["authorization", ""].freeze,
+        ["cache-control", ""].freeze,
+        ["content-disposition", ""].freeze,
+        ["content-encoding", ""].freeze,
+        ["content-language", ""].freeze,
+        ["content-length", ""].freeze,
+        ["content-location", ""].freeze,
+        ["content-range", ""].freeze,
+        ["content-type", ""].freeze,
+        ["cookie", ""].freeze,
+        ["date", ""].freeze,
+        ["etag", ""].freeze,
+        ["expect", ""].freeze,
+        ["expires", ""].freeze,
+        ["from", ""].freeze,
+        ["host", ""].freeze,
+        ["if-match", ""].freeze,
+        ["if-modified-since", ""].freeze,
+        ["if-none-match", ""].freeze,
+        ["if-range", ""].freeze,
+        ["if-unmodified-since", ""].freeze,
+        ["last-modified", ""].freeze,
+        ["link", ""].freeze,
+        ["location", ""].freeze,
+        ["max-forwards", ""].freeze,
+        ["proxy-authenticate", ""].freeze,
+        ["proxy-authorization", ""].freeze,
+        ["range", ""].freeze,
+        ["referer", ""].freeze,
+        ["refresh", ""].freeze,
+        ["retry-after", ""].freeze,
+        ["server", ""].freeze,
+        ["set-cookie", ""].freeze,
+        ["strict-transport-security", ""].freeze,
+        ["transfer-encoding", ""].freeze,
+        ["user-agent", ""].freeze,
+        ["vary", ""].freeze,
+        ["via", ""].freeze,
+        ["www-authenticate", ""].freeze,
+      ].freeze
+      HUFFMAN_CODES = [
+        [0x1ff8, 13].freeze,
+        [0x7fffd8, 23].freeze,
+        [0xfffffe2, 28].freeze,
+        [0xfffffe3, 28].freeze,
+        [0xfffffe4, 28].freeze,
+        [0xfffffe5, 28].freeze,
+        [0xfffffe6, 28].freeze,
+        [0xfffffe7, 28].freeze,
+        [0xfffffe8, 28].freeze,
+        [0xffffea, 24].freeze,
+        [0x3ffffffc, 30].freeze,
+        [0xfffffe9, 28].freeze,
+        [0xfffffea, 28].freeze,
+        [0x3ffffffd, 30].freeze,
+        [0xfffffeb, 28].freeze,
+        [0xfffffec, 28].freeze,
+        [0xfffffed, 28].freeze,
+        [0xfffffee, 28].freeze,
+        [0xfffffef, 28].freeze,
+        [0xffffff0, 28].freeze,
+        [0xffffff1, 28].freeze,
+        [0xffffff2, 28].freeze,
+        [0x3ffffffe, 30].freeze,
+        [0xffffff3, 28].freeze,
+        [0xffffff4, 28].freeze,
+        [0xffffff5, 28].freeze,
+        [0xffffff6, 28].freeze,
+        [0xffffff7, 28].freeze,
+        [0xffffff8, 28].freeze,
+        [0xffffff9, 28].freeze,
+        [0xffffffa, 28].freeze,
+        [0xffffffb, 28].freeze,
+        [0x14, 6].freeze,
+        [0x3f8, 10].freeze,
+        [0x3f9, 10].freeze,
+        [0xffa, 12].freeze,
+        [0x1ff9, 13].freeze,
+        [0x15, 6].freeze,
+        [0xf8, 8].freeze,
+        [0x7fa, 11].freeze,
+        [0x3fa, 10].freeze,
+        [0x3fb, 10].freeze,
+        [0xf9, 8].freeze,
+        [0x7fb, 11].freeze,
+        [0xfa, 8].freeze,
+        [0x16, 6].freeze,
+        [0x17, 6].freeze,
+        [0x18, 6].freeze,
+        [0x0, 5].freeze,
+        [0x1, 5].freeze,
+        [0x2, 5].freeze,
+        [0x19, 6].freeze,
+        [0x1a, 6].freeze,
+        [0x1b, 6].freeze,
+        [0x1c, 6].freeze,
+        [0x1d, 6].freeze,
+        [0x1e, 6].freeze,
+        [0x1f, 6].freeze,
+        [0x5c, 7].freeze,
+        [0xfb, 8].freeze,
+        [0x7ffc, 15].freeze,
+        [0x20, 6].freeze,
+        [0xffb, 12].freeze,
+        [0x3fc, 10].freeze,
+        [0x1ffa, 13].freeze,
+        [0x21, 6].freeze,
+        [0x5d, 7].freeze,
+        [0x5e, 7].freeze,
+        [0x5f, 7].freeze,
+        [0x60, 7].freeze,
+        [0x61, 7].freeze,
+        [0x62, 7].freeze,
+        [0x63, 7].freeze,
+        [0x64, 7].freeze,
+        [0x65, 7].freeze,
+        [0x66, 7].freeze,
+        [0x67, 7].freeze,
+        [0x68, 7].freeze,
+        [0x69, 7].freeze,
+        [0x6a, 7].freeze,
+        [0x6b, 7].freeze,
+        [0x6c, 7].freeze,
+        [0x6d, 7].freeze,
+        [0x6e, 7].freeze,
+        [0x6f, 7].freeze,
+        [0x70, 7].freeze,
+        [0x71, 7].freeze,
+        [0x72, 7].freeze,
+        [0xfc, 8].freeze,
+        [0x73, 7].freeze,
+        [0xfd, 8].freeze,
+        [0x1ffb, 13].freeze,
+        [0x7fff0, 19].freeze,
+        [0x1ffc, 13].freeze,
+        [0x3ffc, 14].freeze,
+        [0x22, 6].freeze,
+        [0x7ffd, 15].freeze,
+        [0x3, 5].freeze,
+        [0x23, 6].freeze,
+        [0x4, 5].freeze,
+        [0x24, 6].freeze,
+        [0x5, 5].freeze,
+        [0x25, 6].freeze,
+        [0x26, 6].freeze,
+        [0x27, 6].freeze,
+        [0x6, 5].freeze,
+        [0x74, 7].freeze,
+        [0x75, 7].freeze,
+        [0x28, 6].freeze,
+        [0x29, 6].freeze,
+        [0x2a, 6].freeze,
+        [0x7, 5].freeze,
+        [0x2b, 6].freeze,
+        [0x76, 7].freeze,
+        [0x2c, 6].freeze,
+        [0x8, 5].freeze,
+        [0x9, 5].freeze,
+        [0x2d, 6].freeze,
+        [0x77, 7].freeze,
+        [0x78, 7].freeze,
+        [0x79, 7].freeze,
+        [0x7a, 7].freeze,
+        [0x7b, 7].freeze,
+        [0x7ffe, 15].freeze,
+        [0x7fc, 11].freeze,
+        [0x3ffd, 14].freeze,
+        [0x1ffd, 13].freeze,
+        [0xffffffc, 28].freeze,
+        [0xfffe6, 20].freeze,
+        [0x3fffd2, 22].freeze,
+        [0xfffe7, 20].freeze,
+        [0xfffe8, 20].freeze,
+        [0x3fffd3, 22].freeze,
+        [0x3fffd4, 22].freeze,
+        [0x3fffd5, 22].freeze,
+        [0x7fffd9, 23].freeze,
+        [0x3fffd6, 22].freeze,
+        [0x7fffda, 23].freeze,
+        [0x7fffdb, 23].freeze,
+        [0x7fffdc, 23].freeze,
+        [0x7fffdd, 23].freeze,
+        [0x7fffde, 23].freeze,
+        [0xffffeb, 24].freeze,
+        [0x7fffdf, 23].freeze,
+        [0xffffec, 24].freeze,
+        [0xffffed, 24].freeze,
+        [0x3fffd7, 22].freeze,
+        [0x7fffe0, 23].freeze,
+        [0xffffee, 24].freeze,
+        [0x7fffe1, 23].freeze,
+        [0x7fffe2, 23].freeze,
+        [0x7fffe3, 23].freeze,
+        [0x7fffe4, 23].freeze,
+        [0x1fffdc, 21].freeze,
+        [0x3fffd8, 22].freeze,
+        [0x7fffe5, 23].freeze,
+        [0x3fffd9, 22].freeze,
+        [0x7fffe6, 23].freeze,
+        [0x7fffe7, 23].freeze,
+        [0xffffef, 24].freeze,
+        [0x3fffda, 22].freeze,
+        [0x1fffdd, 21].freeze,
+        [0xfffe9, 20].freeze,
+        [0x3fffdb, 22].freeze,
+        [0x3fffdc, 22].freeze,
+        [0x7fffe8, 23].freeze,
+        [0x7fffe9, 23].freeze,
+        [0x1fffde, 21].freeze,
+        [0x7fffea, 23].freeze,
+        [0x3fffdd, 22].freeze,
+        [0x3fffde, 22].freeze,
+        [0xfffff0, 24].freeze,
+        [0x1fffdf, 21].freeze,
+        [0x3fffdf, 22].freeze,
+        [0x7fffeb, 23].freeze,
+        [0x7fffec, 23].freeze,
+        [0x1fffe0, 21].freeze,
+        [0x1fffe1, 21].freeze,
+        [0x3fffe0, 22].freeze,
+        [0x1fffe2, 21].freeze,
+        [0x7fffed, 23].freeze,
+        [0x3fffe1, 22].freeze,
+        [0x7fffee, 23].freeze,
+        [0x7fffef, 23].freeze,
+        [0xfffea, 20].freeze,
+        [0x3fffe2, 22].freeze,
+        [0x3fffe3, 22].freeze,
+        [0x3fffe4, 22].freeze,
+        [0x7ffff0, 23].freeze,
+        [0x3fffe5, 22].freeze,
+        [0x3fffe6, 22].freeze,
+        [0x7ffff1, 23].freeze,
+        [0x3ffffe0, 26].freeze,
+        [0x3ffffe1, 26].freeze,
+        [0xfffeb, 20].freeze,
+        [0x7fff1, 19].freeze,
+        [0x3fffe7, 22].freeze,
+        [0x7ffff2, 23].freeze,
+        [0x3fffe8, 22].freeze,
+        [0x1ffffec, 25].freeze,
+        [0x3ffffe2, 26].freeze,
+        [0x3ffffe3, 26].freeze,
+        [0x3ffffe4, 26].freeze,
+        [0x7ffffde, 27].freeze,
+        [0x7ffffdf, 27].freeze,
+        [0x3ffffe5, 26].freeze,
+        [0xfffff1, 24].freeze,
+        [0x1ffffed, 25].freeze,
+        [0x7fff2, 19].freeze,
+        [0x1fffe3, 21].freeze,
+        [0x3ffffe6, 26].freeze,
+        [0x7ffffe0, 27].freeze,
+        [0x7ffffe1, 27].freeze,
+        [0x3ffffe7, 26].freeze,
+        [0x7ffffe2, 27].freeze,
+        [0xfffff2, 24].freeze,
+        [0x1fffe4, 21].freeze,
+        [0x1fffe5, 21].freeze,
+        [0x3ffffe8, 26].freeze,
+        [0x3ffffe9, 26].freeze,
+        [0xffffffd, 28].freeze,
+        [0x7ffffe3, 27].freeze,
+        [0x7ffffe4, 27].freeze,
+        [0x7ffffe5, 27].freeze,
+        [0xfffec, 20].freeze,
+        [0xfffff3, 24].freeze,
+        [0xfffed, 20].freeze,
+        [0x1fffe6, 21].freeze,
+        [0x3fffe9, 22].freeze,
+        [0x1fffe7, 21].freeze,
+        [0x1fffe8, 21].freeze,
+        [0x7ffff3, 23].freeze,
+        [0x3fffea, 22].freeze,
+        [0x3fffeb, 22].freeze,
+        [0x1ffffee, 25].freeze,
+        [0x1ffffef, 25].freeze,
+        [0xfffff4, 24].freeze,
+        [0xfffff5, 24].freeze,
+        [0x3ffffea, 26].freeze,
+        [0x7ffff4, 23].freeze,
+        [0x3ffffeb, 26].freeze,
+        [0x7ffffe6, 27].freeze,
+        [0x3ffffec, 26].freeze,
+        [0x3ffffed, 26].freeze,
+        [0x7ffffe7, 27].freeze,
+        [0x7ffffe8, 27].freeze,
+        [0x7ffffe9, 27].freeze,
+        [0x7ffffea, 27].freeze,
+        [0x7ffffeb, 27].freeze,
+        [0xffffffe, 28].freeze,
+        [0x7ffffec, 27].freeze,
+        [0x7ffffed, 27].freeze,
+        [0x7ffffee, 27].freeze,
+        [0x7ffffef, 27].freeze,
+        [0x7fffff0, 27].freeze,
+        [0x3ffffee, 26].freeze,
+        [0x3fffffff, 30].freeze,
+      ].freeze
+    end
+  end
+end

data/lib/object_framework/http2/inbound.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module ObjectFramework
+  module HTTP2
+    class Inbound
+      def initialize(cancellation:, on_consume: ->(_) {}, buffer_limit: 65_535)
+        @cancellation, @on_consume, @limit = cancellation, on_consume, buffer_limit
+        @mutex, @changed, @queue = Mutex.new, ConditionVariable.new, []
+        @bytes, @finished, @discard = 0, false, false
+      end
+
+      def push(bytes)
+        discarded = @mutex.synchronize do
+          if @discard
+            bytes.bytesize
+          else
+            raise ProtocolError.new("Inbound stream exceeds flow control", code: 3) if @bytes + bytes.bytesize > @limit
+            @queue << bytes.b.freeze unless bytes.empty?
+            @bytes += bytes.bytesize
+            @changed.broadcast
+            0
+          end
+        end
+        @on_consume.call(discarded) if discarded.positive?
+      end
+
+      def finish
+        @mutex.synchronize { @finished = true; @changed.broadcast }
+      end
+
+      def discard
+        bytes = @mutex.synchronize do
+          @discard, @finished = true, true
+          discarded, @bytes = @bytes, 0
+          @queue.clear
+          @changed.broadcast
+          discarded
+        end
+        @on_consume.call(bytes) if bytes.positive?
+      end
+
+      def cancel
+        @cancellation.cancel
+        @mutex.synchronize { @changed.broadcast }
+      end
+
+      def read_exact(count, allow_eof: false)
+        result = +"".b
+        while result.bytesize < count
+          part = @mutex.synchronize do
+            loop do
+              @cancellation.check!
+              unless @queue.empty?
+                first = @queue.shift
+                length = [count - result.bytesize, first.bytesize].min
+                @queue.unshift(first.byteslice(length..)) if length < first.bytesize
+                @bytes -= length
+                break first.byteslice(0, length)
+              end
+              if @finished
+                return nil if allow_eof && result.empty?
+                raise InvalidInput, "Truncated gRPC message"
+              end
+              remaining = @cancellation.deadline ? @cancellation.deadline - HTTP::Timing.now : 0.1
+              @changed.wait(@mutex, [[remaining, 0].max, 0.1].min)
+            end
+          end
+          result << part
+          @on_consume.call(part.bytesize)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/object_framework/memory/storage.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ObjectFramework
+  module Memory
+    class Storage
+      def initialize
+        @mutex, @tables, @revision, @closed = Mutex.new, {}, 0, false
+      end
+
+      def begin_transaction(mode:)
+        @mutex.synchronize do
+          raise Unavailable, "Storage is closed" if @closed
+          Transaction.new(storage: self, tables: @tables.transform_values(&:dup), revision: @revision, mode:)
+        end
+      end
+
+      def publish(tables, revision:)
+        @mutex.synchronize do
+          raise Unavailable, "Storage is closed" if @closed
+          raise Conflict, "Snapshot revision changed" unless revision == @revision
+          # Publishing the whole table set under one lock makes multi-row commits atomic.
+          @tables = tables.transform_values { |rows| rows.dup.freeze }.freeze
+          @revision += 1
+        end
+      end
+
+      def close
+        @mutex.synchronize { @closed = true; @tables = {} }
+      end
+    end
+
+    class Transaction < Persistence::Transaction
+      def initialize(storage:, tables:, revision:, mode:)
+        super(mode:)
+        @storage, @tables, @revision, @dirty = storage, tables, revision, false
+      end
+
+      def find(table, id)
+        active!
+        row = rows(table)[id]
+        Values.detach(row) if row
+      end
+
+      def query(query)
+        active!
+        Values.detach(query.apply(rows(query.table).values))
+      end
+
+      def insert(table, row)
+        writable!
+        value = row_value(row)
+        raise Duplicate, "Duplicate identity" if rows(table).key?(value[:id])
+        rows(table)[value[:id]] = value
+        @dirty = true
+        value[:id]
+      end
+
+      def update(table, id, row)
+        writable!
+        raise NotFound, "Unknown identity" unless rows(table).key?(id)
+        rows(table)[id] = row_value(row, id:)
+        @dirty = true
+      end
+
+      def delete(table, id)
+        writable!
+        raise NotFound, "Unknown identity" unless rows(table).key?(id)
+        rows(table).delete(id)
+        @dirty = true
+      end
+
+      def commit
+        active!
+        @storage.publish(@tables, revision: @revision) if @dirty
+        @state = :committed
+      rescue Conflict
+        @state = :rolled_back
+        @tables.clear
+        raise
+      end
+
+      private
+
+      def rows(table)
+        @tables[Persistence::Query.identifier(table)] ||= {}
+      end
+
+      def rollback_storage
+        @tables.clear
+      end
+
+      def close_storage
+        @tables.clear
+      end
+    end
+  end
+end

data/lib/object_framework/persistence/mapping.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module ObjectFramework
+  module Persistence
+    class Converter
+      def initialize(dump: ->(value) { value }, load: ->(value) { value })
+        @dump, @load = dump, load
+        freeze
+      end
+
+      def dump(value); @dump.call(value); end
+      def load(value); @load.call(value); end
+    end
+
+    Field = Data.define(:name, :column, :type, :converter, :reader, :writer)
+    Association = Data.define(:name, :kind, :target, :foreign_key, :reader, :writer)
+
+    module AssociationDSL
+      %i[belongs_to has_many].each do |kind|
+        define_method(kind) do |name, target:, foreign_key:, read: nil, write: nil|
+          mutable!
+          name = Query.identifier(name)
+          raise ConfigurationError, "Duplicate mapped attribute" if (@fields + @associations).any? { |item| item.name == name }
+          foreign_key = Query.identifier(foreign_key)
+          if kind == :belongs_to && columns.include?(foreign_key)
+            raise ConfigurationError, "Duplicate storage column"
+          end
+          @associations << Association.new(name:, kind:, target:, foreign_key:,
+            reader: read || ->(entity) { entity.public_send(name) },
+            writer: write || ->(entity, value) { entity.public_send("#{name}=", value) })
+          self
+        end
+      end
+    end
+
+    class Mapping
+      include AssociationDSL
+      TYPES = %i[string integer float boolean blob].freeze
+      attr_reader :entity_class, :table, :fields, :associations
+
+      def initialize(entity_class, table:)
+        @entity_class, @table = entity_class, Query.identifier(table)
+        @fields, @associations = [], []
+        @builder = ->(attributes) { entity_class.new(**attributes) }
+      end
+
+      def field(name, column: name, type: :string, converter: Converter.new, read: nil, write: nil)
+        mutable!
+        name, column = Query.identifier(name), Query.identifier(column)
+        raise ConfigurationError, "Unsupported column type" unless TYPES.include?(type)
+        raise ConfigurationError, "Duplicate mapped column or attribute" if columns.include?(column) || (@fields + @associations).any? { |item| item.name == name }
+        @fields << Field.new(name:, column:, type:, converter:,
+          reader: read || ->(entity) { entity.public_send(name) },
+          writer: write || ->(entity, value) { entity.public_send("#{name}=", value) })
+        self
+      end
+
+      def build(&builder)
+        mutable!
+        @builder = builder
+        self
+      end
+
+      def identity
+        fields.find { |field| field.name == :id } || raise(ConfigurationError, "Mapping requires an id field")
+      end
+
+      def columns
+        fields.map(&:column) + associations.select { |item| item.kind == :belongs_to }.map(&:foreign_key)
+      end
+
+      def schema
+        fields.to_h { |field| [field.column, field.type] }.merge(
+          associations.select { |item| item.kind == :belongs_to }.to_h { |item| [item.foreign_key, :string] }
+        ).freeze
+      end
+
+      def hydrate(row)
+        @builder.call(fields.to_h { |field| [field.name, field.converter.load(Values.mutable_copy(row[field.column]))] })
+      end
+
+      def dump(entity, baseline: nil, loaded: [])
+        row = fields.to_h { |field| [field.column, field.converter.dump(field.reader.call(entity))] }
+        associations.select { |association| association.kind == :belongs_to }.each do |association|
+          target = association.reader.call(entity)
+          row[association.foreign_key] = if target
+            target.public_send(:id) || raise(InvalidInput, "Associated entities must be registered before flush")
+          elsif baseline && !loaded.include?(association.name)
+            baseline[association.foreign_key]
+          end
+        end
+        Values.detach(baseline ? baseline.merge(row) : row)
+      end
+
+      def finalize!
+        identity
+        raise ConfigurationError, "Identity must map to the id column" unless identity.column == :id
+        fields.freeze
+        associations.freeze
+        freeze
+      end
+
+      private
+
+      def mutable!
+        raise ConfigurationError, "Mapping is finalized" if frozen?
+      end
+    end
+
+    class Mappings
+      include Enumerable
+
+      def initialize
+        @mappings = {}
+      end
+
+      def define(entity_class, table:, &description)
+        raise ConfigurationError, "Mappings are finalized" if @mappings.frozen?
+        raise ConfigurationError, "Duplicate entity mapping" if @mappings.key?(entity_class)
+        raise ConfigurationError, "Duplicate table mapping" if @mappings.values.any? { |mapping| mapping.table == table.to_sym }
+        mapping = Mapping.new(entity_class, table:)
+        mapping.instance_eval(&description) if description
+        @mappings[entity_class] = mapping
+      end
+
+      def each(&block)
+        @mappings.values.each(&block)
+      end
+
+      def fetch(entity_class)
+        @mappings.fetch(entity_class) { raise ConfigurationError, "Unmapped entity: #{entity_class}" }
+      end
+
+      def validate!
+        each do |mapping|
+          mapping.identity
+          mapping.associations.each do |association|
+            target = fetch(association.target)
+            if association.kind == :has_many && !target.columns.include?(association.foreign_key)
+              raise ConfigurationError, "Collection foreign key is not mapped"
+            end
+          end
+        end
+        each(&:finalize!)
+        @mappings.freeze
+        self
+      end
+    end
+  end
+end