add POC msg-based truthsayer->archaeologist comms (#381)

Author: SergNikitin

archaeologist/package.json

@@ -63,6 +63,7 @@
     "react-helmet": "^6.1.0",
     "react-shadow": "^19.0.3",
     "smuggler-api": "0.0.1",
+    "truthsayer-archaeologist-communication": "0.0.1",
     "ts-loader": "^8.3.0",
     "ts-node": "^9.1.1",
     "typescript": "4.1.3",

archaeologist/public/manifest.json

@@ -57,5 +57,9 @@
   ],
   "omnibox": {
     "keyword": "//"
+  },
+  "externally_connectable": {
+    "ids": [],
+    "matches": []
   }
 }

archaeologist/src/background.ts

@@ -17,6 +17,10 @@ import {
 import * as badge from './badge/badge'
 
 import browser, { Tabs } from 'webextension-polyfill'
+import {
+  FromTruthsayer,
+  ToTruthsayer,
+} from 'truthsayer-archaeologist-communication'
 import { log, isAbortError, genOriginId, unixtime } from 'armoury'
 import {
   TNode,
@@ -707,6 +711,26 @@ browser.runtime.onMessage.addListener(
   }
 )
 
+browser.runtime.onMessageExternal.addListener(
+  async (
+    message: FromTruthsayer.Request,
+    _: browser.Runtime.MessageSender
+  ): Promise<ToTruthsayer.Response> => {
+    switch (message.type) {
+      case 'DUMMY_REQUEST': {
+        return { type: 'VOID_RESPONSE' }
+      }
+      default: {
+        throw new Error(
+          `background received msg from truthsayer of unknown type, message: ${JSON.stringify(
+            message
+          )}`
+        )
+      }
+    }
+  }
+)
+
 // NOTE: on more complex web-pages onUpdated may be invoked multiple times
 // with exactly the same input parameters. So the handling code has to
 // be able to handle that.

archaeologist/src/content/App.tsx

@@ -7,7 +7,7 @@ import { v4 as uuidv4 } from 'uuid'
 
 import { TNode, TNodeJson, NodeType } from 'smuggler-api'
 import { genOriginId, OriginIdentity, log, productanalytics } from 'armoury'
-import { truthsayer_archaeologist_communication } from 'elementary'
+import * as truthsayer_archaeologist_communication from 'truthsayer-archaeologist-communication'
 
 import { mazed } from '../util/mazed'
 
@@ -390,7 +390,7 @@ const App = () => {
         <BrowserHistoryImportControlPortal
           progress={state.browserHistoryUploadProgress}
         />
-        <truthsayer_archaeologist_communication.ArchaeologistVersion
+        <truthsayer_archaeologist_communication.archaeologist.ArchaeologistVersion
           version={{
             version: browser.runtime.getManifest().version,
           }}

archaeologist/src/content/BrowserHistoryImportControl.tsx

@@ -3,13 +3,8 @@ import ReactDOM from 'react-dom'
 import styled from '@emotion/styled'
 import lodash from 'lodash'
 
-import {
-  truthsayer_archaeologist_communication,
-  MdiCancel,
-  MdiCloudUpload,
-  MdiDelete,
-  Spinner,
-} from 'elementary'
+import { MdiCancel, MdiCloudUpload, MdiDelete, Spinner } from 'elementary'
+import * as truthsayer_archaeologist_communication from 'truthsayer-archaeologist-communication'
 import {
   FromContent,
   BrowserHistoryUploadProgress,

archaeologist/src/message/types.ts

@@ -5,7 +5,7 @@ import { OriginHash, TNodeJson } from 'smuggler-api'
 import { OriginIdentity } from 'armoury'
 
 /**
- * There are 3 kind of message senders/receivers:
+ * There are 3 kinds of message senders/receivers:
  *   - popup
  *   - content (all browser tabs)
  *   - background
@@ -17,11 +17,20 @@ import { OriginIdentity } from 'armoury'
  *   - `ToContent` - from background to content (any of the tabs)
  *   - `FromContent` - from content (any tab) to background
  *
+ * Additionally, truthsayer can communicate with background.
+ * @see FromTruthsayer outside of this module for that.
+ *
  *   ┌───────┐       ┌────────────┐       ┌─────────┐
  *   │ popup │  ──▷  │ background │  ──▷  │ content │─┐
  *   └───────┘  ◁──  └────────────┘  ◁──  └───(#1)──┘ │─┐
- *                                          └───(#2)──┘ │
- *                                            └───(#3)──┘
+ *                         ^                 └───(#2)──┘ │
+ *                         :                   └───(#3)──┘
+ *                         :
+ *                 ◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦
+ *                 ◦    truthsayer   ◦
+ *                 ◦  (outside this  ◦
+ *                 ◦     module)     ◦
+ *                 ◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦◦
  */
 
 export interface VoidResponse {

archaeologist/webpack.config.js

@@ -3,6 +3,16 @@ const path = require("path");
 const CopyPlugin = require("copy-webpack-plugin");
 const TerserPlugin = require('terser-webpack-plugin');
 
+const _getTruthsayerUrl = (mode) => {
+  return mode === 'development' ? 'http://localhost:3000' : 'https://mazed.se/'
+}
+
+const _getTruthsayerUrlMask = (mode) => {
+  const url = new URL(_getTruthsayerUrl(mode))
+  url.pathname = '*'
+  return url.toString()
+}
+
 const _getSmugglerApiUrl = (mode) => {
   return mode === 'development'
     ? "http://localhost:3000"
@@ -47,6 +57,11 @@ const _manifestTransform = (buffer, mode, env) => {
   // Add Mazed URL to host_permissions to grant access to mazed cookies
   const smugglerApiUrlMask = _getSmugglerApiUrlMask(mode)
   manifest.host_permissions.push(smugglerApiUrlMask)
+  // Add Mazed URL to externally_connectable to allow to send messages
+  // from truthsayer to archaeologist.
+  // See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/externally_connectable
+  // for more details.
+  manifest.externally_connectable.matches.push(_getTruthsayerUrlMask(mode))
   if (firefox) {
     manifest = _manifestTransformDowngradeToV2(manifest)
   }

elementary/src/index.ts

@@ -58,6 +58,3 @@ export {
   kSlateBlockTypeQuote,
   kSlateBlockTypeUnorderedList,
 } from './editor/types'
-
-// The name is ugly on purpose - use with extra care
-export * as truthsayer_archaeologist_communication from './truthsayer-archaeologist-communication/index'

elementary/src/truthsayer-archaeologist-communication/Version.tsx

@@ -5,6 +5,7 @@
   "scripts": {
     "archaeologist": "yarn workspace archaeologist",
     "elementary": "yarn workspace elementary",
+    "truthsayer-archaeologist-communication": "yarn workspace truthsayer-archaeologist-communication",
     "armoury": "yarn workspace armoury",
     "fix": "yarn syncpack fix-mismatches && yarn workspaces foreach run fix",
     "fix:prettier": "yarn workspaces foreach run fix:prettier",
@@ -19,6 +20,7 @@
     "armoury",
     "elementary",
     "librarius",
+    "truthsayer-archaeologist-communication",
     "smuggler-api",
     "truthsayer"
   ],