@wolsok/spa-cdk-stack 1.0.15 → 1.0.19

package/src/lib/spa/spa.construct.ts

@@ -1,310 +0,0 @@
-import { CfnOutput, Duration, RemovalPolicy } from 'aws-cdk-lib';
-import {
-  Certificate,
-  CertificateValidation,
-} from 'aws-cdk-lib/aws-certificatemanager';
-import {
-  AllowedMethods,
-  Distribution,
-  HttpVersion,
-  IDistribution,
-  ResponseHeadersPolicy,
-  SecurityPolicyProtocol,
-  ViewerProtocolPolicy,
-} from 'aws-cdk-lib/aws-cloudfront';
-import { S3BucketOrigin } from 'aws-cdk-lib/aws-cloudfront-origins';
-import {
-  ARecord,
-  HostedZone,
-  IHostedZone,
-  RecordTarget,
-} from 'aws-cdk-lib/aws-route53';
-import { CloudFrontTarget } from 'aws-cdk-lib/aws-route53-targets';
-import { BlockPublicAccess, Bucket, IBucket } from 'aws-cdk-lib/aws-s3';
-import {
-  BucketDeployment,
-  CacheControl,
-  ISource,
-  Source,
-} from 'aws-cdk-lib/aws-s3-deployment';
-import { Construct } from 'constructs';
-
-export interface SpaProps {
-  domainName: string;
-  buildOutputPath: string;
-  bucketRemovalPolicy?: RemovalPolicy;
-  extraAllowedOrigins?: string[];
-}
-
-const defaultBucketRemovalPolicy: RemovalPolicy = RemovalPolicy.DESTROY;
-
-/**
- * SPA infrastructure, which deploys spa content to an S3 bucket.
- *
- * The spa redirects from HTTP to HTTPS, uses a CloudFront distribution,
- * Route53 alias record,
- * and ACM certificate.
- */
-export class SpaConstruct extends Construct {
-  private bucketDeployments: BucketDeployment[] = [];
-  private readonly bucket: Bucket;
-  private readonly distribution: Distribution;
-
-  constructor(
-    parent: Construct,
-    private readonly spaName: string,
-    props: SpaProps
-  ) {
-    super(parent, spaName);
-    const removalPolicy: RemovalPolicy =
-      props.bucketRemovalPolicy ?? defaultBucketRemovalPolicy;
-    const { buildOutputPath, extraAllowedOrigins } = props;
-
-    const { mainDomain, siteDomain } = this.extractDomains(props.domainName);
-
-    const zone = HostedZone.fromLookup(this, spaName, {
-      privateZone: false,
-      domainName: mainDomain,
-    });
-
-    new CfnOutput(this, `${spaName}-Site:`, { value: 'https://' + siteDomain });
-
-    let certificate: Certificate;
-
-    if (mainDomain === siteDomain) {
-      certificate = this.createCertificate(zone, mainDomain);
-    } else {
-      certificate = this.createCertificate(zone, mainDomain, siteDomain);
-    }
-
-    this.bucket = this.createBucket(siteDomain, removalPolicy);
-
-    this.distribution = this.createDistribution(
-      siteDomain,
-      certificate,
-      this.bucket,
-      extraAllowedOrigins
-    );
-    this.createARecord(siteDomain, this.distribution, zone);
-
-    const indexAsset = Source.asset(buildOutputPath, {
-      // glob ignore all but index.html
-      exclude: ['**', '!index.html'],
-    });
-    this.bucketDeployments.push(
-      this.createBucketDeployment(
-        [indexAsset],
-        CacheControl.noCache(),
-        true,
-        this.bucket,
-        this.distribution
-      )
-    );
-
-    const deploymentAssets = Source.asset(buildOutputPath, {
-      exclude: ['index.html'],
-    });
-
-    this.bucketDeployments.push(
-      this.createBucketDeployment(
-        [deploymentAssets],
-        CacheControl.maxAge(Duration.days(365)),
-        false,
-        this.bucket,
-        this.distribution
-      )
-    );
-
-    // Make sure that the index.html is deployed last, as it's needed to
-    // serve the SPA so chain the deployments
-    this.bucketDeployments[1].node.addDependency(this.bucketDeployments[0]);
-  }
-
-  /**
-   * Add some additional assets to the bucket of the SPA
-   */
-  public addExtraAssets(
-    assets: ISource[],
-    cacheControl: CacheControl = CacheControl.maxAge(Duration.days(365)),
-    contentType?: string
-  ): void {
-    const extraAssetsDeployment: BucketDeployment = this.createBucketDeployment(
-      assets,
-      cacheControl,
-      false,
-      this.bucket,
-      this.distribution,
-      contentType
-    );
-
-    const latestDeployment: BucketDeployment | undefined =
-      this.bucketDeployments.at(-1);
-    if (latestDeployment) {
-      extraAssetsDeployment.node.addDependency(latestDeployment);
-    }
-
-    this.bucketDeployments.push(extraAssetsDeployment);
-  }
-
-  private createBucket(
-    siteDomain: string,
-    removalPolicy: RemovalPolicy = RemovalPolicy.DESTROY
-  ): Bucket {
-    // Content bucket
-    const siteBucket = new Bucket(this, `Bucket`, {
-      websiteIndexDocument: 'index.html',
-      websiteErrorDocument: 'index.html',
-      bucketName: `${siteDomain}-spa-data`,
-      publicReadAccess: false,
-      blockPublicAccess: BlockPublicAccess.BLOCK_ALL,
-      /**
-       * The default removal policy is RETAIN, which means that cdk destroy will not attempt to delete
-       * the new bucket, and it will remain in your account until manually deleted. By setting the policy to
-       * DESTROY, cdk destroy will attempt to delete the bucket, but will error if the bucket is not empty.
-       */
-      removalPolicy: removalPolicy,
-
-      /**
-       * For sample purposes only, if you create an S3 bucket then populate it, stack destruction fails.  This
-       * setting will enable full cleanup of the demo.
-       */
-      autoDeleteObjects: removalPolicy === RemovalPolicy.DESTROY, // Danger not recommended for production code
-    });
-
-    new CfnOutput(this, `${siteDomain}-Bucket`, {
-      value: siteBucket.bucketName,
-    });
-    return siteBucket;
-  }
-
-  private createCertificate(
-    zone: IHostedZone,
-    ...domainNames: string[]
-  ): Certificate {
-    const [mainDomain, ...restofDomains] = domainNames;
-
-    // TLS certificate
-    const certificate = new Certificate(this, 'Certificate', {
-      validation: CertificateValidation.fromDns(zone),
-      domainName: mainDomain,
-      subjectAlternativeNames: restofDomains,
-    });
-
-    new CfnOutput(this, `${this.spaName}-sCertificate`, {
-      value: certificate.certificateArn,
-    });
-    return certificate;
-  }
-
-  private createDistribution(
-    siteDomain: string,
-    certificate: Certificate,
-    siteBucket: IBucket,
-    allowedOrigins: string[] = []
-  ): Distribution {
-    const responseHeadersPolicy = new ResponseHeadersPolicy(
-      this,
-      'ResponseHeadersPolicy',
-      {
-        corsBehavior: {
-          accessControlAllowCredentials: false,
-          accessControlAllowOrigins: [
-            ...allowedOrigins,
-            'https://' + siteDomain,
-            'http://localhost',
-            'http://127.0.0.1',
-          ],
-          accessControlAllowMethods: ['GET', 'HEAD', 'OPTIONS'],
-          accessControlAllowHeaders: ['*'],
-          originOverride: true,
-        },
-      }
-    );
-    // CloudFront distribution that provides HTTPS
-    const distribution = new Distribution(this, 'Distribution', {
-      certificate: certificate,
-      defaultRootObject: 'index.html',
-      domainNames: [siteDomain],
-      httpVersion: HttpVersion.HTTP2_AND_3,
-      minimumProtocolVersion: SecurityPolicyProtocol.TLS_V1_2_2021,
-      errorResponses: [
-        {
-          httpStatus: 403,
-          responseHttpStatus: 200,
-          responsePagePath: '/index.html',
-          ttl: Duration.minutes(30),
-        },
-      ],
-      defaultBehavior: {
-        responseHeadersPolicy,
-        origin: S3BucketOrigin.withOriginAccessControl(siteBucket),
-        compress: true,
-        allowedMethods: AllowedMethods.ALLOW_GET_HEAD_OPTIONS,
-        viewerProtocolPolicy: ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
-      },
-    });
-    new CfnOutput(this, `${this.spaName}-DistributionId`, {
-      value: distribution.distributionId,
-    });
-    return distribution;
-  }
-
-  private createARecord(
-    siteDomain: string,
-    distribution: Distribution,
-    zone: IHostedZone
-  ): void {
-    // Route53 alias record for the CloudFront distribution
-    new ARecord(this, 'SiteAliasRecord', {
-      recordName: siteDomain,
-      target: RecordTarget.fromAlias(new CloudFrontTarget(distribution)),
-      zone,
-    });
-    new CfnOutput(this, `${this.spaName}-ARecord`, { value: siteDomain });
-  }
-
-  private createBucketDeployment(
-    sources: ISource[],
-    cacheControl: CacheControl = CacheControl.maxAge(Duration.days(365)),
-    prune: boolean,
-    destinationBucket: IBucket,
-    distribution: IDistribution,
-    contentType?: string
-  ): BucketDeployment {
-    // Deploy site contents to S3 spaBucket
-    return new BucketDeployment(
-      this,
-      'DeployWithInvalidation' + (this.bucketDeployments.length + 1),
-      {
-        sources,
-        destinationBucket,
-        distribution,
-        prune,
-        memoryLimit: 1024,
-        distributionPaths: ['/*'],
-        cacheControl: [cacheControl],
-        ...(contentType ? { contentType } : {}),
-      }
-    );
-  }
-
-  private extractDomains(domainName: string): {
-    subDomainWildcard: string;
-    mainDomain: string;
-    siteDomain: string;
-  } {
-    // extract main domain
-    const siteDomain = domainName;
-    const mainDomain = domainName.split('.').slice(-2).join('.');
-    const subDomainWildcard: string =
-      mainDomain === siteDomain ? mainDomain : `*.${mainDomain}`;
-
-    // inform user about domain handling
-    if (mainDomain !== siteDomain) {
-      console.warn(
-        `The domain ${siteDomain} is not a top level domain. The certificate will be created for *.${mainDomain}`
-      );
-    }
-    return { siteDomain, mainDomain, subDomainWildcard };
-  }
-}

