Add websocket/longpoll macro

Author: LostKobrakai

lib/phoenix/socket/router.ex

@@ -12,13 +12,7 @@ defmodule Phoenix.Socket.Router do
         path = Path.join(path, end_segment)
 
         quote do
-          match :*,
-                unquote(path),
-                Phoenix.Transports.WebSocket,
-                [
-                  {:user_socket, unquote(user_socket)}
-                  | unquote(websocket)
-                ]
+          websocket unquote(path), unquote(user_socket), unquote(websocket)
         end
       else
         []
@@ -31,13 +25,7 @@ defmodule Phoenix.Socket.Router do
         path = Path.join(path, end_segment)
 
         quote do
-          match :*,
-                unquote(path),
-                Phoenix.Transports.LongPoll,
-                [
-                  {:user_socket, unquote(user_socket)}
-                  | unquote(longpoll)
-                ]
+          longpoll unquote(path), unquote(user_socket), unquote(longpoll)
         end
       else
         []
@@ -49,6 +37,30 @@ defmodule Phoenix.Socket.Router do
     end
   end
 
+  defmacro websocket(path, user_socket, opts \\ []) do
+    quote do
+      match :*,
+            unquote(path),
+            Phoenix.Transports.WebSocket,
+            [
+              {:user_socket, unquote(user_socket)}
+              | unquote(opts)
+            ]
+    end
+  end
+
+  defmacro longpoll(path, user_socket, opts \\ []) do
+    quote do
+      match :*,
+            unquote(path),
+            Phoenix.Transports.LongPoll,
+            [
+              {:user_socket, unquote(user_socket)}
+              | unquote(opts)
+            ]
+    end
+  end
+
   defp put_auth_token(true, enabled), do: [auth_token: enabled]
   defp put_auth_token(opts, enabled), do: Keyword.put(opts, :auth_token, enabled)
 end

test/phoenix/integration/websocket_channels_test.exs

@@ -181,12 +181,20 @@ defmodule Phoenix.Integration.WebSocketChannelsTest do
     get "/", SetSession, []
 
     scope "/ws" do
-      socket "/", UserSocket,
-        websocket: [
+      # socket "/", UserSocket,
+      #   websocket: [
+      #     check_origin: ["//example.com"],
+      #     timeout: 200,
+      #     error_handler: {UserSocket, :handle_error, []}
+      #   ]
+      scope "/" do
+        websocket "/websocket", UserSocket,
           check_origin: ["//example.com"],
           timeout: 200,
           error_handler: {UserSocket, :handle_error, []}
-        ]
+
+        longpoll "/longpoll", UserSocket
+      end
 
       socket "/admin", UserSocket,
         websocket: [

test/phoenix/integration/websocket_socket_test.exs

@@ -90,19 +90,14 @@ defmodule Phoenix.Integration.WebSocketTest do
     use Phoenix.Router
     import Phoenix.Socket.Router
 
-    # extract stuff from Phoenix.Transports.WebSocket, which
-    # can now simply be part of the endpoint (Plug.Session, …)
-
-    # Manual route definition API
-    # scope "/ws" do
-    #   match :*, "/websocket", Phoenix.Transports.WebSocket,
-    #     user_socket: UserSocket, check_origin: ["//example.com"], subprotocols: ["sip"], timeout: 200
-    #
-    #   match :*, "/longpoll", Phoenix.Transports.LongPoll, user_socket: UserSocket
-    # end
-
-    socket "/ws", UserSocket,
-      websocket: [check_origin: ["//example.com"], subprotocols: ["sip"], timeout: 200]
+    # socket "/ws", UserSocket,
+    #       websocket: [check_origin: ["//example.com"], subprotocols: ["sip"], timeout: 200]
+    scope "/ws" do
+      websocket "/websocket", UserSocket,
+        check_origin: ["//example.com"], subprotocols: ["sip"], timeout: 200
+
+      longpoll "/longpoll", UserSocket
+    end
 
     socket "/custom/some_path", UserSocket,
       websocket: [path: "nested/path", check_origin: ["//example.com"], timeout: 200]