Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 2 additions & 63 deletions src/config/config.server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { Config } from './config.interface';
import { DefaultAppConfig } from './default-app-config';
import { ServerConfig } from './server-config.interface';
import { mergeConfig } from './config.util';
import { buildPublicConfig } from './public-config';
import { isNotEmpty } from '../app/shared/empty.util';

const CONFIG_PATH = join(process.cwd(), 'config');
Expand Down Expand Up @@ -237,69 +238,7 @@ export const buildAppConfig = (destConfigPath?: string): AppConfig => {
buildBaseUrl(appConfig.rest);

if (isNotEmpty(destConfigPath)) {
// Create sanitized public config - only expose what frontend actually needs
const publicConfig = {
production: appConfig.production,
// REST API configuration - only public endpoint
...(appConfig.rest && {
rest: {
baseUrl: appConfig.rest.baseUrl,
nameSpace: appConfig.rest.nameSpace,
ssrBaseUrl: appConfig.rest.ssrBaseUrl,
},
}),
// UI namespace for routing
...(appConfig.ui ? { ui: { nameSpace: appConfig.ui.nameSpace } } : {}),
// Auth configuration - only expose client-side settings (idle timeout, token refresh)
auth: {
ui: {
timeUntilIdle: appConfig.auth?.ui?.timeUntilIdle,
idleGracePeriod: appConfig.auth?.ui?.idleGracePeriod,
},
rest: {
timeLeftBeforeTokenRefresh: appConfig.auth?.rest?.timeLeftBeforeTokenRefresh,
},
},
// Cache configuration - frontend needs msToLive, control, and autoSync settings
cache: {
msToLive: appConfig.cache?.msToLive,
control: appConfig.cache?.control,
},
// Frontend feature configurations
languages: appConfig.languages,
defaultLanguage: appConfig.defaultLanguage,
themes: appConfig.themes,
form: appConfig.form,
notifications: appConfig.notifications,
submission: appConfig.submission,
browseBy: appConfig.browseBy,
communityList: appConfig.communityList,
homePage: appConfig.homePage,
item: appConfig.item,
collection: appConfig.collection,
mediaViewer: appConfig.mediaViewer,
bundle: appConfig.bundle,
info: appConfig.info,
markdown: appConfig.markdown,
vocabularies: appConfig.vocabularies,
comcolSelectionSort: appConfig.comcolSelectionSort,
liveRegion: appConfig.liveRegion,
search: appConfig.search,
accessibility: appConfig.accessibility,
signpostingEnabled: appConfig.signpostingEnabled,
// Matomo analytics - only expose client-side tracking properties
...(appConfig.matomo && {
matomo: {
enabled: appConfig.matomo.enabled,
hostUrl: appConfig.matomo.hostUrl,
siteId: appConfig.matomo.siteId,
dimensionId: appConfig.matomo.dimensionId,
},
}),
debug: appConfig.debug,
};

writeFileSync(destConfigPath, JSON.stringify(publicConfig, null, 2));
writeFileSync(destConfigPath, JSON.stringify(buildPublicConfig(appConfig), null, 2));

console.log(`Angular ${bold('config.json')} file generated correctly at ${bold(destConfigPath)} \n`);
}
Expand Down
64 changes: 64 additions & 0 deletions src/config/public-config.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import { BuildConfig } from './build-config.interface';
import { DefaultAppConfig } from './default-app-config';
import { buildPublicConfig } from './public-config';

describe('buildPublicConfig', () => {
const appConfig: BuildConfig = {
...new DefaultAppConfig(),
ui: {
ssl: false,
host: 'dspace-angular',
port: 4000,
nameSpace: '/',
baseUrl: 'http://dspace-angular:4000/',
rateLimiter: { windowMs: 60000, max: 500 },
useProxies: true,
},
rest: {
ssl: true,
host: 'repository.example.org',
port: 443,
nameSpace: '/server',
baseUrl: 'https://repository.example.org/server',
ssrBaseUrl: 'http://dspace:8080/server',
},
universal: {
preboot: true,
async: true,
time: false,
transferState: false,
replaceRestUrl: true,
excludePathPatterns: [{ pattern: '^/search' }],
enableSearchComponent: false,
enableBrowseComponent: false,
},
};

let publicConfig: any;

beforeEach(() => {
publicConfig = buildPublicConfig(appConfig);
});

it('should not contain the server settings', () => {
expect(Object.keys(publicConfig.ui)).toEqual(['nameSpace']);
expect(Object.keys(publicConfig.rest)).toEqual(['baseUrl', 'nameSpace']);
expect(publicConfig.cache.serverSide).toBeUndefined();
expect(publicConfig.actuators).toBeUndefined();
});

it('should contain the settings the browser reads', () => {
expect(publicConfig.rest.baseUrl).toEqual('https://repository.example.org/server');
expect(publicConfig.ui.nameSpace).toEqual('/');
expect(publicConfig.universal).toEqual({ transferState: false });
expect(publicConfig.cache.msToLive).toEqual(appConfig.cache.msToLive);
expect(publicConfig.cache.control).toEqual(appConfig.cache.control);
expect(publicConfig.cache.autoSync).toEqual(appConfig.cache.autoSync);
expect(publicConfig.auth).toEqual({
ui: appConfig.auth.ui,
rest: { timeLeftBeforeTokenRefresh: appConfig.auth.rest.timeLeftBeforeTokenRefresh },
});
expect(publicConfig.matomo).toEqual(appConfig.matomo);
expect(publicConfig.themes).toEqual(appConfig.themes);
});
});
63 changes: 63 additions & 0 deletions src/config/public-config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import { BuildConfig } from './build-config.interface';

type DeepPartial<T> = T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T;

/**
* Returns only the part of the app config the browser needs.
* It is written to config.json and to the SSR transfer state.
*/
export const buildPublicConfig = (appConfig: Partial<BuildConfig>): DeepPartial<BuildConfig> => ({
production: appConfig.production,
...(appConfig.rest && {
rest: {
baseUrl: appConfig.rest.baseUrl,
nameSpace: appConfig.rest.nameSpace,
},
}),
...(appConfig.ui ? { ui: { nameSpace: appConfig.ui.nameSpace } } : {}),
...(appConfig.universal && { universal: { transferState: appConfig.universal.transferState } }),
auth: {
ui: {
timeUntilIdle: appConfig.auth?.ui?.timeUntilIdle,
idleGracePeriod: appConfig.auth?.ui?.idleGracePeriod,
},
rest: {
timeLeftBeforeTokenRefresh: appConfig.auth?.rest?.timeLeftBeforeTokenRefresh,
},
},
cache: {
msToLive: appConfig.cache?.msToLive,
control: appConfig.cache?.control,
autoSync: appConfig.cache?.autoSync,
},
languages: appConfig.languages,
defaultLanguage: appConfig.defaultLanguage,
themes: appConfig.themes,
form: appConfig.form,
notifications: appConfig.notifications,
submission: appConfig.submission,
browseBy: appConfig.browseBy,
communityList: appConfig.communityList,
homePage: appConfig.homePage,
item: appConfig.item,
collection: appConfig.collection,
mediaViewer: appConfig.mediaViewer,
bundle: appConfig.bundle,
info: appConfig.info,
markdown: appConfig.markdown,
vocabularies: appConfig.vocabularies,
comcolSelectionSort: appConfig.comcolSelectionSort,
liveRegion: appConfig.liveRegion,
search: appConfig.search,
accessibility: appConfig.accessibility,
signpostingEnabled: appConfig.signpostingEnabled,
...(appConfig.matomo && {
matomo: {
enabled: appConfig.matomo.enabled,
hostUrl: appConfig.matomo.hostUrl,
siteId: appConfig.matomo.siteId,
dimensionId: appConfig.matomo.dimensionId,
},
}),
debug: appConfig.debug,
});
13 changes: 3 additions & 10 deletions src/modules/app/server-init.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ import { BreadcrumbsService } from '../../app/breadcrumbs/breadcrumbs.service';
import { ThemeService } from '../../app/shared/theme-support/theme.service';
import { take } from 'rxjs/operators';
import { MenuService } from '../../app/shared/menu/menu.service';
import { isEmpty, isNotEmpty } from '../../app/shared/empty.util';
import { isEmpty } from '../../app/shared/empty.util';
import { BuildConfig } from '../../config/build-config.interface';
import { buildPublicConfig } from '../../config/public-config';

/**
* Performs server-side initialization.
Expand Down Expand Up @@ -95,14 +96,6 @@ export class ServerInitService extends InitService {
}

private saveAppConfigForCSR(): void {
if (isNotEmpty(environment.rest.ssrBaseUrl) && environment.rest.baseUrl !== environment.rest.ssrBaseUrl) {
// Avoid to transfer ssrBaseUrl in order to prevent security issues
const config: AppConfig = Object.assign({}, environment as AppConfig, {
rest: Object.assign({}, environment.rest, { ssrBaseUrl: '', hasSsrBaseUrl: true }),
});
this.transferState.set<AppConfig>(APP_CONFIG_STATE, config);
} else {
this.transferState.set<AppConfig>(APP_CONFIG_STATE, environment as AppConfig);
}
this.transferState.set<AppConfig>(APP_CONFIG_STATE, buildPublicConfig(environment) as AppConfig);
}
}
Loading