feat: subscription installer (#266)

barnabasJ · web-flow · commit c2fd5ec600bb · 2025-02-24T18:24:55.000+01:00
* remove subscription opt in
diff --git a/config/config.exs b/config/config.exs
@@ -7,8 +7,6 @@ config :ash, :validate_domain_config_inclusion?, false
 config :ash, :pub_sub, debug?: true
 config :logger, level: :info
 
-config :ash_graphql, :subscriptions, true
-
 if Mix.env() == :test do
   config :ash_graphql, :simulate_subscription_slowness?, true
 end
diff --git a/lib/igniter.ex b/lib/igniter.ex
@@ -147,8 +147,9 @@ if Code.ensure_loaded?(Igniter) do
     end
 
     @doc "Sets up the phoenix module for AshGraphql"
-    def setup_phoenix(igniter, schema_name \\ nil) do
+    def setup_phoenix(igniter, schema_name \\ nil, socket_name \\ nil) do
       schema_name = schema_name || Igniter.Project.Module.module_name(igniter, "GraphqlSchema")
+      socket_name = socket_name || Igniter.Project.Module.module_name(igniter, "GraphqlSocket")
 
       case Igniter.Libs.Phoenix.select_router(igniter) do
         {igniter, nil} ->
@@ -162,78 +163,176 @@ if Code.ensure_loaded?(Igniter) do
 
         {igniter, router} ->
           igniter
-          |> update_endpoints(router)
-          |> Igniter.Libs.Phoenix.add_pipeline(:graphql, "plug AshGraphql.Plug", router: router)
-          |> Igniter.Libs.Phoenix.add_scope(
-            "/gql",
-            """
-              pipe_through [:graphql]
-
-              forward "/playground",
-                      Absinthe.Plug.GraphiQL,
-                      schema: Module.concat(["#{inspect(schema_name)}"]),
-                      interface: :playground
-
-              forward "/",
-                Absinthe.Plug,
-                schema: Module.concat(["#{inspect(schema_name)}"])
-            """,
-            router: router
-          )
+          |> create_socket(schema_name, socket_name)
+          |> update_router(router, socket_name, schema_name)
+          |> update_application(router)
       end
     end
 
+    defp update_router(igniter, router, socket_name, schema_name) do
+      igniter
+      |> update_endpoints(router, socket_name)
+      |> Igniter.Libs.Phoenix.add_pipeline(:graphql, "plug AshGraphql.Plug", router: router)
+      |> Igniter.Libs.Phoenix.add_scope(
+        "/gql",
+        """
+          pipe_through [:graphql]
+
+          forward "/playground",
+                  Absinthe.Plug.GraphiQL,
+                  schema: Module.concat(["#{inspect(schema_name)}"]),
+                  socket: Module.concat(["#{inspect(socket_name)}"]),
+                  interface: :playground
+
+          forward "/",
+            Absinthe.Plug,
+            schema: Module.concat(["#{inspect(schema_name)}"])
+        """,
+        router: router
+      )
+    end
+
+    defp update_application(igniter, router) do
+      {igniter, endpoints} =
+        Igniter.Libs.Phoenix.endpoints_for_router(igniter, router)
+
+      igniter =
+        Enum.reduce(endpoints, igniter, fn endpoint, igniter ->
+          igniter
+          |> Igniter.Project.Application.add_new_child({Absinthe.Subscription, endpoint},
+            after: endpoint
+          )
+        end)
+
+      igniter
+      |> Igniter.Project.Application.add_new_child(AshGraphql.Subscription.Batcher,
+        after: Absinthe.Subscription
+      )
+    end
+
+    defp create_socket(igniter, schema_name, socket_name) do
+      otp_app = Igniter.Project.Application.app_name(igniter)
+
+      igniter
+      |> Igniter.Project.Module.find_and_update_or_create_module(
+        socket_name,
+        """
+        use Phoenix.Socket
+
+        use Absinthe.Phoenix.Socket,
+          schema: #{inspect(schema_name)}
+
+        @otp_app #{inspect(otp_app)}
+
+        @impl true
+        def connect(_params, socket, _connect_info) do
+          {:ok, socket}
+        end
+
+        @impl true
+        def id(_socket), do: nil
+        """,
+        fn zipper ->
+          # Should never get here
+          {:ok, zipper}
+        end
+      )
+    end
+
     @doc "Returns all modules that `use AshGraphql`"
     def ash_graphql_schemas(igniter) do
       Igniter.Project.Module.find_all_matching_modules(igniter, fn _name, zipper ->
         match?({:ok, _}, Igniter.Code.Module.move_to_use(zipper, AshGraphql))
       end)
     end
 
-    defp update_endpoints(igniter, router) do
+    defp update_endpoints(igniter, router, socket_name) do
       {igniter, endpoints_that_need_parser} =
         Igniter.Libs.Phoenix.endpoints_for_router(igniter, router)
 
+      igniter =
+        Enum.reduce(endpoints_that_need_parser, igniter, fn endpoint, igniter ->
+          Igniter.Project.Module.find_and_update_module!(igniter, endpoint, fn zipper ->
+            case Igniter.Code.Function.move_to_function_call_in_current_scope(
+                   zipper,
+                   :plug,
+                   2,
+                   &Igniter.Code.Function.argument_equals?(&1, 0, Plug.Parsers)
+                 ) do
+              {:ok, zipper} ->
+                with {:ok, zipper} <- Igniter.Code.Function.move_to_nth_argument(zipper, 1),
+                     {:ok, zipper} <- Igniter.Code.Keyword.get_key(zipper, :parsers),
+                     {:ok, zipper} <-
+                       Igniter.Code.List.append_new_to_list(zipper, Absinthe.Plug.Parser) do
+                  {:ok, zipper}
+                else
+                  _ ->
+                    {:warning,
+                     "Could not add `Absinthe.Plug.Parser` to parsers in endpoint #{endpoint}. Please make this change manually."}
+                end
+
+              :error ->
+                case parser_location(zipper) do
+                  {:ok, zipper} ->
+                    {:ok,
+                     Igniter.Code.Common.add_code(zipper, """
+                     plug Plug.Parsers,
+                       parsers: [:urlencoded, :multipart, :json, Absinthe.Plug.Parser],
+                       pass: ["*/*"],
+                       json_decoder: Jason
+                     """)}
+
+                  _ ->
+                    {:warning,
+                     "Could not add `Absinthe.Plug.Parser` to parsers in endpoint #{endpoint}. Please make this change manually."}
+                end
+            end
+          end)
+        end)
+
       Enum.reduce(endpoints_that_need_parser, igniter, fn endpoint, igniter ->
         Igniter.Project.Module.find_and_update_module!(igniter, endpoint, fn zipper ->
           case Igniter.Code.Function.move_to_function_call_in_current_scope(
                  zipper,
-                 :plug,
-                 2,
-                 &Igniter.Code.Function.argument_equals?(&1, 0, Plug.Parsers)
+                 :socket,
+                 3,
+                 &Igniter.Code.Function.argument_equals?(&1, 1, socket_name)
                ) do
             {:ok, zipper} ->
-              with {:ok, zipper} <- Igniter.Code.Function.move_to_nth_argument(zipper, 1),
-                   {:ok, zipper} <- Igniter.Code.Keyword.get_key(zipper, :parsers),
-                   {:ok, zipper} <-
-                     Igniter.Code.List.append_new_to_list(zipper, Absinthe.Plug.Parser) do
-                {:ok, zipper}
-              else
-                _ ->
-                  {:warning,
-                   "Could not add `Absinthe.Plug.Parser` to parsers in endpoint #{endpoint}. Please make this change manually."}
-              end
+              # Already installed
+              {:ok, zipper}
 
             :error ->
-              case parser_location(zipper) do
+              case socket_location(zipper) do
                 {:ok, zipper} ->
                   {:ok,
                    Igniter.Code.Common.add_code(zipper, """
-                   plug Plug.Parsers,
-                     parsers: [:urlencoded, :multipart, :json, Absinthe.Plug.Parser],
-                     pass: ["*/*"],
-                     json_decoder: Jason
+                     socket "/ws/gql", #{inspect(socket_name)},
+                       websocket: true,
+                       longpoll: true
                    """)}
 
                 _ ->
                   {:warning,
-                   "Could not add `Absinthe.Plug.Parser` to parsers in endpoint #{endpoint}. Please make this change manually."}
+                   "Could not add #{socket_name} in endpoint #{endpoint}. Please make this change manually."}
               end
           end
         end)
       end)
     end
 
