+
Service Worker Tools:
diff --git a/src/components/modal/modals/SettingsModal.tsx b/src/components/modal/modals/SettingsModal.tsx
index 43d61492..8ba18173 100644
--- a/src/components/modal/modals/SettingsModal.tsx
+++ b/src/components/modal/modals/SettingsModal.tsx
@@ -71,17 +71,6 @@ export const SettingsModal: React.FC
= props => {
onContinue: () => {
clearStorage()
.then(() => {
- // resets the default drive to unloaded if it is defined
- setConfig(conf => ({
- ...conf,
- defaultDrives: conf.defaultDrives
- ? conf.defaultDrives.map(drive => ({
- ...drive,
- loaded: false,
- }))
- : undefined,
- }));
-
// refreshes the page to reload default drive
onRefresh();
})
diff --git a/connect.config.ts b/src/connect.config.ts
similarity index 51%
rename from connect.config.ts
rename to src/connect.config.ts
index 4992c1d0..cee239db 100644
--- a/connect.config.ts
+++ b/src/connect.config.ts
@@ -1,40 +1,47 @@
import { CLOUD, LOCAL, PUBLIC } from '@powerhousedao/design-system';
+import { version } from '../package.json';
+
+const APP_VERSION = import.meta.env.APP_VERSION || version;
const DISABLE_ADD_PUBLIC_DRIVES =
- import.meta.env.VITE_DISABLE_ADD_PUBLIC_DRIVES || undefined;
+ import.meta.env.PH_CONNECT_DISABLE_ADD_PUBLIC_DRIVES || undefined;
const DISABLE_ADD_CLOUD_DRIVES =
- import.meta.env.VITE_DISABLE_ADD_CLOUD_DRIVES || undefined;
+ import.meta.env.PH_CONNECT_DISABLE_ADD_CLOUD_DRIVES || undefined;
const DISABLE_ADD_LOCAL_DRIVES =
- import.meta.env.VITE_DISABLE_ADD_LOCAL_DRIVES || undefined;
+ import.meta.env.PH_CONNECT_DISABLE_ADD_LOCAL_DRIVES || undefined;
const DISABLE_DELETE_PUBLIC_DRIVES =
- import.meta.env.VITE_DISABLE_DELETE_PUBLIC_DRIVES || undefined;
+ import.meta.env.PH_CONNECT_DISABLE_DELETE_PUBLIC_DRIVES || undefined;
const DISABLE_DELETE_CLOUD_DRIVES =
- import.meta.env.VITE_DISABLE_DELETE_CLOUD_DRIVES || undefined;
+ import.meta.env.PH_CONNECT_DISABLE_DELETE_CLOUD_DRIVES || undefined;
const DISABLE_DELETE_LOCAL_DRIVES =
- import.meta.env.VITE_DISABLE_DELETE_LOCAL_DRIVES || undefined;
+ import.meta.env.PH_CONNECT_DISABLE_DELETE_LOCAL_DRIVES || undefined;
const LOCAL_DRIVES_ENABLED =
- import.meta.env.VITE_LOCAL_DRIVES_ENABLED || undefined;
+ import.meta.env.PH_CONNECT_LOCAL_DRIVES_ENABLED || undefined;
const CLOUD_DRIVES_ENABLED =
- import.meta.env.VITE_CLOUD_DRIVES_ENABLED || undefined;
+ import.meta.env.PH_CONNECT_CLOUD_DRIVES_ENABLED || undefined;
const PUBLIC_DRIVES_ENABLED =
- import.meta.env.VITE_PUBLIC_DRIVES_ENABLED || undefined;
+ import.meta.env.PH_CONNECT_PUBLIC_DRIVES_ENABLED || undefined;
-const SEARCH_BAR_ENABLED = import.meta.env.VITE_SEARCH_BAR_ENABLED || undefined;
+const SEARCH_BAR_ENABLED =
+ import.meta.env.PH_CONNECT_SEARCH_BAR_ENABLED || undefined;
const HIDE_DOCUMENT_MODEL_SELECTION_SETTINGS =
- import.meta.env.VITE_HIDE_DOCUMENT_MODEL_SELECTION_SETTINGS || 'false';
+ import.meta.env.PH_CONNECT_HIDE_DOCUMENT_MODEL_SELECTION_SETTINGS ||
+ 'false';
-const VITE_ROUTER_BASENAME = import.meta.env.VITE_ROUTER_BASENAME || '/';
+const PH_CONNECT_ROUTER_BASENAME =
+ import.meta.env.PH_CONNECT_ROUTER_BASENAME || '/';
-const VITE_SENTRY_DSN = import.meta.env.VITE_SENTRY_DSN || '';
-const VITE_SENTRY_ENV = import.meta.env.VITE_SENTRY_ENV || 'dev';
+const PH_CONNECT_SENTRY_DSN = import.meta.env.PH_CONNECT_SENTRY_DSN || '';
+const PH_CONNECT_SENTRY_ENV = import.meta.env.PH_CONNECT_SENTRY_ENV || 'dev';
export default {
- routerBasename: VITE_ROUTER_BASENAME,
+ appVersion: APP_VERSION,
+ routerBasename: PH_CONNECT_ROUTER_BASENAME,
sentry: {
- dsn: VITE_SENTRY_DSN,
- env: VITE_SENTRY_ENV,
+ dsn: PH_CONNECT_SENTRY_DSN,
+ env: PH_CONNECT_SENTRY_ENV,
},
content: {
showSearchBar: SEARCH_BAR_ENABLED !== 'false',
diff --git a/src/env.d.ts b/src/env.d.ts
deleted file mode 100644
index cf4180a2..00000000
--- a/src/env.d.ts
+++ /dev/null
@@ -1,27 +0,0 @@
-///
-
-interface ImportMetaEnv {
- VITE_ENABLED_EDITORS: string;
- VITE_DISABLED_EDITORS: string;
- VITE_DEFAULT_DRIVES_URL: string;
- VITE_DISABLE_ADD_PUBLIC_DRIVES: string;
- VITE_DISABLE_ADD_CLOUD_DRIVES: string;
- VITE_DISABLE_ADD_LOCAL_DRIVES: string;
- VITE_DISABLE_DELETE_PUBLIC_DRIVES: string;
- VITE_DISABLE_DELETE_CLOUD_DRIVES: string;
- VITE_DISABLE_DELETE_LOCAL_DRIVES: string;
- VITE_PUBLIC_DRIVES_ENABLED: string;
- VITE_CLOUD_DRIVES_ENABLED: string;
- VITE_LOCAL_DRIVES_ENABLED: string;
- VITE_SEARCH_BAR_ENABLED: string;
- VITE_ROUTER_BASENAME: string;
- VITE_SENTRY_DSN: string;
- VITE_SENTRY_ENV: string;
- VITE_ARBITRUM_ALLOW_LIST: string | undefined;
- VITE_RWA_ALLOW_LIST: string | undefined;
- VITE_HIDE_DOCUMENT_MODEL_SELECTION_SETTINGS: string;
-}
-
-interface ImportMeta {
- readonly env: ImportMetaEnv;
-}
diff --git a/src/hooks/useAllowList.ts b/src/hooks/useAllowList.ts
index 3346e11e..634e934f 100644
--- a/src/hooks/useAllowList.ts
+++ b/src/hooks/useAllowList.ts
@@ -7,8 +7,8 @@ export function useAllowList(): {
} {
const { user, status } = useLogin();
- const arbitrumAllowListEnvString = import.meta.env.VITE_ARBITRUM_ALLOW_LIST;
- const rwaAllowListEnvString = import.meta.env.VITE_RWA_ALLOW_LIST;
+ const arbitrumAllowListEnvString = import.meta.env.PH_CONNECT_ARBITRUM_ALLOW_LIST;
+ const rwaAllowListEnvString = import.meta.env.PH_CONNECT_RWA_ALLOW_LIST;
const arbitrumAllowListIsDefined =
!!arbitrumAllowListEnvString && arbitrumAllowListEnvString !== '';
diff --git a/src/hooks/useDocumentDriveServer.ts b/src/hooks/useDocumentDriveServer.ts
index 4530e49a..79fd2c3d 100644
--- a/src/hooks/useDocumentDriveServer.ts
+++ b/src/hooks/useDocumentDriveServer.ts
@@ -5,6 +5,7 @@ import {
SharingType,
UiNode,
} from '@powerhousedao/design-system';
+import { SynchronizationUnitNotFoundError } from 'document-drive';
import {
DriveInput,
IDocumentDriveServer,
@@ -579,7 +580,10 @@ export function useDocumentDriveServer(
): Promise => {
if (sharingType === LOCAL) return;
try {
- return server.getSyncStatus(syncId);
+ const syncStatus = server.getSyncStatus(syncId);
+ if (syncStatus instanceof SynchronizationUnitNotFoundError)
+ return 'INITIAL_SYNC';
+ return syncStatus;
} catch (error) {
console.error(error);
return ERROR;
diff --git a/src/hooks/useFeatureFlags/default-config.ts b/src/hooks/useFeatureFlags/default-config.ts
index 7fc5ffab..7d75cf77 100644
--- a/src/hooks/useFeatureFlags/default-config.ts
+++ b/src/hooks/useFeatureFlags/default-config.ts
@@ -1,17 +1,13 @@
export const FEATURE_FLAG_KEY_STORAGE = 'feature-flags-config';
-const ENABLED_EDITORS = import.meta.env.VITE_ENABLED_EDITORS || undefined;
+const ENABLED_EDITORS = import.meta.env.PH_CONNECT_ENABLED_EDITORS || undefined;
const enabledEditors = ENABLED_EDITORS?.split(',');
-const DISABLED_EDITORS = import.meta.env.VITE_DISABLED_EDITORS || undefined;
-const DEFAULT_DRIVES_URL = import.meta.env.VITE_DEFAULT_DRIVES_URL || undefined;
+const DISABLED_EDITORS =
+ import.meta.env.PH_CONNECT_DISABLED_EDITORS || undefined;
const disabledEditors = DISABLED_EDITORS?.split(',');
export interface FeatureFlag {
- defaultDrives?: {
- url: string;
- loaded: boolean;
- }[];
editors: {
enabledEditors?: '*' | string[];
disabledEditors?: '*' | string[];
@@ -19,12 +15,6 @@ export interface FeatureFlag {
}
const defaultConfig: FeatureFlag = {
- defaultDrives: DEFAULT_DRIVES_URL
- ? DEFAULT_DRIVES_URL.split(',').map(url => ({
- url,
- loaded: false,
- }))
- : undefined,
editors: {
enabledEditors: ENABLED_EDITORS === '*' ? '*' : enabledEditors,
disabledEditors: DISABLED_EDITORS === '*' ? '*' : disabledEditors,
diff --git a/src/hooks/useLoadDefaultDrives.ts b/src/hooks/useLoadDefaultDrives.ts
deleted file mode 100644
index daed457f..00000000
--- a/src/hooks/useLoadDefaultDrives.ts
+++ /dev/null
@@ -1,139 +0,0 @@
-import { useEffect, useRef } from 'react';
-import { logger } from 'src/services/logger';
-import { useDocumentDriveServer } from './useDocumentDriveServer';
-import { useFeatureFlag } from './useFeatureFlags';
-import defaultConfig from './useFeatureFlags/default-config';
-
-type DefaultDrive = {
- url: string;
- loaded: boolean;
-};
-
-const areLoadedDrivesUpToDate = (
- defaultDrivesConfig: DefaultDrive[],
- loadedDrives: DefaultDrive[],
-) => {
- for (const defaultDrive of defaultDrivesConfig) {
- const loadedDrive = loadedDrives.find(
- loadedDrive => loadedDrive.url === defaultDrive.url,
- );
-
- if (!loadedDrive) {
- return false;
- }
- }
-
- return true;
-};
-
-export const useLoadDefaultDrives = () => {
- const loadingDrives = useRef([]);
- const {
- addRemoteDrive,
- documentDrives,
- documentDrivesStatus,
- clearStorage,
- } = useDocumentDriveServer();
- const {
- setConfig,
- config: { defaultDrives },
- } = useFeatureFlag();
-
- async function resetDefaultDrive() {
- await clearStorage();
- setConfig(defaultConfig);
- location.reload();
- loadingDrives.current = [];
- }
-
- useEffect(() => {
- if (!defaultDrives) return;
-
- // reset default drives if config has been updated
- if (
- loadingDrives.current.length <= 0 &&
- defaultDrives.every(drive => drive.loaded) &&
- defaultConfig.defaultDrives &&
- defaultConfig.defaultDrives.length > 0 &&
- !areLoadedDrivesUpToDate(defaultConfig.defaultDrives, defaultDrives)
- ) {
- void resetDefaultDrive();
- return;
- }
-
- for (const defaultDrive of defaultDrives) {
- if (
- documentDrivesStatus === 'LOADED' &&
- !defaultDrive.loaded &&
- !loadingDrives.current.includes(defaultDrive.url)
- ) {
- const isDriveAlreadyAdded = documentDrives.some(drive => {
- return drive.state.local.triggers.some(
- trigger => trigger.data?.url === defaultDrive.url,
- );
- });
-
- if (isDriveAlreadyAdded) {
- setConfig(conf => ({
- ...conf,
- defaultDrives: [
- ...(conf.defaultDrives || []).filter(
- drive => drive.url !== defaultDrive.url,
- ),
- { ...defaultDrive, loaded: true },
- ],
- }));
-
- return;
- }
-
- loadingDrives.current.push(defaultDrive.url);
-
- addRemoteDrive(defaultDrive.url, {
- sharingType: 'PUBLIC',
- availableOffline: true,
- listeners: [
- {
- block: true,
- callInfo: {
- data: defaultDrive.url,
- name: 'switchboard-push',
- transmitterType: 'SwitchboardPush',
- },
- filter: {
- branch: ['main'],
- documentId: ['*'],
- documentType: ['*'],
- scope: ['global'],
- },
- label: 'Switchboard Sync',
- listenerId: '1',
- system: true,
- },
- ],
- triggers: [],
- pullInterval: 3000,
- })
- .then(() =>
- setConfig(conf => ({
- ...conf,
- defaultDrives: [
- ...(conf.defaultDrives || []).filter(
- drive => drive.url !== defaultDrive.url,
- ),
- { ...defaultDrive, loaded: true },
- ],
- })),
- )
- .catch(logger.error)
- .finally(() => {
- loadingDrives.current = loadingDrives.current.filter(
- url => url !== defaultDrive.url,
- );
- });
- }
- }
- }, [documentDrives, defaultDrives, documentDrivesStatus]);
-
- return loadingDrives.current.length > 0;
-};
diff --git a/src/hooks/useLoadInitialData.tsx b/src/hooks/useLoadInitialData.tsx
index 320a4754..f0849f56 100644
--- a/src/hooks/useLoadInitialData.tsx
+++ b/src/hooks/useLoadInitialData.tsx
@@ -15,7 +15,6 @@ import { useUiNodes } from 'src/hooks/useUiNodes';
import { DefaultDocumentDriveServer as server } from 'src/utils/document-drive-server';
import { useClientErrorHandler } from './useClientErrorHandler';
import { useDocumentDrives } from './useDocumentDrives';
-import { useLoadDefaultDrives } from './useLoadDefaultDrives';
import { isLatestVersion } from './utils';
export const useLoadInitialData = () => {
@@ -32,8 +31,6 @@ export const useLoadInitialData = () => {
const [, , serverSubscribeUpdates] = useDocumentDrives(server);
const clientErrorHandler = useClientErrorHandler();
- useLoadDefaultDrives();
-
async function checkLatestVersion() {
const result = await isLatestVersion();
if (result === null) return;
diff --git a/src/hooks/useUiNodes.ts b/src/hooks/useUiNodes.ts
index 377665e7..01b8a7c4 100644
--- a/src/hooks/useUiNodes.ts
+++ b/src/hooks/useUiNodes.ts
@@ -84,6 +84,12 @@ export function useUiNodes() {
) as SharingType;
const driveSyncStatus = await getSyncStatus(id, sharingType);
+ // TODO: rempve this after integration in design-system
+ const normalizedDriveSyncStatus =
+ driveSyncStatus === 'INITIAL_SYNC'
+ ? 'SYNCING'
+ : driveSyncStatus;
+
const driveNode: UiDriveNode = {
id,
name,
@@ -92,7 +98,7 @@ export function useUiNodes() {
children: [],
nodeMap: {},
sharingType,
- syncStatus: driveSyncStatus,
+ syncStatus: normalizedDriveSyncStatus,
availableOffline,
icon,
parentFolder: null,
@@ -106,7 +112,7 @@ export function useUiNodes() {
driveId: id,
parentFolder: n.parentFolder || id,
kind: n.kind.toUpperCase(),
- syncStatus: driveSyncStatus,
+ syncStatus: normalizedDriveSyncStatus,
sharingType,
};
@@ -130,10 +136,18 @@ export function useUiNodes() {
for await (const node of nodes) {
if (node.kind === FILE) {
- node.syncStatus = await getSyncStatus(
+ const fileSyncStatus = await getSyncStatus(
node.synchronizationUnits[0].syncId,
sharingType,
);
+
+ // TODO: rempve this after integration in design-system
+ const normalizedFileSyncStatus =
+ fileSyncStatus === 'INITIAL_SYNC'
+ ? 'SYNCING'
+ : fileSyncStatus;
+
+ node.syncStatus = normalizedFileSyncStatus;
}
if (node.parentFolder === id) {
@@ -222,10 +236,13 @@ export function useUiNodes() {
if (parentNode.kind === FILE) {
throw new Error('Cannot add file to a file');
}
+
+ const fileName = file.name.replace(/\.zip$/gim, '');
+
return await addFile(
file,
parentNode.driveId,
- file.name,
+ fileName,
parentNode.id,
);
},
diff --git a/src/hooks/utils.ts b/src/hooks/utils.ts
index cd8b99f1..d3e8b9e5 100644
--- a/src/hooks/utils.ts
+++ b/src/hooks/utils.ts
@@ -1,4 +1,5 @@
-import { version as currentVersion } from '../../package.json';
+const currentVersion = import.meta.env.APP_VERSION;
+
export const isElectron = window.navigator.userAgent.includes('Electron');
export const isMac = window.navigator.appVersion.includes('Mac');
diff --git a/src/renderer.ts b/src/renderer.ts
index 3aab81b3..b504cefa 100644
--- a/src/renderer.ts
+++ b/src/renderer.ts
@@ -33,10 +33,15 @@ import './index.css';
import { DocumentEditorDebugTools } from './utils/document-editor-debug-tools';
import serviceWorkerManager from './utils/registerServiceWorker';
+const AppElement = document.getElementById('app');
+if (!AppElement) {
+ throw new Error('#app element not found!');
+}
+
if (import.meta.env.MODE === 'development') {
window.documentEditorDebugTools = new DocumentEditorDebugTools();
} else {
serviceWorkerManager.registerServiceWorker(false);
}
-createRoot(document.getElementById('app')!).render(App);
+createRoot(AppElement).render(App);
diff --git a/src/service-worker.ts b/src/service-worker.ts
new file mode 100644
index 00000000..e199dfd6
--- /dev/null
+++ b/src/service-worker.ts
@@ -0,0 +1,124 @@
+///
+
+import {
+ ServiceWorkerEvent,
+ ServiceWorkerManagerMessage,
+} from './utils/registerServiceWorker';
+
+const _self = self as unknown as ServiceWorkerGlobalScope;
+
+const VERSION_CHECK_INTERVAL =
+ parseInt(import.meta.env.PH_CONNECT_VERSION_CHECK_INTERVAL as string) ||
+ 5 * 60 * 1000; // 5 minutes;
+const VERSION_CACHE = 'version-cache';
+const VERSION_KEY = 'app-version';
+
+_self.addEventListener('install', () => {
+ _self.skipWaiting().catch(console.error);
+});
+
+_self.addEventListener('activate', (event: ExtendableEvent) => {
+ event.waitUntil(_self.clients.claim());
+});
+
+export type NEW_VERSION_AVAILABLE_MESSAGE = {
+ type: 'NEW_VERSION_AVAILABLE';
+ requiresHardRefresh: boolean;
+};
+
+export type ServiceWorkerMessageData = NEW_VERSION_AVAILABLE_MESSAGE;
+
+export type ServiceWorkerMessage = ServiceWorkerEvent;
+
+interface VersionResponse {
+ version: string;
+ requiresHardRefresh: boolean;
+}
+
+function postMessage(client: Client, message: ServiceWorkerMessageData) {
+ return client.postMessage(message);
+}
+
+_self.addEventListener('message', async event => {
+ const message =
+ 'type' in event.data ? (event as ServiceWorkerManagerMessage) : null;
+ switch (message?.data.type) {
+ case 'SET_APP_VERSION': {
+ const cache = await caches.open(VERSION_CACHE);
+ await cache.put(VERSION_KEY, new Response(message.data.version));
+ break;
+ }
+ case 'NETWORK_STATUS': {
+ message.data.online
+ ? startCheckingForUpdates()
+ : stopCheckingForUpdates();
+ break;
+ }
+ default: {
+ console.warn('Unhandled message:', message);
+ break;
+ }
+ }
+});
+
+async function checkForUpdates(basePath: string) {
+ try {
+ const response = await fetch(new URL('./version.json', basePath), {
+ cache: 'no-store',
+ });
+ const newVersion = (await response.json()) as VersionResponse;
+ const cache = await caches.open(VERSION_CACHE);
+ const cachedResponse = await cache.match(VERSION_KEY);
+
+ let currentVersion = '';
+
+ if (cachedResponse) {
+ currentVersion = await cachedResponse.text();
+ }
+
+ if (currentVersion === '') {
+ // Initial cache
+ await cache.put(VERSION_KEY, new Response(newVersion.version));
+ } else if (currentVersion !== newVersion.version) {
+ // New version detected
+ console.log('Current version:', currentVersion);
+ console.log('New version:', newVersion.version);
+
+ const clients = await _self.clients.matchAll();
+ clients.forEach(client => {
+ postMessage(client, {
+ type: 'NEW_VERSION_AVAILABLE',
+ requiresHardRefresh: newVersion.requiresHardRefresh,
+ });
+ });
+
+ // Update the stored version
+ await cache.put(VERSION_KEY, new Response(newVersion.version));
+ }
+ } catch (error) {
+ console.error('Error checking version:', error);
+ }
+}
+
+let checkUpdatesInterval: number | undefined;
+function startCheckingForUpdates() {
+ stopCheckingForUpdates();
+ const basePath = _self.registration.scope;
+
+ // does the initial check right away
+ setTimeout(() => checkForUpdates(basePath), 0);
+
+ // Check for updates every 5 minutes
+ checkUpdatesInterval = setInterval(
+ () => checkForUpdates(basePath),
+ VERSION_CHECK_INTERVAL,
+ ) as unknown as number;
+}
+
+function stopCheckingForUpdates() {
+ if (checkUpdatesInterval) {
+ clearInterval(checkUpdatesInterval);
+ }
+}
+
+startCheckingForUpdates();
diff --git a/src/services/renown/constants.ts b/src/services/renown/constants.ts
index 5462e1ea..762af7a9 100644
--- a/src/services/renown/constants.ts
+++ b/src/services/renown/constants.ts
@@ -1,9 +1,9 @@
export const RENOWN_URL =
- (import.meta.env.VITE_RENOWN_URL as string) || 'https://www.renown.id';
+ import.meta.env.PH_CONNECT_RENOWN_URL || 'https://www.renown.id';
export const RENOWN_NETWORK_ID =
- (import.meta.env.VITE_RENOWN_NETWORK_ID as string) || 'eip155';
+ import.meta.env.PH_CONNECT_RENOWN_NETWORK_ID || 'eip155';
export const RENOWN_CHAIN_ID =
- (import.meta.env.VITE_RENOWN_CHAIN_ID as string) || '1';
+ import.meta.env.PH_CONNECT_RENOWN_CHAIN_ID || '1';
export const DOMAIN_TYPE = [
{ name: 'name', type: 'string' },
diff --git a/src/utils/browser-document-drive.ts b/src/utils/browser-document-drive.ts
index b1cc1769..679c7471 100644
--- a/src/utils/browser-document-drive.ts
+++ b/src/utils/browser-document-drive.ts
@@ -6,12 +6,14 @@ import { BrowserStorage } from 'document-drive/storage/browser';
import { utils } from 'document-model/document';
import { logger } from 'src/services/logger';
import { documentModels } from 'src/store/document-model';
+import { getReactorDefaultDrivesConfig } from './reactor';
export const BrowserDocumentDriveServer = new DocumentDriveServer(
documentModels,
new BrowserStorage(connectConfig.routerBasename),
new InMemoryCache(),
new BaseQueueManager(1, 10),
+ { ...getReactorDefaultDrivesConfig() },
);
async function init() {
diff --git a/src/utils/reactor.ts b/src/utils/reactor.ts
new file mode 100644
index 00000000..5661bd89
--- /dev/null
+++ b/src/utils/reactor.ts
@@ -0,0 +1,53 @@
+import { DocumentDriveServerOptions } from 'document-drive/server';
+
+const DEFAULT_DRIVES_URL =
+ import.meta.env.PH_CONNECT_DEFAULT_DRIVES_URL || undefined;
+const defaultDrivesUrl = DEFAULT_DRIVES_URL
+ ? DEFAULT_DRIVES_URL.split(',')
+ : [];
+
+export const getReactorDefaultDrivesConfig = (): Pick<
+ DocumentDriveServerOptions,
+ 'defaultRemoteDrives' | 'removeOldRemoteDrives'
+> => {
+ const defaultDrives: DocumentDriveServerOptions['defaultRemoteDrives'] =
+ defaultDrivesUrl.map(driveUrl => ({
+ url: driveUrl,
+ options: {
+ sharingType: 'PUBLIC',
+ availableOffline: true,
+ listeners: [
+ {
+ block: true,
+ callInfo: {
+ data: driveUrl,
+ name: 'switchboard-push',
+ transmitterType: 'SwitchboardPush',
+ },
+ filter: {
+ branch: ['main'],
+ documentId: ['*'],
+ documentType: ['*'],
+ scope: ['global'],
+ },
+ label: 'Switchboard Sync',
+ listenerId: '1',
+ system: true,
+ },
+ ],
+ triggers: [],
+ pullInterval: 3000,
+ },
+ }));
+
+ return {
+ defaultRemoteDrives: defaultDrives,
+ removeOldRemoteDrives:
+ defaultDrivesUrl.length > 0
+ ? {
+ strategy: 'preserve-by-url',
+ urls: defaultDrivesUrl,
+ }
+ : { strategy: 'preserve-all' },
+ };
+};
diff --git a/src/utils/registerServiceWorker.ts b/src/utils/registerServiceWorker.ts
index 45dbd781..1b7490a2 100644
--- a/src/utils/registerServiceWorker.ts
+++ b/src/utils/registerServiceWorker.ts
@@ -1,17 +1,36 @@
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
-type SET_APP_VERSION_MESSAGE = {
+import connectConfig from 'connect-config';
+import { ServiceWorkerMessage } from 'src/service-worker';
+
+const basePath = connectConfig.routerBasename;
+
+const serviceWorkerScriptPath = [basePath, 'service-worker.js']
+ .join('/')
+ .replace(/\/{2,}/gm, '/');
+
+export interface IServiceWorkerMessageData {
+ type: string;
+}
+
+export interface ServiceWorkerEvent
+ extends ExtendableMessageEvent {
+ data: T;
+}
+
+export type SET_APP_VERSION = {
type: 'SET_APP_VERSION';
version: string;
};
-export type ServiceWorkerPostMessage = SET_APP_VERSION_MESSAGE;
-
-type NEW_VERSION_AVAILABLE_MESSAGE = {
- type: 'NEW_VERSION_AVAILABLE';
- requiresHardRefresh: boolean;
+export type NETWORK_STATUS = {
+ type: 'NETWORK_STATUS';
+ online: boolean;
};
-export type ServiceWorkerMessage = NEW_VERSION_AVAILABLE_MESSAGE;
+export type ServiceWorkerManagerMessageData = SET_APP_VERSION | NETWORK_STATUS;
+
+export type ServiceWorkerManagerMessage =
+ ServiceWorkerEvent;
class ServiceWorkerManager {
ready = false;
@@ -26,67 +45,93 @@ class ServiceWorkerManager {
this.debug = debug;
}
- registerServiceWorker(debug = false) {
- this.debug = debug;
+ #handleServiceWorkerMessage(event: MessageEvent | ServiceWorkerMessage) {
+ if (this.debug) {
+ console.log('ServiceWorker message: ', event);
+ }
+ const message =
+ 'type' in event.data ? (event as ServiceWorkerMessage) : null;
+ switch (message?.data.type) {
+ case 'NEW_VERSION_AVAILABLE': {
+ if (message.data.requiresHardRefresh) {
+ if (this.debug) {
+ console.log('New version available');
+ }
+ window.location.reload(); // Reload the page to load the new version
+ }
+ break;
+ }
+ default: {
+ console.warn('Unhandled message:', message);
+ break;
+ }
+ }
+ }
- if ('serviceWorker' in navigator) {
- window.addEventListener('load', () => {
- navigator.serviceWorker
- .register('/service-worker.js')
- .then(registration => {
- // Listen for messages from the service worker
- if (this.debug) {
- console.log(
- 'ServiceWorker registered: ',
- registration,
- );
- }
-
- navigator.serviceWorker.addEventListener(
- 'message',
- event => {
- if (this.debug) {
- console.log(
- 'ServiceWorker message: ',
- event,
- );
- }
-
- if (
- event.data &&
- event.data.type ===
- 'NEW_VERSION_AVAILABLE' &&
- event.data.requiresHardRefresh === true
- ) {
- if (this.debug) {
- console.log('New version available');
- }
- window.location.reload(); // Reload the page to load the new version
- }
- },
- );
-
- if (navigator.serviceWorker.controller) {
- navigator.serviceWorker.controller.postMessage({
- type: 'SET_APP_VERSION',
- version: process.env.APP_VERSION,
- });
- }
-
- this.ready = true;
- this.registration = registration;
- })
- .catch(error => {
- console.error(
- 'ServiceWorker registration failed: ',
- error,
- );
+ #handleServiceWorker(registration: ServiceWorkerRegistration) {
+ {
+ // Listen for messages from the service worker
+ if (this.debug) {
+ console.log('ServiceWorker registered: ', registration);
+ }
+
+ navigator.serviceWorker.addEventListener(
+ 'message',
+ this.#handleServiceWorkerMessage.bind(this),
+ );
+
+ this.registration = registration;
+ this.ready = true;
+
+ window.addEventListener('online', () => {
+ if (navigator.serviceWorker.controller) {
+ this.sendMessage({
+ type: 'NETWORK_STATUS',
+ online: true,
});
+ }
+ });
+
+ window.addEventListener('offline', () => {
+ if (navigator.serviceWorker.controller) {
+ this.sendMessage({
+ type: 'NETWORK_STATUS',
+ online: false,
+ });
+ }
});
+
+ if (navigator.serviceWorker.controller) {
+ this.sendMessage({
+ type: 'SET_APP_VERSION',
+ version: import.meta.env.APP_VERSION,
+ });
+ }
+ }
+ }
+
+ registerServiceWorker(debug = false) {
+ this.debug = debug;
+
+ if (!('serviceWorker' in navigator)) {
+ console.warn('Service Worker not available');
+ return;
}
+ window.addEventListener('load', () => {
+ navigator.serviceWorker
+ .register(
+ import.meta.env.MODE === 'development'
+ ? './src/service-worker.ts'
+ : serviceWorkerScriptPath,
+ )
+ .then(this.#handleServiceWorker.bind(this))
+ .catch(error => {
+ console.error('ServiceWorker registration failed: ', error);
+ });
+ });
}
- sendMessage(message: ServiceWorkerPostMessage) {
+ sendMessage(message: ServiceWorkerManagerMessageData) {
if (this.ready && this.registration) {
const serviceWorker =
this.registration.active ||
diff --git a/src/utils/validate-document.ts b/src/utils/validate-document.ts
index b28f9aad..b5e0bb83 100644
--- a/src/utils/validate-document.ts
+++ b/src/utils/validate-document.ts
@@ -1,7 +1,6 @@
import { Document, ValidationError } from 'document-model/document';
import {
DocumentModel as DocumentModelClass,
- Module,
utils as documentModelUtils,
} from 'document-model/document-model';
@@ -61,9 +60,7 @@ export const validateDocument = (document: Document) => {
}, []);
// modules validation
- const modulesErrors = documentModelUtils.validateModules(
- specs.modules as Module[],
- );
+ const modulesErrors = documentModelUtils.validateModules(specs.modules);
return [...initialStateErrors, ...schemaStateErrors, ...modulesErrors];
};
diff --git a/src/vite-env.d.ts b/src/vite-env.d.ts
new file mode 100644
index 00000000..0de38d88
--- /dev/null
+++ b/src/vite-env.d.ts
@@ -0,0 +1,66 @@
+///
+
+
+type ImportMetaEnv = {
+ // Auto-generated by `npx vite-envs update-types` and hot-reloaded by the `vite-env` plugin
+ // You probably want to add `/src/vite-env.d.ts` to your .prettierignore
+ BASE_URL: string
+ MODE: string
+ DEV: boolean
+ PROD: boolean
+ APP_VERSION: string
+ REQUIRES_HARD_REFRESH: boolean
+ SENTRY_RELEASE: string
+ BASE_PATH: string
+ BASE_HREF: string
+ PH_CONNECT_APP_REQUIRES_HARD_REFRESH: string
+ SENTRY_AUTH_TOKEN: string
+ SENTRY_ORG: string
+ SENTRY_PROJECT: string
+ PH_CONNECT_ROUTER_BASENAME: string
+ PH_CONNECT_DEFAULT_DRIVES_URL: string
+ PH_CONNECT_ENABLED_EDITORS: string
+ PH_CONNECT_DISABLE_ADD_PUBLIC_DRIVES: string
+ PH_CONNECT_SEARCH_BAR_ENABLED: string
+ PH_CONNECT_DISABLE_ADD_CLOUD_DRIVES: string
+ PH_CONNECT_DISABLE_ADD_LOCAL_DRIVES: string
+ PH_CONNECT_DISABLE_DELETE_PUBLIC_DRIVES: string
+ PH_CONNECT_DISABLE_DELETE_CLOUD_DRIVES: string
+ PH_CONNECT_DISABLE_DELETE_LOCAL_DRIVES: string
+ PH_CONNECT_PUBLIC_DRIVES_ENABLED: string
+ PH_CONNECT_CLOUD_DRIVES_ENABLED: string
+ PH_CONNECT_LOCAL_DRIVES_ENABLED: string
+ PH_CONNECT_ARBITRUM_ALLOW_LIST: string
+ PH_CONNECT_RWA_ALLOW_LIST: string
+ PH_CONNECT_HIDE_DOCUMENT_MODEL_SELECTION_SETTINGS: string
+ PH_CONNECT_RENOWN_URL: string
+ PH_CONNECT_RENOWN_NETWORK_ID: string
+ PH_CONNECT_RENOWN_CHAIN_ID: string
+ PH_CONNECT_DISABLED_EDITORS: string
+ PH_CONNECT_SENTRY_DSN: string
+ PH_CONNECT_SENTRY_PROJECT: string
+ PH_CONNECT_SENTRY_ENV: string
+ // @user-defined-start
+ /*
+ * You can use this section to explicitly extend the type definition of `import.meta.env`
+ * This is useful if you're using Vite plugins that define specific `import.meta.env` properties.
+ * If you're not using such plugins, this section should remain as is.
+ */
+ SSR: boolean;
+ // @user-defined-end
+}
+
+
+
+interface ImportMeta {
+ // Auto-generated by `npx vite-envs update-types`
+
+ url: string
+
+ readonly hot?: import('vite-envs/types/hot').ViteHotContext
+
+ readonly env: ImportMetaEnv
+
+ glob: import('vite-envs/types/importGlob').ImportGlobFunction
+}
+
diff --git a/tsconfig.json b/tsconfig.json
index 359c9407..7b026830 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -20,7 +20,7 @@
"baseUrl": ".",
"paths": {
"@/assets": ["assets"],
- "connect-config": ["connect.config.ts"],
+ "connect-config": ["src/connect.config.ts"],
},
"types": ["vite/client", "vite-plugin-svgr/client", "@types/wicg-file-system-access"]
},
diff --git a/tsconfig.sw.json b/tsconfig.sw.json
new file mode 100644
index 00000000..a9339f9d
--- /dev/null
+++ b/tsconfig.sw.json
@@ -0,0 +1,15 @@
+{
+ "compilerOptions": {
+ "allowSyntheticDefaultImports": true,
+ "isolatedModules": false,
+ "strict": true,
+ "module": "ESNext",
+ "target": "ESNext",
+ "lib": ["es2019", "es6", "dom", "webworker"],
+ "noEmit": false,
+ "moduleResolution": "node",
+ "skipLibCheck": true,
+ "outDir": "./dist"
+ },
+ "files": ["./src/service-worker.ts"]
+}
diff --git a/vite.main.config.mts b/vite.main.config.mts
index e797c701..673ff31d 100644
--- a/vite.main.config.mts
+++ b/vite.main.config.mts
@@ -6,7 +6,10 @@ export default defineConfig({
resolve: {
alias: {
src: path.resolve(__dirname, './src'),
- 'connect-config': path.resolve(__dirname, './connect.config.ts'),
+ 'connect-config': path.resolve(
+ __dirname,
+ './src/connect.config.ts',
+ ),
},
},
});
diff --git a/vite.renderer.config.mts b/vite.renderer.config.mts
index 4b061fde..1ed5728c 100644
--- a/vite.renderer.config.mts
+++ b/vite.renderer.config.mts
@@ -4,26 +4,55 @@ import fs from 'fs';
import jotaiDebugLabel from 'jotai/babel/plugin-debug-label';
import jotaiReactRefresh from 'jotai/babel/plugin-react-refresh';
import path from 'path';
-import { HtmlTagDescriptor, PluginOption, defineConfig, loadEnv } from 'vite';
+import {
+ HtmlTagDescriptor,
+ Plugin,
+ PluginOption,
+ defineConfig,
+ loadEnv,
+} from 'vite';
+import { viteEnvs } from 'vite-envs';
import { createHtmlPlugin } from 'vite-plugin-html';
import svgr from 'vite-plugin-svgr';
import pkg from './package.json';
import clientConfig from './client.config';
-const appVersion = pkg.version;
+// Plugin to generate version.json in both dev and prod
+const addToBundlePlugin = (
+ file: { version: string; requiresHardRefresh?: boolean },
+ basePath = '/',
+): Plugin => {
+ const versionManifest = {
+ version: file.version,
+ requiresHardRefresh: file.requiresHardRefresh || false,
+ };
+
+ console.info(versionManifest);
-const generateVersionPlugin = (hardRefresh = false) => {
return {
- name: 'generate-version',
+ name: 'add-to-bundle',
+
+ // Hook for development mode (serves the file dynamically)
+ configureServer(server) {
+ // Middleware to serve version.json in dev mode
+ server.middlewares.use((req, res, next) => {
+ if (req.url === path.join(basePath, './version.json')) {
+ res.setHeader('Content-Type', 'application/json');
+ res.end(JSON.stringify(versionManifest, null, 2));
+ } else {
+ next();
+ }
+ });
+ },
+
+ // Hook for production mode (writes the file to the dist folder)
closeBundle() {
- const versionManifest = {
- version: appVersion,
- requiresHardRefresh: hardRefresh,
- };
+ const outputPath = path.join('dist', 'version.json');
+ // Write the JSON file to the dist folder during production builds
fs.writeFileSync(
- path.join('dist', 'version.json'),
+ outputPath,
JSON.stringify(versionManifest, null, 2),
);
},
@@ -34,7 +63,27 @@ export default defineConfig(({ mode }) => {
const isProd = mode === 'production';
const env = loadEnv(mode, process.cwd());
- const requiresHardRefresh = env.VITE_APP_REQUIRES_HARD_REFRESH === 'true';
+ const requiresHardRefreshEnv: unknown =
+ process.env.PH_CONNECT_APP_REQUIRES_HARD_REFRESH ??
+ env.PH_CONNECT_APP_REQUIRES_HARD_REFRESH;
+
+ const REQUIRES_HARD_REFRESH =
+ typeof requiresHardRefreshEnv === 'boolean'
+ ? requiresHardRefreshEnv
+ : requiresHardRefreshEnv !== undefined
+ ? requiresHardRefreshEnv === 'true'
+ : isProd;
+
+ const APP_VERSION =
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ (process.env.APP_VERSION ?? env.APP_VERSION ?? pkg.version).toString();
+
+ const authToken = process.env.SENTRY_AUTH_TOKEN ?? env.SENTRY_AUTH_TOKEN;
+ const org = process.env.SENTRY_ORG ?? env.SENTRY_ORG;
+ const project = process.env.SENTRY_PROJECT ?? env.SENTRY_PROJECT;
+ const release =
+ (process.env.SENTRY_RELEASE ?? env.SENTRY_RELEASE) || APP_VERSION;
+ const uploadSentrySourcemaps = authToken && org && project;
const plugins: PluginOption[] = [
react({
@@ -55,16 +104,31 @@ export default defineConfig(({ mode }) => {
],
},
}),
- generateVersionPlugin(isProd ? requiresHardRefresh : false),
- ];
+ addToBundlePlugin(
+ {
+ version: APP_VERSION,
+ requiresHardRefresh: REQUIRES_HARD_REFRESH,
+ },
+ env.PH_CONNECT_ROUTER_BASENAME,
+ ),
+ viteEnvs({
+ computedEnv() {
+ return {
+ APP_VERSION,
+ REQUIRES_HARD_REFRESH,
+ SENTRY_RELEASE: release,
+ };
+ },
+ }),
+ ] as const;
- const authToken = process.env.SENTRY_AUTH_TOKEN;
- const org = process.env.SENTRY_ORG;
- const project = process.env.SENTRY_PROJECT;
- const uploadSentrySourcemaps = authToken && org && project;
if (uploadSentrySourcemaps) {
plugins.push(
sentryVitePlugin({
+ release: {
+ name: release,
+ inject: false, // prevent it from injecting the release id in the service worker code, this is done in 'src/app/sentry.ts' instead
+ },
authToken,
org,
project,
@@ -73,16 +137,28 @@ export default defineConfig(({ mode }) => {
}
return {
- define: {
- 'process.env': {
- APP_VERSION: appVersion,
- REQUIRES_HARD_REFRESH: isProd ? requiresHardRefresh : false,
- },
- },
plugins,
build: {
minify: isProd,
sourcemap: isProd,
+ rollupOptions: {
+ input: {
+ main: path.resolve(__dirname, 'index.html'),
+ // Adds the service worker as a separate file
+ 'service-worker': path.resolve(
+ __dirname,
+ 'src/service-worker.ts',
+ ),
+ },
+ output: {
+ // Ensure the service worker file goes to the root of the dist folder
+ entryFileNames: chunk => {
+ return ['service-worker'].includes(chunk.name)
+ ? `${chunk.name}.js`
+ : 'assets/[name].[hash].js';
+ },
+ },
+ },
},
resolve: {
alias: {
@@ -90,7 +166,7 @@ export default defineConfig(({ mode }) => {
src: path.resolve(__dirname, './src'),
'connect-config': path.resolve(
__dirname,
- './connect.config.ts',
+ './src/connect.config.ts',
),
path: 'rollup-plugin-node-polyfills/polyfills/path',
events: 'rollup-plugin-node-polyfills/polyfills/events',