Backport SW API changes without service worker (#2137)

* Backport SW API changes without service worker

* PR feedback

* Feedback #2

* Feedback #3

* Feedback #4

* Feedback #5

* Feedback #6 (revert removing getters)

* Feedback #7

* Feedback #8

* Queue login logout

* Bugfix: wrong commit event

* Fix voting by adding await

* Documentation & bugfixes

* Remove state/vuex/_private/save

* Bugfixes

* Add logoutInProgress check to prevent saving Chelonia state after a session ended

* Add comment to DELETED_CHATROOM; remove Vue from contracts

* Remove debug logging

frontend/controller/actions/README.md

@@ -0,0 +1,15 @@
+The files in this directory define selectors under the `gi.actions` domain.
+
+The `gi.actions` domain is used for operations that
+_execute in the same context as Chelonia_, which may be a _browsing context_
+(e.g., a tab window), but it could also be something like a service worker.
+**Operations that affect the overall application state, regardless of the UI state in a specific tab or window genrally belong under `gi.actions`**.
+
+When using a service worker, calls to these selectors will be forwarded from
+browsing contexts using a star selector (i.e., `gi.actions/*`).
+
+The operations under this domain, `gi.actions`, will usually be called from
+contracts, other selectors under `gi.actions` and other selectors under `gi.app`.
+
+For an explanation about `gi.app` and a worked example of where a selector
+belongs, see the [`README.md` file there](../app/README.md).

frontend/controller/actions/chatroom.js

@@ -4,7 +4,7 @@ import sbp from '@sbp/sbp'
 import { GIErrorUIRuntimeError, L } from '@common/common.js'
 import { has, omit } from '@model/contracts/shared/giLodash.js'
 import { GIMessage } from '~/shared/domains/chelonia/GIMessage.js'
-import { findKeyIdByName } from '~/shared/domains/chelonia/utils.js'
+import { Secret } from '~/shared/domains/chelonia/Secret.js'
 import { encryptedOutgoingData, encryptedOutgoingDataWithRawKey } from '~/shared/domains/chelonia/encryptedData.js'
 // Using relative path to crypto.js instead of ~-path to workaround some esbuild bug
 import { CURVE25519XSALSA20POLY1305, EDWARDS25519SHA512BATCH, deserializeKey, keyId, keygen, serializeKey } from '../../../shared/domains/chelonia/crypto.js'
@@ -63,12 +63,12 @@ export default (sbp('sbp/selectors/register', {
       }
 
       // Before creating the contract, put all keys into transient store
-      sbp('chelonia/storeSecretKeys',
+      await sbp('chelonia/storeSecretKeys',
         // $FlowFixMe[incompatible-use]
-        () => [cekOpts._rawKey, cskOpts._rawKey].map(key => ({ key, transient: true }))
+        new Secret([cekOpts._rawKey, cskOpts._rawKey].map(key => ({ key, transient: true })))
       )
 
-      const userCSKid = findKeyIdByName(rootState[userID], 'csk')
+      const userCSKid = await sbp('chelonia/contract/currentKeyIdByName', userID, 'csk')
       if (!userCSKid) throw new Error('User CSK id not found')
 
       const SAK = keygen(EDWARDS25519SHA512BATCH)
@@ -160,9 +160,9 @@ export default (sbp('sbp/selectors/register', {
       })
 
       // After the contract has been created, store pesistent keys
-      sbp('chelonia/storeSecretKeys',
+      await sbp('chelonia/storeSecretKeys',
         // $FlowFixMe[incompatible-use]
-        () => [cekOpts._rawKey, cskOpts._rawKey].map(key => ({ key }))
+        new Secret([cekOpts._rawKey, cskOpts._rawKey].map(key => ({ key })))
       )
 
       return chatroom
@@ -178,11 +178,11 @@ export default (sbp('sbp/selectors/register', {
     const originatingContractID = state.attributes.groupContractID ? state.attributes.groupContractID : contractID
 
     // $FlowFixMe
-    return Promise.all(Object.keys(state.members).map((pContractID) => {
-      const CEKid = findKeyIdByName(rootState[pContractID], 'cek')
+    return Promise.all(Object.keys(state.members).map(async (pContractID) => {
+      const CEKid = await sbp('chelonia/contract/currentKeyIdByName', pContractID, 'cek')
       if (!CEKid) {
         console.warn(`Unable to share rotated keys for ${originatingContractID} with ${pContractID}: Missing CEK`)
-        return Promise.resolve()
+        return
       }
       return {
         contractID,
@@ -221,7 +221,7 @@ export default (sbp('sbp/selectors/register', {
       throw new Error(`Unable to send gi.actions/chatroom/join on ${params.contractID} because user ID contract ${userID} is missing`)
     }
 
-    const CEKid = params.encryptionKeyId || sbp('chelonia/contract/currentKeyIdByName', params.contractID, 'cek')
+    const CEKid = params.encryptionKeyId || await sbp('chelonia/contract/currentKeyIdByName', params.contractID, 'cek')
 
     const userCSKid = sbp('chelonia/contract/currentKeyIdByName', userID, 'csk')
     return await sbp('chelonia/out/atomic', {
@@ -253,7 +253,7 @@ export default (sbp('sbp/selectors/register', {
   ...encryptedAction('gi.actions/chatroom/changeDescription', L('Failed to change chat channel description.')),
   ...encryptedAction('gi.actions/chatroom/leave', L('Failed to leave chat channel.'), async (sendMessage, params, signingKeyId) => {
     const userID = params.data.memberID
-    const keyIds = userID && sbp('chelonia/contract/foreignKeysByContractID', params.contractID, userID)
+    const keyIds = userID && await sbp('chelonia/contract/foreignKeysByContractID', params.contractID, userID)
 
     if (keyIds?.length) {
       return await sbp('chelonia/out/atomic', {

frontend/controller/actions/group-kv.js

@@ -5,8 +5,8 @@ import { KV_QUEUE } from '~/frontend/utils/events.js'
 
 export default (sbp('sbp/selectors/register', {
   'gi.actions/group/kv/updateLastLoggedIn': async ({ contractID }: { contractID: string }) => {
-    const { ourIdentityContractId } = sbp('state/vuex/getters')
-    if (!ourIdentityContractId) {
+    const identityContractID = sbp('chelonia/rootState').loggedIn?.identityContractID
+    if (!identityContractID) {
       throw new Error('Unable to update lastLoggedIn without an active session')
     }
 
@@ -17,13 +17,13 @@ export default (sbp('sbp/selectors/register', {
     return sbp('okTurtles.eventQueue/queueEvent', KV_QUEUE, async () => {
       const getUpdatedLastLoggedIn = async (cID, key) => {
         const current = (await sbp('chelonia/kv/get', cID, key))?.data || {}
-        return { ...current, [ourIdentityContractId]: now }
+        return { ...current, [identityContractID]: now }
       }
 
       const data = await getUpdatedLastLoggedIn(contractID, KV_KEYS.LAST_LOGGED_IN)
       await sbp('chelonia/kv/set', contractID, KV_KEYS.LAST_LOGGED_IN, data, {
-        encryptionKeyId: sbp('chelonia/contract/currentKeyIdByName', contractID, 'cek'),
-        signingKeyId: sbp('chelonia/contract/currentKeyIdByName', contractID, 'csk'),
+        encryptionKeyId: await sbp('chelonia/contract/currentKeyIdByName', contractID, 'cek'),
+        signingKeyId: await sbp('chelonia/contract/currentKeyIdByName', contractID, 'csk'),
         onconflict: getUpdatedLastLoggedIn
       })
     })