package/src/lib/stack-spa.spec.ts

@@ -1,121 +0,0 @@
-import { App, Duration, RemovalPolicy, Stack, StackProps } from 'aws-cdk-lib';
-import { Match, Template } from 'aws-cdk-lib/assertions';
-import * as path from 'path';
-import { vitest } from 'vitest';
-import { SpaConstruct, SpaProps } from './spa/spa.construct';
-import { CacheControl, Source } from 'aws-cdk-lib/aws-s3-deployment';
-
-// Mock the fromLookup method
-vitest.mock('aws-cdk-lib/aws-route53', () => {
-  return {
-    HostedZone: {
-      fromLookup: vitest.fn((domain: string) => ({ superZone: domain })),
-    },
-    RecordTarget: {
-      fromAlias: vitest.fn(),
-    },
-    ARecord: vitest.fn(),
-  };
-});
-class TestSpaStack extends Stack {
-  spaConstruct: SpaConstruct;
-  constructor(parent: App, name: string, props: SpaProps & StackProps) {
-    super(parent, name, props);
-
-    const { domainName, buildOutputPath, bucketRemovalPolicy } = props;
-    this.spaConstruct = new SpaConstruct(this, name, {
-      domainName,
-      buildOutputPath,
-      bucketRemovalPolicy: bucketRemovalPolicy,
-    });
-  }
-}
-
-const defaultTestProps: SpaProps & StackProps = {
-  env: {
-    region: 'us-east-1',
-    account: '123456789',
-  },
-  buildOutputPath: path.join(__dirname, '../../test-build-path'),
-  domainName: 'test-domain.com',
-};
-describe('SpaCdkStack', () => {
-  function testStackFactory(
-    props: Partial<SpaProps & StackProps> = defaultTestProps
-  ): { app: App; template: () => Template; stack: TestSpaStack } {
-    // GIVEN
-    const app = new App();
-
-    // WHEN
-    const stack = new TestSpaStack(app, 'TestSpaStack', {
-      ...defaultTestProps,
-      ...props,
-    });
-    const template = () => Template.fromStack(stack);
-    return { stack, app, template };
-  }
-
-  it('should match snapshot', () => {
-    const { template } = testStackFactory();
-    expect(template().toJSON()).toMatchSnapshot();
-  });
-
-  it('should match snapshot setting bucket removal policy to retain', () => {
-    const { template } = testStackFactory({
-      bucketRemovalPolicy: RemovalPolicy.RETAIN_ON_UPDATE_OR_DELETE,
-    });
-    expect(template().toJSON()).toMatchSnapshot();
-  });
-
-  it('should use the main domain name even if a subdomain is provided', () => {
-    // given, when
-    const { template } = testStackFactory({
-      domainName: 'subdomain.test-domain.com',
-    });
-
-    //then
-    expect(template().toJSON()).toMatchSnapshot();
-  });
-
-  it('should create an BucketDeployment for the buildOutputPath and index.html', () => {
-    const { template } = testStackFactory();
-    //then
-    template().resourceCountIs('Custom::CDKBucketDeployment', 2);
-    template().hasResourceProperties('Custom::CDKBucketDeployment', {
-      SourceObjectKeys: Match.arrayEquals([Match.stringLikeRegexp('\\w+.zip')]),
-    });
-  });
-
-  it('should create an extra BucketDeployment when using addExtraAssets', () => {
-    const { template, stack } = testStackFactory();
-    stack.spaConstruct.addExtraAssets([
-      Source.asset(path.join(__dirname, '../../extra-assets-path')),
-    ]);
-    //then
-    expect(template().toJSON()).toMatchSnapshot();
-  });
-
-  it('should create an extra BucketDeployment when using addExtraAssets with cache control', () => {
-    const { template, stack } = testStackFactory();
-    stack.spaConstruct.addExtraAssets(
-      [Source.asset(path.join(__dirname, '../../extra-assets-path'))],
-      CacheControl.maxAge(Duration.seconds(123456))
-    );
-    //then
-    expect(template().toJSON()).toMatchSnapshot();
-  });
-
-  it('should create an extra Custom::CDKBucketDeployment when using addExtraAssets', () => {
-    const { template, stack } = testStackFactory();
-
-    //when
-    stack.spaConstruct.addExtraAssets([
-      Source.asset(path.join(__dirname, '../../extra-assets-path')),
-    ]);
-    //then
-    template().resourceCountIs('Custom::CDKBucketDeployment', 3);
-    template().hasResourceProperties('Custom::CDKBucketDeployment', {
-      SourceObjectKeys: Match.arrayEquals([Match.stringLikeRegexp('\\w+.zip')]),
-    });
-  });
-});