+    defp socket_location(zipper) do
+      with :error <-
+             Igniter.Code.Function.move_to_function_call_in_current_scope(
+               zipper,
+               :socket,
+               3,
+               &Igniter.Code.Function.argument_equals?(&1, 1, Phoenix.LiveView.Socket)
+             ) do
+        Igniter.Code.Module.move_to_use(zipper, Phoenix.Endpoint)
+      end
+    end
+
     defp parser_location(zipper) do
       with :error <-
              Igniter.Code.Function.move_to_function_call_in_current_scope(
diff --git a/lib/mix/tasks/ash_graphql.install.ex b/lib/mix/tasks/ash_graphql.install.ex
@@ -15,14 +15,15 @@ if Code.ensure_loaded?(Igniter) do
         |> Spark.Igniter.prepend_to_section_order(:"Ash.Domain", [:graphql])
 
       schema_name = Igniter.Libs.Phoenix.web_module_name(igniter, "GraphqlSchema")
+      socket_name = Igniter.Libs.Phoenix.web_module_name(igniter, "GraphqlSocket")
 
       {igniter, candidate_ash_graphql_schemas} =
         AshGraphql.Igniter.ash_graphql_schemas(igniter)
 
       if Enum.empty?(candidate_ash_graphql_schemas) do
         igniter
         |> AshGraphql.Igniter.setup_absinthe_schema(schema_name)
-        |> AshGraphql.Igniter.setup_phoenix(schema_name)
+        |> AshGraphql.Igniter.setup_phoenix(schema_name, socket_name)
       else
         igniter
         |> Igniter.add_warning("AshGraphql schema already exists, skipping installation.")
diff --git a/lib/resource/resource.ex b/lib/resource/resource.ex
@@ -467,8 +467,7 @@ defmodule AshGraphql.Resource do
   @verifiers [
     AshGraphql.Resource.Verifiers.VerifyQueryMetadata,
     AshGraphql.Resource.Verifiers.RequirePkeyDelimiter,
-    AshGraphql.Resource.Verifiers.VerifyPaginateRelationshipWith,
-    AshGraphql.Resource.Verifiers.VerifySubscriptionOptIn
+    AshGraphql.Resource.Verifiers.VerifyPaginateRelationshipWith
   ]
 
   @sections [@graphql]
diff --git a/lib/resource/verifiers/verify_subscription_opt_in.ex b/lib/resource/verifiers/verify_subscription_opt_in.ex
diff --git a/mix.exs b/mix.exs
@@ -155,7 +155,7 @@ defmodule AshGraphql.MixProject do
       {:absinthe, "~> 1.7"},
       {:absinthe_phoenix, "~> 2.0.0", optional: true},
       {:jason, "~> 1.2"},
-      {:igniter, "~> 0.3 and >= 0.3.34", optional: true},
+      {:igniter, "~> 0.5 and >= 0.5.28", optional: true},
       {:spark, "~> 2.2 and >= 2.2.10"},
       {:owl, "~> 0.11"},
       # dev/test dependencies
@@ -168,7 +168,8 @@ defmodule AshGraphql.MixProject do
       {:mix_test_watch, "~> 1.0", only: :dev, runtime: false},
       {:simple_sat, ">= 0.0.0", only: :test},
       {:mix_audit, ">= 0.0.0", only: [:dev, :test], runtime: false},
-      {:benchee, "~> 1.1", only: [:dev, :test]}
+      {:benchee, "~> 1.1", only: [:dev, :test]},
+      {:phx_new, "~> 1.7", only: [:test]}
     ]
   end
 
