paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

app-backend: replace all instances when injecting config

Browse Source 
Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>
This commit is contained in:
MT Lewis
2024-01-31 10:47:22 +00:00
parent 33daed5469
commit 998ccf6620
3 changed files with 81 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/red-eggs-serve.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-app-backend': patch
---
Support injecting config multiple times in a single bundle
plugins/app-backend/src/lib/config.test.ts
+73
View File
@@ -62,6 +62,28 @@ describe('injectConfig', () => {
expect(JSON.parse(eval(fsMock.writeFile.mock.calls[0][1]))).toEqual([]);
});
it('should inject config repeatedly if marker appears multiple times', async () => {
fsMock.readdir.mockResolvedValue(['main.js'] as any);
readFileMock.mockImplementation(
async () =>
'({a:"__APP_INJECTED_RUNTIME_CONFIG__",b:"__APP_INJECTED_RUNTIME_CONFIG__"})',
);
await injectConfig(baseOptions);
expect(fsMock.readdir).toHaveBeenCalledTimes(1);
expect(fsMock.readFile).toHaveBeenCalledTimes(1);
expect(fsMock.writeFile).toHaveBeenCalledTimes(1);
expect(fsMock.writeFile).toHaveBeenCalledWith(
resolvePath(MOCK_DIR, 'main.js'),
'({a:/*__APP_INJECTED_CONFIG_MARKER__*/"[]"/*__INJECTED_END__*/,b:/*__APP_INJECTED_CONFIG_MARKER__*/"[]"/*__INJECTED_END__*/})',
'utf8',
);
// eslint-disable-next-line no-eval
expect(JSON.parse(eval(fsMock.writeFile.mock.calls[0][1]).a)).toEqual([]);
// eslint-disable-next-line no-eval
expect(JSON.parse(eval(fsMock.writeFile.mock.calls[0][1]).b)).toEqual([]);
});
it('should find the correct file to inject', async () => {
fsMock.readdir.mockResolvedValue([
'before.js',
@@ -152,4 +174,55 @@ describe('injectConfig', () => {
{ data: { x: 1, y: 2 }, context: 'test' },
]);
});
it('should re-inject config repeatedly if needed', async () => {
fsMock.readdir.mockResolvedValue(['main.js'] as any);
readFileMock.mockResolvedValue(
'({ a: JSON.parse("__APP_INJECTED_RUNTIME_CONFIG__"), b: JSON.parse("__APP_INJECTED_RUNTIME_CONFIG__") })',
);
await injectConfig({
...baseOptions,
appConfigs: [{ data: { x: 0 }, context: 'test' }],
});
expect(fsMock.writeFile).toHaveBeenCalledTimes(1);
expect(fsMock.writeFile).toHaveBeenCalledWith(
resolvePath(MOCK_DIR, 'main.js'),
'({ a: JSON.parse(/*__APP_INJECTED_CONFIG_MARKER__*/"[{\\"data\\":{\\"x\\":0},\\"context\\":\\"test\\"}]"/*__INJECTED_END__*/), b: JSON.parse(/*__APP_INJECTED_CONFIG_MARKER__*/"[{\\"data\\":{\\"x\\":0},\\"context\\":\\"test\\"}]"/*__INJECTED_END__*/) })',
'utf8',
);
// eslint-disable-next-line no-eval
expect(eval(fsMock.writeFile.mock.calls[0][1]).a).toEqual([
{ data: { x: 0 }, context: 'test' },
]);
// eslint-disable-next-line no-eval
expect(eval(fsMock.writeFile.mock.calls[0][1]).b).toEqual([
{ data: { x: 0 }, context: 'test' },
]);
readFileMock.mockResolvedValue(fsMock.writeFile.mock.calls[0][1]);
await injectConfig({
...baseOptions,
appConfigs: [{ data: { x: 1, y: 2 }, context: 'test' }],
});
expect(fsMock.writeFile).toHaveBeenCalledTimes(2);
expect(fsMock.writeFile).toHaveBeenLastCalledWith(
resolvePath(MOCK_DIR, 'main.js'),
'({ a: JSON.parse(/*__APP_INJECTED_CONFIG_MARKER__*/"[{\\"data\\":{\\"x\\":1,\\"y\\":2},\\"context\\":\\"test\\"}]"/*__INJECTED_END__*/), b: JSON.parse(/*__APP_INJECTED_CONFIG_MARKER__*/"[{\\"data\\":{\\"x\\":1,\\"y\\":2},\\"context\\":\\"test\\"}]"/*__INJECTED_END__*/) })',
'utf8',
);
// eslint-disable-next-line no-eval
expect(eval(fsMock.writeFile.mock.calls[1][1]).a).toEqual([
{ data: { x: 1, y: 2 }, context: 'test' },
]);
// eslint-disable-next-line no-eval
expect(eval(fsMock.writeFile.mock.calls[1][1]).b).toEqual([
{ data: { x: 1, y: 2 }, context: 'test' },
]);
});
});
plugins/app-backend/src/lib/config.ts
+3 -3
View File
@@ -49,7 +49,7 @@ export async function injectConfig(
if (content.includes('__APP_INJECTED_RUNTIME_CONFIG__')) {
logger.info(`Injecting env config into ${jsFile}`);
const newContent = content.replace(
const newContent = content.replaceAll(
'"__APP_INJECTED_RUNTIME_CONFIG__"',
injected,
);
@@ -58,8 +58,8 @@ export async function injectConfig(
} else if (content.includes('__APP_INJECTED_CONFIG_MARKER__')) {
logger.info(`Replacing injected env config in ${jsFile}`);
const newContent = content.replace(
/\/\*__APP_INJECTED_CONFIG_MARKER__\*\/.*\/\*__INJECTED_END__\*\//,
const newContent = content.replaceAll(
/\/\*__APP_INJECTED_CONFIG_MARKER__\*\/.*?\/\*__INJECTED_END__\*\//g,
injected,
);
await fs.writeFile(path, newContent, 'utf8');