package/src/lib/utils/envOrDie.ts

@@ -1,8 +0,0 @@
-export function envOrDie(key: string): string {
-  const value = process.env[key];
-  if (!value) {
-    console.error(`Environment variable ${key} is required`);
-    process.exit(1);
-  }
-  return value;
-}

package/test-build-path/index.html

@@ -1,15 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
-    />
-    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
-    <title>Document</title>
-  </head>
-  <body>
-    AWESOME
-  </body>
-</html>

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler"
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
-    "declaration": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["vite.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,26 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
-    "types": [
-      "vitest/globals",
-      "vitest/importMeta",
-      "vite/client",
-      "node",
-      "vitest"
-    ]
-  },
-  "include": [
-    "vite.config.ts",
-    "vitest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx",
-    "src/**/*.d.ts"
-  ]
-}

package/vite.config.ts

@@ -1,30 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
-
-import { fileURLToPath } from 'node:url';
-import { dirname } from 'node:path';
-
-export default defineConfig({
-  root: dirname(fileURLToPath(import.meta.url)),
-  cacheDir: '../../../node_modules/.vite/libs/public/spa-cdk-stack',
-
-  plugins: [nxViteTsPaths()],
-
-  // Uncomment this if you are using workers.
-  // worker: {
-  //  plugins: [ nxViteTsPaths() ],
-  // },
-
-  test: {
-    globals: true,
-    environment: 'node',
-    include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-    reporters: ['default'],
-    coverage: {
-      reporter: ['lcov', 'html', 'text-summary'],
-      reportsDirectory: '../../../coverage/libs/public/spa-cdk-stack',
-      provider: 'v8',
-    },
-  },
-});