Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp

refactor(desktop): hide module system implementation exports

Hampusecbf613efa2d
diff --git a/fluxer_desktop/src/common/ModuleSystem.ts b/fluxer_desktop/src/common/ModuleSystem.ts
index c81b2670b..93a112b83 100644
--- a/fluxer_desktop/src/common/ModuleSystem.ts
+++ b/fluxer_desktop/src/common/ModuleSystem.ts
@@ -4,7 +4,7 @@ import fs from 'node:fs';
import path from 'node:path';
import {fileURLToPath} from 'node:url';
-export const MODULE_SYSTEM_BUILD_ENABLED = process.env.FLUXER_MODULES === '1';
+const MODULE_SYSTEM_BUILD_ENABLED = process.env.FLUXER_MODULES === '1';
const OFFLINE_RENDERER_DIRECTORY_SEGMENTS: ReadonlyArray<string> = Object.freeze(['..', 'renderer']);
const OFFLINE_RENDERER_INDEX_NAME = 'index.html';
@@ -15,7 +15,7 @@ const MODULE_SYSTEM_ENV = 'FLUXER_MODULE_SYSTEM';
const MODULE_SYSTEM_DISABLE_ARGUMENT = '--fluxer-no-module-system';
const FALSY_VALUES: ReadonlySet<string> = new Set(['0', 'false', 'no', 'off']);
-export function readModuleSystemDisableRequest(
+function readModuleSystemDisableRequest(
argv: ReadonlyArray<string> = process.argv,
env: NodeJS.ProcessEnv = process.env,
): boolean {
@@ -26,13 +26,13 @@ export function readModuleSystemDisableRequest(
return value != null && FALSY_VALUES.has(value);
}
-export const ModuleSystemDisableDecision = Object.freeze({
+const ModuleSystemDisableDecision = Object.freeze({
NOT_REQUESTED: 'not-requested',
HONOURED: 'honoured',
IGNORED_WITHOUT_OFFLINE_RENDERER: 'ignored-without-offline-renderer',
} as const);
-export type ModuleSystemDisableDecision =
+type ModuleSystemDisableDecision =
| {readonly kind: typeof ModuleSystemDisableDecision.NOT_REQUESTED}
| {readonly kind: typeof ModuleSystemDisableDecision.HONOURED}
| {readonly kind: typeof ModuleSystemDisableDecision.IGNORED_WITHOUT_OFFLINE_RENDERER};
@@ -50,7 +50,7 @@ export type ModuleSystemLaunchDecision =
| {readonly kind: typeof ModuleSystemLaunchDecision.ENABLED}
| {readonly kind: typeof ModuleSystemLaunchDecision.ENABLED_WITH_IGNORED_DISABLE_REQUEST};
-export function decideModuleSystemDisableRequest(
+function decideModuleSystemDisableRequest(
requested: boolean,
hasOfflineRenderer: boolean,
): ModuleSystemDisableDecision {
@@ -98,7 +98,7 @@ export function resolveAsarUnpackedPath(target: string): string {
return fs.existsSync(unpacked) ? unpacked : target;
}
-export function getOfflineRendererRoot(mainModuleUrl: string): string {
+function getOfflineRendererRoot(mainModuleUrl: string): string {
return resolveAsarUnpackedPath(
path.join(path.dirname(fileURLToPath(mainModuleUrl)), ...OFFLINE_RENDERER_DIRECTORY_SEGMENTS),
);
diff --git a/fluxer_desktop/src/main/ModuleManifest.ts b/fluxer_desktop/src/main/ModuleManifest.ts
index 70087ce1f..5de7e400c 100644
--- a/fluxer_desktop/src/main/ModuleManifest.ts
+++ b/fluxer_desktop/src/main/ModuleManifest.ts
@@ -26,7 +26,7 @@ export interface DesktopModuleManifestEntry {
readonly maximumShellVersion: ModuleVersion | null;
}
-export interface DesktopModuleShellRequirement {
+interface DesktopModuleShellRequirement {
readonly latestVersion: ModuleVersion;
readonly minimumVersion: ModuleVersion;
}
diff --git a/fluxer_desktop/src/main/ModulePackage.ts b/fluxer_desktop/src/main/ModulePackage.ts
index bea13f565..3717ba559 100644
--- a/fluxer_desktop/src/main/ModulePackage.ts
+++ b/fluxer_desktop/src/main/ModulePackage.ts
@@ -39,7 +39,7 @@ const MODULE_BUILD_VERSION_PATTERN = /^\d+\.\d+\.\d+$/u;
export const DESKTOP_MODULE_FILE_LIST_NAME = 'module.json';
const DESKTOP_MODULE_FILES_PREFIX = 'files/';
-export interface DesktopSharedAssetFile {
+interface DesktopSharedAssetFile {
readonly path: string;
readonly sha256: string;
readonly bytes: number;
diff --git a/fluxer_desktop/src/main/ModulePackageInstaller.ts b/fluxer_desktop/src/main/ModulePackageInstaller.ts
index 08be80eff..b3ec3cb01 100644
--- a/fluxer_desktop/src/main/ModulePackageInstaller.ts
+++ b/fluxer_desktop/src/main/ModulePackageInstaller.ts
@@ -16,7 +16,7 @@ import type {ModulePlanItem} from '@electron/main/ModuleUpdatePlanner';
const MODULE_PACKAGE_HASH_MISMATCH_RETRIES = 1;
const MODULE_PACKAGE_HEADER_TIMEOUT_MS = 30000;
-export const MODULE_PACKAGE_STALL_TIMEOUT_MS = 30000;
+const MODULE_PACKAGE_STALL_TIMEOUT_MS = 30000;
const MODULE_PACKAGE_PROGRESS_INTERVAL_MS = 250;
const TRANSIENT_HTTP_STATUS_FLOOR = 500;
const TRANSIENT_PACKAGE_HTTP_STATUSES: ReadonlySet<number> = new Set([408, 425, 429]);
@@ -98,7 +98,7 @@ export class ModulePackageFetchError extends Error {
}
}
-export class ModulePackageStallError extends ModulePackageFetchError {
+class ModulePackageStallError extends ModulePackageFetchError {
public constructor(moduleName: string, stallMs: number) {
super(moduleName, null, `package download stalled for ${stallMs}ms`);
this.name = 'ModulePackageStallError';
@@ -417,14 +417,15 @@ export class ModulePackageInstaller {
yield chunk.value;
}
} catch (error) {
- transferFailure =
- controller.signal.reason instanceof ModulePackageFetchError
- ? controller.signal.reason
- : error instanceof ModulePackageFetchError
- ? error
- : new ModulePackageFetchError(item.module, null, `package download failed for ${item.module}`, {
- cause: error,
- });
+ if (controller.signal.reason instanceof ModulePackageFetchError) {
+ transferFailure = controller.signal.reason;
+ } else if (error instanceof ModulePackageFetchError) {
+ transferFailure = error;
+ } else {
+ transferFailure = new ModulePackageFetchError(item.module, null, `package download failed for ${item.module}`, {
+ cause: error,
+ });
+ }
throw transferFailure;
} finally {
disarm();
diff --git a/fluxer_desktop/src/main/ModuleStore.ts b/fluxer_desktop/src/main/ModuleStore.ts
index 64bc43749..73d37952a 100644
--- a/fluxer_desktop/src/main/ModuleStore.ts
+++ b/fluxer_desktop/src/main/ModuleStore.ts
@@ -28,17 +28,17 @@ import {parseModuleVersion} from '@electron/main/ModuleVersion';
import {isDesktopModuleName} from '@fluxer/desktop_ipc/src/ModuleContract';
const MODULE_STORE_DIRECTORY_NAME = 'modules';
-export const MODULE_STATE_FILE_NAME = 'state.json';
-export const MODULE_STATE_VERSION = 3;
+const MODULE_STATE_FILE_NAME = 'state.json';
+const MODULE_STATE_VERSION = 3;
const MODULE_UNREADABLE_STATE_SUFFIX = '.unreadable';
const MODULE_DOWNLOAD_DIRECTORY_NAME = 'download';
const MODULE_DOWNLOAD_INCOMING_DIRECTORY_NAME = 'incoming';
const MODULE_STORE_TREE_DIRECTORY_NAME = 'store';
const MODULE_PACKAGE_FILE_EXTENSION = '.br';
const MODULE_PARTIAL_PACKAGE_FILE_EXTENSION = '.partial';
-export const MODULE_INCOMING_STORE_PREFIX = '.incoming-';
+const MODULE_INCOMING_STORE_PREFIX = '.incoming-';
const MODULE_REPLACED_STORE_PREFIX = '.replaced-';
-export const MODULE_PACKAGE_MAX_AGE_MS = 7 * 24 * 60 * 60 * 1000;
+const MODULE_PACKAGE_MAX_AGE_MS = 7 * 24 * 60 * 60 * 1000;
export const MODULE_BOOT_ATTEMPT_ROLLBACK_THRESHOLD = 2;
const MODULE_STATE_MAX_BYTES = 4 * 1024 * 1024;
@@ -50,7 +50,7 @@ const STATE_FILE_MODE = 0o600;
const INSTALLED_FILE_HASH_CHUNK_BYTES = 1024 * 1024;
const INSTALLED_FILE_CHECK_CONCURRENCY = 32;
const TREE_FSYNC_CONCURRENCY = 4;
-export const MODULE_FILE_STAMPS_NAME = '.installed-files.json';
+const MODULE_FILE_STAMPS_NAME = '.installed-files.json';
const MODULE_FILE_STAMPS_VERSION = 1;
const MODULE_FILE_STAMPS_MODE = 0o600;
const MODULE_FILE_STAMPS_MAX_BYTES = 16 * 1024 * 1024;
@@ -110,7 +110,7 @@ export class ModuleStoreDownloadHashMismatchError extends ModuleStoreError {
}
}
-export class ModuleStoreInstallationMissingError extends ModuleStoreError {
+class ModuleStoreInstallationMissingError extends ModuleStoreError {
public readonly module: string;
public readonly sha256: string;
public readonly directory: string;
@@ -124,7 +124,7 @@ export class ModuleStoreInstallationMissingError extends ModuleStoreError {
}
}
-export class ModuleStoreGarbageCollectionOrderError extends ModuleStoreError {
+class ModuleStoreGarbageCollectionOrderError extends ModuleStoreError {
public constructor() {
super('module garbage collection ran before a successful launch');
this.name = 'ModuleStoreGarbageCollectionOrderError';
@@ -1088,7 +1088,7 @@ function serializeModuleStoreState(state: ModuleStoreState): string {
export class ModuleStore {
public readonly root: string;
- public readonly statePath: string;
+ private readonly statePath: string;
public readonly downloadRoot: string;
public readonly incomingDownloadRoot: string;
public readonly storeRoot: string;
diff --git a/fluxer_desktop/src/main/ModuleUpdatePlanner.ts b/fluxer_desktop/src/main/ModuleUpdatePlanner.ts
index 748508a39..8d2816f59 100644
--- a/fluxer_desktop/src/main/ModuleUpdatePlanner.ts
+++ b/fluxer_desktop/src/main/ModuleUpdatePlanner.ts
@@ -41,13 +41,13 @@ export type ModuleUnreachableLaunchDecision =
| {readonly kind: typeof ModuleUnreachableLaunchDecision.LAUNCH}
| {readonly kind: typeof ModuleUnreachableLaunchDecision.BLOCK; readonly reason: ModuleUpdaterBlockReason};
-export const ServedRendererSource = Object.freeze({
+const ServedRendererSource = Object.freeze({
BUNDLED: 'bundled',
MODULE: 'module',
NONE: 'none',
} as const);
-export type ServedRendererSource = (typeof ServedRendererSource)[keyof typeof ServedRendererSource];
+type ServedRendererSource = (typeof ServedRendererSource)[keyof typeof ServedRendererSource];
export interface ServedModuleSelection {
readonly modules: Readonly<Record<string, string>>;
@@ -83,7 +83,7 @@ export class ModuleUpdatePlanner {
return this.hasOfflineRenderer || Object.keys(committed).length > 0;
}
- public hasBundledRenderer(): boolean {
+ private hasBundledRenderer(): boolean {
return this.bundledRendererVersion != null || this.bundleOutranksEveryModule;
}
@@ -91,7 +91,7 @@ export class ModuleUpdatePlanner {
return this.hasBundledRenderer() ? [DESKTOP_RENDERER_MODULE_NAME] : [];
}
- public bundleCoversRendererAt(version: ModuleVersion): boolean {
+ private bundleCoversRendererAt(version: ModuleVersion): boolean {
if (this.bundleOutranksEveryModule) {
return true;
}
diff --git a/fluxer_desktop/src/main/ModuleUpdater.ts b/fluxer_desktop/src/main/ModuleUpdater.ts
index 8b8f3dfe3..badfc5e29 100644
--- a/fluxer_desktop/src/main/ModuleUpdater.ts
+++ b/fluxer_desktop/src/main/ModuleUpdater.ts
@@ -284,7 +284,7 @@ function isRejectedManifestError(error: unknown): boolean {
}
export class ModuleUpdater {
- public readonly store: ModuleStore;
+ private readonly store: ModuleStore;
private readonly platform: string;
private readonly shellVersion: ModuleVersion;
private readonly hasOfflineRenderer: boolean;