rails_audit_log-graphql 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8365cc8fe6ee9823f9cc1ec386fe119675e60fb70214e4fd91e3133c4b1c208
-  data.tar.gz: 89251a109b0d83c5150fd3b93253a8152421c9eb5bb2ef6ddc2be7304761e451
+  metadata.gz: fd228bcaff874e10bbd50927cb3bc44d22b5c860acf8dd444624eff80c7dea96
+  data.tar.gz: 29ebf0ccd63fd0827689d3cf0b5e5bd3b4c6194c12468aa347c0fadb1fe0c5f3
 SHA512:
-  metadata.gz: dc978f7e8627a1f0449ee93e0abe737eb1e4a5b348d66295fb9630a5714553ea2b4d594a69e55fc682724fbc689493592ad656b217cb17f5150614746416224c
-  data.tar.gz: b93fdc0c1577144640b5475c7af57407827ffe015d3579aa2d4fd2c1d3b58ccd5b31c891b66790a9c75e745eb4b5c674172d79c0fdd9c3a2dc8a26caa3b00356
+  metadata.gz: 81930d3cedc11053354b5b86349d5483b326f43d774ebea49f97bc61e827c1ede95fa61c1b2671c611df266a9f7b4f4e497d472d47d86fc01b9e6863dd2b8df2
+  data.tar.gz: 158775764845a120940581a0e6c47be8ca3ba992c5195b4bb899c970d069f27dc94faf53c4dde7ee1e4752992d8de62adec09f3f20a68e8209499239e9589887

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.4.0] - 2026-06-04
+
+### Added
+
+- `AuditLogEntryCreated` subscription — `auditLogEntryCreated(itemType:, itemId:)` subscribes to new entries for a specific record; `auditLogEntryCreated(actorId:)` subscribes to all entries by a specific actor
+- `AuditLogSubscriptionsMixin` — include into host app's `SubscriptionType` to add the `auditLogEntryCreated` subscription field
+- `BaseSubscription` base class for all gem GraphQL subscription types
+- `Broadcaster` — call `Broadcaster.new(schema: MySchema).start` in an initializer to relay `rails_audit_log.entry_created` `ActiveSupport::Notifications` events into GraphQL subscription triggers; supports `stop` to unsubscribe
+
 ## [0.3.0] - 2026-06-03
 
 ### Added

data/README.md

