@prairielearn/config 2.0.17 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mocharc.cjs +3 -0
- package/CHANGELOG.md +11 -0
- package/dist/index.js +25 -36
- package/dist/index.js.map +1 -1
- package/dist/index.test.js +38 -40
- package/dist/index.test.js.map +1 -1
- package/package.json +7 -6
- package/src/index.test.ts +1 -1
package/.mocharc.cjs
ADDED
package/CHANGELOG.md
CHANGED
package/dist/index.js
CHANGED
|
@@ -1,47 +1,39 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
};
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
const
|
|
8
|
-
|
|
9
|
-
const zod_1 = require("zod");
|
|
10
|
-
const client_ec2_1 = require("@aws-sdk/client-ec2");
|
|
11
|
-
const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
|
|
12
|
-
const aws_imds_1 = require("@prairielearn/aws-imds");
|
|
13
|
-
const AbstractConfigSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
|
|
14
|
-
function makeLiteralConfigSource(config) {
|
|
1
|
+
import _ from 'lodash';
|
|
2
|
+
import fs from 'fs-extra';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
import { EC2Client, DescribeTagsCommand } from '@aws-sdk/client-ec2';
|
|
5
|
+
import { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-secrets-manager';
|
|
6
|
+
import { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';
|
|
7
|
+
const AbstractConfigSchema = z.record(z.string(), z.unknown());
|
|
8
|
+
export function makeLiteralConfigSource(config) {
|
|
15
9
|
return {
|
|
16
10
|
load: async () => config,
|
|
17
11
|
};
|
|
18
12
|
}
|
|
19
|
-
|
|
20
|
-
function makeFileConfigSource(path) {
|
|
13
|
+
export function makeFileConfigSource(path) {
|
|
21
14
|
return {
|
|
22
15
|
load: async () => {
|
|
23
|
-
if (!(await
|
|
16
|
+
if (!(await fs.pathExists(path)))
|
|
24
17
|
return {};
|
|
25
|
-
const config = await
|
|
26
|
-
return
|
|
18
|
+
const config = await fs.readJson(path);
|
|
19
|
+
return z.record(z.string(), z.any()).parse(config);
|
|
27
20
|
},
|
|
28
21
|
};
|
|
29
22
|
}
|
|
30
|
-
|
|
31
|
-
function makeSecretsManagerConfigSource(tagKey) {
|
|
23
|
+
export function makeSecretsManagerConfigSource(tagKey) {
|
|
32
24
|
return {
|
|
33
25
|
load: async (existingConfig) => {
|
|
34
26
|
if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {
|
|
35
27
|
return {};
|
|
36
28
|
}
|
|
37
|
-
const identity = await
|
|
29
|
+
const identity = await fetchInstanceIdentity();
|
|
38
30
|
// We disable the ESLint rule here because we don't care about sharing
|
|
39
31
|
// configs between clients in this case. We only want to share configs
|
|
40
32
|
// to avoid spamming the IMDS API when creating lots of clients, but
|
|
41
33
|
// this client will only be used once, typically at application startup.
|
|
42
34
|
// eslint-disable-next-line @prairielearn/aws-client-shared-config
|
|
43
|
-
const ec2Client = new
|
|
44
|
-
const tags = await ec2Client.send(new
|
|
35
|
+
const ec2Client = new EC2Client({ region: identity.region });
|
|
36
|
+
const tags = await ec2Client.send(new DescribeTagsCommand({
|
|
45
37
|
Filters: [{ Name: 'resource-id', Values: [identity.instanceId] }],
|
|
46
38
|
}));
|
|
47
39
|
const secretId = tags.Tags?.find((tag) => tag.Key === tagKey)?.Value;
|
|
@@ -49,24 +41,23 @@ function makeSecretsManagerConfigSource(tagKey) {
|
|
|
49
41
|
return {};
|
|
50
42
|
// As above, we don't care about sharing configs between clients.
|
|
51
43
|
// eslint-disable-next-line @prairielearn/aws-client-shared-config
|
|
52
|
-
const secretsManagerClient = new
|
|
53
|
-
const secretValue = await secretsManagerClient.send(new
|
|
44
|
+
const secretsManagerClient = new SecretsManagerClient({ region: identity.region });
|
|
45
|
+
const secretValue = await secretsManagerClient.send(new GetSecretValueCommand({ SecretId: secretId }));
|
|
54
46
|
if (!secretValue.SecretString)
|
|
55
47
|
return {};
|
|
56
48
|
const config = JSON.parse(secretValue.SecretString);
|
|
57
|
-
return
|
|
49
|
+
return z.record(z.string(), z.any()).parse(config);
|
|
58
50
|
},
|
|
59
51
|
};
|
|
60
52
|
}
|
|
61
|
-
|
|
62
|
-
function makeImdsConfigSource() {
|
|
53
|
+
export function makeImdsConfigSource() {
|
|
63
54
|
return {
|
|
64
55
|
load: async (existingConfig) => {
|
|
65
56
|
if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {
|
|
66
57
|
return {};
|
|
67
58
|
}
|
|
68
|
-
const hostname = await
|
|
69
|
-
const identity = await
|
|
59
|
+
const hostname = await fetchInstanceHostname();
|
|
60
|
+
const identity = await fetchInstanceIdentity();
|
|
70
61
|
return {
|
|
71
62
|
hostname,
|
|
72
63
|
instanceId: identity.instanceId,
|
|
@@ -75,8 +66,7 @@ function makeImdsConfigSource() {
|
|
|
75
66
|
},
|
|
76
67
|
};
|
|
77
68
|
}
|
|
78
|
-
|
|
79
|
-
class ConfigLoader {
|
|
69
|
+
export class ConfigLoader {
|
|
80
70
|
schema;
|
|
81
71
|
resolvedConfig;
|
|
82
72
|
constructor(schema) {
|
|
@@ -91,14 +81,13 @@ class ConfigLoader {
|
|
|
91
81
|
// If the config setting is an array, override instead of merge
|
|
92
82
|
const mergeRule = (_obj, src) => (Array.isArray(src) ? src : undefined);
|
|
93
83
|
for (const source of sources) {
|
|
94
|
-
config =
|
|
84
|
+
config = _.mergeWith(config, await source.load(config), mergeRule);
|
|
95
85
|
}
|
|
96
86
|
const parsedConfig = this.schema.parse(config);
|
|
97
|
-
|
|
87
|
+
_.mergeWith(this.resolvedConfig, parsedConfig, mergeRule);
|
|
98
88
|
}
|
|
99
89
|
get config() {
|
|
100
90
|
return this.resolvedConfig;
|
|
101
91
|
}
|
|
102
92
|
}
|
|
103
|
-
exports.ConfigLoader = ConfigLoader;
|
|
104
93
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEtF,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAO/D,MAAM,UAAU,uBAAuB,CAAC,MAAsB;IAC5D,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM;KACzB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAAE,OAAO,EAAE,CAAC;YAE5C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,MAAc;IAC3D,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YAC7B,IAAI,CAAC,cAAc,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE/C,sEAAsE;YACtE,sEAAsE;YACtE,oEAAoE;YACpE,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7D,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAC/B,IAAI,mBAAmB,CAAC;gBACtB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;aAClE,CAAC,CACH,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC;YACrE,IAAI,CAAC,QAAQ;gBAAE,OAAO,EAAE,CAAC;YAEzB,iEAAiE;YACjE,kEAAkE;YAClE,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YACnF,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,IAAI,CACjD,IAAI,qBAAqB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,YAAY;gBAAE,OAAO,EAAE,CAAC;YAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACpD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB;IAClC,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YAC7B,IAAI,CAAC,cAAc,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE/C,OAAO;gBACL,QAAQ;gBACR,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,SAAS,EAAE,QAAQ,CAAC,MAAM;aAC3B,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,YAAY;IACN,MAAM,CAAS;IACf,cAAc,CAAkB;IAEjD,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,uEAAuE;QACvE,qEAAqE;QACrE,sCAAsC;QACtC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,UAA0B,EAAE;QAChD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnC,+DAA+D;QAC/D,MAAM,SAAS,GAAG,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAElF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,GAAG,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/C,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import _ from 'lodash';\nimport fs from 'fs-extra';\nimport { z } from 'zod';\nimport { EC2Client, DescribeTagsCommand } from '@aws-sdk/client-ec2';\nimport { SecretsManagerClient, GetSecretValueCommand } from '@aws-sdk/client-secrets-manager';\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\nconst AbstractConfigSchema = z.record(z.string(), z.unknown());\ntype AbstractConfig = z.infer<typeof AbstractConfigSchema>;\n\ninterface ConfigSource {\n load: (existingConfig: AbstractConfig) => Promise<AbstractConfig>;\n}\n\nexport function makeLiteralConfigSource(config: AbstractConfig) {\n return {\n load: async () => config,\n };\n}\n\nexport function makeFileConfigSource(path: string): ConfigSource {\n return {\n load: async () => {\n if (!(await fs.pathExists(path))) return {};\n\n const config = await fs.readJson(path);\n return z.record(z.string(), z.any()).parse(config);\n },\n };\n}\n\nexport function makeSecretsManagerConfigSource(tagKey: string): ConfigSource {\n return {\n load: async (existingConfig) => {\n if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n return {};\n }\n\n const identity = await fetchInstanceIdentity();\n\n // We disable the ESLint rule here because we don't care about sharing\n // configs between clients in this case. We only want to share configs\n // to avoid spamming the IMDS API when creating lots of clients, but\n // this client will only be used once, typically at application startup.\n // eslint-disable-next-line @prairielearn/aws-client-shared-config\n const ec2Client = new EC2Client({ region: identity.region });\n const tags = await ec2Client.send(\n new DescribeTagsCommand({\n Filters: [{ Name: 'resource-id', Values: [identity.instanceId] }],\n }),\n );\n\n const secretId = tags.Tags?.find((tag) => tag.Key === tagKey)?.Value;\n if (!secretId) return {};\n\n // As above, we don't care about sharing configs between clients.\n // eslint-disable-next-line @prairielearn/aws-client-shared-config\n const secretsManagerClient = new SecretsManagerClient({ region: identity.region });\n const secretValue = await secretsManagerClient.send(\n new GetSecretValueCommand({ SecretId: secretId }),\n );\n if (!secretValue.SecretString) return {};\n\n const config = JSON.parse(secretValue.SecretString);\n return z.record(z.string(), z.any()).parse(config);\n },\n };\n}\n\nexport function makeImdsConfigSource(): ConfigSource {\n return {\n load: async (existingConfig) => {\n if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n return {};\n }\n\n const hostname = await fetchInstanceHostname();\n const identity = await fetchInstanceIdentity();\n\n return {\n hostname,\n instanceId: identity.instanceId,\n awsRegion: identity.region,\n };\n },\n };\n}\n\nexport class ConfigLoader<Schema extends z.ZodTypeAny> {\n private readonly schema: Schema;\n private readonly resolvedConfig: z.infer<Schema>;\n\n constructor(schema: Schema) {\n this.schema = schema;\n\n // Get the default values from the schema. This ensures that all values\n // have defaults, and also allows us to override nested defaults with\n // `_.merge()` in `loadAndValidate()`.\n this.resolvedConfig = schema.parse({});\n }\n\n async loadAndValidate(sources: ConfigSource[] = []) {\n let config = this.schema.parse({});\n // If the config setting is an array, override instead of merge\n const mergeRule = (_obj: any, src: any) => (Array.isArray(src) ? src : undefined);\n\n for (const source of sources) {\n config = _.mergeWith(config, await source.load(config), mergeRule);\n }\n\n const parsedConfig = this.schema.parse(config);\n _.mergeWith(this.resolvedConfig, parsedConfig, mergeRule);\n }\n\n get config() {\n return this.resolvedConfig;\n }\n}\n"]}
|
package/dist/index.test.js
CHANGED
|
@@ -1,76 +1,74 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
const zod_1 = require("zod");
|
|
7
|
-
const index_1 = require("./index");
|
|
1
|
+
import { assert } from 'chai';
|
|
2
|
+
import { writeFile } from 'node:fs/promises';
|
|
3
|
+
import { withFile } from 'tmp-promise';
|
|
4
|
+
import { z } from 'zod';
|
|
5
|
+
import { ConfigLoader, makeLiteralConfigSource, makeFileConfigSource } from './index.js';
|
|
8
6
|
describe('config', () => {
|
|
9
7
|
it('loads config with defaults', async () => {
|
|
10
|
-
const schema =
|
|
11
|
-
foo:
|
|
12
|
-
bar:
|
|
8
|
+
const schema = z.object({
|
|
9
|
+
foo: z.string().nullable().default(null),
|
|
10
|
+
bar: z.string().default('bar'),
|
|
13
11
|
});
|
|
14
|
-
const loader = new
|
|
12
|
+
const loader = new ConfigLoader(schema);
|
|
15
13
|
await loader.loadAndValidate();
|
|
16
|
-
|
|
17
|
-
|
|
14
|
+
assert.equal(loader.config.foo, null);
|
|
15
|
+
assert.equal(loader.config.bar, 'bar');
|
|
18
16
|
});
|
|
19
17
|
it('loads config from a file', async () => {
|
|
20
|
-
const schema =
|
|
21
|
-
foo:
|
|
22
|
-
bar:
|
|
23
|
-
baz:
|
|
18
|
+
const schema = z.object({
|
|
19
|
+
foo: z.string().optional().nullable(),
|
|
20
|
+
bar: z.string().default('bar'),
|
|
21
|
+
baz: z.string().default('baz'),
|
|
24
22
|
});
|
|
25
|
-
const loader = new
|
|
26
|
-
await
|
|
27
|
-
await
|
|
28
|
-
await loader.loadAndValidate([
|
|
23
|
+
const loader = new ConfigLoader(schema);
|
|
24
|
+
await withFile(async ({ path }) => {
|
|
25
|
+
await writeFile(path, JSON.stringify({ foo: 'bar', bar: 'bar' }));
|
|
26
|
+
await loader.loadAndValidate([makeFileConfigSource(path)]);
|
|
29
27
|
});
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
28
|
+
assert.equal(loader.config.foo, 'bar');
|
|
29
|
+
assert.equal(loader.config.bar, 'bar');
|
|
30
|
+
assert.equal(loader.config.baz, 'baz');
|
|
33
31
|
});
|
|
34
32
|
it('overrides deep objects', async () => {
|
|
35
|
-
const schema =
|
|
36
|
-
features:
|
|
33
|
+
const schema = z.object({
|
|
34
|
+
features: z.record(z.string(), z.boolean()).default({
|
|
37
35
|
foo: true,
|
|
38
36
|
bar: false,
|
|
39
37
|
}),
|
|
40
38
|
});
|
|
41
|
-
const loader = new
|
|
39
|
+
const loader = new ConfigLoader(schema);
|
|
42
40
|
await loader.loadAndValidate([
|
|
43
|
-
|
|
41
|
+
makeLiteralConfigSource({
|
|
44
42
|
features: {
|
|
45
43
|
foo: false,
|
|
46
44
|
baz: true,
|
|
47
45
|
},
|
|
48
46
|
}),
|
|
49
47
|
]);
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
48
|
+
assert.equal(loader.config.features.foo, false);
|
|
49
|
+
assert.equal(loader.config.features.bar, false);
|
|
50
|
+
assert.equal(loader.config.features.baz, true);
|
|
53
51
|
});
|
|
54
52
|
it('replaces arrays', async () => {
|
|
55
|
-
const schema =
|
|
56
|
-
courseDirs:
|
|
57
|
-
.array(
|
|
53
|
+
const schema = z.object({
|
|
54
|
+
courseDirs: z
|
|
55
|
+
.array(z.string())
|
|
58
56
|
.default(['exampleCourse', '/course', '/course2', '/course3', '/course4', '/course5']),
|
|
59
57
|
});
|
|
60
|
-
const loader = new
|
|
58
|
+
const loader = new ConfigLoader(schema);
|
|
61
59
|
await loader.loadAndValidate([
|
|
62
|
-
|
|
60
|
+
makeLiteralConfigSource({
|
|
63
61
|
courseDirs: ['testCourse', '/mycourse'],
|
|
64
62
|
}),
|
|
65
63
|
]);
|
|
66
|
-
|
|
64
|
+
assert.deepEqual(loader.config.courseDirs, ['testCourse', '/mycourse']);
|
|
67
65
|
});
|
|
68
66
|
it('maintains object identity when loading config', async () => {
|
|
69
|
-
const schema =
|
|
70
|
-
const loader = new
|
|
67
|
+
const schema = z.object({});
|
|
68
|
+
const loader = new ConfigLoader(schema);
|
|
71
69
|
const config = loader.config;
|
|
72
70
|
await loader.loadAndValidate();
|
|
73
|
-
|
|
71
|
+
assert.strictEqual(config, loader.config);
|
|
74
72
|
});
|
|
75
73
|
});
|
|
76
74
|
//# sourceMappingURL=index.test.js.map
|
package/dist/index.test.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,YAAY,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEzF,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;YACtB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;SAC/B,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAExC,MAAM,MAAM,CAAC,eAAe,EAAE,CAAC;QAE/B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;YACtB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;YACrC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;YAC9B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;SAC/B,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAExC,MAAM,QAAQ,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YAChC,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YAClE,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;YACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC;gBAClD,GAAG,EAAE,IAAI;gBACT,GAAG,EAAE,KAAK;aACX,CAAC;SACH,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAExC,MAAM,MAAM,CAAC,eAAe,CAAC;YAC3B,uBAAuB,CAAC;gBACtB,QAAQ,EAAE;oBACR,GAAG,EAAE,KAAK;oBACV,GAAG,EAAE,IAAI;iBACV;aACF,CAAC;SACH,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAC/B,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;YACtB,UAAU,EAAE,CAAC;iBACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,OAAO,CAAC,CAAC,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;SACzF,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAExC,MAAM,MAAM,CAAC,eAAe,CAAC;YAC3B,uBAAuB,CAAC;gBACtB,UAAU,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC;aACxC,CAAC;SACH,CAAC,CAAC;QAEH,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAE7B,MAAM,MAAM,CAAC,eAAe,EAAE,CAAC;QAE/B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { assert } from 'chai';\nimport { writeFile } from 'node:fs/promises';\nimport { withFile } from 'tmp-promise';\nimport { z } from 'zod';\n\nimport { ConfigLoader, makeLiteralConfigSource, makeFileConfigSource } from './index.js';\n\ndescribe('config', () => {\n it('loads config with defaults', async () => {\n const schema = z.object({\n foo: z.string().nullable().default(null),\n bar: z.string().default('bar'),\n });\n const loader = new ConfigLoader(schema);\n\n await loader.loadAndValidate();\n\n assert.equal(loader.config.foo, null);\n assert.equal(loader.config.bar, 'bar');\n });\n\n it('loads config from a file', async () => {\n const schema = z.object({\n foo: z.string().optional().nullable(),\n bar: z.string().default('bar'),\n baz: z.string().default('baz'),\n });\n const loader = new ConfigLoader(schema);\n\n await withFile(async ({ path }) => {\n await writeFile(path, JSON.stringify({ foo: 'bar', bar: 'bar' }));\n await loader.loadAndValidate([makeFileConfigSource(path)]);\n });\n\n assert.equal(loader.config.foo, 'bar');\n assert.equal(loader.config.bar, 'bar');\n assert.equal(loader.config.baz, 'baz');\n });\n\n it('overrides deep objects', async () => {\n const schema = z.object({\n features: z.record(z.string(), z.boolean()).default({\n foo: true,\n bar: false,\n }),\n });\n const loader = new ConfigLoader(schema);\n\n await loader.loadAndValidate([\n makeLiteralConfigSource({\n features: {\n foo: false,\n baz: true,\n },\n }),\n ]);\n\n assert.equal(loader.config.features.foo, false);\n assert.equal(loader.config.features.bar, false);\n assert.equal(loader.config.features.baz, true);\n });\n\n it('replaces arrays', async () => {\n const schema = z.object({\n courseDirs: z\n .array(z.string())\n .default(['exampleCourse', '/course', '/course2', '/course3', '/course4', '/course5']),\n });\n const loader = new ConfigLoader(schema);\n\n await loader.loadAndValidate([\n makeLiteralConfigSource({\n courseDirs: ['testCourse', '/mycourse'],\n }),\n ]);\n\n assert.deepEqual(loader.config.courseDirs, ['testCourse', '/mycourse']);\n });\n\n it('maintains object identity when loading config', async () => {\n const schema = z.object({});\n const loader = new ConfigLoader(schema);\n const config = loader.config;\n\n await loader.loadAndValidate();\n\n assert.strictEqual(config, loader.config);\n });\n});\n"]}
|
package/package.json
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prairielearn/config",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
|
+
"type": "module",
|
|
4
5
|
"main": "dist/index.js",
|
|
5
6
|
"scripts": {
|
|
6
7
|
"build": "tsc",
|
|
7
8
|
"dev": "tsc --watch --preserveWatchOutput",
|
|
8
|
-
"test": "mocha
|
|
9
|
+
"test": "mocha src/**/*.test.ts"
|
|
9
10
|
},
|
|
10
11
|
"dependencies": {
|
|
11
|
-
"@aws-sdk/client-ec2": "^3.
|
|
12
|
-
"@aws-sdk/client-secrets-manager": "^3.
|
|
13
|
-
"@prairielearn/aws-imds": "^
|
|
12
|
+
"@aws-sdk/client-ec2": "^3.565.0",
|
|
13
|
+
"@aws-sdk/client-secrets-manager": "^3.565.0",
|
|
14
|
+
"@prairielearn/aws-imds": "^2.0.0",
|
|
14
15
|
"fs-extra": "^11.2.0",
|
|
15
16
|
"lodash": "^4.17.21",
|
|
16
17
|
"zod": "^3.22.4"
|
|
@@ -24,7 +25,7 @@
|
|
|
24
25
|
"chai": "^4.4.1",
|
|
25
26
|
"mocha": "^10.4.0",
|
|
26
27
|
"tmp-promise": "^3.0.3",
|
|
27
|
-
"tsx": "^4.
|
|
28
|
+
"tsx": "^4.9.3",
|
|
28
29
|
"typescript": "^5.4.3"
|
|
29
30
|
}
|
|
30
31
|
}
|
package/src/index.test.ts
CHANGED
|
@@ -3,7 +3,7 @@ import { writeFile } from 'node:fs/promises';
|
|
|
3
3
|
import { withFile } from 'tmp-promise';
|
|
4
4
|
import { z } from 'zod';
|
|
5
5
|
|
|
6
|
-
import { ConfigLoader, makeLiteralConfigSource, makeFileConfigSource } from './index';
|
|
6
|
+
import { ConfigLoader, makeLiteralConfigSource, makeFileConfigSource } from './index.js';
|
|
7
7
|
|
|
8
8
|
describe('config', () => {
|
|
9
9
|
it('loads config with defaults', async () => {
|