Skip to content

Make phxWindow.addEventListener optional #6198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make phxWindow.addEventListener optional #6198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion assets/js/phoenix/socket.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ import Timer from "./timer"
* removeItem(keyName) { delete this.storage[keyName] }
* setItem(keyName, keyValue) { this.storage[keyName] = keyValue }
* }
*
* @param {boolean} [opts.disableWindowEventListeners] - Boolean that determines if window event listeners should be active
Copy link
Contributor

@SteffenDE SteffenDE Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we add this, I'd rather call it something like disableAutoDisconnectOnPageHide to be explicit. LiveView passes unknown options to Phoenix and uses a lot of window event listeners, so this might be confusing.

cc @chrismccord

*
* Defaults to false.
*
*/
export default class Socket {
Expand Down Expand Up @@ -137,7 +141,8 @@ export default class Socket {
this.decode = this.defaultDecoder
}
let awaitingConnectionOnPageShow = null
if(phxWindow && phxWindow.addEventListener){
this.disableWindowEventListeners = opts.disableWindowEventListeners || false
if(!this.disableWindowEventListeners && phxWindow && phxWindow.addEventListener){
phxWindow.addEventListener("pagehide", _e => {
if(this.conn){
this.disconnect()
Expand Down
3 changes: 3 additions & 0 deletions assets/test/socket_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ describe("with transports", function (){
expect(socket.longpollerTimeout).toBe(20000)
expect(socket.heartbeatIntervalMs).toBe(30000)
expect(socket.logger).toBeNull()
expect(socket.disableWindowEventListeners).toBe(false)
expect(socket.binaryType).toBe("arraybuffer")
expect(typeof socket.reconnectAfterMs).toBe("function")
})
Expand All @@ -64,6 +65,7 @@ describe("with transports", function (){
logger: customLogger,
reconnectAfterMs: customReconnect,
params: {one: "two"},
disableWindowEventListeners: true
})

expect(socket.timeout).toBe(40000)
Expand All @@ -72,6 +74,7 @@ describe("with transports", function (){
expect(socket.transport).toBe(customTransport)
expect(socket.logger).toBe(customLogger)
expect(socket.params()).toEqual({one: "two"})
expect(socket.disableWindowEventListeners).toBe(true)
})

describe("with Websocket", function (){
Expand Down