replace StorageApi global var with a make fn (#394)

Author: SergNikitin

archaeologist/src/background.ts

@@ -27,7 +27,7 @@ import {
   NodeUtil,
   TotalUserActivity,
   ResourceVisit,
-  smuggler,
+  makeDatacenterStorageApi,
   UserExternalPipelineId,
   NodeCreatedVia,
   UserExternalPipelineIngestionProgress,
@@ -877,7 +877,7 @@ browser.contextMenus.onClicked.addListener(
   }
 )
 
-const storage: StorageApi = smuggler
+const storage: StorageApi = makeDatacenterStorageApi()
 
 auth.register()
 browserBookmarks.register(storage)

archaeologist/src/content/App.tsx

@@ -5,7 +5,7 @@ import browser from 'webextension-polyfill'
 import { PostHog } from 'posthog-js'
 import { v4 as uuidv4 } from 'uuid'
 
-import { NodeUtil, NodeType, smuggler } from 'smuggler-api'
+import { NodeUtil, NodeType, makeDatacenterStorageApi } from 'smuggler-api'
 import type { TNode, TNodeJson } from 'smuggler-api'
 import { genOriginId, OriginIdentity, log, productanalytics } from 'armoury'
 import * as truthsayer_archaeologist_communication from 'truthsayer-archaeologist-communication'
@@ -390,7 +390,10 @@ const App = () => {
   return (
     <AppErrorBoundary>
       <ContentContext.Provider
-        value={{ analytics: state.analytics, storage: smuggler }}
+        value={{
+          analytics: state.analytics,
+          storage: makeDatacenterStorageApi(),
+        }}
       >
         <BrowserHistoryImportControlPortal
           progress={state.browserHistoryUploadProgress}

archaeologist/src/popup/PopUpApp.tsx

@@ -15,7 +15,7 @@ import { mazed } from '../util/mazed'
 import { MdiLaunch } from 'elementary'
 import { productanalytics } from 'armoury'
 import { PopUpContext } from './context'
-import { smuggler } from 'smuggler-api'
+import { makeDatacenterStorageApi } from 'smuggler-api'
 
 const AppContainer = styled.div`
   width: 340px;
@@ -74,7 +74,7 @@ export const PopUpApp = () => {
 
   return (
     <AppContainer>
-      <PopUpContext.Provider value={{ storage: smuggler }}>
+      <PopUpContext.Provider value={{ storage: makeDatacenterStorageApi() }}>
         {state.userUid == null ? <LoginPage /> : <ViewActiveTabStatus />}
       </PopUpContext.Provider>
     </AppContainer>

smuggler-api/src/api_cloud.ts renamed to smuggler-api/src/api_datacenter.ts

@@ -1,6 +1,6 @@
 /**
- * Implementation of smuggler APIs like @see StorageApi which interact with a
- * cloud-hosted infrastructure to perform their job.
+ * Implementation of smuggler APIs like @see StorageApi which,  to perform their job,
+ * interact with an infrastructure hosted in Mazed's datacenter.
  */
 
 import {
@@ -233,7 +233,7 @@ async function lookupNodes(key: NodeLookupKey, signal?: AbortSignal) {
   } else if ('webBookmark' in key) {
     const { id, stableUrl } = genOriginId(key.webBookmark.url)
     const query = { ...SLICE_ALL, origin: { id } }
-    const iter = smuggler.node.slice(query)
+    const iter = _getNodesSliceIter(query)
 
     for (let node = await iter.next(); node != null; node = await iter.next()) {
       const nodeUrl = node.extattrs?.web?.url
@@ -245,7 +245,7 @@ async function lookupNodes(key: NodeLookupKey, signal?: AbortSignal) {
   } else if ('webQuote' in key) {
     const { id, stableUrl } = genOriginId(key.webQuote.url)
     const query = { ...SLICE_ALL, origin: { id } }
-    const iter = smuggler.node.slice(query)
+    const iter = _getNodesSliceIter(query)
 
     const nodes: TNode[] = []
     for (let node = await iter.next(); node != null; node = await iter.next()) {
@@ -261,7 +261,7 @@ async function lookupNodes(key: NodeLookupKey, signal?: AbortSignal) {
   } else if ('url' in key) {
     const { id, stableUrl } = genOriginId(key.url)
     const query = { ...SLICE_ALL, origin: { id } }
-    const iter = smuggler.node.slice(query)
+    const iter = _getNodesSliceIter(query)
 
     const nodes: TNode[] = []
     for (let node = await iter.next(); node != null; node = await iter.next()) {
@@ -957,62 +957,67 @@ function _makeResponseError(response: Response, message?: string): Error {
   })
 }
 
-export const smuggler: StorageApi & AuthenticationApi = {
-  getAuth,
-  node: {
-    get: getNode,
-    update: updateNode,
-    create: createNode,
-    createOrUpdate: createOrUpdateNode,
-    slice: _getNodesSliceIter,
-    lookup: lookupNodes,
-    delete: deleteNode,
-    bulkDelete: bulkDeleteNodes,
-    batch: {
-      /**
-       * Caution: these methods are not cached
-       */
-      get: getNodeBatch,
+export function makeDatacenterStorageApi(): StorageApi {
+  return {
+    node: {
+      get: getNode,
+      update: updateNode,
+      create: createNode,
+      createOrUpdate: createOrUpdateNode,
+      slice: _getNodesSliceIter,
+      lookup: lookupNodes,
+      delete: deleteNode,
+      bulkDelete: bulkDeleteNodes,
+      batch: {
+        /**
+         * Caution: these methods are not cached
+         */
+        get: getNodeBatch,
+      },
+      url: makeDirectUrl,
     },
-    url: makeDirectUrl,
-  },
-  blob: {
-    upload: uploadFiles,
-    sourceUrl: makeBlobSourceUrl,
-  },
-  blob_index: {
-    build: buildFilesSearchIndex,
-    cfg: {
-      supportsMime: mimeTypeIsSupportedByBuildIndex,
+    blob: {
+      upload: uploadFiles,
+      sourceUrl: makeBlobSourceUrl,
     },
-  },
-  edge: {
-    create: createEdge,
-    get: getNodeAllEdges,
-    sticky: switchEdgeStickiness,
-    delete: deleteEdge,
-  },
+    blob_index: {
+      build: buildFilesSearchIndex,
+      cfg: {
+        supportsMime: mimeTypeIsSupportedByBuildIndex,
+      },
+    },
+    edge: {
+      create: createEdge,
+      get: getNodeAllEdges,
+      sticky: switchEdgeStickiness,
+      delete: deleteEdge,
+    },
+    activity: {
+      external: {
+        add: addExternalUserActivity,
+        get: getExternalUserActivity,
+      },
+      association: {
+        record: recordExternalAssociation,
+        get: getExternalAssociation,
+      },
+    },
+    external: {
+      ingestion: {
+        get: getUserIngestionProgress,
+        advance: advanceUserIngestionProgress,
+      },
+    },
+  }
+}
+
+export const authentication: AuthenticationApi = {
+  getAuth,
   session: {
     create: createSession,
     delete: deleteSession,
     update: updateSession,
   },
-  activity: {
-    external: {
-      add: addExternalUserActivity,
-      get: getExternalUserActivity,
-    },
-    association: {
-      record: recordExternalAssociation,
-      get: getExternalAssociation,
-    },
-  },
-  external: {
-    ingestion: {
-      get: getUserIngestionProgress,
-      advance: advanceUserIngestionProgress,
-    },
-  },
   user: {
     password: {
       recover: passwordRecoverRequest,

smuggler-api/src/auth/account.ts

@@ -1,4 +1,4 @@
-import { smuggler } from './../api_cloud'
+import { authentication } from '../api_datacenter'
 import { authCookie } from './cookie'
 import { AccountInterface } from './account_interface'
 import type { LocalCrypto } from './account_interface'
@@ -40,7 +40,7 @@ export class UserAccount extends AnonymousAccount {
   }
 
   static async create(signal?: AbortSignal): Promise<AccountInterface> {
-    const user = await smuggler.getAuth({ signal }).catch(() => {
+    const user = await authentication.getAuth({ signal }).catch(() => {
       return null
     })
     if (!user) {

smuggler-api/src/auth/knocker.ts

@@ -1,4 +1,4 @@
-import { smuggler, SmugglerError } from '../api_cloud'
+import { authentication, SmugglerError } from '../api_datacenter'
 import { StatusCode } from './../status_codes'
 import { authCookie } from './cookie'
 
@@ -106,7 +106,7 @@ export class Knocker {
       const now = unixtime.now()
       if (this.#knockingPeriodSeconds < now - lastUpdateTime) {
         log.debug('Knock-knock smuggler', now, lastUpdateTime)
-        await smuggler.session.update(this.#abortController.signal)
+        await authentication.session.update(this.#abortController.signal)
         this.setLastUpdate({ time: now })
 
         try {

smuggler-api/src/index.ts

@@ -8,5 +8,5 @@ export * from './node_slice_iterator'
 export * from './storage_api'
 export * from './storage_api_throwing'
 export * from './authentication_api'
-export { smuggler } from './api_cloud'
+export { authentication, makeDatacenterStorageApi } from './api_datacenter'
 export { steroid } from './steroid/steroid'

smuggler-api/src/steroid/node.ts

@@ -34,7 +34,7 @@ export type CreateNodeFromLocalBinaryArgs = {
 
 /**
  * Upload a local binary file as a *fully featured* Mazed node
- * (as opposed to, for example, @see smuggler.blob.upload that
+ * (as opposed to, for example, @see StorageApi.blob.upload that
  * at the time of this writing creates a node that *doesn't support some
  * Mazed features* like search index).
  */

truthsayer/src/account/create/Signup.tsx

@@ -11,7 +11,7 @@ import { goto, History, routes } from '../../lib/route'
 
 import { log } from 'armoury'
 
-import { smuggler } from 'smuggler-api'
+import { authentication } from 'smuggler-api'
 import { Link } from 'react-router-dom'
 
 type SignupProps = {
@@ -92,7 +92,7 @@ class SignupImpl extends React.Component<SignupProps, SignupState> {
     this.setState({
       errorMsg: undefined,
     })
-    smuggler.user
+    authentication.user
       .register({
         name: this.state.name,
         email: this.state.email,

truthsayer/src/auth/Login.js

@@ -8,7 +8,7 @@ import PropTypes from 'prop-types'
 import { css } from '@emotion/react'
 import { withRouter, Link } from 'react-router-dom'
 
-import { smuggler } from 'smuggler-api'
+import { authentication } from 'smuggler-api'
 import { goto } from '../lib/route'
 
 class Login extends React.Component {
@@ -54,7 +54,7 @@ class Login extends React.Component {
     })
     const { email, password } = this.state
     const permissions = null
-    smuggler.session
+    authentication.session
       .create(
         email,
         password,