Skip to content

bugfix: Clean up internet account event listeners #714

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

Merged
garrettjstevens merged 1 commit into from
Oct 10, 2025
Merged

bugfix: Clean up internet account event listeners #714

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
110 changes: 64 additions & 46 deletions packages/jbrowse-plugin-apollo/src/ApolloInternetAccount/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,56 +407,72 @@ const stateModelFactory = (configSchema: ApolloInternetAccountConfigModel) => {
return { postUserLocation: debouncePostUserLocation(postUserLocation) }
})
.volatile(() => ({ roleNotificationSent: false }))
.actions((self) => ({
initialize: flow(function* initialize(role: Role) {
if (role === 'none') {
if (!self.roleNotificationSent) {
const { session } = getRoot<ApolloRootModel>(self)
;(session as unknown as AbstractSessionModel).notify(
'You have registered as an Apollo user but have not been given access. Ask your administrator to enable access for your account.',
'warning',
)
self.roleNotificationSent = true
}
return
.actions((self) => {
function beforeUnloadListener() {
self.postUserLocation([])
}
function visibilityChangeListener() {
// fires when user switches tabs, apps, goes to homescreen, etc.
if (document.visibilityState === 'hidden') {
self.postUserLocation([])
}
if (role === 'admin') {
const rootModel = getRoot(self)
if (isAbstractMenuManager(rootModel)) {
addTopLevelAdminMenus(rootModel)
}
// fires when app transitions from prerender, user returns to the app / tab.
if (document.visibilityState === 'visible') {
const { session } = getRoot<ApolloRootModel>(self)
session.broadcastLocations()
}
// Get and set server last change sequence into session storage
yield self.updateLastChangeSequenceNumber()
// Open socket listeners
self.addSocketListeners()
// request user locations
const { baseURL } = self
const uri = new URL('users/locations', baseURL).href
const apolloFetch = self.getFetcher({
locationType: 'UriLocation',
uri,
})
yield apolloFetch(uri, {
method: 'GET',
signal: self.controller.signal,
})
window.addEventListener('beforeunload', () => {
self.postUserLocation([])
})
document.addEventListener('visibilitychange', () => {
// fires when user switches tabs, apps, goes to homescreen, etc.
if (document.visibilityState === 'hidden') {
self.postUserLocation([])
}
return {
initialize: flow(function* initialize(role: Role) {
if (role === 'none') {
if (!self.roleNotificationSent) {
const { session } = getRoot<ApolloRootModel>(self)
;(session as unknown as AbstractSessionModel).notify(
'You have registered as an Apollo user but have not been given access. Ask your administrator to enable access for your account.',
'warning',
)
self.roleNotificationSent = true
}
return
}
// fires when app transitions from prerender, user returns to the app / tab.
if (document.visibilityState === 'visible') {
const { session } = getRoot<ApolloRootModel>(self)
session.broadcastLocations()
if (role === 'admin') {
const rootModel = getRoot(self)
if (isAbstractMenuManager(rootModel)) {
addTopLevelAdminMenus(rootModel)
}
}
})
}),
}))
// Get and set server last change sequence into session storage
yield self.updateLastChangeSequenceNumber()
// Open socket listeners
self.addSocketListeners()
// request user locations
const { baseURL } = self
const uri = new URL('users/locations', baseURL).href
const apolloFetch = self.getFetcher({
locationType: 'UriLocation',
uri,
})
yield apolloFetch(uri, {
method: 'GET',
signal: self.controller.signal,
})
window.addEventListener('beforeunload', beforeUnloadListener)
document.addEventListener(
'visibilitychange',
visibilityChangeListener,
)
}),
removeBeforeUnloadListener() {
window.removeEventListener('beforeunload', beforeUnloadListener)
},
removeVisibilityChangeListener() {
document.removeEventListener(
'visibilitychange',
visibilityChangeListener,
)
},
}
})
.actions((self) => ({
afterAttach() {
self.setRole()
Expand All @@ -481,6 +497,8 @@ const stateModelFactory = (configSchema: ApolloInternetAccountConfigModel) => {
)
},
beforeDestroy() {
self.removeBeforeUnloadListener()
self.removeVisibilityChangeListener()
self.controller.abort('internet account beforeDestroy')
self.socket.close()
},
Expand Down