2018-12-23 20:11:29 +00:00
|
|
|
# Pleroma: A lightweight social networking server
|
2023-01-02 20:38:50 +00:00
|
|
|
# Copyright © 2017-2022 Pleroma Authors <https://pleroma.social/>
|
2018-12-23 20:11:29 +00:00
|
|
|
# SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
|
2018-12-17 16:09:06 +00:00
|
|
|
defmodule Pleroma.Integration.MastodonWebsocketTest do
|
2020-12-21 11:21:40 +00:00
|
|
|
# Needs a streamer, needs to stay synchronous
|
2018-12-17 16:09:06 +00:00
|
|
|
use Pleroma.DataCase
|
|
|
|
|
2019-09-13 15:46:41 +00:00
|
|
|
import ExUnit.CaptureLog
|
2018-12-17 16:09:06 +00:00
|
|
|
import Pleroma.Factory
|
|
|
|
|
2019-03-05 02:52:23 +00:00
|
|
|
alias Pleroma.Integration.WebsocketClient
|
2018-12-17 16:09:06 +00:00
|
|
|
alias Pleroma.Web.CommonAPI
|
|
|
|
alias Pleroma.Web.OAuth
|
|
|
|
|
2020-05-07 09:13:32 +00:00
|
|
|
@moduletag needs_streamer: true, capture_log: true
|
|
|
|
|
2018-12-17 16:09:06 +00:00
|
|
|
@path Pleroma.Web.Endpoint.url()
|
|
|
|
|> URI.parse()
|
|
|
|
|> Map.put(:scheme, "ws")
|
|
|
|
|> Map.put(:path, "/api/v1/streaming")
|
|
|
|
|> URI.to_string()
|
|
|
|
|
|
|
|
def start_socket(qs \\ nil, headers \\ []) do
|
|
|
|
path =
|
|
|
|
case qs do
|
|
|
|
nil -> @path
|
|
|
|
qs -> @path <> qs
|
|
|
|
end
|
|
|
|
|
2022-09-02 22:35:40 +00:00
|
|
|
WebsocketClient.start_link(self(), path, headers)
|
2018-12-17 16:09:06 +00:00
|
|
|
end
|
|
|
|
|
2023-04-01 02:55:52 +00:00
|
|
|
defp decode_json(json) do
|
|
|
|
with {:ok, %{"event" => event, "payload" => payload_text}} <- Jason.decode(json),
|
|
|
|
{:ok, payload} <- Jason.decode(payload_text) do
|
|
|
|
{:ok, %{"event" => event, "payload" => payload}}
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-12-17 16:09:06 +00:00
|
|
|
test "refuses invalid requests" do
|
2019-09-13 15:46:41 +00:00
|
|
|
capture_log(fn ->
|
2022-08-19 17:56:39 +00:00
|
|
|
assert {:error, %WebSockex.RequestError{code: 404}} = start_socket("?stream=ncjdk")
|
2019-09-17 14:44:52 +00:00
|
|
|
Process.sleep(30)
|
2019-09-13 15:46:41 +00:00
|
|
|
end)
|
2018-12-17 16:09:06 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
test "requires authentication and a valid token for protected streams" do
|
2019-09-13 15:46:41 +00:00
|
|
|
capture_log(fn ->
|
2022-08-19 17:56:39 +00:00
|
|
|
assert {:error, %WebSockex.RequestError{code: 401}} =
|
|
|
|
start_socket("?stream=user&access_token=aaaaaaaaaaaa")
|
|
|
|
|
|
|
|
assert {:error, %WebSockex.RequestError{code: 401}} = start_socket("?stream=user")
|
2019-09-17 14:44:52 +00:00
|
|
|
Process.sleep(30)
|
2019-09-13 15:46:41 +00:00
|
|
|
end)
|
2018-12-17 16:09:06 +00:00
|
|
|
end
|
|
|
|
|
2023-04-01 01:47:37 +00:00
|
|
|
test "allows unified stream" do
|
|
|
|
assert {:ok, _} = start_socket()
|
|
|
|
end
|
|
|
|
|
2018-12-17 16:09:06 +00:00
|
|
|
test "allows public streams without authentication" do
|
|
|
|
assert {:ok, _} = start_socket("?stream=public")
|
|
|
|
assert {:ok, _} = start_socket("?stream=public:local")
|
2020-10-09 01:01:48 +00:00
|
|
|
assert {:ok, _} = start_socket("?stream=public:remote&instance=lain.com")
|
2018-12-17 16:09:06 +00:00
|
|
|
assert {:ok, _} = start_socket("?stream=hashtag&tag=lain")
|
|
|
|
end
|
|
|
|
|
|
|
|
test "receives well formatted events" do
|
|
|
|
user = insert(:user)
|
|
|
|
{:ok, _} = start_socket("?stream=public")
|
2020-05-12 19:59:26 +00:00
|
|
|
{:ok, activity} = CommonAPI.post(user, %{status: "nice echo chamber"})
|
2018-12-17 16:09:06 +00:00
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
assert {:ok, json} = Jason.decode(raw_json)
|
|
|
|
|
|
|
|
assert "update" == json["event"]
|
|
|
|
assert json["payload"]
|
|
|
|
assert {:ok, json} = Jason.decode(json["payload"])
|
|
|
|
|
|
|
|
view_json =
|
2019-09-09 14:49:02 +00:00
|
|
|
Pleroma.Web.MastodonAPI.StatusView.render("show.json", activity: activity, for: nil)
|
2018-12-17 16:09:06 +00:00
|
|
|
|> Jason.encode!()
|
|
|
|
|> Jason.decode!()
|
|
|
|
|
|
|
|
assert json == view_json
|
|
|
|
end
|
|
|
|
|
2023-04-01 02:55:52 +00:00
|
|
|
describe "subscribing via WebSocket" do
|
|
|
|
test "can subscribe" do
|
|
|
|
user = insert(:user)
|
|
|
|
{:ok, pid} = start_socket()
|
|
|
|
WebsocketClient.send_text(pid, %{type: "subscribe", stream: "public"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 02:55:52 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
{:ok, activity} = CommonAPI.post(user, %{status: "nice echo chamber"})
|
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
assert {:ok, json} = Jason.decode(raw_json)
|
|
|
|
|
|
|
|
assert "update" == json["event"]
|
|
|
|
assert json["payload"]
|
|
|
|
assert {:ok, json} = Jason.decode(json["payload"])
|
|
|
|
|
|
|
|
view_json =
|
|
|
|
Pleroma.Web.MastodonAPI.StatusView.render("show.json", activity: activity, for: nil)
|
|
|
|
|> Jason.encode!()
|
|
|
|
|> Jason.decode!()
|
|
|
|
|
|
|
|
assert json == view_json
|
|
|
|
end
|
|
|
|
|
2023-04-01 05:25:13 +00:00
|
|
|
test "can subscribe to multiple streams" do
|
|
|
|
user = insert(:user)
|
|
|
|
{:ok, pid} = start_socket()
|
|
|
|
WebsocketClient.send_text(pid, %{type: "subscribe", stream: "public"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 05:25:13 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
2023-04-01 05:29:11 +00:00
|
|
|
WebsocketClient.send_text(
|
|
|
|
pid,
|
|
|
|
%{type: "subscribe", stream: "hashtag", tag: "mew"} |> Jason.encode!()
|
|
|
|
)
|
|
|
|
|
2023-04-01 05:25:13 +00:00
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 05:25:13 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
{:ok, _activity} = CommonAPI.post(user, %{status: "nice echo chamber #mew"})
|
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
assert {:ok, %{"stream" => stream1}} = Jason.decode(raw_json)
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
assert {:ok, %{"stream" => stream2}} = Jason.decode(raw_json)
|
|
|
|
|
|
|
|
streams = [stream1, stream2]
|
|
|
|
assert ["hashtag", "mew"] in streams
|
|
|
|
assert ["public"] in streams
|
|
|
|
end
|
|
|
|
|
2023-04-01 02:55:52 +00:00
|
|
|
test "won't double subscribe" do
|
|
|
|
user = insert(:user)
|
|
|
|
{:ok, pid} = start_socket()
|
|
|
|
WebsocketClient.send_text(pid, %{type: "subscribe", stream: "public"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 02:55:52 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
WebsocketClient.send_text(pid, %{type: "subscribe", stream: "public"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 02:55:52 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "ignored"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
{:ok, _activity} = CommonAPI.post(user, %{status: "nice echo chamber"})
|
|
|
|
|
|
|
|
assert_receive {:text, _}, 1_000
|
|
|
|
refute_receive {:text, _}, 1_000
|
|
|
|
end
|
|
|
|
|
|
|
|
test "can unsubscribe" do
|
|
|
|
user = insert(:user)
|
|
|
|
{:ok, pid} = start_socket()
|
|
|
|
WebsocketClient.send_text(pid, %{type: "subscribe", stream: "public"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 02:55:52 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
WebsocketClient.send_text(pid, %{type: "unsubscribe", stream: "public"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 02:55:52 +00:00
|
|
|
"payload" => %{"type" => "unsubscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
{:ok, _activity} = CommonAPI.post(user, %{status: "nice echo chamber"})
|
|
|
|
refute_receive {:text, _}, 1_000
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-12-17 16:09:06 +00:00
|
|
|
describe "with a valid user token" do
|
|
|
|
setup do
|
|
|
|
{:ok, app} =
|
|
|
|
Pleroma.Repo.insert(
|
|
|
|
OAuth.App.register_changeset(%OAuth.App{}, %{
|
|
|
|
client_name: "client",
|
2020-09-19 16:16:55 +00:00
|
|
|
scopes: ["read"],
|
2018-12-17 16:09:06 +00:00
|
|
|
redirect_uris: "url"
|
|
|
|
})
|
|
|
|
)
|
|
|
|
|
|
|
|
user = insert(:user)
|
|
|
|
|
|
|
|
{:ok, auth} = OAuth.Authorization.create_authorization(app, user)
|
|
|
|
|
|
|
|
{:ok, token} = OAuth.Token.exchange_token(app, auth)
|
|
|
|
|
2022-08-19 18:09:42 +00:00
|
|
|
%{app: app, user: user, token: token}
|
2018-12-17 16:09:06 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
test "accepts valid tokens", state do
|
|
|
|
assert {:ok, _} = start_socket("?stream=user&access_token=#{state.token.token}")
|
|
|
|
end
|
2019-06-16 10:33:25 +00:00
|
|
|
|
|
|
|
test "accepts the 'user' stream", %{token: token} = _state do
|
|
|
|
assert {:ok, _} = start_socket("?stream=user&access_token=#{token.token}")
|
2019-09-13 15:46:41 +00:00
|
|
|
|
2020-09-10 18:28:47 +00:00
|
|
|
capture_log(fn ->
|
2022-08-19 17:56:39 +00:00
|
|
|
assert {:error, %WebSockex.RequestError{code: 401}} = start_socket("?stream=user")
|
2020-09-10 18:28:47 +00:00
|
|
|
Process.sleep(30)
|
|
|
|
end)
|
2019-06-16 10:33:25 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
test "accepts the 'user:notification' stream", %{token: token} = _state do
|
|
|
|
assert {:ok, _} = start_socket("?stream=user:notification&access_token=#{token.token}")
|
2019-09-13 15:46:41 +00:00
|
|
|
|
2020-09-10 18:28:47 +00:00
|
|
|
capture_log(fn ->
|
2022-08-19 17:56:39 +00:00
|
|
|
assert {:error, %WebSockex.RequestError{code: 401}} =
|
|
|
|
start_socket("?stream=user:notification")
|
|
|
|
|
2020-09-10 18:28:47 +00:00
|
|
|
Process.sleep(30)
|
|
|
|
end)
|
2019-06-16 10:33:25 +00:00
|
|
|
end
|
2019-07-07 06:58:24 +00:00
|
|
|
|
|
|
|
test "accepts valid token on Sec-WebSocket-Protocol header", %{token: token} do
|
|
|
|
assert {:ok, _} = start_socket("?stream=user", [{"Sec-WebSocket-Protocol", token.token}])
|
|
|
|
|
2020-09-10 18:28:47 +00:00
|
|
|
capture_log(fn ->
|
2022-08-19 17:56:39 +00:00
|
|
|
assert {:error, %WebSockex.RequestError{code: 401}} =
|
2020-09-10 18:28:47 +00:00
|
|
|
start_socket("?stream=user", [{"Sec-WebSocket-Protocol", "I am a friend"}])
|
2019-09-17 14:44:52 +00:00
|
|
|
|
2020-09-10 18:28:47 +00:00
|
|
|
Process.sleep(30)
|
|
|
|
end)
|
2019-07-07 06:58:24 +00:00
|
|
|
end
|
2022-08-19 18:09:42 +00:00
|
|
|
|
2023-04-01 03:19:57 +00:00
|
|
|
test "accepts valid token on client-sent event", %{token: token} do
|
|
|
|
assert {:ok, pid} = start_socket()
|
|
|
|
|
|
|
|
WebsocketClient.send_text(
|
|
|
|
pid,
|
2023-04-01 05:29:11 +00:00
|
|
|
%{type: "pleroma:authenticate", token: token.token} |> Jason.encode!()
|
2023-04-01 03:19:57 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
|
|
|
"payload" => %{"type" => "pleroma:authenticate", "result" => "success"}
|
2023-04-01 03:19:57 +00:00
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
WebsocketClient.send_text(pid, %{type: "subscribe", stream: "user"} |> Jason.encode!())
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 03:19:57 +00:00
|
|
|
"payload" => %{"type" => "subscribe", "result" => "success"}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
end
|
|
|
|
|
|
|
|
test "rejects invalid token on client-sent event" do
|
|
|
|
assert {:ok, pid} = start_socket()
|
|
|
|
|
|
|
|
WebsocketClient.send_text(
|
|
|
|
pid,
|
2023-04-01 05:29:11 +00:00
|
|
|
%{type: "pleroma:authenticate", token: "Something else"} |> Jason.encode!()
|
2023-04-01 03:19:57 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 03:19:57 +00:00
|
|
|
"payload" => %{
|
2023-04-01 05:29:11 +00:00
|
|
|
"type" => "pleroma:authenticate",
|
2023-04-01 03:19:57 +00:00
|
|
|
"result" => "error",
|
|
|
|
"error" => "unauthorized"
|
|
|
|
}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
end
|
|
|
|
|
|
|
|
test "rejects new authenticate request if already logged-in", %{token: token} do
|
|
|
|
assert {:ok, pid} = start_socket()
|
|
|
|
|
|
|
|
WebsocketClient.send_text(
|
|
|
|
pid,
|
2023-04-01 05:29:11 +00:00
|
|
|
%{type: "pleroma:authenticate", token: token.token} |> Jason.encode!()
|
2023-04-01 03:19:57 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
|
|
|
"payload" => %{"type" => "pleroma:authenticate", "result" => "success"}
|
2023-04-01 03:19:57 +00:00
|
|
|
}} = decode_json(raw_json)
|
|
|
|
|
|
|
|
WebsocketClient.send_text(
|
|
|
|
pid,
|
2023-04-01 05:29:11 +00:00
|
|
|
%{type: "pleroma:authenticate", token: "Something else"} |> Jason.encode!()
|
2023-04-01 03:19:57 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
assert_receive {:text, raw_json}, 1_000
|
|
|
|
|
|
|
|
assert {:ok,
|
|
|
|
%{
|
2023-04-01 05:29:11 +00:00
|
|
|
"event" => "pleroma:respond",
|
2023-04-01 03:19:57 +00:00
|
|
|
"payload" => %{
|
2023-04-01 05:29:11 +00:00
|
|
|
"type" => "pleroma:authenticate",
|
2023-04-01 03:19:57 +00:00
|
|
|
"result" => "error",
|
|
|
|
"error" => "already_authenticated"
|
|
|
|
}
|
|
|
|
}} = decode_json(raw_json)
|
|
|
|
end
|
|
|
|
|
2022-08-19 18:09:42 +00:00
|
|
|
test "disconnect when token is revoked", %{app: app, user: user, token: token} do
|
|
|
|
assert {:ok, _} = start_socket("?stream=user:notification&access_token=#{token.token}")
|
|
|
|
assert {:ok, _} = start_socket("?stream=user&access_token=#{token.token}")
|
|
|
|
|
|
|
|
{:ok, auth} = OAuth.Authorization.create_authorization(app, user)
|
|
|
|
|
|
|
|
{:ok, token2} = OAuth.Token.exchange_token(app, auth)
|
|
|
|
assert {:ok, _} = start_socket("?stream=user&access_token=#{token2.token}")
|
|
|
|
|
|
|
|
OAuth.Token.Strategy.Revoke.revoke(token)
|
|
|
|
|
|
|
|
assert_receive {:close, _}
|
|
|
|
assert_receive {:close, _}
|
|
|
|
refute_receive {:close, _}
|
|
|
|
end
|
2018-12-17 16:09:06 +00:00
|
|
|
end
|
|
|
|
end
|