@prairielearn/config 3.1.11 → 3.2.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/CHANGELOG.md +20 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -1
- package/package.json +15 -10
- package/src/index.ts +27 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# @prairielearn/config
|
|
2
2
|
|
|
3
|
+
## 3.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- af40dd0: Add `makeEnvConfigSource(...)`
|
|
8
|
+
|
|
9
|
+
## 3.1.13
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- 5496156: Fix `repository` field in `package.json`
|
|
14
|
+
|
|
15
|
+
## 3.1.12
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- 70a8029: Upgrade all JavaScript dependencies
|
|
20
|
+
- Updated dependencies [70a8029]
|
|
21
|
+
- @prairielearn/aws-imds@2.0.23
|
|
22
|
+
|
|
3
23
|
## 3.1.11
|
|
4
24
|
|
|
5
25
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -7,6 +7,14 @@ export declare function makeLiteralConfigSource(config: AbstractConfig): {
|
|
|
7
7
|
load: () => Promise<AbstractConfig>;
|
|
8
8
|
};
|
|
9
9
|
export declare function makeFileConfigSource(path: string): ConfigSource;
|
|
10
|
+
/**
|
|
11
|
+
* Extracts keys from T where string is assignable to the value type.
|
|
12
|
+
* This ensures we only map environment variables to fields that accept strings.
|
|
13
|
+
*/
|
|
14
|
+
type StringAssignableKeys<T> = {
|
|
15
|
+
[K in keyof T]: string extends T[K] ? K : never;
|
|
16
|
+
}[keyof T];
|
|
17
|
+
export declare function makeEnvConfigSource<Schema extends z.ZodTypeAny>(mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>): ConfigSource;
|
|
10
18
|
export declare function makeSecretsManagerConfigSource(tagKey: string): ConfigSource;
|
|
11
19
|
export declare function makeImdsConfigSource(): ConfigSource;
|
|
12
20
|
export declare class ConfigLoader<Schema extends z.ZodTypeAny> {
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CACnE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,cAAc;;EAI7D;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAS/D;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAoC3E;AAED,wBAAgB,oBAAoB,IAAI,YAAY,CAiBnD;AAED,qBAAa,YAAY,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,cAAc,CAAkB;gBAE5B,MAAM,EAAE,MAAM;IASpB,eAAe,CAAC,OAAO,GAAE,YAAY,EAAO;IAalD,KAAK;IAIL,IAAI,MAAM,qBAET;CACF"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CACnE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,cAAc;;EAI7D;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAS/D;AAED;;;GAGG;AACH,KAAK,oBAAoB,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,wBAAgB,mBAAmB,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU,EAC7D,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GACtE,YAAY,CAed;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAoC3E;AAED,wBAAgB,oBAAoB,IAAI,YAAY,CAiBnD;AAED,qBAAa,YAAY,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,cAAc,CAAkB;gBAE5B,MAAM,EAAE,MAAM;IASpB,eAAe,CAAC,OAAO,GAAE,YAAY,EAAO;IAalD,KAAK;IAIL,IAAI,MAAM,qBAET;CACF"}
|
package/dist/index.js
CHANGED
|
@@ -19,6 +19,20 @@ export function makeFileConfigSource(path) {
|
|
|
19
19
|
},
|
|
20
20
|
};
|
|
21
21
|
}
|
|
22
|
+
export function makeEnvConfigSource(mapping) {
|
|
23
|
+
return {
|
|
24
|
+
load: async () => {
|
|
25
|
+
const config = {};
|
|
26
|
+
for (const [key, envVar] of Object.entries(mapping)) {
|
|
27
|
+
const value = process.env[envVar];
|
|
28
|
+
if (value !== undefined) {
|
|
29
|
+
config[key] = value;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
return config;
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
}
|
|
22
36
|
export function makeSecretsManagerConfigSource(tagKey) {
|
|
23
37
|
return {
|
|
24
38
|
load: async (existingConfig) => {
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAQtF,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;IACxB,cAAc,CAAkB;IAExC,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,KAAK;QACH,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import { DescribeTagsCommand, EC2Client } from '@aws-sdk/client-ec2';\nimport { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';\nimport fs from 'fs-extra';\nimport _ from 'lodash';\nimport { z } from 'zod';\n\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\ntype AbstractConfig = Record<string, unknown>;\n\nexport interface 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 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 reset() {\n this.resolvedConfig = this.schema.parse({});\n }\n\n get config() {\n return this.resolvedConfig;\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,CAAC,MAAM,QAAQ,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAQtF,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;AAUD,MAAM,UAAU,mBAAmB,CACjC,OAAuE;IAEvE,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,MAAM,MAAM,GAA2B,EAAE,CAAC;YAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAuB,EAAE,CAAC;gBAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACtB,CAAC;YACH,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,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;IACxB,cAAc,CAAkB;IAExC,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,KAAK;QACH,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF","sourcesContent":["import { DescribeTagsCommand, EC2Client } from '@aws-sdk/client-ec2';\nimport { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';\nimport fs from 'fs-extra';\nimport _ from 'lodash';\nimport { z } from 'zod';\n\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\ntype AbstractConfig = Record<string, unknown>;\n\nexport interface 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\n/**\n * Extracts keys from T where string is assignable to the value type.\n * This ensures we only map environment variables to fields that accept strings.\n */\ntype StringAssignableKeys<T> = {\n [K in keyof T]: string extends T[K] ? K : never;\n}[keyof T];\n\nexport function makeEnvConfigSource<Schema extends z.ZodTypeAny>(\n mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>,\n): ConfigSource {\n return {\n load: async () => {\n const config: Record<string, string> = {};\n\n for (const [key, envVar] of Object.entries(mapping) as [string, string][]) {\n const value = process.env[envVar];\n if (value !== undefined) {\n config[key] = value;\n }\n }\n\n return 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 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 reset() {\n this.resolvedConfig = this.schema.parse({});\n }\n\n get config() {\n return this.resolvedConfig;\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prairielearn/config",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.0",
|
|
4
4
|
"type": "module",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/PrairieLearn/PrairieLearn.git",
|
|
8
|
+
"directory": "packages/config"
|
|
9
|
+
},
|
|
5
10
|
"main": "dist/index.js",
|
|
6
11
|
"scripts": {
|
|
7
12
|
"build": "tsc",
|
|
@@ -9,22 +14,22 @@
|
|
|
9
14
|
"test": "vitest run --coverage"
|
|
10
15
|
},
|
|
11
16
|
"dependencies": {
|
|
12
|
-
"@aws-sdk/client-ec2": "^3.
|
|
13
|
-
"@aws-sdk/client-secrets-manager": "^3.
|
|
14
|
-
"@prairielearn/aws-imds": "^2.0.
|
|
15
|
-
"fs-extra": "^11.3.
|
|
17
|
+
"@aws-sdk/client-ec2": "^3.966.0",
|
|
18
|
+
"@aws-sdk/client-secrets-manager": "^3.966.0",
|
|
19
|
+
"@prairielearn/aws-imds": "^2.0.23",
|
|
20
|
+
"fs-extra": "^11.3.3",
|
|
16
21
|
"lodash": "^4.17.21",
|
|
17
22
|
"zod": "^3.25.76"
|
|
18
23
|
},
|
|
19
24
|
"devDependencies": {
|
|
20
25
|
"@prairielearn/tsconfig": "^0.0.0",
|
|
21
26
|
"@types/fs-extra": "^11.0.4",
|
|
22
|
-
"@types/lodash": "^4.17.
|
|
23
|
-
"@types/node": "^22.
|
|
24
|
-
"@vitest/coverage-v8": "^4.0.
|
|
27
|
+
"@types/lodash": "^4.17.23",
|
|
28
|
+
"@types/node": "^22.19.5",
|
|
29
|
+
"@vitest/coverage-v8": "^4.0.17",
|
|
25
30
|
"tmp-promise": "^3.0.3",
|
|
26
|
-
"tsx": "^4.
|
|
31
|
+
"tsx": "^4.21.0",
|
|
27
32
|
"typescript": "^5.9.3",
|
|
28
|
-
"vitest": "^4.0.
|
|
33
|
+
"vitest": "^4.0.17"
|
|
29
34
|
}
|
|
30
35
|
}
|
package/src/index.ts
CHANGED
|
@@ -29,6 +29,33 @@ export function makeFileConfigSource(path: string): ConfigSource {
|
|
|
29
29
|
};
|
|
30
30
|
}
|
|
31
31
|
|
|
32
|
+
/**
|
|
33
|
+
* Extracts keys from T where string is assignable to the value type.
|
|
34
|
+
* This ensures we only map environment variables to fields that accept strings.
|
|
35
|
+
*/
|
|
36
|
+
type StringAssignableKeys<T> = {
|
|
37
|
+
[K in keyof T]: string extends T[K] ? K : never;
|
|
38
|
+
}[keyof T];
|
|
39
|
+
|
|
40
|
+
export function makeEnvConfigSource<Schema extends z.ZodTypeAny>(
|
|
41
|
+
mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>,
|
|
42
|
+
): ConfigSource {
|
|
43
|
+
return {
|
|
44
|
+
load: async () => {
|
|
45
|
+
const config: Record<string, string> = {};
|
|
46
|
+
|
|
47
|
+
for (const [key, envVar] of Object.entries(mapping) as [string, string][]) {
|
|
48
|
+
const value = process.env[envVar];
|
|
49
|
+
if (value !== undefined) {
|
|
50
|
+
config[key] = value;
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
return config;
|
|
55
|
+
},
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
32
59
|
export function makeSecretsManagerConfigSource(tagKey: string): ConfigSource {
|
|
33
60
|
return {
|
|
34
61
|
load: async (existingConfig) => {
|