switch direct smuggler access to StorageApi (#393)

Author: SergNikitin

archaeologist/src/background.ts

@@ -31,6 +31,7 @@ import {
   UserExternalPipelineId,
   NodeCreatedVia,
   UserExternalPipelineIngestionProgress,
+  StorageApi,
 } from 'smuggler-api'
 
 import { isReadyToBeAutoSaved } from './background/pageAutoSaving'
@@ -67,13 +68,14 @@ async function requestPageConnections(bookmark?: TNode) {
   }
   try {
     // Fetch all edges for a given node
-    const { from_edges: fromEdges, to_edges: toEdges } =
-      await smuggler.edge.get(bookmark.nid)
+    const { from_edges: fromEdges, to_edges: toEdges } = await storage.edge.get(
+      bookmark.nid
+    )
     // Gather node IDs of neighbour nodes to reqeust them
     const nids = fromEdges
       .map((edge) => edge.from_nid)
       .concat(toEdges.map((edge) => edge.to_nid))
-    const { nodes } = await smuggler.node.batch.get({ nids })
+    const { nodes } = await storage.node.batch.get({ nids })
     // Sort neighbour nodes out
     fromNodes = nodes.filter(
       (node) => fromEdges.findIndex((edge) => edge.from_nid === node.nid) !== -1
@@ -96,7 +98,7 @@ async function requestPageSavedStatus(url: string | undefined) {
   }
   let nodes
   try {
-    nodes = await smuggler.node.lookup({ url })
+    nodes = await storage.node.lookup({ url })
   } catch (err) {
     log.debug('Lookup by origin ID failed, consider page as non saved', err)
     return { unmemorable: false }
@@ -154,7 +156,7 @@ async function registerAttentionTime(
   log.debug('Register Attention Time', tab, totalSecondsEstimation)
   let total: TotalUserActivity
   try {
-    total = await smuggler.activity.external.add(
+    total = await storage.activity.external.add(
       { id: origin.id },
       {
         attention: {
@@ -182,7 +184,16 @@ async function registerAttentionTime(
     }
     const { url, content, originId, quoteNids } = response
     const createdVia: NodeCreatedVia = { autoAttentionTracking: null }
-    await saveWebPage(url, originId, quoteNids, [], createdVia, content, tab.id)
+    await saveWebPage(
+      storage,
+      url,
+      originId,
+      quoteNids,
+      [],
+      createdVia,
+      content,
+      tab.id
+    )
   }
 }
 
@@ -406,7 +417,7 @@ async function handleMessageFromContent(
       return { type: 'VOID_RESPONSE' }
     }
     case 'DELETE_PREVIOUSLY_UPLOADED_BROWSER_HISTORY': {
-      const numDeleted = await smuggler.node.bulkDelete({
+      const numDeleted = await storage.node.bulkDelete({
         createdVia: {
           autoIngestion: idOfBrowserHistoryOnThisDeviceAsExternalPipeline(),
         },
@@ -417,7 +428,11 @@ async function handleMessageFromContent(
       }
     }
     case 'REQUEST_SUGGESTED_CONTENT_ASSOCIATIONS': {
-      const suggested = await suggestAssociations(message.phrase, message.limit)
+      const suggested = await suggestAssociations(
+        storage,
+        message.phrase,
+        message.limit
+      )
       return {
         type: 'SUGGESTED_CONTENT_ASSOCIATIONS',
         suggested: suggested.map((node: TNode) => NodeUtil.toJson(node)),
@@ -481,14 +496,14 @@ async function uploadBrowserHistory(mode: BrowserHistoryUploadMode) {
   )
 
   const epid = idOfBrowserHistoryOnThisDeviceAsExternalPipeline()
-  const currentProgress = await smuggler.external.ingestion.get(epid)
+  const currentProgress = await storage.external.ingestion.get(epid)
 
   log.debug('Progress until now:', currentProgress)
 
   const advanceIngestionProgress = lodash.throttle(
     mode.mode !== 'untracked'
       ? async (date: Date) => {
-          return smuggler.external.ingestion.advance(epid, {
+          return storage.external.ingestion.advance(epid, {
             ingested_until: unixtime.from(date),
           })
         }
@@ -503,7 +518,7 @@ async function uploadBrowserHistory(mode: BrowserHistoryUploadMode) {
   // is already in the order from "pages that hasn't been visited the longest"
   // to "most recently visited". However `browser.history.search` doesn't seem
   // to provide any guarantees about it. Since logic which relies on
-  // `smuggler.thirdparty.fs.progress` would break under different ordering,
+  // `storage.thirdparty.fs.progress` would break under different ordering,
   // explicit sorting is added as a safeguard
   items.sort(sortWithOldestLastVisitAtEnd)
 
@@ -601,6 +616,7 @@ async function handleMessageFromPopup(
       const { url, content, originId, quoteNids } = response
       const createdVia: NodeCreatedVia = { manualAction: null }
       const { node, unmemorable } = await saveWebPage(
+        storage,
         url,
         originId,
         quoteNids,
@@ -659,7 +675,7 @@ async function uploadSingleHistoryItem(
   const resourceVisits: ResourceVisit[] = visits.map((visit) => {
     return { timestamp: unixtime.from(new Date(visit.visitTime ?? 0)) }
   })
-  const total = await smuggler.activity.external.add(origin, {
+  const total = await storage.activity.external.add(origin, {
     visit: { visits: resourceVisits, reported_by: epid },
   })
   if (!isReadyToBeAutoSaved(total, 0)) {
@@ -677,6 +693,7 @@ async function uploadSingleHistoryItem(
   const { url, content, originId, quoteNids } = response
   const createdVia: NodeCreatedVia = { autoIngestion: epid }
   await saveWebPage(
+    storage,
     url,
     originId,
     quoteNids,
@@ -844,6 +861,7 @@ browser.contextMenus.onClicked.addListener(
         const { url, text, path, lang, fromNid } = response
         const createdVia: NodeCreatedVia = { manualAction: null }
         await savePageQuote(
+          storage,
           { url, path, text },
           createdVia,
           lang,
@@ -859,8 +877,10 @@ browser.contextMenus.onClicked.addListener(
   }
 )
 
+const storage: StorageApi = smuggler
+
 auth.register()
-browserBookmarks.register()
-omnibox.register()
-webNavigation.register()
+browserBookmarks.register(storage)
+omnibox.register(storage)
+webNavigation.register(storage)
 backgroundpa.register()

archaeologist/src/background/savePage.ts

@@ -14,7 +14,7 @@ import {
   TNode,
   NodeUtil,
   makeEmptyNodeTextData,
-  smuggler,
+  StorageApi,
 } from 'smuggler-api'
 import { ToContent } from '../message/types'
 import { mazed } from '../util/mazed'
@@ -87,6 +87,7 @@ async function showDisappearingNotification(
 }
 
 async function _getOriginRelationNids(
+  storage: StorageApi,
   nids: Nid[],
   url?: string
 ): Promise<Nid[]> {
@@ -96,6 +97,7 @@ async function _getOriginRelationNids(
     const query = extractSearchEngineQuery(url)
     if (query != null) {
       const { nid } = await _saveWebSearchQuery(
+        storage,
         url,
         [],
         [],
@@ -109,6 +111,7 @@ async function _getOriginRelationNids(
 }
 
 export async function saveWebPage(
+  storage: StorageApi,
   url: string,
   originId: OriginHash,
   toNids: string[],
@@ -121,6 +124,7 @@ export async function saveWebPage(
   const searchEngineQuery = extractSearchEngineQuery(url)
   if (searchEngineQuery != null) {
     const node = await _saveWebSearchQuery(
+      storage,
       url,
       toNids,
       fromNids,
@@ -156,13 +160,14 @@ export async function saveWebPage(
     },
     blob: undefined,
   }
-  const originTransitions = await smuggler.activity.association.get({
+  const originTransitions = await storage.activity.association.get({
     origin: { id: originId },
   })
   log.debug('Gather transitions', originTransitions)
   for (const association of originTransitions.to) {
     if ('web_transition' in association.association) {
       const nids = await _getOriginRelationNids(
+        storage,
         association.to.nids,
         association.association.web_transition.to_url
       )
@@ -174,6 +179,7 @@ export async function saveWebPage(
   for (const association of originTransitions.from) {
     if ('web_transition' in association.association) {
       const nids = await _getOriginRelationNids(
+        storage,
         association.from.nids,
         association.association.web_transition.from_url
       )
@@ -182,7 +188,7 @@ export async function saveWebPage(
       }
     }
   }
-  const resp = await smuggler.node.create({
+  const resp = await storage.node.create({
     text,
     index_text,
     extattrs,
@@ -200,7 +206,7 @@ export async function saveWebPage(
   await badge.setStatus(tabId, ACTION_DONE_BADGE_MARKER)
 
   const { nid } = resp
-  const node = await smuggler.node.get({ nid })
+  const node = await storage.node.get({ nid })
   await updateContent([], [], node, tabId)
   await showDisappearingNotification(tabId, {
     text: 'Added',
@@ -211,6 +217,7 @@ export async function saveWebPage(
 }
 
 export async function savePageQuote(
+  storage: StorageApi,
   { url, path, text }: NodeExtattrsWebQuote,
   createdVia: NodeCreatedVia,
   lang?: string,
@@ -222,7 +229,7 @@ export async function savePageQuote(
     lang: lang || undefined,
     web_quote: { url, path, text },
   }
-  const resp = await smuggler.node.create({
+  const resp = await storage.node.create({
     text: makeEmptyNodeTextData(),
     ntype: NodeType.WebQuote,
     from_nid: fromNid ? [fromNid] : undefined,
@@ -233,12 +240,13 @@ export async function savePageQuote(
     // Update badge counter
     await badge.setStatus(tabId, ACTION_DONE_BADGE_MARKER)
     const { nid } = resp
-    const node = await smuggler.node.get({ nid })
+    const node = await storage.node.get({ nid })
     await updateContent([], [node], undefined, tabId)
   }
 }
 
 async function _saveWebSearchQuery(
+  storage: StorageApi,
   url: string,
   toNids: string[],
   fromNids: string[],
@@ -261,7 +269,7 @@ async function _saveWebSearchQuery(
     preview_image: icon ? { data: icon } : undefined,
     web: { url },
   }
-  const resp = await smuggler.node.create({
+  const resp = await storage.node.create({
     text,
     index_text,
     extattrs,
@@ -273,6 +281,6 @@ async function _saveWebSearchQuery(
     from_nid: fromNids,
   })
   const { nid } = resp
-  const node = await smuggler.node.get({ nid })
+  const node = await storage.node.get({ nid })
   return node
 }

archaeologist/src/background/suggestAssociations.ts

@@ -1,13 +1,13 @@
-import { smuggler } from 'smuggler-api'
-import type { TNode } from 'smuggler-api'
+import type { TNode, StorageApi } from 'smuggler-api'
 import { Beagle } from 'elementary'
 
 export async function suggestAssociations(
+  storage: StorageApi,
   phrase: string,
   limit?: number
 ): Promise<TNode[]> {
   const beagle = Beagle.fromString(phrase)
-  const iter = smuggler.node.slice({})
+  const iter = storage.node.slice({})
   const suggested: TNode[] = []
   limit = limit ?? 8
   // FIXME(akindyakov): This is a dirty hack to limit time of search by limiting

archaeologist/src/browser-bookmarks/bookmarks.ts

@@ -2,9 +2,10 @@ import browser from 'webextension-polyfill'
 import { log } from 'armoury'
 import { FromContent, ToContent } from '../message/types'
 import { saveWebPage } from '../background/savePage'
-import { NodeCreatedVia } from 'smuggler-api'
+import { NodeCreatedVia, StorageApi } from 'smuggler-api'
 
 async function onCreatedEventListener(
+  storage: StorageApi,
   id: string,
   bookmark: browser.Bookmarks.BookmarkTreeNode
 ): Promise<void> {
@@ -28,7 +29,15 @@ async function onCreatedEventListener(
     }
     const { url: stableUrl, content, originId, quoteNids } = response
     const createdVia: NodeCreatedVia = { manualAction: null }
-    await saveWebPage(stableUrl, originId, quoteNids, [], createdVia, content)
+    await saveWebPage(
+      storage,
+      stableUrl,
+      originId,
+      quoteNids,
+      [],
+      createdVia,
+      content
+    )
   }
 }
 
@@ -38,9 +47,11 @@ async function onCreatedEventListener(
  * Add listeners for:
  *  - created naitive bookmark
  */
-export function register() {
-  browser.bookmarks.onCreated.addListener(onCreatedEventListener)
+export function register(storage: StorageApi) {
+  const callback = (id: string, bookmark: browser.Bookmarks.BookmarkTreeNode) =>
+    onCreatedEventListener(storage, id, bookmark)
+  browser.bookmarks.onCreated.addListener(callback)
   return () => {
-    browser.bookmarks.onCreated.removeListener(onCreatedEventListener)
+    browser.bookmarks.onCreated.removeListener(callback)
   }
 }

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 } from 'smuggler-api'
+import { NodeUtil, NodeType, smuggler } 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'
@@ -389,7 +389,9 @@ const App = () => {
     ) : null
   return (
     <AppErrorBoundary>
-      <ContentContext.Provider value={{ analytics: state.analytics }}>
+      <ContentContext.Provider
+        value={{ analytics: state.analytics, storage: smuggler }}
+      >
         <BrowserHistoryImportControlPortal
           progress={state.browserHistoryUploadProgress}
         />