diff --git a/mix.lock b/mix.lock
@@ -22,7 +22,7 @@
   "git_ops": {:hex, :git_ops, "2.7.0", "fed1400d516d06810ac46a9d4b3e12ca4973683158ddc5931935567075ff1a4c", [:mix], [{:git_cli, "~> 0.2", [hex: :git_cli, repo: "hexpm", optional: false]}, {:igniter, "~> 0.5", [hex: :igniter, repo: "hexpm", optional: true]}, {:nimble_parsec, "~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "29f1ddb3678969cb81dc56177d0c6e5c85a77a7ce50036207b920005cc6b5b26"},
   "glob_ex": {:hex, :glob_ex, "0.1.11", "cb50d3f1ef53f6ca04d6252c7fde09fd7a1cf63387714fe96f340a1349e62c93", [:mix], [], "hexpm", "342729363056e3145e61766b416769984c329e4378f1d558b63e341020525de4"},
   "hpax": {:hex, :hpax, "1.0.2", "762df951b0c399ff67cc57c3995ec3cf46d696e41f0bba17da0518d94acd4aac", [:mix], [], "hexpm", "2f09b4c1074e0abd846747329eaa26d535be0eb3d189fa69d812bfb8bfefd32f"},
-  "igniter": {:hex, :igniter, "0.5.25", "a9e26794efe4b5619edd112b2ce8ffa3931f1e4d558dfebcd344553024e359b5", [:mix], [{:glob_ex, "~> 0.1.7", [hex: :glob_ex, repo: "hexpm", optional: false]}, {:inflex, "~> 2.0", [hex: :inflex, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:phx_new, "~> 1.7", [hex: :phx_new, repo: "hexpm", optional: true]}, {:req, "~> 0.5", [hex: :req, repo: "hexpm", optional: false]}, {:rewrite, ">= 1.1.1 and < 2.0.0-0", [hex: :rewrite, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.4", [hex: :sourceror, repo: "hexpm", optional: false]}, {:spitfire, ">= 0.1.3 and < 1.0.0-0", [hex: :spitfire, repo: "hexpm", optional: false]}], "hexpm", "d944d3ed8439bb2d98391f39b86305d109f4123c947061db54c1c0f9ecad890e"},
+  "igniter": {:hex, :igniter, "0.5.28", "db2cf71ac6f33b0c6893a0fad4fa218f07fa993c3b0e5d7295ff451d7d112312", [:mix], [{:glob_ex, "~> 0.1.7", [hex: :glob_ex, repo: "hexpm", optional: false]}, {:inflex, "~> 2.0", [hex: :inflex, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:phx_new, "~> 1.7", [hex: :phx_new, repo: "hexpm", optional: true]}, {:req, "~> 0.5", [hex: :req, repo: "hexpm", optional: false]}, {:rewrite, ">= 1.1.1 and < 2.0.0-0", [hex: :rewrite, repo: "hexpm", optional: false]}, {:sourceror, "~> 1.4", [hex: :sourceror, repo: "hexpm", optional: false]}, {:spitfire, ">= 0.1.3 and < 1.0.0-0", [hex: :spitfire, repo: "hexpm", optional: false]}], "hexpm", "44cf39a35defd5678f751d69bae68280dc7327243e14d00c365267d993d0b9c7"},
   "inflex": {:hex, :inflex, "2.1.0", "a365cf0821a9dacb65067abd95008ca1b0bb7dcdd85ae59965deef2aa062924c", [:mix], [], "hexpm", "14c17d05db4ee9b6d319b0bff1bdf22aa389a25398d1952c7a0b5f3d93162dd8"},
   "iterex": {:hex, :iterex, "0.1.2", "58f9b9b9a22a55cbfc7b5234a9c9c63eaac26d276b3db80936c0e1c60355a5a6", [:mix], [], "hexpm", "2e103b8bcc81757a9af121f6dc0df312c9a17220f302b1193ef720460d03029d"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
@@ -41,6 +41,7 @@
   "phoenix": {:hex, :phoenix, "1.7.14", "a7d0b3f1bc95987044ddada111e77bd7f75646a08518942c72a8440278ae7825", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 2.1", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:phoenix_template, "~> 1.0", [hex: :phoenix_template, repo: "hexpm", optional: false]}, {:phoenix_view, "~> 2.0", [hex: :phoenix_view, repo: "hexpm", optional: true]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 2.7", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:plug_crypto, "~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:websock_adapter, "~> 0.5.3", [hex: :websock_adapter, repo: "hexpm", optional: false]}], "hexpm", "c7859bc56cc5dfef19ecfc240775dae358cbaa530231118a9e014df392ace61a"},
   "phoenix_pubsub": {:hex, :phoenix_pubsub, "2.1.3", "3168d78ba41835aecad272d5e8cd51aa87a7ac9eb836eabc42f6e57538e3731d", [:mix], [], "hexpm", "bba06bc1dcfd8cb086759f0edc94a8ba2bc8896d5331a1e2c2902bf8e36ee502"},
   "phoenix_template": {:hex, :phoenix_template, "1.0.4", "e2092c132f3b5e5b2d49c96695342eb36d0ed514c5b252a77048d5969330d639", [:mix], [{:phoenix_html, "~> 2.14.2 or ~> 3.0 or ~> 4.0", [hex: :phoenix_html, repo: "hexpm", optional: true]}], "hexpm", "2c0c81f0e5c6753faf5cca2f229c9709919aba34fab866d3bc05060c9c444206"},
+  "phx_new": {:hex, :phx_new, "1.7.20", "ba8eab3438a6c3524298cdfb44f9cee59af0935fffa4b40cbd07fe739f9ac93f", [:mix], [], "hexpm", "006bc4d57a9e1606fdf0776543f70e23cbd8b64b706b95d280b4d420f22d1d43"},
   "plug": {:hex, :plug, "1.16.1", "40c74619c12f82736d2214557dedec2e9762029b2438d6d175c5074c933edc9d", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "a13ff6b9006b03d7e33874945b2755253841b238c34071ed85b0e86057f8cddc"},
   "plug_crypto": {:hex, :plug_crypto, "2.1.0", "f44309c2b06d249c27c8d3f65cfe08158ade08418cf540fd4f72d4d6863abb7b", [:mix], [], "hexpm", "131216a4b030b8f8ce0f26038bc4421ae60e4bb95c5cf5395e1421437824c4fa"},
   "reactor": {:hex, :reactor, "0.13.3", "8d49362564970c3331ba306213bc2416c682a04bfab0f710ac3c740060bbdc71", [:mix], [{:igniter, "~> 0.4", [hex: :igniter, repo: "hexpm", optional: true]}, {:iterex, "~> 0.1", [hex: :iterex, repo: "hexpm", optional: false]}, {:libgraph, "~> 0.16", [hex: :libgraph, repo: "hexpm", optional: false]}, {:spark, "~> 2.0", [hex: :spark, repo: "hexpm", optional: false]}, {:splode, "~> 0.2", [hex: :splode, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.2", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "b8227ed82a2aabaedc24a09e347002bb14c58701989d7383c51e941e03085180"},
diff --git a/test/mix/tasks/ash_graphql_install_test.exs b/test/mix/tasks/ash_graphql_install_test.exs

Original file line number	Diff line number	Diff line change
`@@ -467,8 +467,7 @@ defmodule AshGraphql.Resource do`
`467`	`467`	`@verifiers [`
`468`	`468`	`AshGraphql.Resource.Verifiers.VerifyQueryMetadata,`
`469`	`469`	`AshGraphql.Resource.Verifiers.RequirePkeyDelimiter,`
`470`		`- AshGraphql.Resource.Verifiers.VerifyPaginateRelationshipWith,`
`471`		`- AshGraphql.Resource.Verifiers.VerifySubscriptionOptIn`
	`470`	`+ AshGraphql.Resource.Verifiers.VerifyPaginateRelationshipWith`
`472`	`471`	`]`
`473`	`472`
`474`	`473`	`@sections [@graphql]`