skyqrose
How to mock phoenix sockets in Jest?
I want to test my js app that uses phoenix.js sockets. I want to write tests along the lines of:
- Set up a mocked socket and channel.
- Render my app.
- Interact with the app.
- Assert that a message was sent on the channel.
- Mock a response to that message as if the server had replied.
- Assert that the UI was updated with the response.
Is there a recommended way to do this?
I’m familiar with using jest to mock functions, but I’m struggling to set it up through the layers of callbacks and classes in a way that lets me assert something was pushed or send a reply.
First Post!
regan-karlewicz
Sorry, I’m a bit late to the party here.
Using vitest, I was able to accomplish creating a phoenix channel mock doing something like this:
import { vi } from 'vitest';
import * as phoenix from 'phoenix';
vi.mock('phoenix', () => {
return {
Socket: vi.fn().mockImplementation(() => fakeSocket)
};
});
const fakeChannel = {
join: vi.fn().mockReturnThis(),
push: vi.fn().mockReturnThis(),
on: vi.fn().mockReturnThis(),
off: vi.fn().mockReturnThis(),
leave: vi.fn().mockReturnThis(),
receive: vi.fn().mockImplementation((event, callback) => {
if (event === 'ok') {
callback({});
}
return this;
})
};
const fakeSocket = {
connect: vi.fn(),
channel: vi.fn(() => fakeChannel),
// mock any other used Socket class methods here
};
Then inside of your tests, you can override the mocks as needed:
describe("Example", () => {
it("can join a channel", async () => {
await joinChannel(); // This is the `socket.channel(...).join().receive("ok", callback)` wrapped by a promise that resolves in the callback
expect(fakeSocket.connect).toHaveBeenCalledOnce();
expect(fakeChannel.join).toHaveBeenCalledOnce();
});
it("can receive pushed event", async () => {
await joinChannel();
fakeChannel.on.mockImplementation((event, handler) => {
if (event == "pushed:event") handler("Some data");
return fakeChannel;
});
const result = await listenForPushedEvent(); // This is the function that sets up `channel.on("pushed:event", callback)` wrapped in a promise that resolves in the callback
expect(result).toEqual("Some data");
});
});
The challenge still exists that you have to carefully craft your mocks, which can be difficult since the Phoenix JS API is callback based.
0
Popular in Questions
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Hi guys, i’m new in the Elixir world, and i have to say, that i love it!
i’m having some problem to understand anonymous functions with ...
New
Hi all,
I’ve just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage.
I’m trying to use Postgres...
New
Hi,
I’m quite new in Elixir and I’m trying to format a string to a PEM format. I have the certificate value like MIIDBTCCAe2...... and I...
New
I have a super simple question about elixir - how would I take a file like this
foo
bar
baz
and output a new file that enumerates th...
New
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
Hello!
Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New
Hi!
Currently I want to submit a form by pressing the Enter key. However, since my input field is of type “textarea” this is just adds a...
New
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New
Other popular topics
lets say i have a sample like
a = 20; b = 10;
if (a > b) do
{:ok, "a"}
end
if (a < b) do
{:ok, b}
end
if (a == b) do
{:ok, "equa...
New
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New
Anybody knows a comprehensive comparison of Django and Phoenix, thanks for the help.
Where are they similar?
Where do they differ the m...
New
I believe there are people here who are dealing with CSV files import on the daily basis, and since Excel is a really popular tool there ...
New
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
Surface is an experimental library built on top of Phoenix LiveView and its new LiveComponent API that aims to provide a more declarative...
New
Please see the new poll here: Which code editor or IDE do you use? (Poll) (2022 Edition)
It’s been a while since we first asked this, I...
New
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #advent-of-code
- #elixirconf-us
- #distillery
- #processes
- #forms
- #api
- #metaprogramming
- #security
- #performance









