Skip to content

feat!: update runtime config support #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brian-smith-tcril wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat!: update runtime config support #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
49c9056
feat!: update runtime config support
brian-smith-tcril Jan 21, 2026
18bac8e
test: update runtime config test for top-level config merging
brian-smith-tcril Feb 4, 2026
e2c6343
test: add app-level runtime config merge test
brian-smith-tcril Feb 4, 2026
c72f4de
refactor: remove unused newConfig test fixture
brian-smith-tcril Feb 4, 2026
6132012
refactor: use realistic config values and fake.url pattern
brian-smith-tcril Feb 4, 2026
ca88aa9
fix: merge apps by appId instead of array index
brian-smith-tcril Feb 4, 2026
d05935e
test: add unit tests for mergeSiteConfig
brian-smith-tcril Feb 4, 2026
b2729a9
chore: rename appConfigOnly to limitAppMergeToConfig
brian-smith-tcril Feb 4, 2026
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
2 changes: 1 addition & 1 deletion docs/how_tos/migrate-frontend-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,7 @@ Other configuration is now optional, and many values have been given sensible de

- environment: EnvironmentTypes
- basename: string
- mfeConfigApiUrl: string | null
- runtimeConfigJsonUrl: string | null
- accessTokenCookieName: string
- languagePreferenceCookieName: string
- userInfoCookieName: string
Expand Down
19 changes: 18 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"@stylistic/eslint-plugin": "^2.9.0",
"@types/eslint__js": "^8.42.3",
"@types/gradient-string": "^1.1.6",
"@types/lodash.keyby": "^4.6.9",
"autoprefixer": "^10.4.20",
"axios": "^1.7.9",
"axios-cache-interceptor": "^1.6.0",
Expand Down Expand Up @@ -94,6 +95,7 @@
"localforage": "^1.10.0",
"localforage-memoryStorageDriver": "^0.9.2",
"lodash.camelcase": "^4.3.0",
"lodash.keyby": "^4.6.0",
"lodash.memoize": "^4.1.2",
"lodash.merge": "^4.6.2",
"lodash.snakecase": "^4.1.1",
Expand Down
298 changes: 298 additions & 0 deletions runtime/config/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,298 @@
import { CONFIG_CHANGED } from '../constants';
import * as subscriptions from '../subscriptions';
import {
getSiteConfig,
mergeSiteConfig,
setSiteConfig,
} from './index';

const defaultSiteConfig = {
siteId: '',
baseUrl: '',
siteName: '',
loginUrl: '',
logoutUrl: '',
lmsBaseUrl: '',
apps: [],
};

describe('mergeSiteConfig', () => {
let publishSpy: jest.SpyInstance;

beforeEach(() => {
setSiteConfig({ ...defaultSiteConfig });
publishSpy = jest.spyOn(subscriptions, 'publish');
});

afterEach(() => {
publishSpy.mockRestore();
});

describe('top-level config merging', () => {
it('should merge new values into site config', () => {
mergeSiteConfig({
siteName: 'Test Site',
lmsBaseUrl: 'http://fake.lms.url',
});

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);
expect(getSiteConfig().siteName).toBe('Test Site');
expect(getSiteConfig().lmsBaseUrl).toBe('http://fake.lms.url');
});

it('should override existing values', () => {
setSiteConfig({ ...defaultSiteConfig, siteName: 'Original' });
publishSpy.mockClear();

mergeSiteConfig({ siteName: 'Updated' });

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);
expect(getSiteConfig().siteName).toBe('Updated');
});

it('should preserve existing values not in new config', () => {
setSiteConfig({ ...defaultSiteConfig, siteName: 'Original', lmsBaseUrl: 'http://original.url' });
publishSpy.mockClear();

mergeSiteConfig({ siteName: 'Updated' });

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);
expect(getSiteConfig().siteName).toBe('Updated');
expect(getSiteConfig().lmsBaseUrl).toBe('http://original.url');
});
});

describe('app merging (full merge, default behavior)', () => {
it('should add new apps when none exist', () => {
mergeSiteConfig({
apps: [{
appId: 'new-app',
config: { FEATURE: true },
}],
});

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);
expect(getSiteConfig().apps).toHaveLength(1);
expect(getSiteConfig().apps![0].appId).toBe('new-app');
expect(getSiteConfig().apps![0].config!.FEATURE).toBe(true);
});

it('should merge apps by appId, not array index', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [
{ appId: 'app-one', config: { VALUE: 'one' } },
{ appId: 'app-two', config: { VALUE: 'two' } },
],
});
publishSpy.mockClear();

// New config has apps in different order
mergeSiteConfig({
apps: [
{ appId: 'app-two', config: { EXTRA: 'added-to-two' } },
],
});

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

const apps = getSiteConfig().apps!;
expect(apps).toHaveLength(2);

const appOne = apps.find(a => a.appId === 'app-one')!;
const appTwo = apps.find(a => a.appId === 'app-two')!;

