improvement: Add support for relay_id_translation on GraphQL subscriptions (#349)

Author: mike1o1

documentation/dsls/DSL-AshGraphql.Domain.md

@@ -538,6 +538,7 @@ end
 | [`action_types`](#graphql-subscriptions-subscribe-action_types){: #graphql-subscriptions-subscribe-action_types } | `list(atom) \| atom` |  | The type of actions the subsciption should listen to. |
 | [`read_action`](#graphql-subscriptions-subscribe-read_action){: #graphql-subscriptions-subscribe-read_action } | `atom` |  | The read action to use for reading data |
 | [`hide_inputs`](#graphql-subscriptions-subscribe-hide_inputs){: #graphql-subscriptions-subscribe-hide_inputs } | `list(atom)` | `[]` | A list of inputs to hide from the subscription, usable if the read action has arguments. |
+| [`relay_id_translations`](#graphql-subscriptions-subscribe-relay_id_translations){: #graphql-subscriptions-subscribe-relay_id_translations } | `keyword` | `[]` | A keyword list indicating arguments or attributes that have to be translated from global Relay IDs to internal IDs. See the [Relay guide](/documentation/topics/relay.md#translating-relay-global-ids-passed-as-arguments) for more. |
 | [`meta`](#graphql-subscriptions-subscribe-meta){: #graphql-subscriptions-subscribe-meta } | `keyword` |  | A keyword list of metadata to include in the subscription. |
 
 

documentation/dsls/DSL-AshGraphql.Resource.md

@@ -558,6 +558,7 @@ end
 | [`action_types`](#graphql-subscriptions-subscribe-action_types){: #graphql-subscriptions-subscribe-action_types } | `list(atom) \| atom` |  | The type of actions the subsciption should listen to. |
 | [`read_action`](#graphql-subscriptions-subscribe-read_action){: #graphql-subscriptions-subscribe-read_action } | `atom` |  | The read action to use for reading data |
 | [`hide_inputs`](#graphql-subscriptions-subscribe-hide_inputs){: #graphql-subscriptions-subscribe-hide_inputs } | `list(atom)` | `[]` | A list of inputs to hide from the subscription, usable if the read action has arguments. |
+| [`relay_id_translations`](#graphql-subscriptions-subscribe-relay_id_translations){: #graphql-subscriptions-subscribe-relay_id_translations } | `keyword` | `[]` | A keyword list indicating arguments or attributes that have to be translated from global Relay IDs to internal IDs. See the [Relay guide](/documentation/topics/relay.md#translating-relay-global-ids-passed-as-arguments) for more. |
 | [`meta`](#graphql-subscriptions-subscribe-meta){: #graphql-subscriptions-subscribe-meta } | `keyword` |  | A keyword list of metadata to include in the subscription. |
 
 

lib/resource/resource.ex

@@ -1306,6 +1306,7 @@ defmodule AshGraphql.Resource do
           action_middleware ++
             domain_middleware(domain) ++
             metadata_middleware(subscription.meta) ++
+            id_translation_middleware(subscription.relay_id_translations, relay_ids?) ++
             [
               {{AshGraphql.Graphql.Resolver, :resolve},
                {domain, resource, subscription, relay_ids?}}

lib/resource/subscription.ex

@@ -8,6 +8,7 @@ defmodule AshGraphql.Resource.Subscription do
     :read_action,
     :actor,
     :hide_inputs,
+    :relay_id_translations,
     :meta
   ]
 
@@ -40,6 +41,13 @@ defmodule AshGraphql.Resource.Subscription do
         "A list of inputs to hide from the subscription, usable if the read action has arguments.",
       default: []
     ],
+    relay_id_translations: [
+      type: :keyword_list,
+      doc: """
+      A keyword list indicating arguments or attributes that have to be translated from global Relay IDs to internal IDs. See the [Relay guide](/documentation/topics/relay.md#translating-relay-global-ids-passed-as-arguments) for more.
+      """,
+      default: []
+    ],
     meta: [
       type: :keyword_list,
       doc: "A keyword list of metadata to include in the subscription."

test/subscription_test.exs

@@ -400,6 +400,61 @@ defmodule AshGraphql.SubscriptionTest do
              subscription_data["subscribableEventsWithArguments"]["created"]["id"]
   end
 
+  test "can subscribe to read actions that take arguments with relay style id's" do
+    subscribable =
+      RelaySubscribable
+      |> Ash.Changeset.for_create(:create, %{text: "foo", topic: "news", actor_id: 1},
+        actor: @admin
+      )
+      |> Ash.create!()
+
+    relay_id = AshGraphql.Resource.encode_relay_id(subscribable)
+
+    subscription = """
+    subscription WithIdFilter($subscribableId: ID!) {
+      subscribableEventsRelayWithIdFilter(subscribableId: $subscribableId) {
+        updated {
+          id
+          text
+        }
+      }
+    }
+    """
+
+    assert {:ok, %{"subscribed" => topic}} =
+             Absinthe.run(
+               subscription,
+               RelaySchema,
+               variables: %{"subscribableId" => relay_id},
+               context: %{actor: @admin, pubsub: PubSub}
+             )
+
+    update_mutation = """
+    mutation UpdateSubscribable($id: ID! $input: UpdateRelaySubscribableInput) {
+        updateRelaySubscribable(id: $id, input: $input) {
+          result{
+            id
+            text
+          }
+          errors{
+            message
+          }
+        }
+      }
+    """
+
+    assert {:ok, %{data: _mutation_result}} =
+             Absinthe.run(update_mutation, RelaySchema,
+               variables: %{"id" => relay_id, "input" => %{"text" => "updated"}},
+               context: %{actor: @admin}
+             )
+
+    assert_receive({^topic, %{data: subscription_data}})
+
+    assert relay_id ==
+             subscription_data["subscribableEventsRelayWithIdFilter"]["updated"]["id"]
+  end
+
   test "can subscribe on the domain" do
     actor1 = %{
       id: 1,

test/support/resources/relay_subscribable.ex

@@ -12,6 +12,7 @@ defmodule AshGraphql.Test.RelaySubscribable do
     type :relay_subscribable
 
     mutations do
+      update :update_relay_subscribable, :update
       destroy :destroy_subscribable_relay, :destroy
     end
 
@@ -25,6 +26,17 @@ defmodule AshGraphql.Test.RelaySubscribable do
       subscribe(:subscribable_deleted_relay) do
         action_types(:destroy)
       end
+
+      subscribe(:subscribable_events_relay_with_arguments) do
+        read_action(:read_with_arg)
+        actions([:create])
+      end
+
+      subscribe(:subscribable_events_relay_with_id_filter) do
+        read_action(:read_with_id_arg)
+        action_types([:create, :update, :destroy])
+        relay_id_translations(subscribable_id: :relay_subscribable)
+      end
     end
   end
 
@@ -37,7 +49,7 @@ defmodule AshGraphql.Test.RelaySubscribable do
       authorize_if(expr(actor_id == ^actor(:id)))
     end
 
-    policy action([:open_read, :read_with_arg]) do
+    policy action([:open_read, :read_with_arg, :read_with_id_arg]) do
       authorize_if(always())
     end
   end
@@ -65,6 +77,14 @@ defmodule AshGraphql.Test.RelaySubscribable do
 
       filter(expr(topic == ^arg(:topic)))
     end
+
+    read :read_with_id_arg do
+      argument(:subscribable_id, :uuid) do
+        allow_nil? false
+      end
+
+      filter(expr(id == ^arg(:subscribable_id)))
+    end
   end
 
   attributes do