rails_audit_log-graphql 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca2df96cd0a69c6449fc8585832293c9a06d487a7525f40c1d15762c61710b5
-  data.tar.gz: 8262257281bef88c4ab07700ec88b5755ca6b2a095fd879bf5462d403ec1ac00
+  metadata.gz: a1df5ae47e9bae5cc635eb04372e8a84f3c484350f50284d98ab4602d9f2175c
+  data.tar.gz: 5bd2df5463caab8646bfab17973cd85343819b94fb189d6c3d52bbe65cbf11ce
 SHA512:
-  metadata.gz: 4598525fe46095cbd1209e9bc3af297950526eb9c7ecfab9e382ee3554f376e73b0db3073986d49cdd05190e42f90e1d09e3f1a00c3ecb948a0f02d04f5ba9f0
-  data.tar.gz: 2069e44509afdccf33c443bcf443da4480e83e60034f73bf24b0a7139ab012910d60e17dd85d06897b0642a6e4cb0d0d548a08c6bfbd5ac8318f6bd787d998b3
+  metadata.gz: 3899c333a5af6c7f9c1a05cfe1bc882f8464ad9da9d21ed677c75ce7ec6546a6181893d8a27f563822d46ed4bfb7d6f91e8349285d1bc83e3cc6aaae2a8d5147
+  data.tar.gz: cdc13b1d159a794f67fa1c46a3410b3196529dba59e234eba32147338d15e85a2478bcb676821738256792e4358100a4c07bc96cfb855c00d68db828807a1d48

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.6.1] - 2026-06-04
+
+### Added
+
+- `actorType:` filter argument on `auditLogEntries`, `auditLogEntriesConnection`, and `auditLogEntriesCount` — filter by actor model class name (e.g. `"User"`)
+- `forTenant:` argument on `auditLogReify` and `auditLogEntriesCount` — consistent tenant scoping across all query fields; both also respect `RailsAuditLog.current_tenant` auto-tenant
+
+### Changed
+
+- `auditLogReify` return type changed from generic `JSON` to `AuditLogJson` for consistency with other entry fields
+- `rails g rails_audit_log:graphql:install` now also injects `SchemaPlugin` into the host schema file (detected via `app/graphql/**/*schema*.rb` glob); `print_next_steps` updated to mention all available queries and the complexity config override
+
 ## [0.6.0] - 2026-06-04
 
 ### Added

data/README.md

@@ -152,6 +152,7 @@ List entries with optional filters and offset pagination.
 | `itemType` | `String` | — | Filter by audited model class name |
 | `itemId` | `ID` | — | Filter by audited record ID |
 | `actorId` | `ID` | — | Filter by actor ID |
+| `actorType` | `String` | — | Filter by actor model class name (e.g. `"User"`) |
 | `since` | `ISO8601DateTime` | — | Return entries created at or after this time |
 | `until` | `ISO8601DateTime` | — | Return entries created at or before this time |
 | `touching` | `String` | — | Filter to entries that changed a specific attribute |