// app-one should be unchanged
expect(appOne.config!.VALUE).toBe('one');
expect(appOne.config!.EXTRA).toBeUndefined();

// app-two should have merged config
expect(appTwo.config!.VALUE).toBe('two');
expect(appTwo.config!.EXTRA).toBe('added-to-two');
});

it('should add new apps while preserving existing ones', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{ appId: 'existing-app', config: { VALUE: 'existing' } }],
});
publishSpy.mockClear();

mergeSiteConfig({
apps: [{ appId: 'new-app', config: { VALUE: 'new' } }],
});

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

const apps = getSiteConfig().apps!;
expect(apps).toHaveLength(2);
expect(apps.find(a => a.appId === 'existing-app')).toBeDefined();
expect(apps.find(a => a.appId === 'new-app')).toBeDefined();
});

it('should deep merge app properties', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{
appId: 'test-app',
config: { NESTED: { a: 1, b: 2 } },
}],
});
publishSpy.mockClear();

mergeSiteConfig({
apps: [{
appId: 'test-app',
config: { NESTED: { b: 3, c: 4 } },
}],
});

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

const app = getSiteConfig().apps!.find(a => a.appId === 'test-app')!;
expect(app.config!.NESTED).toEqual({ a: 1, b: 3, c: 4 });
});
});

describe('app merging (limitAppMergeToConfig: true)', () => {
it('should do nothing when no existing apps', () => {
mergeSiteConfig(
{ apps: [{ appId: 'new-app', config: { VALUE: 'test' } }] },
{ limitAppMergeToConfig: true }
);

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);
expect(getSiteConfig().apps).toHaveLength(0);
});

it('should not add new apps', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{ appId: 'existing-app', config: { VALUE: 'existing' } }],
});
publishSpy.mockClear();

mergeSiteConfig(
{ apps: [{ appId: 'new-app', config: { VALUE: 'new' } }] },
{ limitAppMergeToConfig: true }
);

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);
expect(getSiteConfig().apps).toHaveLength(1);
expect(getSiteConfig().apps![0].appId).toBe('existing-app');
});

it('should only merge config for existing apps', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{
appId: 'test-app',
config: { ORIGINAL: 'value', OVERRIDE: 'old' },
}],
});
publishSpy.mockClear();

mergeSiteConfig(
{
apps: [{
appId: 'test-app',
config: { OVERRIDE: 'new', ADDED: 'extra' },
}],
},
{ limitAppMergeToConfig: true }
);

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

const app = getSiteConfig().apps![0];
expect(app.config!.ORIGINAL).toBe('value');
expect(app.config!.OVERRIDE).toBe('new');
expect(app.config!.ADDED).toBe('extra');
});

it('should merge by appId, not array index', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [
{ appId: 'app-one', config: { VALUE: 'one' } },
{ appId: 'app-two', config: { VALUE: 'two' } },
],
});
publishSpy.mockClear();

// New config only has app-two at index 0
mergeSiteConfig(
{
apps: [{ appId: 'app-two', config: { EXTRA: 'added' } }],
},
{ limitAppMergeToConfig: true }
);

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

const apps = getSiteConfig().apps!;
const appOne = apps.find(a => a.appId === 'app-one')!;
const appTwo = apps.find(a => a.appId === 'app-two')!;

// app-one should be unchanged (was at index 0, but new config had app-two at index 0)
expect(appOne.config!.VALUE).toBe('one');
expect(appOne.config!.EXTRA).toBeUndefined();

// app-two should have merged config
expect(appTwo.config!.VALUE).toBe('two');
expect(appTwo.config!.EXTRA).toBe('added');
});
});

describe('edge cases', () => {
it('should handle empty apps array in new config', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{ appId: 'existing', config: { VALUE: 'test' } }],
});
publishSpy.mockClear();

mergeSiteConfig({ apps: [] });

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

// Should be unchanged
expect(getSiteConfig().apps).toHaveLength(1);
expect(getSiteConfig().apps![0].appId).toBe('existing');
});

it('should handle undefined apps in new config', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{ appId: 'existing', config: { VALUE: 'test' } }],
});
publishSpy.mockClear();

mergeSiteConfig({ siteName: 'Updated' });

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

// Apps should be unchanged
expect(getSiteConfig().apps).toHaveLength(1);
expect(getSiteConfig().siteName).toBe('Updated');
});

it('should handle app with no config property', () => {
setSiteConfig({
...defaultSiteConfig,
apps: [{ appId: 'test-app', config: { ORIGINAL: 'value' } }],
});
publishSpy.mockClear();

mergeSiteConfig(
{ apps: [{ appId: 'test-app' }] },
{ limitAppMergeToConfig: true }
);

expect(publishSpy).toHaveBeenCalledWith(CONFIG_CHANGED);

// Config should be unchanged
expect(getSiteConfig().apps![0].config!.ORIGINAL).toBe('value');
});
});
});
Loading
Loading