@@ -21,6 +21,10 @@ A [graphql-ruby](https://graphql-ruby.org) API layer for the [`rails_audit_log`]
     - [auditLogEntries](#auditlogentries-auditlogentry)
     - [auditLogEntriesConnection](#auditlogentriesconnection-auditlogentryconnection)
   - [Authentication](#authentication)
+  - [Subscriptions](#subscriptions)
+    - [AuditLogSubscriptionsMixin](#auditlogsubscriptionsmixin)
+    - [auditLogEntryCreated](#auditlogentrycreated)
+    - [Broadcaster](#broadcaster)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -217,6 +221,84 @@ If no authenticate block is set, all queries are permitted.
 
 [↑ Back to top](#table-of-contents)
 
+### Subscriptions
+
+Requires Action Cable in the host application.
+
+#### AuditLogSubscriptionsMixin
+
+Include `RailsAuditLog::Graphql::Subscriptions::AuditLogSubscriptionsMixin` into your app's `SubscriptionType` to add the `auditLogEntryCreated` field. Your schema must also use `GraphQL::Subscriptions::ActionCableSubscriptions`.
+
+```ruby
+# app/graphql/types/subscription_type.rb
+class Types::SubscriptionType < Types::BaseObject
+  include RailsAuditLog::Graphql::Subscriptions::AuditLogSubscriptionsMixin
+end
+
+# app/graphql/my_schema.rb
+class MySchema < GraphQL::Schema
+  query Types::QueryType
+  subscription Types::SubscriptionType
+  use GraphQL::Subscriptions::ActionCableSubscriptions
+end
+```
+
+#### `auditLogEntryCreated`
+
+Fires when a new `RailsAuditLog::AuditLogEntry` is created. Accepts one of two argument combinations:
+
+| Argument | Type | Description |
+|---|---|---|
+| `itemType` | `String` | Model class name to scope the subscription to |
+| `itemId` | `ID` | Record ID to scope the subscription to |
+| `actorId` | `ID` | Actor ID — subscribe to all entries by a specific actor |
+
+Subscribe to all changes on a specific record:
+
+```graphql
+subscription {
+  auditLogEntryCreated(itemType: "Post", itemId: "42") {
+    id
+    event
+    diff { attribute from to }
+  }
+}
+```
+
+Subscribe to all entries by a specific actor:
+
+```graphql
+subscription {
+  auditLogEntryCreated(actorId: "7") {
+    id
+    event
+    itemType
+    itemId
+  }
+}
+```
+
+#### Broadcaster
+
+`RailsAuditLog::Graphql::Subscriptions::Broadcaster` bridges `ActiveSupport::Notifications` (fired by `RailsAuditLog::Streaming::NotificationsAdapter` or `ActiveJobAdapter`) to GraphQL subscription triggers. Start it in an initializer:
+
+```ruby
+# config/initializers/rails_audit_log_graphql.rb
+RailsAuditLog.configure do |c|
+  c.streaming_adapter = RailsAuditLog::Streaming::NotificationsAdapter.new
+end
+
+Rails.application.config.after_initialize do
+  RailsAuditLog::Graphql::Subscriptions::Broadcaster.new(schema: MySchema).start
+end
+```
+
+For each entry, the broadcaster triggers:
+- `auditLogEntryCreated(itemType:, itemId:)` — notifies record-specific subscribers
+- `auditLogEntryCreated(actorId:)` — notifies actor-specific subscribers (when an actor is present)
+
+[↑ Back to top](#table-of-contents)
+
 ## Development
 
 ```bash

data/ROADMAP.md

@@ -4,16 +4,6 @@ This gem adds a GraphQL API layer on top of [`rails_audit_log`](https://github.c
 
 ---
 
-## 0.4.0 — Subscriptions
-
-Requires Action Cable in the host application.
-
-- **`auditLogEntryCreated(itemType:, itemId:)`** — subscribe to new entries for a specific record
-- **`auditLogEntryCreated(actorId:)`** — subscribe to all entries by a specific actor
-- Hooks into `RailsAuditLog::Streaming::NotificationsAdapter` to trigger broadcasts
-
----
-
 ## 0.5.0 — Multi-tenancy & Advanced Filtering
 
 - **Tenant scoping** — automatically scope queries via `RailsAuditLog.current_tenant` when configured

data/lib/rails_audit_log/graphql/subscriptions/audit_log_entry_created.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Subscriptions
+      class AuditLogEntryCreated < Types::BaseSubscription
+        description "Fires when a new audit log entry is created."
+
+        argument :item_type, String, required: false,
+          description: "Filter to entries for a specific model class name."
+        argument :item_id, GraphQL::Types::ID, required: false,
+          description: "Filter to entries for a specific record ID."
+        argument :actor_id, GraphQL::Types::ID, required: false,
+          description: "Filter to entries by a specific actor ID."
+
+        type Types::AuditLogEntryType, null: false
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/subscriptions/audit_log_subscriptions_mixin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Subscriptions
+      module AuditLogSubscriptionsMixin
+        def self.included(base)
+          base.field(
+            :audit_log_entry_created,
+            subscription: AuditLogEntryCreated,
+            description: "Fires when a new audit log entry is created."
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/subscriptions/broadcaster.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Subscriptions
+      class Broadcaster
+        EVENT = "rails_audit_log.entry_created"
+
+        def initialize(schema:)
+          @schema = schema
+          @subscriber = nil
+        end
+
+        def start
+          @subscriber = ActiveSupport::Notifications.subscribe(EVENT) do |*, payload|
+            broadcast(payload[:entry])
+          end
+        end
+
+        def stop
+          ActiveSupport::Notifications.unsubscribe(@subscriber) if @subscriber
+          @subscriber = nil
+        end
+
+        def broadcast(entry)
+          @schema.subscriptions.trigger(
+            "audit_log_entry_created",
+            {item_type: entry.item_type, item_id: entry.item_id.to_s},
+            entry
+          )
+
+          return unless entry.actor_id.present?
+
+          @schema.subscriptions.trigger(
+            "audit_log_entry_created",
+            {actor_id: entry.actor_id.to_s},
+            entry
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/types/base_subscription.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RailsAuditLog
+  module Graphql
+    module Types
+      class BaseSubscription < GraphQL::Schema::Subscription
+      end
+    end
+  end
+end

data/lib/rails_audit_log/graphql/version.rb

@@ -2,6 +2,6 @@
 
 module RailsAuditLog
   module Graphql
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/rails_audit_log/graphql.rb

@@ -3,6 +3,7 @@
 require "graphql"
 require_relative "graphql/version"
 require_relative "graphql/types/base_object"
+require_relative "graphql/types/base_subscription"
 require_relative "graphql/types/diff_type"
 require_relative "graphql/types/actor_type"
 require_relative "graphql/types/audited_resource_type"
@@ -11,6 +12,9 @@ require_relative "graphql/types/sort_direction_enum"
 require_relative "graphql/types/audit_log_entry_sort_field_enum"
 require_relative "graphql/input_objects/audit_log_entry_sort_input"
 require_relative "graphql/queries/audit_log_entries_query_mixin"
+require_relative "graphql/subscriptions/audit_log_entry_created"
+require_relative "graphql/subscriptions/audit_log_subscriptions_mixin"
+require_relative "graphql/subscriptions/broadcaster"
 
 module RailsAuditLog
   module Graphql

data/sig/rails_audit_log/graphql.rbs

@@ -6,6 +6,9 @@ module RailsAuditLog
       class BaseObject < GraphQL::Schema::Object
       end
 
+      class BaseSubscription < GraphQL::Schema::Subscription
+      end
+
       class DiffType < BaseObject
         def attribute: () -> String
         def from: () -> untyped
@@ -51,6 +54,24 @@ module RailsAuditLog
       end
     end
 
+    module Subscriptions
+      class AuditLogEntryCreated < Types::BaseSubscription
+        def subscribe: (?item_type: String?, ?item_id: String?, ?actor_id: String?) -> :no_response
+        def update: (?item_type: String?, ?item_id: String?, ?actor_id: String?) -> untyped
+      end
+
+      module AuditLogSubscriptionsMixin
+        def self.included: (untyped base) -> void
+      end
+
+      class Broadcaster
+        def initialize: (schema: untyped) -> void
+        def start: () -> void
+        def stop: () -> void
+        def broadcast: (untyped entry) -> void
+      end
+    end
+
     module Queries
       module AuditLogEntriesQueryMixin
         def self.included: (untyped base) -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log-graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -86,11 +86,15 @@ files:
 - lib/rails_audit_log/graphql/input_objects/audit_log_entry_sort_input.rb
 - lib/rails_audit_log/graphql/queries/audit_log_entries_query_mixin.rb
 - lib/rails_audit_log/graphql/release_tooling.rb
+- lib/rails_audit_log/graphql/subscriptions/audit_log_entry_created.rb
+- lib/rails_audit_log/graphql/subscriptions/audit_log_subscriptions_mixin.rb
+- lib/rails_audit_log/graphql/subscriptions/broadcaster.rb
 - lib/rails_audit_log/graphql/types/actor_type.rb
 - lib/rails_audit_log/graphql/types/audit_log_entry_sort_field_enum.rb
 - lib/rails_audit_log/graphql/types/audit_log_entry_type.rb
 - lib/rails_audit_log/graphql/types/audited_resource_type.rb
 - lib/rails_audit_log/graphql/types/base_object.rb
+- lib/rails_audit_log/graphql/types/base_subscription.rb
 - lib/rails_audit_log/graphql/types/diff_type.rb
 - lib/rails_audit_log/graphql/types/sort_direction_enum.rb
 - lib/rails_audit_log/graphql/version.rb