Skip to content
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.

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

Extend web workers to call main thread #277

Merged
merged 5 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/jbrowse-plugin-apollo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
"fake-indexeddb": "^4.0.2",
"jest": "^29.6.2",
"jest-fetch-mock": "^3.0.3",
"librpc-web-mod": "^1.1.9",
"mobx": "^6.6.1",
"mobx-react": "^7.2.1",
"mobx-state-tree": "^5.1.7",
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,17 @@ import {
BaseOptions,
BaseSequenceAdapter,
} from '@jbrowse/core/data_adapters/BaseAdapter'
import { getFetcher } from '@jbrowse/core/util/io'
import { ObservableCreate } from '@jbrowse/core/util/rxjs'
import SimpleFeature, { Feature } from '@jbrowse/core/util/simpleFeature'
import { NoAssemblyRegion, UriLocation } from '@jbrowse/core/util/types'
import { NoAssemblyRegion, Region } from '@jbrowse/core/util/types'
import { nanoid } from 'nanoid'

import { createFetchErrorMessage } from '../util'
import { BackendDriver } from '../BackendDrivers'
import { ApolloSessionModel } from '../session'

// declare global {
// var rpcServer: import('librpc-web-mod').RpcServer
// }

export interface RefSeq {
_id: string
Expand All @@ -17,110 +22,156 @@ export interface RefSeq {
length: number
}

export class ApolloSequenceAdapter extends BaseSequenceAdapter {
private refSeqs: Promise<RefSeq[]> | undefined
interface ApolloMessageData {
apollo: true
messageId: string
sequence: string
regions: Region[]
}

get baseURL(): string {
return readConfObject(this.config, 'baseURL').uri
}
function isApolloMessageData(data?: unknown): data is ApolloMessageData {
return (
typeof data === 'object' &&
data !== null &&
'apollo' in data &&
data.apollo === true
)
}

get internetAccountPreAuthorization():
| { authInfo: { token: string }; internetAccountType: string }
| undefined {
return readConfObject(this.config, 'baseURL')
.internetAccountPreAuthorization
}
const isInWebWorker = typeof sessionStorage === 'undefined'

protected async getRefSeqs({ signal }: BaseOptions) {
if (this.refSeqs) {
return this.refSeqs
}
const assemblyId = readConfObject(this.config, 'assemblyId')
const url = new URL('refSeqs', this.baseURL)
const searchParams = new URLSearchParams({ assembly: assemblyId })
url.search = searchParams.toString()
const uri = url.toString()
const location: UriLocation = { locationType: 'UriLocation', uri }
if (this.internetAccountPreAuthorization) {
location.internetAccountPreAuthorization =
this.internetAccountPreAuthorization
}
const fetch = getFetcher(location, this.pluginManager)
const response = await fetch(uri, { signal })
if (!response.ok) {
const errorMessage = await createFetchErrorMessage(
response,
'Failed to fetch refSeqs',
)
throw new Error(errorMessage)
}
const refSeqs = (await response.json()) as RefSeq[]
this.refSeqs = Promise.resolve(refSeqs)
return refSeqs
}
export class ApolloSequenceAdapter extends BaseSequenceAdapter {
private regions: NoAssemblyRegion[] | undefined

public async getRefNames(opts: BaseOptions) {
const refSeqs = await this.getRefSeqs(opts)
return refSeqs.map((refSeq) => refSeq.name)
const regions = await this.getRegions(opts)
return regions.map((regions) => regions.refName)
}

public async getRegions(opts: BaseOptions): Promise<NoAssemblyRegion[]> {
const refSeqs = await this.getRefSeqs(opts)
return refSeqs.map((refSeq) => ({
refName: refSeq.name,
start: 0,
end: refSeq.length,
}))
if (this.regions) {
return this.regions
}
const assemblyId = readConfObject(this.config, 'assemblyId')
if (!isInWebWorker) {
const dataStore = (
this.pluginManager?.rootModel?.session as ApolloSessionModel | undefined
)?.apolloDataStore
if (!dataStore) {
throw new Error('No Apollo data store found')
}
const backendDriver = dataStore.getBackendDriver(
assemblyId,
) as BackendDriver
const regions = await backendDriver.getRegions(assemblyId)
this.regions = regions
return regions
}
const { signal } = opts
const regions = await new Promise(
(
resolve: (sequence: Region[]) => void,
reject: (reason: string) => void,
) => {
const timeoutId = setTimeout(() => {
reject('timeout')
}, 20_000)
const messageId = nanoid()
const messageListener = (event: MessageEvent) => {
const { data } = event
if (!isApolloMessageData(data)) {
return
}
if (data.messageId !== messageId) {
return
}
clearTimeout(timeoutId)
removeEventListener('message', messageListener)
resolve(data.regions)
}
addEventListener('message', messageListener, { signal })
// @ts-expect-error waiting for types to be published
globalThis.rpcServer.emit('apollo', {
apollo: true,
method: 'getRegions',
assembly: assemblyId,
messageId,
})
},
)
this.regions = regions
return regions
}

/**
* Fetch features for a certain region
* @param param -
* @returns Observable of Feature objects in the region
*/
public getFeatures(
{ end, refName, start }: NoAssemblyRegion,
opts: BaseOptions,
) {
public getFeatures(region: Region, opts: BaseOptions) {
const { signal } = opts
const { assemblyName, end, refName, start } = region
return ObservableCreate<Feature>(async (observer) => {
const refSeqs = await this.getRefSeqs(opts)
const refSeq = refSeqs.find((rs) => rs.name === refName)
if (!refSeq) {
return observer.error(
`Could not find refSeq that matched refName "${refName}"`,
)
}
const url = new URL('refSeqs/getSequence', this.baseURL)
const searchParams = new URLSearchParams({
refSeq: refSeq._id,
start: String(start),
end: String(end),
})
url.search = searchParams.toString()
const uri = url.toString()
const location: UriLocation = { locationType: 'UriLocation', uri }
if (this.internetAccountPreAuthorization) {
location.internetAccountPreAuthorization =
this.internetAccountPreAuthorization
}
const fetch = getFetcher(location, this.pluginManager)
const response = await fetch(uri, { signal: opts.signal })
if (!response.ok) {
const errorMessage = await createFetchErrorMessage(
response,
'Failed to fetch refSeqs',
)
throw new Error(errorMessage)
}
const seq = (await response.text()) as string
if (seq) {
if (!isInWebWorker) {
const dataStore = (
this.pluginManager?.rootModel?.session as
| ApolloSessionModel
| undefined
)?.apolloDataStore
if (!dataStore) {
observer.error('No Apollo data store found')
return
}
const backendDriver = dataStore.getBackendDriver(
assemblyName,
) as BackendDriver
const { seq } = await backendDriver.getSequence(region)
observer.next(
new SimpleFeature({
id: `${refName} ${start}-${end}`,
data: { refName, start, end, seq },
}),
)
observer.complete()
return
}
const seq = await new Promise(
(
resolve: (sequence: string) => void,
reject: (reason: string) => void,
) => {
const timeoutId = setTimeout(() => {
reject('timeout')
}, 20_000)
const messageId = nanoid()
const messageListener = (event: MessageEvent) => {
const { data } = event
if (!isApolloMessageData(data)) {
return
}
if (data.messageId !== messageId) {
return
}
clearTimeout(timeoutId)
removeEventListener('message', messageListener)
resolve(data.sequence)
}
addEventListener('message', messageListener, { signal })
// @ts-expect-error waiting for types to be published
globalThis.rpcServer.emit('apollo', {
apollo: true,
method: 'getSequence',
region,
messageId,
})
},
)
observer.next(
new SimpleFeature({
id: `${refName} ${start}-${end}`,
data: { refName, start, end, seq },
}),
)
observer.complete()
})
}
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,6 @@ export default ConfigurationSchema(
type: 'string',
defaultValue: '',
},
baseURL: {
type: 'fileLocation',
defaultValue: {
uri: '',
locationType: 'UriLocation',
},
},
},
{ explicitlyTyped: true },
)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export abstract class BackendDriver {

abstract getSequence(region: Region): Promise<{ seq: string; refSeq: string }>

abstract getRefSeqs(): Promise<string[]>
abstract getRegions(assemblyName: string): Promise<Region[]>

abstract getAssemblies(internetAccountConfigId?: string): Assembly[]

Expand Down
Loading