sequel-privacy 0.5.7 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f44402a685dc5c1569213ac155c7fba6ecbd291eb8a2091491f510105ddcc4d7
-  data.tar.gz: bc3a007c36fb539cd5f911b65c8bccf087218bd871b53991cfb9987cf44acc1c
+  metadata.gz: 627da75fe2db0e41382bd4b6a6e44cf85bb01a3a52aef9c1c16df85b0b4af5d8
+  data.tar.gz: e0cfd6b79e35d81a51d6897fa37f9130e5fb567f3422c0014500be6bb0d95183
 SHA512:
-  metadata.gz: c8ed3ffe946e6525075651c1965ded61114b44d0bfc10e67bcac71d5d2bfce7f8dcd682818fc6c1611eaca1ab8cfd5d709c24067d03c394edcb31b4de5b08593
-  data.tar.gz: 694cc27fb53f8ef0c68c7ab645c3f55251d1b3c838fdb9f52c9cf66bbbd33a8caff9d8969f0157f8fef8101562a99e570fbe3916d2d04389eccb7fc207a2aa5c
+  metadata.gz: c1450ee72abf6ef060a7d2f8d541f3d418724cca9650370746e996427d4da438e93fa96410b47b6606ab4a41542d014b46dbf97a08e3e4623cf120b419736372
+  data.tar.gz: 5ccadc4dfb1b84fb7ab9d3beefb2b396b2b1302239c0b63fc97a2c34a6fb9b5a025857542814167e007326a17e08e1697d56731cdff690a5c9d72d850cb96529

data/lib/sequel/plugins/privacy.rb

@@ -43,10 +43,15 @@ module Sequel
         model.instance_variable_set(:@privacy_association_policies, {})
         model.instance_variable_set(:@privacy_finalized, false)
         model.instance_variable_set(:@allow_unsafe_access, false)
+        model.instance_variable_set(:@privacy_wrapped_association_reflections, {})
       end
 
       sig { params(model: T.class_of(Sequel::Model), opts: T::Hash[Symbol, T.untyped]).void }
-      def self.configure(model, opts = {}); end
+      def self.configure(model, opts = {})
+        model.all_association_reflections.each do |reflection|
+          model.send(:_setup_privacy_association_readers, reflection[:type], reflection[:name], true)
+        end
+      end
 
       class AssociationPrivacyDSL
         extend T::Sig
@@ -146,6 +151,7 @@ module Sequel
           :@privacy_policies => :dup,
           :@privacy_fields => :dup,
           :@privacy_association_policies => :dup,
+          :@privacy_wrapped_association_reflections => :dup,
           :@privacy_finalized => nil,
           :@allow_unsafe_access => nil
         )
@@ -350,15 +356,7 @@ module Sequel
           opts = _inject_privacy_eager_block(opts)
           result = super
 
-          case type
-          when :many_to_one, :one_to_one
-            _override_singular_association(name)
-            _override_association_dataset(name)
-          when :one_to_many, :many_to_many
-            _override_plural_association(name)
-            _override_association_dataset(name)
-            setup_association_privacy(name) if privacy_association_policies[name]
-          end
+          _setup_privacy_association_readers(type, name, false)
 
           result
         end
@@ -368,32 +366,74 @@ module Sequel
         # DatasetMethods#post_load). Preserves any user-supplied block.
         sig { params(opts: T::Hash[Symbol, T.untyped]).returns(T::Hash[Symbol, T.untyped]) }
         def _inject_privacy_eager_block(opts)
-          original = opts[:eager_block]
-          wrapped = proc do |ds|
-            ds = original.call(ds) if original
+          opts.merge(eager_block: _privacy_eager_block(opts[:eager_block]))
+        end
+
+        sig { params(original: T.untyped).returns(Proc) }
+        def _privacy_eager_block(original)
+          wrapped = proc do |dataset|
+            dataset = original.call(dataset) if original
             vc = Thread.current[DatasetMethods::EAGER_VC_KEY]
-            if vc && T.unsafe(ds).model.respond_to?(:privacy_vc_key)
-              T.unsafe(ds).for_vc(vc)
+            if vc && T.unsafe(dataset).model.respond_to?(:privacy_vc_key)
+              T.unsafe(dataset).for_vc(vc).clone(privacy_eager_load: true)
             else
