mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2025-12-03 20:04:28 +01:00
# Description of Changes <img width="1521" height="1041" alt="image" src="https://github.com/user-attachments/assets/2644bf70-0a9b-4c91-9046-02f555314608" /> <img width="1162" height="1598" alt="image" src="https://github.com/user-attachments/assets/36d693f7-6fdd-4f2b-9db1-39ac336d9055" /> <img width="1220" height="1625" alt="image" src="https://github.com/user-attachments/assets/4d4c19ea-0020-45fb-b15a-9f6ad377856c" /> <!-- Please provide a summary of the changes, including: - What was changed - Why the change was made - Any challenges encountered Closes #(issue_number) --> --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
208 lines
6.4 KiB
TypeScript
208 lines
6.4 KiB
TypeScript
import React, { createContext, useContext, useState, useEffect, ReactNode, useCallback } from 'react';
|
|
import apiClient from '@app/services/apiClient';
|
|
|
|
/**
|
|
* Sleep utility for delays
|
|
*/
|
|
function sleep(ms: number): Promise<void> {
|
|
return new Promise(resolve => setTimeout(resolve, ms));
|
|
}
|
|
|
|
export interface AppConfigRetryOptions {
|
|
maxRetries?: number;
|
|
initialDelay?: number;
|
|
}
|
|
|
|
export interface AppConfig {
|
|
baseUrl?: string;
|
|
contextPath?: string;
|
|
serverPort?: number;
|
|
appNameNavbar?: string;
|
|
languages?: string[];
|
|
logoStyle?: 'modern' | 'classic';
|
|
enableLogin?: boolean;
|
|
enableEmailInvites?: boolean;
|
|
isAdmin?: boolean;
|
|
enableAlphaFunctionality?: boolean;
|
|
enableAnalytics?: boolean | null;
|
|
enablePosthog?: boolean | null;
|
|
enableScarf?: boolean | null;
|
|
premiumEnabled?: boolean;
|
|
premiumKey?: string;
|
|
termsAndConditions?: string;
|
|
privacyPolicy?: string;
|
|
cookiePolicy?: string;
|
|
impressum?: string;
|
|
accessibilityStatement?: string;
|
|
runningProOrHigher?: boolean;
|
|
runningEE?: boolean;
|
|
license?: string;
|
|
SSOAutoLogin?: boolean;
|
|
serverCertificateEnabled?: boolean;
|
|
appVersion?: string;
|
|
machineType?: string;
|
|
activeSecurity?: boolean;
|
|
error?: string;
|
|
}
|
|
|
|
export type AppConfigBootstrapMode = 'blocking' | 'non-blocking';
|
|
|
|
interface AppConfigContextValue {
|
|
config: AppConfig | null;
|
|
loading: boolean;
|
|
error: string | null;
|
|
refetch: () => Promise<void>;
|
|
}
|
|
|
|
const AppConfigContext = createContext<AppConfigContextValue | undefined>({
|
|
config: null,
|
|
loading: true,
|
|
error: null,
|
|
refetch: async () => {},
|
|
});
|
|
|
|
/**
|
|
* Provider component that fetches and provides app configuration
|
|
* Should be placed at the top level of the app, before any components that need config
|
|
*/
|
|
export interface AppConfigProviderProps {
|
|
children: ReactNode;
|
|
retryOptions?: AppConfigRetryOptions;
|
|
initialConfig?: AppConfig | null;
|
|
bootstrapMode?: AppConfigBootstrapMode;
|
|
autoFetch?: boolean;
|
|
}
|
|
|
|
export const AppConfigProvider: React.FC<AppConfigProviderProps> = ({
|
|
children,
|
|
retryOptions,
|
|
initialConfig = null,
|
|
bootstrapMode = 'blocking',
|
|
autoFetch = true,
|
|
}) => {
|
|
const isBlockingMode = bootstrapMode === 'blocking';
|
|
const [config, setConfig] = useState<AppConfig | null>(initialConfig);
|
|
const [error, setError] = useState<string | null>(null);
|
|
const [fetchCount, setFetchCount] = useState(0);
|
|
const [hasResolvedConfig, setHasResolvedConfig] = useState(Boolean(initialConfig) && !isBlockingMode);
|
|
const [loading, setLoading] = useState(!hasResolvedConfig);
|
|
|
|
const maxRetries = retryOptions?.maxRetries ?? 0;
|
|
const initialDelay = retryOptions?.initialDelay ?? 1000;
|
|
|
|
const fetchConfig = useCallback(async (force = false) => {
|
|
// Prevent duplicate fetches unless forced
|
|
if (!force && fetchCount > 0) {
|
|
console.debug('[AppConfig] Already fetched, skipping');
|
|
return;
|
|
}
|
|
|
|
const shouldBlockUI = !hasResolvedConfig || isBlockingMode;
|
|
if (shouldBlockUI) {
|
|
setLoading(true);
|
|
}
|
|
setError(null);
|
|
|
|
for (let attempt = 0; attempt <= maxRetries; attempt++) {
|
|
try {
|
|
if (attempt > 0) {
|
|
const delay = initialDelay * Math.pow(2, attempt - 1);
|
|
console.log(`[AppConfig] Retry attempt ${attempt}/${maxRetries} after ${delay}ms delay...`);
|
|
await sleep(delay);
|
|
} else {
|
|
console.log('[AppConfig] Fetching app config...');
|
|
}
|
|
|
|
// apiClient automatically adds JWT header if available via interceptors
|
|
const response = await apiClient.get<AppConfig>('/api/v1/config/app-config', !isBlockingMode ? { suppressErrorToast: true } : undefined);
|
|
const data = response.data;
|
|
|
|
console.debug('[AppConfig] Config fetched successfully:', data);
|
|
setConfig(data);
|
|
setFetchCount(prev => prev + 1);
|
|
setHasResolvedConfig(true);
|
|
setLoading(false);
|
|
return; // Success - exit function
|
|
} catch (err: any) {
|
|
const status = err?.response?.status;
|
|
|
|
// On 401 (not authenticated), use default config with login enabled
|
|
// This allows the app to work even without authentication
|
|
if (status === 401) {
|
|
console.debug('[AppConfig] 401 error - using default config (login enabled)');
|
|
setConfig({ enableLogin: true });
|
|
setHasResolvedConfig(true);
|
|
setLoading(false);
|
|
return;
|
|
}
|
|
|
|
// Check if we should retry (network errors or 5xx errors)
|
|
const shouldRetry = (!status || status >= 500) && attempt < maxRetries;
|
|
|
|
if (shouldRetry) {
|
|
console.warn(`[AppConfig] Attempt ${attempt + 1} failed (status ${status || 'network error'}):`, err.message, '- will retry...');
|
|
continue;
|
|
}
|
|
|
|
// Final attempt failed or non-retryable error (4xx)
|
|
const errorMessage = err?.response?.data?.message || err?.message || 'Unknown error occurred';
|
|
setError(errorMessage);
|
|
console.error(`[AppConfig] Failed to fetch app config after ${attempt + 1} attempts:`, err);
|
|
// Preserve existing config (initial default or previous fetch). If nothing is set, assume login enabled.
|
|
setConfig((current) => current ?? { enableLogin: true });
|
|
setHasResolvedConfig(true);
|
|
break;
|
|
}
|
|
}
|
|
|
|
setLoading(false);
|
|
}, [fetchCount, hasResolvedConfig, isBlockingMode, maxRetries, initialDelay]);
|
|
|
|
useEffect(() => {
|
|
// Always try to fetch config to check if login is disabled
|
|
// The endpoint should be public and return proper JSON
|
|
if (autoFetch) {
|
|
fetchConfig();
|
|
}
|
|
}, [autoFetch, fetchConfig]);
|
|
|
|
// Listen for JWT availability (triggered on login/signup)
|
|
useEffect(() => {
|
|
const handleJwtAvailable = () => {
|
|
console.debug('[AppConfig] JWT available event - refetching config');
|
|
// Force refetch with JWT
|
|
fetchConfig(true);
|
|
};
|
|
|
|
window.addEventListener('jwt-available', handleJwtAvailable);
|
|
return () => window.removeEventListener('jwt-available', handleJwtAvailable);
|
|
}, [fetchConfig]);
|
|
|
|
const value: AppConfigContextValue = {
|
|
config,
|
|
loading,
|
|
error,
|
|
refetch: () => fetchConfig(true),
|
|
};
|
|
|
|
return (
|
|
<AppConfigContext.Provider value={value}>
|
|
{children}
|
|
</AppConfigContext.Provider>
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Hook to access application configuration
|
|
* Must be used within AppConfigProvider
|
|
*/
|
|
export function useAppConfig(): AppConfigContextValue {
|
|
const context = useContext(AppConfigContext);
|
|
|
|
if (context === undefined) {
|
|
throw new Error('useAppConfig must be used within AppConfigProvider');
|
|
}
|
|
|
|
return context;
|
|
}
|