@@ -172,6 +173,7 @@ Same filters as `auditLogEntries`, but returns a [Relay-style connection](https:
 | `itemType` | `String` | Filter by audited model class name |
 | `itemId` | `ID` | Filter by audited record ID |
 | `actorId` | `ID` | Filter by actor ID |
+| `actorType` | `String` | Filter by actor model class name (e.g. `"User"`) |
 | `forTenant` | `String` | Scope to a specific tenant ID; overrides auto-tenant |
 | `first` | `Int` | Return the first N edges after `after` |
 | `after` | `String` | Cursor to paginate forward from |
@@ -221,7 +223,9 @@ Returns the count of matching audit log entries. Respects auto-tenant when `Rail
 |---|---|---|
 | `event` | `String` | Filter by event type (`create`, `update`, `destroy`) |
 | `itemType` | `String` | Filter by audited model class name |
+| `actorType` | `String` | Filter by actor model class name (e.g. `"User"`) |
 | `since` | `ISO8601DateTime` | Count entries created at or after this time |
+| `forTenant` | `String` | Scope to a specific tenant ID; overrides auto-tenant |
 
 ```graphql
 { auditLogEntriesCount(event: "update", itemType: "Post") }
@@ -291,9 +295,9 @@ The plugin also adds `AuditLogActor.record` and `AuditedResource.record` fields
 
 [↑ Back to top](#table-of-contents)
 
-### `auditLogReify(itemType:, itemId:, at:): JSON`
+### `auditLogReify(itemType:, itemId:, at:): AuditLogJson`
 
-Reconstructs the attribute state of a record at a given point in time. Returns the attributes as JSON, or `nil` when no entry exists at or before `at` or the record was destroyed at that time.
+Reconstructs the attribute state of a record at a given point in time. Returns the attributes as `AuditLogJson`, or `nil` when no entry exists at or before `at` or the record was destroyed at that time. Accepts `forTenant:` and respects auto-tenant.
 
 ```graphql
 {

data/lib/generators/rails_audit_log/graphql/install/install_generator.rb

@@ -7,10 +7,11 @@ module RailsAuditLog
     module Graphql
       class InstallGenerator < Rails::Generators::Base
         source_root File.expand_path("templates", __dir__)
-        desc "Injects AuditLogEntriesQueryMixin into your GraphQL QueryType."
+        desc "Injects AuditLogEntriesQueryMixin into your GraphQL QueryType and SchemaPlugin into your schema."
 
         QUERY_TYPE_PATH = "app/graphql/types/query_type.rb"
         MIXIN = "RailsAuditLog::Graphql::Queries::AuditLogEntriesQueryMixin"
+        SCHEMA_PLUGIN = "RailsAuditLog::Graphql::SchemaPlugin"
 
         def inject_mixin
           if File.exist?(File.join(destination_root, QUERY_TYPE_PATH))
@@ -24,11 +25,31 @@ module RailsAuditLog
           end
         end
 
+        def inject_schema_plugin
+          schema_files = Dir.glob(File.join(destination_root, "app/graphql/**/*schema*.rb"))
+          if schema_files.any?
+            schema_path = schema_files.first.delete_prefix("#{destination_root}/")
+            inject_into_file schema_path,
+              "  include #{SCHEMA_PLUGIN}\n",
+              after: /class\s+\S+\s*<\s*GraphQL::Schema\s*\n/
+          else
+            say ""
+            say "No schema file found. Add this line manually to your GraphQL::Schema subclass:", :yellow
+            say "  include #{SCHEMA_PLUGIN}", :green
+          end
+        end
+
         def print_next_steps
           say ""
           say "Done! Your GraphQL API now has:", :green
           say "  auditLogEntry(id: ID!): AuditLogEntry"
           say "  auditLogEntries(...): [AuditLogEntry!]!"
+          say "  auditLogReify(itemType:, itemId:, at:): AuditLogJson"
+          say "  auditLogEntriesCount(...): Int!"
+          say ""
+          say "SchemaPlugin applies complexity/depth limits and enables dataloader."
+          say "Override defaults in an initializer:"
+          say "  RailsAuditLog::Graphql.max_complexity = 500"
           say ""
           say "See the README for full documentation."
         end

data/lib/rails_audit_log/graphql/queries/audit_log_entries_query_mixin.rb

@@ -29,6 +29,7 @@ module RailsAuditLog
             argument :item_type, String, required: false, description: "Filter by audited model class name."
             argument :item_id, GraphQL::Types::ID, required: false, description: "Filter by audited record ID."
             argument :actor_id, GraphQL::Types::ID, required: false, description: "Filter by actor ID."
+            argument :actor_type, String, required: false, description: "Filter by actor model class name (e.g. \"User\")."
             argument :since, GraphQL::Types::ISO8601DateTime, required: false, description: "Return entries created at or after this time."
             argument :until, GraphQL::Types::ISO8601DateTime, required: false, as: :until_time, description: "Return entries created at or before this time."
             argument :touching, String, required: false, description: "Filter to entries that changed a specific attribute (matches object_changes keys)."
@@ -50,6 +51,7 @@ module RailsAuditLog
             argument :item_type, String, required: false, description: "Filter by audited model class name."
             argument :item_id, GraphQL::Types::ID, required: false, description: "Filter by audited record ID."
             argument :actor_id, GraphQL::Types::ID, required: false, description: "Filter by actor ID."
+            argument :actor_type, String, required: false, description: "Filter by actor model class name (e.g. \"User\")."
             argument :since, GraphQL::Types::ISO8601DateTime, required: false, description: "Return entries created at or after this time."
             argument :until, GraphQL::Types::ISO8601DateTime, required: false, as: :until_time, description: "Return entries created at or before this time."
             argument :touching, String, required: false, description: "Filter to entries that changed a specific attribute (matches object_changes keys)."
@@ -60,7 +62,7 @@ module RailsAuditLog
 
           base.field(
             :audit_log_reify,
-            GraphQL::Types::JSON,
+            Types::AuditLogJsonScalar,
             null: true,
             description: "Reconstruct the attribute state of a record at a given point in time. Returns nil when no entry exists at or before `at`, or when the record was destroyed.",
             resolver_method: :resolve_audit_log_reify
@@ -68,6 +70,8 @@ module RailsAuditLog
             argument :item_type, String, required: true, description: "The audited model class name."
             argument :item_id, GraphQL::Types::ID, required: true, description: "The audited record ID."
             argument :at, GraphQL::Types::ISO8601DateTime, required: true, description: "Reconstruct state as of this time."
+            argument :for_tenant, String, required: false,
+              description: "Scope to a specific tenant ID. Overrides auto-tenant when RailsAuditLog.current_tenant is configured."
           end
 
           base.field(
@@ -79,7 +83,10 @@ module RailsAuditLog
           ) do
             argument :event, String, required: false, description: "Filter by event type (create, update, destroy)."
             argument :item_type, String, required: false, description: "Filter by audited model class name."
+            argument :actor_type, String, required: false, description: "Filter by actor model class name (e.g. \"User\")."
             argument :since, GraphQL::Types::ISO8601DateTime, required: false, description: "Count entries created at or after this time."
+            argument :for_tenant, String, required: false,
+              description: "Scope to a specific tenant ID. Overrides auto-tenant when RailsAuditLog.current_tenant is configured."
           end
         end
 
@@ -90,43 +97,45 @@ module RailsAuditLog
           base.find_by(id: id)
         end
 
-        def resolve_audit_log_entries(event: nil, item_type: nil, item_id: nil, actor_id: nil, since: nil, until_time: nil, touching: nil, order_by: nil, for_tenant: nil, page: 1, per_page: 25)
+        def resolve_audit_log_entries(event: nil, item_type: nil, item_id: nil, actor_id: nil, actor_type: nil, since: nil, until_time: nil, touching: nil, order_by: nil, for_tenant: nil, page: 1, per_page: 25)
           check_authentication!
-          scope = build_scope(event: event, item_type: item_type, item_id: item_id, actor_id: actor_id, since: since, until_time: until_time, touching: touching, order_by: order_by, for_tenant: for_tenant)
+          scope = build_scope(event: event, item_type: item_type, item_id: item_id, actor_id: actor_id, actor_type: actor_type, since: since, until_time: until_time, touching: touching, order_by: order_by, for_tenant: for_tenant)
           scope.limit(per_page).offset((page - 1) * per_page)
         end
 
-        def resolve_audit_log_entries_connection(event: nil, item_type: nil, item_id: nil, actor_id: nil, since: nil, until_time: nil, touching: nil, order_by: nil, for_tenant: nil)
+        def resolve_audit_log_entries_connection(event: nil, item_type: nil, item_id: nil, actor_id: nil, actor_type: nil, since: nil, until_time: nil, touching: nil, order_by: nil, for_tenant: nil)
           check_authentication!
-          build_scope(event: event, item_type: item_type, item_id: item_id, actor_id: actor_id, since: since, until_time: until_time, touching: touching, order_by: order_by, for_tenant: for_tenant)
+          build_scope(event: event, item_type: item_type, item_id: item_id, actor_id: actor_id, actor_type: actor_type, since: since, until_time: until_time, touching: touching, order_by: order_by, for_tenant: for_tenant)
         end
 
-        def resolve_audit_log_reify(item_type:, item_id:, at:)
+        def resolve_audit_log_reify(item_type:, item_id:, at:, for_tenant: nil)
           check_authentication!
-          entry = RailsAuditLog::AuditLogEntry
+          tenant_id = for_tenant || RailsAuditLog.current_tenant&.call
+          scope = RailsAuditLog::AuditLogEntry
             .where(item_type: item_type, item_id: item_id)
             .where("created_at <= ?", at)
-            .order(created_at: :desc, id: :desc)
-            .first
+          scope = scope.for_tenant(tenant_id) if tenant_id
+          entry = scope.order(created_at: :desc, id: :desc).first
           return nil if entry.nil? || entry.event == "destroy"
           to_attrs = (entry.object_changes || {}).transform_values { |v| v[1] }
           entry.object.present? ? entry.object.merge(to_attrs) : to_attrs
         end
 
-        def resolve_audit_log_entries_count(event: nil, item_type: nil, since: nil)
+        def resolve_audit_log_entries_count(event: nil, item_type: nil, actor_type: nil, since: nil, for_tenant: nil)
           check_authentication!
           scope = RailsAuditLog::AuditLogEntry.all
           scope = scope.where(event: event) if event
           scope = scope.where(item_type: item_type) if item_type
+          scope = scope.where(actor_type: actor_type) if actor_type
           scope = scope.where("created_at >= ?", since) if since
-          tenant_id = RailsAuditLog.current_tenant&.call
+          tenant_id = for_tenant || RailsAuditLog.current_tenant&.call
           scope = scope.for_tenant(tenant_id) if tenant_id
           scope.count
         end
 
         private
 
-        def build_scope(event: nil, item_type: nil, item_id: nil, actor_id: nil, since: nil, until_time: nil, touching: nil, order_by: nil, for_tenant: nil)
+        def build_scope(event: nil, item_type: nil, item_id: nil, actor_id: nil, actor_type: nil, since: nil, until_time: nil, touching: nil, order_by: nil, for_tenant: nil)
           sort_field = order_by&.field || :created_at
           sort_direction = order_by&.direction || :desc
           scope = RailsAuditLog::AuditLogEntry.order(sort_field => sort_direction)
@@ -134,6 +143,7 @@ module RailsAuditLog
           scope = scope.where(item_type: item_type) if item_type
           scope = scope.where(item_id: item_id) if item_id
           scope = scope.where(actor_id: actor_id) if actor_id
+          scope = scope.where(actor_type: actor_type) if actor_type
           scope = scope.where("created_at >= ?", since) if since
           scope = scope.where("created_at <= ?", until_time) if until_time
           if touching

data/lib/rails_audit_log/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module RailsAuditLog
   module Graphql
-    VERSION = "0.6.0"
+    VERSION = "0.6.1"
   end
 end

data/sig/rails_audit_log/graphql.rbs

@@ -112,6 +112,7 @@ module RailsAuditLog
           ?item_type: String?,
           ?item_id: String?,
           ?actor_id: String?,
+          ?actor_type: String?,
           ?since: Time?,
           ?until_time: Time?,
           ?touching: String?,
@@ -126,6 +127,7 @@ module RailsAuditLog
           ?item_type: String?,
           ?item_id: String?,
           ?actor_id: String?,
+          ?actor_type: String?,
           ?since: Time?,
           ?until_time: Time?,
           ?touching: String?,
@@ -136,13 +138,16 @@ module RailsAuditLog
         def resolve_audit_log_reify: (
           item_type: String,
           item_id: String,
-          at: Time
+          at: Time,
+          ?for_tenant: String?
         ) -> Hash[String, untyped]?
 
         def resolve_audit_log_entries_count: (
           ?event: String?,
           ?item_type: String?,
-          ?since: Time?
+          ?actor_type: String?,
+          ?since: Time?,
+          ?for_tenant: String?
         ) -> Integer
 
         private
@@ -152,6 +157,7 @@ module RailsAuditLog
           ?item_type: String?,
           ?item_id: String?,
           ?actor_id: String?,
+          ?actor_type: String?,
           ?since: Time?,
           ?until_time: Time?,
           ?touching: String?,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log-graphql
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Chuck Smith