-              ds
+              dataset
             end
           end
-          opts.merge(eager_block: wrapped)
+          wrapped
         end
 
         private
 
+        sig { returns(T::Module[T.anything]) }
+        def privacy_association_wrapper
+          wrapper = @privacy_association_wrapper ||= T.let(
+            Module.new,
+            T.nilable(T::Module[T.anything])
+          )
+          prepend(wrapper) unless ancestors.include?(wrapper)
+          wrapper
+        end
+
+        sig { params(type: Symbol, name: Symbol, inject_eager_block: T::Boolean).void }
+        def _setup_privacy_association_readers(type, name, inject_eager_block)
+          reflection = association_reflection(name)
+          return unless reflection
+
+          @privacy_wrapped_association_reflections ||= T.let(
+            {},
+            T.nilable(T::Hash[Symbol, T.untyped])
+          )
+          wrapped = @privacy_wrapped_association_reflections
+          return if wrapped[name].equal?(reflection)
+
+          if inject_eager_block
+            reflection[:eager_block] = _privacy_eager_block(reflection[:eager_block])
+          end
+
+          case type
+          when :many_to_one, :one_to_one
+            _override_singular_association(name)
+            _override_association_dataset(name)
+          when :one_to_many, :many_to_many
+            _override_plural_association(name)
+            _override_association_dataset(name)
+            setup_association_privacy(name) if privacy_association_policies[name]
+          end
+
+          wrapped[name] = reflection
+        end
+
         sig { params(name: Symbol).void }
         def _override_association_dataset(name)
           dataset_method = :"#{name}_dataset"
           return unless method_defined?(dataset_method)
 
-          original = instance_method(dataset_method)
           assoc_reflection = association_reflection(name)
           assoc_class = T.let(nil, T.nilable(T.class_of(Sequel::Model)))
 
-          define_method(dataset_method) do |*args|
-            ds = original.bind(self).(*args)
+          privacy_association_wrapper.define_method(dataset_method) do |*args, &block|
+            ds = super(*args, &block)
             vc = instance_variable_get(:@viewer_context)
             return ds unless vc
 
@@ -408,12 +448,11 @@ module Sequel
 
         sig { params(name: Symbol).void }
         def _override_singular_association(name)
-          original = instance_method(name)
           assoc_reflection = association_reflection(name)
           # Resolve lazily to handle forward references between models.
           assoc_class = T.let(nil, T.nilable(T.class_of(Sequel::Model)))
 
-          define_method(name) do
+          privacy_association_wrapper.define_method(name) do |*args, &block|
             vc = instance_variable_get(:@viewer_context)
 
             if vc.nil? && !T.unsafe(self.class).allow_unsafe_access?(name)
@@ -428,12 +467,12 @@ module Sequel
                     old_vc = Thread.current[vc_key]
                     Thread.current[vc_key] = vc
                     begin
-                      original.bind(self).()
+                      super(*args, &block)
                     ensure
                       Thread.current[vc_key] = old_vc
                     end
                   else
-                    original.bind(self).()
+                    super(*args, &block)
                   end
 
             return nil unless obj
@@ -453,11 +492,10 @@ module Sequel
 
         sig { params(name: Symbol).void }
         def _override_plural_association(name)
-          original = instance_method(name)
           assoc_reflection = association_reflection(name)
           assoc_class = T.let(nil, T.nilable(T.class_of(Sequel::Model)))
 
-          define_method(name) do
+          privacy_association_wrapper.define_method(name) do |*args, &block|
             vc = instance_variable_get(:@viewer_context)
 
             if vc.nil? && !T.unsafe(self.class).allow_unsafe_access?(name)
@@ -472,12 +510,12 @@ module Sequel
                      old_vc = Thread.current[vc_key]
                      Thread.current[vc_key] = vc
                      begin
-                       original.bind(self).()
+                       super(*args, &block)
                      ensure
                        Thread.current[vc_key] = old_vc
                      end
                    else
-                     original.bind(self).()
+                     super(*args, &block)
                    end
 
             return objs unless vc
@@ -499,13 +537,13 @@ module Sequel
         sig { params(assoc_name: Symbol, singular_name: Symbol, policies: T::Array[T.untyped]).void }
         def _wrap_association_add(assoc_name, singular_name, policies)
           method_name = :"add_#{singular_name}"
