remnantchat/src/Bootstrap.tsx
Jeremy Kahn 6cbfaacf1a
feat(verification): [closes #209] Verified peers (#216)
* refactor(bootstrap): add BootstrapShim
* feat(security): [#209] generate public/private keys
* refactor(encryption): move encryption utils to a service
* feat(encryption): [wip] implement convertCryptoKeyToString
* fix(user-settings): serialize crypto keys to strings
* feat(user-settings): deserialize user settings from IndexedDB
* feat(user-settings): upgrade persisted settings on boot
* feat(user-settings): automatically migrate persisted user settings
* refactor(encryption): simplify CryptoKey stringification
* refactor(encryption): DRY up EncryptionService
* feat(verification): send public key to new peers
* refactor(encryption): use class instance
* refactor(serialization): use class instance
* refactor(verification): [wip] create usePeerVerification hook
* feat(verification): encrypt verification token
* feat(verification): send encrypted token to peer
* feat(verification): verify peer
* refactor(verification): use enum for verification state
* feat(verification): expire verification requests
* fix(updatePeer): update with fresh state data
* feat(verification): display verification state
* refactor(usePeerVerification): store verification timer in Peer
* feat(verification): present tooltips explaining verification state
* feat(ui): show full page loading indicator
* feat(init): present bootup failure reasons
* refactor(init): move init to its own file
* feat(verification): show errors upon verification failure
* refactor(verification): move workaround to usePeerVerification
* feat(verification): present peer public keys
* refactor(verification): move peer public key rendering to its own component
* refactor(verification): only pass publicKey into renderer
* feat(verification): show user's own public key
* refactor(naming): rename Username to UserInfo
* refactor(loading): encapsulate height styling
* feat(verification): improve user messaging
* refactor(style): improve formatting and variable names
* feat(verification): add user info tooltip
* docs(verification): explain verification
2023-12-09 17:47:05 -06:00

267 lines
7.7 KiB
TypeScript

import { useCallback, useEffect, useMemo, useState } from 'react'
import {
BrowserRouter as Router,
Routes,
Route,
Navigate,
} from 'react-router-dom'
import localforage from 'localforage'
import * as serviceWorkerRegistration from 'serviceWorkerRegistration'
import { StorageContext } from 'contexts/StorageContext'
import { SettingsContext } from 'contexts/SettingsContext'
import { homepageUrl, routes } from 'config/routes'
import { Home } from 'pages/Home'
import { About } from 'pages/About'
import { Disclaimer } from 'pages/Disclaimer'
import { Settings } from 'pages/Settings'
import { PublicRoom } from 'pages/PublicRoom'
import { PrivateRoom } from 'pages/PrivateRoom'
import { UserSettings } from 'models/settings'
import { PersistedStorageKeys } from 'models/storage'
import { QueryParamKeys } from 'models/shell'
import { Shell } from 'components/Shell'
import { WholePageLoading } from 'components/Loading/Loading'
import {
isConfigMessageEvent,
PostMessageEvent,
PostMessageEventName,
} from 'models/sdk'
import {
serializationService as serializationServiceInstance,
SerializedUserSettings,
} from 'services/Serialization'
export interface BootstrapProps {
persistedStorage?: typeof localforage
initialUserSettings: UserSettings
serializationService?: typeof serializationServiceInstance
}
const configListenerTimeout = 3000
const getConfigFromSdk = () => {
const queryParams = new URLSearchParams(window.location.search)
const { origin: parentFrameOrigin } = new URL(
decodeURIComponent(queryParams.get(QueryParamKeys.PARENT_DOMAIN) ?? '')
)
return new Promise<Partial<UserSettings>>((resolve, reject) => {
let expireTimout: NodeJS.Timeout
const expireListener = () => {
window.removeEventListener('message', handleMessage)
clearTimeout(expireTimout)
reject()
}
expireTimout = setTimeout(expireListener, configListenerTimeout)
const handleMessage = (event: MessageEvent) => {
if (!isConfigMessageEvent(event)) return
resolve(event.data.payload)
expireListener()
}
window.addEventListener('message', handleMessage)
const postMessageEvent: PostMessageEvent['data'] = {
name: PostMessageEventName.CONFIG_REQUESTED,
payload: {},
}
window.parent.postMessage(postMessageEvent, parentFrameOrigin)
})
}
export const Bootstrap = ({
persistedStorage: persistedStorageProp = localforage.createInstance({
name: 'chitchatter',
description: 'Persisted settings data for chitchatter',
}),
initialUserSettings,
serializationService = serializationServiceInstance,
}: BootstrapProps) => {
const queryParams = useMemo(
() => new URLSearchParams(window.location.search),
[]
)
const [persistedStorage] = useState(persistedStorageProp)
const [appNeedsUpdate, setAppNeedsUpdate] = useState(false)
const [hasLoadedSettings, setHasLoadedSettings] = useState(false)
const [userSettings, setUserSettings] =
useState<UserSettings>(initialUserSettings)
const { userId } = userSettings
const handleServiceWorkerUpdate = () => {
setAppNeedsUpdate(true)
}
const persistUserSettings = useCallback(
async (newUserSettings: UserSettings) => {
if (queryParams.has(QueryParamKeys.IS_EMBEDDED)) {
return Promise.resolve(userSettings)
}
const userSettingsForIndexedDb =
await serializationService.serializeUserSettings(newUserSettings)
return persistedStorageProp.setItem(
PersistedStorageKeys.USER_SETTINGS,
userSettingsForIndexedDb
)
},
[persistedStorageProp, queryParams, serializationService, userSettings]
)
useEffect(() => {
serviceWorkerRegistration.register({ onUpdate: handleServiceWorkerUpdate })
}, [])
useEffect(() => {
;(async () => {
if (hasLoadedSettings) return
const serializedUserSettings = {
// NOTE: This migrates persisted user settings data to latest version
...(await serializationService.serializeUserSettings(
initialUserSettings
)),
...(await persistedStorageProp.getItem<SerializedUserSettings>(
PersistedStorageKeys.USER_SETTINGS
)),
}
const persistedUserSettings =
await serializationService.deserializeUserSettings(
serializedUserSettings
)
const computeUserSettings = async (): Promise<UserSettings> => {
if (queryParams.has(QueryParamKeys.GET_SDK_CONFIG)) {
try {
const configFromSdk = await getConfigFromSdk()
return {
...userSettings,
...persistedUserSettings,
...configFromSdk,
}
} catch (e) {
console.error(
'Chitchatter configuration from parent frame could not be loaded'
)
}
}
return {
...userSettings,
...persistedUserSettings,
}
}
const computedUserSettings = await computeUserSettings()
setUserSettings(computedUserSettings)
setHasLoadedSettings(true)
await persistUserSettings(computedUserSettings)
})()
}, [
hasLoadedSettings,
persistedStorageProp,
userSettings,
userId,
queryParams,
persistUserSettings,
serializationService,
initialUserSettings,
])
useEffect(() => {
const queryParams = new URLSearchParams(window.location.search)
if (!queryParams.has(QueryParamKeys.IS_EMBEDDED)) return
const handleConfigMessage = (event: MessageEvent) => {
if (!hasLoadedSettings) return
if (!isConfigMessageEvent(event)) return
const overrideConfig: Partial<UserSettings> = event.data.payload
setUserSettings({
...userSettings,
...overrideConfig,
})
}
window.addEventListener('message', handleConfigMessage)
return () => {
window.removeEventListener('message', handleConfigMessage)
}
}, [hasLoadedSettings, userSettings])
const settingsContextValue = {
updateUserSettings: async (changedSettings: Partial<UserSettings>) => {
const newSettings = {
...userSettings,
...changedSettings,
}
await persistUserSettings(newSettings)
setUserSettings(newSettings)
},
getUserSettings: () => ({ ...userSettings }),
}
const storageContextValue = {
getPersistedStorage: () => persistedStorage,
}
return (
<Router basename={homepageUrl.pathname}>
<StorageContext.Provider value={storageContextValue}>
<SettingsContext.Provider value={settingsContextValue}>
{hasLoadedSettings ? (
<Shell appNeedsUpdate={appNeedsUpdate} userPeerId={userId}>
<Routes>
{[routes.ROOT, routes.INDEX_HTML].map(path => (
<Route
key={path}
path={path}
element={<Home userId={userId} />}
/>
))}
<Route path={routes.ABOUT} element={<About />} />
<Route path={routes.DISCLAIMER} element={<Disclaimer />} />
<Route
path={routes.SETTINGS}
element={<Settings userId={userId} />}
/>
<Route
path={routes.PUBLIC_ROOM}
element={<PublicRoom userId={userId} />}
/>
<Route
path={routes.PRIVATE_ROOM}
element={<PrivateRoom userId={userId} />}
/>
<Route
path="*"
element={<Navigate to={routes.ROOT} replace />}
/>
</Routes>
</Shell>
) : (
<WholePageLoading />
)}
</SettingsContext.Provider>
</StorageContext.Provider>
</Router>
)
}