Skip to content

Commit ed5bb3c

Browse files
committed
Write diagnostics to temporary location when database isn't ready
1 parent bf28f43 commit ed5bb3c

5 files changed

Lines changed: 257 additions & 167 deletions

File tree

‎lib/entry-points.js‎

Lines changed: 41 additions & 24 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/config/db-config.test.ts‎

Lines changed: 75 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ import {
99
LoggedMessage,
1010
makeMacro,
1111
RecordingLogger,
12+
setupActionsVars,
1213
} from "../testing-utils";
13-
import { ConfigurationError, prettyPrintPack } from "../util";
14+
import { ConfigurationError, prettyPrintPack, withTmpDir } from "../util";
1415

1516
import * as dbConfig from "./db-config";
1617

@@ -562,69 +563,84 @@ test("mergeDefaultSetupAndUserConfigs - keeps other properties from user-supplie
562563
t.deepEqual(result, configFile);
563564
});
564565

565-
test("mergeDefaultSetupAndUserConfigs - ignores, but warns about, unknown keys from Default Setup", async (t) => {
566-
const logger = new RecordingLogger();
567-
const configFile: dbConfig.UserConfig = {
568-
"query-filters": [{ exclude: { a: "b" } }],
569-
"paths-ignore": ["path"],
570-
};
571-
572-
const result = dbConfig.mergeDefaultSetupAndUserConfigs(
573-
logger,
574-
{
575-
"default-setup": {
576-
borg: [],
577-
org: {
578-
unknown: "foo",
579-
"model-packs": [],
566+
test.serial(
567+
"mergeDefaultSetupAndUserConfigs - ignores, but warns about, unknown keys from Default Setup",
568+
async (t) => {
569+
const logger = new RecordingLogger();
570+
const configFile: dbConfig.UserConfig = {
571+
"query-filters": [{ exclude: { a: "b" } }],
572+
"paths-ignore": ["path"],
573+
};
574+
575+
await withTmpDir(async (tmpDir) => {
576+
setupActionsVars(tmpDir, tmpDir);
577+
const result = dbConfig.mergeDefaultSetupAndUserConfigs(
578+
logger,
579+
{
580+
"default-setup": {
581+
borg: [],
582+
org: {
583+
unknown: "foo",
584+
"model-packs": [],
585+
},
586+
} as unknown as dbConfig.DefaultSetupConfig,
587+
"paths-ignore": ["other-path"],
580588
},
581-
} as unknown as dbConfig.DefaultSetupConfig,
582-
"paths-ignore": ["other-path"],
583-
},
584-
configFile,
585-
);
589+
configFile,
590+
);
591+
592+
t.deepEqual(result, {
593+
...configFile,
594+
"default-setup": { org: { "model-packs": [] } },
595+
});
596+
597+
const expectedUnrecognisedKeys = [
598+
".default-setup.org.unknown",
599+
".default-setup.borg",
600+
".paths-ignore",
601+
].join(", ");
602+
checkExpectedLogMessages(t, logger.messages, [
603+
`Unrecognised keys in Default Setup configuration: ${expectedUnrecognisedKeys}`,
604+
]);
605+
});
606+
},
607+
);
586608

587-
t.deepEqual(result, {
588-
...configFile,
589-
"default-setup": { org: { "model-packs": [] } },
590-
});
591-
592-
const expectedUnrecognisedKeys = [
593-
".default-setup.org.unknown",
594-
".default-setup.borg",
595-
".paths-ignore",
596-
].join(", ");
597-
checkExpectedLogMessages(t, logger.messages, [
598-
`Unrecognised keys in Default Setup configuration: ${expectedUnrecognisedKeys}`,
599-
]);
600-
});
609+
test.serial(
610+
"mergeDefaultSetupAndUserConfigs - warns about invalid keys from Default Setup",
611+
async (t) => {
612+
const logger = new RecordingLogger();
613+
const configFile: dbConfig.UserConfig = {};
601614

602-
test("mergeDefaultSetupAndUserConfigs - warns about invalid keys from Default Setup", async (t) => {
603-
const logger = new RecordingLogger();
604-
const configFile: dbConfig.UserConfig = {};
615+
await withTmpDir(async (tmpDir) => {
616+
setupActionsVars(tmpDir, tmpDir);
605617

606-
const result = dbConfig.mergeDefaultSetupAndUserConfigs(
607-
logger,
608-
{
609-
"default-setup": {
610-
org: {
611-
"model-packs": [123],
618+
const result = dbConfig.mergeDefaultSetupAndUserConfigs(
619+
logger,
620+
{
621+
"default-setup": {
622+
org: {
623+
"model-packs": [123],
624+
},
625+
} as unknown as dbConfig.DefaultSetupConfig,
612626
},
613-
} as unknown as dbConfig.DefaultSetupConfig,
614-
},
615-
configFile,
616-
);
617-
618-
t.deepEqual(result, {
619-
...configFile,
620-
"default-setup": { org: { "model-packs": [123] } },
621-
});
622-
623-
const expectedInvalidKeys = [".default-setup.org.model-packs[0]"].join(", ");
624-
checkExpectedLogMessages(t, logger.messages, [
625-
`Invalid keys in Default Setup configuration: ${expectedInvalidKeys}`,
626-
]);
627-
});
627+
configFile,
628+
);
629+
630+
t.deepEqual(result, {
631+
...configFile,
632+
"default-setup": { org: { "model-packs": [123] } },
633+
});
634+
635+
const expectedInvalidKeys = [".default-setup.org.model-packs[0]"].join(
636+
", ",
637+
);
638+
checkExpectedLogMessages(t, logger.messages, [
639+
`Invalid keys in Default Setup configuration: ${expectedInvalidKeys}`,
640+
]);
641+
});
642+
},
643+
);
628644

629645
/** Parses `contents` as a configuration without validating it. */
630646
function parseUnvalidatedConfig(contents: string): dbConfig.UserConfig {

0 commit comments

Comments
 (0)