@jbrowse/product-core 2.6.1 → 2.6.2

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './RootModel';
 export * from './Session';
 export * from './ui';
+export * from './rpcWorker';

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./RootModel"), exports);
 __exportStar(require("./Session"), exports);
 __exportStar(require("./ui"), exports);
+__exportStar(require("./rpcWorker"), exports);

package/dist/rpcWorker.d.ts

@@ -0,0 +1,6 @@
+import { LoadedPlugin } from '@jbrowse/core/PluginLoader';
+import { PluginConstructor } from '@jbrowse/core/Plugin';
+export declare function initializeWorker(corePlugins: PluginConstructor[], opts: {
+    fetchESM?: (url: string) => Promise<LoadedPlugin>;
+    fetchCJS?: (url: string) => Promise<LoadedPlugin>;
+}): Promise<void>;

package/dist/rpcWorker.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeWorker = void 0;
+/* eslint-disable no-restricted-globals */
+const librpc_web_mod_1 = __importDefault(require("librpc-web-mod"));
+const PluginManager_1 = __importDefault(require("@jbrowse/core/PluginManager"));
+const remoteAbortSignals_1 = require("@jbrowse/core/rpc/remoteAbortSignals");
+const PluginLoader_1 = __importDefault(require("@jbrowse/core/PluginLoader"));
+const serialize_error_1 = require("serialize-error");
+// waits for a message from the main thread containing our configuration, which
+// must be sent on boot
+function receiveConfiguration() {
+    const configurationP = new Promise(resolve => {
+        function listener(e) {
+            if (e.data.message === 'config') {
+                resolve(e.data.config);
+                removeEventListener('message', listener);
+            }
+        }
+        self.addEventListener('message', listener);
+    });
+    postMessage({ message: 'readyForConfig' });
+    return configurationP;
+}
+async function getPluginManager(corePlugins, opts) {
+    // Load runtime plugins
+    const config = await receiveConfiguration();
+    const pluginLoader = new PluginLoader_1.default(config.plugins, opts);
+    pluginLoader.installGlobalReExports(self);
+    const runtimePlugins = await pluginLoader.load(config.windowHref);
+    const plugins = [...corePlugins.map(p => ({ plugin: p })), ...runtimePlugins];
+    const pluginManager = new PluginManager_1.default(plugins.map(P => new P.plugin()));
+    pluginManager.createPluggableElements();
+    pluginManager.configure();
+    return pluginManager;
+}
+function wrapForRpc(func) {
+    return (args) => {
+        const { channel, rpcDriverClassName } = args;
+        return func({
+            ...args,
+            statusCallback: (message) => {
+                // @ts-expect-error
+                self.rpcServer.emit(channel, message);
+            },
+        }, rpcDriverClassName);
+    };
+}
+async function initializeWorker(corePlugins, opts) {
+    try {
+        const pluginManager = await getPluginManager(corePlugins, opts);
+        const rpcConfig = Object.fromEntries(pluginManager
+            .getRpcElements()
+            .map(e => [e.name, wrapForRpc(e.execute.bind(e))]));
+        // @ts-expect-error
+        self.rpcServer = new librpc_web_mod_1.default.Server({
+            ...rpcConfig,
+            ...(0, remoteAbortSignals_1.remoteAbortRpcHandler)(),
+            ping: () => {
+                // the ping method is required by the worker driver for checking the
+                // health of the worker
+            },
+        });
+        postMessage({ message: 'ready' });
+    }
+    catch (e) {
+        postMessage({ message: 'error', error: (0, serialize_error_1.serializeError)(e) });
+    }
+    /* do nothing */
+}
+exports.initializeWorker = initializeWorker;

package/esm/index.d.ts

@@ -1,3 +1,4 @@
 export * from './RootModel';
 export * from './Session';
 export * from './ui';
+export * from './rpcWorker';

package/esm/index.js

@@ -1,3 +1,4 @@
 export * from './RootModel';
 export * from './Session';
 export * from './ui';
