-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Do not parse full config for commands that don't need it
Motivation The [cleanup job for the Feature Hub](https://github.com/sinnerschrader/feature-hub/actions/workflows/cleanup-stacks.yml) (using the `purge` command) currently fails with the following Zod validation error: ``` [ { "code": "too_small", "minimum": 1, "type": "array", "inclusive": true, "exact": false, "message": "Array must contain at least 1 element(s)", "path": [ "routes" ] } ] ``` This is because the routes are inferred from the built documentation. But when running the `purge` command, we don't actually need the routes, and we also don't want to build the docs just to avoid the config validation error. Proposed Solution For a couple of commands (including `purge`) we only need the domain name parts (`hostedZoneName` and sometimes `aliasRecordName`), so we can limit the parsing/validation to those fields, and thus implicitly allow an empty array of routes in this context.
- Loading branch information
1 parent
d506d76
commit bddbb00
Showing
26 changed files
with
172 additions
and
137 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import {z} from 'zod'; | ||
|
||
export type DomainNameParts = z.TypeOf<typeof DomainNamePartsSchema>; | ||
|
||
export const DomainNamePartsSchema = z.object({ | ||
hostedZoneName: z.string().optional(), | ||
aliasRecordName: z.string().optional(), | ||
}); | ||
|
||
export function parseDomainNameParts(config: unknown): DomainNameParts { | ||
return DomainNamePartsSchema.parse(config); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
import type {Stack, aws_apigateway, aws_lambda} from 'aws-cdk-lib'; | ||
import type {Express} from 'express'; | ||
|
||
import {DomainNamePartsSchema} from './parse-domain-name-parts.js'; | ||
import {validateRoutes} from './utils/validate-routes.js'; | ||
import {z} from 'zod'; | ||
|
||
export type StackConfig = Omit< | ||
z.TypeOf<typeof StackConfigSchema>, | ||
'routes' | 'onSynthesize' | 'onStart' | ||
> & { | ||
readonly routes: Route[]; | ||
|
||
readonly onSynthesize?: (constructs: { | ||
readonly stack: Stack; | ||
readonly restApi: aws_apigateway.RestApiBase; | ||
}) => void; | ||
|
||
readonly onStart?: (app: Express) => void; | ||
}; | ||
|
||
export type Route = LambdaRoute | S3Route; | ||
|
||
export type LambdaRoute = Omit< | ||
z.TypeOf<typeof LambdaRouteSchema>, | ||
'onSynthesize' | ||
> & { | ||
readonly onSynthesize?: (constructs: { | ||
readonly stack: Stack; | ||
readonly restApi: aws_apigateway.RestApiBase; | ||
readonly lambdaFunction: aws_lambda.FunctionBase; | ||
}) => void; | ||
}; | ||
|
||
export type S3Route = z.TypeOf<typeof S3RouteSchema>; | ||
|
||
const LambdaRouteSchema = z.object({ | ||
type: z.literal(`function`), | ||
httpMethod: z.enum([`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `PUT`]), | ||
publicPath: z.string(), | ||
path: z.string(), | ||
functionName: z.string(), | ||
memorySize: z.number().optional(), | ||
timeoutInSeconds: z.number().int().min(0).max(28).optional(), | ||
environment: z.record(z.string()).optional(), | ||
requestParameters: z | ||
.record( | ||
z.object({ | ||
cacheKey: z.boolean().optional(), | ||
required: z.boolean().optional(), | ||
}), | ||
) | ||
.optional(), | ||
throttling: z | ||
.object({rateLimit: z.number(), burstLimit: z.number()}) | ||
.optional(), | ||
cacheTtlInSeconds: z.number().int().min(0).max(3600).optional(), | ||
authenticationEnabled: z.boolean().optional(), | ||
corsEnabled: z.boolean().optional(), | ||
onSynthesize: z.function().optional(), | ||
}); | ||
|
||
const S3RouteSchema = z.object({ | ||
type: z.enum([`file`, `folder`]), | ||
httpMethod: z.literal(`GET`).optional(), | ||
publicPath: z.string(), | ||
path: z.string(), | ||
responseHeaders: z.record(z.string()).optional(), | ||
throttling: z | ||
.object({rateLimit: z.number(), burstLimit: z.number()}) | ||
.optional(), | ||
cacheTtlInSeconds: z.number().int().min(0).max(3600).optional(), | ||
authenticationEnabled: z.boolean().optional(), | ||
corsEnabled: z.boolean().optional(), | ||
}); | ||
|
||
const StackConfigSchema = DomainNamePartsSchema.extend({ | ||
cachingEnabled: z.boolean().optional(), | ||
terminationProtectionEnabled: z.boolean().optional(), | ||
authentication: z | ||
.object({ | ||
username: z.string(), | ||
password: z.string(), | ||
realm: z.string().optional(), | ||
cacheTtlInSeconds: z.number().int().min(0).max(3600).optional(), | ||
}) | ||
.optional(), | ||
monitoring: z | ||
.union([ | ||
z.literal(true), | ||
z.object({ | ||
accessLoggingEnabled: z.boolean().optional(), | ||
loggingEnabled: z.boolean().optional(), | ||
metricsEnabled: z.boolean().optional(), | ||
tracingEnabled: z.boolean().optional(), | ||
}), | ||
]) | ||
.optional(), | ||
tags: z.record(z.string()).optional(), | ||
routes: z.array(z.union([LambdaRouteSchema, S3RouteSchema])).min(1), | ||
onSynthesize: z.function().optional(), | ||
onStart: z.function().optional(), | ||
}); | ||
|
||
export function parseStackConfig(config: unknown): StackConfig { | ||
const stackConfig = StackConfigSchema.parse(config); | ||
|
||
validateRoutes(stackConfig.routes); | ||
|
||
return stackConfig; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.