-          original = instance_method(method_name)
 
-          define_method(method_name) do |obj|
+          privacy_association_wrapper.define_method(method_name) do |*args, &block|
+            obj = args.first
             vc = instance_variable_get(:@viewer_context)
 
             unless vc
-              return original.bind(self).(obj) if T.unsafe(self.class).allow_unsafe_access?(assoc_name)
+              return super(*args, &block) if T.unsafe(self.class).allow_unsafe_access?(assoc_name)
 
               Kernel.raise Sequel::Privacy::MissingViewerContext,
                            "Cannot #{method_name} without a viewer context"
@@ -523,20 +561,20 @@ module Sequel
                            "Cannot #{method_name} on #{self.class}"
             end
 
-            original.bind(self).(obj)
+            super(*args, &block)
           end
         end
 
         sig { params(assoc_name: Symbol, singular_name: Symbol, policies: T::Array[T.untyped]).void }
         def _wrap_association_remove(assoc_name, singular_name, policies)
           method_name = :"remove_#{singular_name}"
-          original = instance_method(method_name)
 
-          define_method(method_name) do |obj|
+          privacy_association_wrapper.define_method(method_name) do |*args, &block|
+            obj = args.first
             vc = instance_variable_get(:@viewer_context)
 
             unless vc
-              return original.bind(self).(obj) if T.unsafe(self.class).allow_unsafe_access?(assoc_name)
+              return super(*args, &block) if T.unsafe(self.class).allow_unsafe_access?(assoc_name)
 
               Kernel.raise Sequel::Privacy::MissingViewerContext,
                            "Cannot #{method_name} without a viewer context"
@@ -554,20 +592,19 @@ module Sequel
                            "Cannot #{method_name} on #{self.class}"
             end
 
-            original.bind(self).(obj)
+            super(*args, &block)
           end
         end
 
         sig { params(assoc_name: Symbol, plural_name: Symbol, policies: T::Array[T.untyped]).void }
         def _wrap_association_remove_all(assoc_name, plural_name, policies)
           method_name = :"remove_all_#{plural_name}"
-          original = instance_method(method_name)
 
-          define_method(method_name) do
+          privacy_association_wrapper.define_method(method_name) do |*args, &block|
             vc = instance_variable_get(:@viewer_context)
 
             unless vc
-              return original.bind(self).() if T.unsafe(self.class).allow_unsafe_access?(assoc_name)
+              return super(*args, &block) if T.unsafe(self.class).allow_unsafe_access?(assoc_name)
 
               Kernel.raise Sequel::Privacy::MissingViewerContext,
                            "Cannot #{method_name} without a viewer context"
@@ -585,7 +622,7 @@ module Sequel
                            "Cannot #{method_name} on #{self.class}"
             end
 
-            original.bind(self).()
+            super(*args, &block)
           end
         end
       end
@@ -716,8 +753,9 @@ module Sequel
         # can retreive. Materializes the model, and then checks the view
         # policy. If the model is being materialized within the context of
         # checking a policy this is bypassed, because policies often need to
-        # check data that a VC might not have permission to see. The check is also
-        # bypassed for eager loads, and checked on the association.
+        # check data that a VC might not have permission to see. For eager
+        # association loads, enforcement is deferred until association access so
+        # Sequel can finish attachment and populate reciprocal caches first.
         sig { returns(T.untyped) }
         def row_proc
           vc = opts[:viewer_context]
@@ -737,8 +775,8 @@ module Sequel
             next nil if instance.nil?
 
             instance.instance_variable_set(:@viewer_context, vc)
+            next instance if opts[:privacy_eager_load]
             next instance if Sequel::Privacy::Enforcer.in_policy_eval?
-            next instance if Thread.current[EAGER_VC_KEY]
 
             if T.cast(instance, InstanceMethods).allow?(vc, :view)
               instance

data/lib/sequel/privacy/version.rb

@@ -3,6 +3,6 @@
 
 module Sequel
   module Privacy
-    VERSION = '0.5.7'
+    VERSION = '0.6.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-privacy
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.1
 platform: ruby
 authors:
 - Austin Bales
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Privacy enforcement plugin for Sequel models
 test_files: []