+export * from './rpcWorker';

package/esm/rpcWorker.d.ts

@@ -0,0 +1,6 @@
+import { LoadedPlugin } from '@jbrowse/core/PluginLoader';
+import { PluginConstructor } from '@jbrowse/core/Plugin';
+export declare function initializeWorker(corePlugins: PluginConstructor[], opts: {
+    fetchESM?: (url: string) => Promise<LoadedPlugin>;
+    fetchCJS?: (url: string) => Promise<LoadedPlugin>;
+}): Promise<void>;

package/esm/rpcWorker.js

@@ -0,0 +1,67 @@
+/* eslint-disable no-restricted-globals */
+import RpcServer from 'librpc-web-mod';
+import PluginManager from '@jbrowse/core/PluginManager';
+import { remoteAbortRpcHandler } from '@jbrowse/core/rpc/remoteAbortSignals';
+import PluginLoader from '@jbrowse/core/PluginLoader';
+import { serializeError } from 'serialize-error';
+// waits for a message from the main thread containing our configuration, which
+// must be sent on boot
+function receiveConfiguration() {
+    const configurationP = new Promise(resolve => {
+        function listener(e) {
+            if (e.data.message === 'config') {
+                resolve(e.data.config);
+                removeEventListener('message', listener);
+            }
+        }
+        self.addEventListener('message', listener);
+    });
+    postMessage({ message: 'readyForConfig' });
+    return configurationP;
+}
+async function getPluginManager(corePlugins, opts) {
+    // Load runtime plugins
+    const config = await receiveConfiguration();
+    const pluginLoader = new PluginLoader(config.plugins, opts);
+    pluginLoader.installGlobalReExports(self);
+    const runtimePlugins = await pluginLoader.load(config.windowHref);
+    const plugins = [...corePlugins.map(p => ({ plugin: p })), ...runtimePlugins];
+    const pluginManager = new PluginManager(plugins.map(P => new P.plugin()));
+    pluginManager.createPluggableElements();
+    pluginManager.configure();
+    return pluginManager;
+}
+function wrapForRpc(func) {
+    return (args) => {
+        const { channel, rpcDriverClassName } = args;
+        return func({
+            ...args,
+            statusCallback: (message) => {
+                // @ts-expect-error
+                self.rpcServer.emit(channel, message);
+            },
+        }, rpcDriverClassName);
+    };
+}
+export async function initializeWorker(corePlugins, opts) {
+    try {
+        const pluginManager = await getPluginManager(corePlugins, opts);
+        const rpcConfig = Object.fromEntries(pluginManager
+            .getRpcElements()
+            .map(e => [e.name, wrapForRpc(e.execute.bind(e))]));
+        // @ts-expect-error
+        self.rpcServer = new RpcServer.Server({
+            ...rpcConfig,
+            ...remoteAbortRpcHandler(),
+            ping: () => {
+                // the ping method is required by the worker driver for checking the
+                // health of the worker
+            },
+        });
+        postMessage({ message: 'ready' });
+    }
+    catch (e) {
+        postMessage({ message: 'error', error: serializeError(e) });
+    }
+    /* do nothing */
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jbrowse/product-core",
-  "version": "2.6.1",
+  "version": "2.6.2",
   "sideEffects": false,
   "description": "JBrowse 2 code shared between products but not used by plugins",
   "keywords": [
@@ -27,13 +27,12 @@
   "module": "esm/index.js",
   "files": [
     "dist",
-    "esm",
-    "src"
+    "esm"
   ],
   "scripts": {
     "build:esm": "tsc --build tsconfig.build.esm.json",
-    "build:es5": "tsc --build tsconfig.build.es5.json",
-    "build": "npm run build:esm && npm run build:es5",
+    "build:commonjs": "tsc --build tsconfig.build.commonjs.json",
+    "build": "npm run build:esm && npm run build:commonjs",
     "test": "cd ../..; jest packages/product-core",
     "clean": "rimraf dist esm *.tsbuildinfo",
     "prebuild": "yarn clean",
@@ -47,7 +46,9 @@
     "@mui/icons-material": "^5.0.0",
     "@mui/material": "^5.10.17",
     "copy-to-clipboard": "^3.3.1",
+    "librpc-web-mod": "^1.0.0",
     "react-error-boundary": "^4.0.3",
+    "serialize-error": "^8.0.0",
     "shortid": "^2.2.15"
   },
   "peerDependencies": {
@@ -62,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1cbe7ba097fb2d2763c776e5e429e4670cdd583c"
+  "gitHead": "bbea587a402d9974acdd804a33f4b77f31a2fd5f"
 }

package/src/RootModel/BaseRootModel.ts

@@ -1,131 +0,0 @@
-import PluginManager from '@jbrowse/core/PluginManager'
-import assemblyManagerFactory, {
-  BaseAssemblyConfigSchema,
-} from '@jbrowse/core/assemblyManager'
-import RpcManager from '@jbrowse/core/rpc/RpcManager'
-import {
-  IAnyType,
-  Instance,
-  SnapshotIn,
-  cast,
-  getSnapshot,
-  isStateTreeNode,
-  types,
-} from 'mobx-state-tree'
-import TextSearchManager from '@jbrowse/core/TextSearch/TextSearchManager'
-
-/**
- * #stateModel BaseRootModel
- * #category root
- * factory function for the Base-level root model shared by all products
- */
-export function BaseRootModelFactory({
-  pluginManager,
-  jbrowseModelType,
-  sessionModelType,
-  assemblyConfigSchema,
-}: {
-  pluginManager: PluginManager
-  jbrowseModelType: IAnyType
-  sessionModelType: IAnyType
-  assemblyConfigSchema: BaseAssemblyConfigSchema
-}) {
-  return types
-    .model('BaseRootModel', {
-      /**
-       * #property
-       * `jbrowse` is a mapping of the config.json into the in-memory state
-       * tree
-       */
-      jbrowse: jbrowseModelType,
-
-      /**
-       * #property
-       * `session` encompasses the currently active state of the app, including
-       * views open, tracks open in those views, etc.
-       */
-      session: types.maybe(sessionModelType),
-      /**
-       * #property
-       */
-      sessionPath: types.optional(types.string, ''),
-
-      /**
-       * #property
-       */
-      assemblyManager: types.optional(
-        assemblyManagerFactory(assemblyConfigSchema, pluginManager),
-        {},
-      ),
-    })
-    .volatile(self => ({
-      rpcManager: new RpcManager(
-        pluginManager,
-        self.jbrowse.configuration.rpc,
-        {
-          MainThreadRpcDriver: {},
-        },
-      ),
-
-      adminMode: false,
-      isAssemblyEditing: false,
-      error: undefined as unknown,
-      textSearchManager: new TextSearchManager(pluginManager),
-      pluginManager,
-    }))
-    .actions(self => ({
-      /**
-       * #action
-       */
-      setError(error: unknown) {
-        self.error = error
-      },
-      /**
-       * #action
-       */
-      setSession(sessionSnapshot?: SnapshotIn<IAnyType>) {
-        self.session = cast(sessionSnapshot)
-      },
-      /**
-       * #action
-       */
-      setDefaultSession() {
-        this.setSession(self.jbrowse.defaultSession)
-      },
-      /**
-       * #action
-       */
-      setSessionPath(path: string) {
-        self.sessionPath = path
-      },
-      /**
-       * #action
-       */
-      renameCurrentSession(newName: string) {
-        if (self.session) {
-          const snapshot = JSON.parse(JSON.stringify(getSnapshot(self.session)))
-          snapshot.name = newName
-          this.setSession(snapshot)
-        }
-      },
-      /**
-       * #action
-       */
-      setAssemblyEditing(flag: boolean) {
-        self.isAssemblyEditing = flag
-      },
-    }))
-}
-
-export type BaseRootModelType = ReturnType<typeof BaseRootModelFactory>
-export type BaseRootModel = Instance<BaseRootModelType>
-
-/** Type guard for checking if something is a JB root model */
-export function isRootModel(thing: unknown): thing is BaseRootModelType {
-  return (
-    isStateTreeNode(thing) &&
-    'session' in thing &&
-    'jbrowse' in thing &&
-    'assemblyManager' in thing
-  )
-}

package/src/RootModel/InternetAccounts.ts

@@ -1,126 +0,0 @@
-import PluginManager from '@jbrowse/core/PluginManager'
-import { AnyConfigurationModel } from '@jbrowse/core/configuration'
-import { UriLocation } from '@jbrowse/core/util'
-import { autorun } from 'mobx'
-import { Instance, addDisposer, types } from 'mobx-state-tree'
-import { BaseRootModel } from './BaseRootModel'
-
-/**
- * #stateModel InternetAccountsMixin
- * #category root
- */
-export function InternetAccountsRootModelMixin(pluginManager: PluginManager) {
-  return types
-    .model({
-      /**
-       * #property
-       */
-      internetAccounts: types.array(
-        pluginManager.pluggableMstType('internet account', 'stateModel'),
-      ),
-    })
-    .actions(self => ({
-      /**
-       * #action
-       */
-      initializeInternetAccount(
-        internetAccountConfig: AnyConfigurationModel,
-        initialSnapshot = {},
-      ) {
-        const internetAccountType = pluginManager.getInternetAccountType(
-          internetAccountConfig.type,
-        )
-        if (!internetAccountType) {
-          throw new Error(
-            `unknown internet account type ${internetAccountConfig.type}`,
-          )
-        }
-
-        const length = self.internetAccounts.push({
-          ...initialSnapshot,
-          type: internetAccountConfig.type,
-          configuration: internetAccountConfig,
-        })
-        return self.internetAccounts[length - 1]
-      },
-
-      /**
-       * #action
-       */
-      createEphemeralInternetAccount(
-        internetAccountId: string,
-        initialSnapshot = {},
-        url: string,
-      ) {
-        let hostUri
-
-        try {
-          hostUri = new URL(url).origin
-        } catch (e) {
-          // ignore
-        }
-        // id of a custom new internaccount is `${type}-${name}`
-        const internetAccountSplit = internetAccountId.split('-')
-        const configuration = {
-          type: internetAccountSplit[0],
-          internetAccountId: internetAccountId,
-          name: internetAccountSplit.slice(1).join('-'),
-          description: '',
-          domains: hostUri ? [hostUri] : [],
-        }
-        const type = pluginManager.getInternetAccountType(configuration.type)
-        const internetAccount = type.stateModel.create({
-          ...initialSnapshot,
-          type: configuration.type,
-          configuration,
-        })
-        self.internetAccounts.push(internetAccount)
-        return internetAccount
-      },
-      /**
-       * #action
-       */
-      findAppropriateInternetAccount(location: UriLocation) {
-        // find the existing account selected from menu
-        const selectedId = location.internetAccountId
-        if (selectedId) {
-          const selectedAccount = self.internetAccounts.find(account => {
-            return account.internetAccountId === selectedId
-          })
-          if (selectedAccount) {
-            return selectedAccount
-          }
-        }
-
-        // if no existing account or not found, try to find working account
-        for (const account of self.internetAccounts) {
-          const handleResult = account.handlesLocation(location)
-          if (handleResult) {
-            return account
-          }
-        }
-
-        // if still no existing account, create ephemeral config to use
-        return selectedId
-          ? this.createEphemeralInternetAccount(selectedId, {}, location.uri)
-          : null
-      },
-    }))
-    .actions(self => ({
-      afterCreate() {
-        addDisposer(
-          self,
-          autorun(() => {
-            const { jbrowse } = self as typeof self & BaseRootModel
-            jbrowse.internetAccounts.forEach(self.initializeInternetAccount)
-          }),
-        )
-      },
-    }))
-}
-
-export type RootModelWithInternetAccountsType = ReturnType<
-  typeof InternetAccountsRootModelMixin
->
-export type RootModelWithInternetAccounts =
-  Instance<RootModelWithInternetAccountsType>

package/src/RootModel/index.ts

@@ -1,2 +0,0 @@
-export * from './BaseRootModel'
-export * from './InternetAccounts'

package/src/Session/BaseSession.ts

@@ -1,129 +0,0 @@
-import shortid from 'shortid'
-import PluginManager from '@jbrowse/core/PluginManager'
-import {
-  IAnyStateTreeNode,
-  Instance,
-  getParent,
-  isStateTreeNode,
-  types,
-} from 'mobx-state-tree'
-import { AnyConfigurationSchemaType } from '@jbrowse/core/configuration'
-import { BaseAssemblyConfigSchema } from '@jbrowse/core/assemblyManager'
-
-// locals
-import type { BaseRootModelType } from '../RootModel/BaseRootModel'
-
-/**
- * #stateModel BaseSessionModel
- * base session shared by **all** JBrowse products. Be careful what you include
- * here, everything will use it.
- */
-export function BaseSessionModel<
-  ROOT_MODEL_TYPE extends BaseRootModelType,
-  JB_CONFIG_SCHEMA extends AnyConfigurationSchemaType,
->(pluginManager: PluginManager) {
-  return types
-    .model({
-      /**
-       * #property
-       */
-      id: types.optional(types.identifier, shortid()),
-      /**
-       * #property
-       */
-      name: types.string,
-      /**
-       * #property
-       */
-      margin: 0,
-    })
-    .volatile(() => ({
-      /**
-       * #volatile
-       * this is the globally "selected" object. can be anything. code that
-       * wants to deal with this should examine it to see what kind of thing it
-       * is.
-       */
-      selection: undefined as unknown,
-    }))
-    .views(self => ({
-      get root() {
-        return getParent<ROOT_MODEL_TYPE>(self)
-      },
-    }))
-    .views(self => ({
-      /**
-       * #getter
-       */
-      get jbrowse() {
-        return self.root.jbrowse
-      },
-      /**
-       * #getter
-       */
-      get rpcManager() {
-        return self.root.rpcManager
-      },
-      /**
-       * #getter
-       */
-      get configuration(): Instance<JB_CONFIG_SCHEMA> {
-        return this.jbrowse.configuration
-      },
-      /**
-       * #getter
-       */
-      get adminMode() {
-        return self.root.adminMode
-      },
-
-      /**
-       * #getter
-       */
-      get textSearchManager() {
-        return self.root.textSearchManager
-      },
-    }))
-    .views(self => ({
-      /**
-       * #getter
-       */
-      get assemblies(): Instance<BaseAssemblyConfigSchema>[] {
-        return self.jbrowse.assemblies
-      },
-    }))
-    .actions(self => ({
-      /**
-       * #action
-       * set the global selection, i.e. the globally-selected object. can be a
-       * feature, a view, just about anything
-       */
-      setSelection(thing: unknown) {
-        self.selection = thing
-      },
-
-      /**
-       * #action
-       * clears the global selection
-       */
-      clearSelection() {
-        self.selection = undefined
-      },
-    }))
-}
-
-/** Session mixin MST type for the most basic session */
-export type BaseSessionType = ReturnType<typeof BaseSessionModel>
-
-/** Instance of the most basic possible session */
-export type BaseSession = Instance<BaseSessionType>
-
-/** Type guard for BaseSession */
-export function isBaseSession(thing: IAnyStateTreeNode): thing is BaseSession {
-  return 'id' in thing && 'name' in thing && 'root' in thing
-}
-
-/** Type guard for whether a thing is JBrowse session */
-export function isSession(thing: unknown): thing is BaseSession {
-  return isStateTreeNode(thing) && isBaseSession(thing)
-}