Merge pull request #12 from mococa/types/enhanced-types-and-added-configurations-to-zipping-util

🔍 types: enhanced types and added configurations to zipping util

Author: mococa

infrastructure/README.md

@@ -1,32 +1,14 @@
 ## Infrastructure folder
 
 Here, it lays the CDK App. Where the magic happens.
-There is a a `src/index.ts` file, there is a CDK app being instantiated and the nullstack stack being called passing some props to it.
+There is a a `testing/index.ts` file, there is a CDK app being instantiated and creating 3 nullstack apps.
 
-What the stack, that is located at `lib/null-stack.ts`, does is:
+What the construct, that is located at `lib/nullstack-construct.ts`, does is:
 
-1. It creates an s3 bucket to host all the public files
-2. It creates a private s3 bucket to host the build files. in it, there will be a folder, with an index.js, where it uses [@vendia/serverless-express](https://github.com/vendia/serverless-express), where it gets the Express server in Nullstack and converts it into a lambda function; in this folder there is also the node_modules of this external package, and a .production folder from nullstack (changed server.js in it removing the crossorigin attribute - [explained here](https://github.com/nullstack/nullstack/pull/355))
-3. It deploys the necessary files into these buckets
-4. It creates a lambda that will run the files in the build bucket
-5. It creates an API Gateway with the route `/` and the route `/{proxy+}` for the rest of the routes.
-6. It creates a lambda function url for it to be accessible.
-
-### Scripts
-
-You can run `yarn deploy` and it will do everything it takes to deploy the application.
-
-# Welcome to your CDK TypeScript project
-
-This is a blank project for CDK development with TypeScript.
-
-The `cdk.json` file tells the CDK Toolkit how to execute your app.
-
-## Useful commands
-
-- `npm run build` compile typescript to js
-- `npm run watch` watch for changes and compile
-- `npm run test` perform the jest unit tests
-- `cdk deploy` deploy this stack to your default AWS account/region
-- `cdk diff` compare deployed stack with current state
-- `cdk synth` emits the synthesized CloudFormation template
+1. It creates an s3 bucket to host all the public files.
+2. (SSR only) It creates a private s3 bucket to host the build files. in it, there will be a folder, with an index.js, where it uses [@vendia/serverless-express](https://github.com/vendia/serverless-express), and gets the Express server in Nullstack and converts it into a lambda function; in this folder there is also the node_modules of this external package, and a .production folder from nullstack (changed server.js in it removing the crossorigin attribute - [explained here](https://github.com/nullstack/nullstack/pull/355), but got merged on [Nullstack v0.19.2](https://github.com/nullstack/nullstack/releases/tag/v0.19.2)).
+3. It deploys the necessary files into these buckets.
+4. (SSR only) It creates a lambda that will run the files in the build bucket
+5. (SSR only) It creates an API Gateway with the route `/` and the route `/{proxy+}` for the rest of the routes.
+6. (SSR only) It creates a lambda function url for it to be accessible.
+7. (SSG and SPA only) It creates an s3 website url for it to be accessible.

infrastructure/cdk.json

@@ -1,5 +1,5 @@
 {
-  "app": "npx ts-node --prefer-ts-exts test/index.ts",
+  "app": "npx ts-node --prefer-ts-exts testing/index.ts",
   "watch": {
     "include": [
       "**"

infrastructure/lib/null-stack.ts renamed to infrastructure/lib/nullstack-construct.ts

@@ -17,7 +17,7 @@ interface GetBucket extends s3.BucketProps {
   environment: string;
 }
 
-interface Bucket {
+export interface AppBucket {
   /**
    * Bucket resource ID
    */
@@ -36,7 +36,7 @@ type SSG = {
   /**
    * Bucket to host all files generated in the SSG build
    */
-  bucket: Bucket;
+  bucket: AppBucket;
 
   /**
    * Built Nullstack application SSG directory
@@ -54,7 +54,7 @@ type SPA = {
   /**
    * Bucket to host all files generated in the SPA build
    */
-  bucket: Bucket;
+  bucket: AppBucket;
 
   /**
    * Built Nullstack application SPA directory
@@ -72,12 +72,12 @@ type SSR = {
   /**
    * Bucket to host a zip file containing all the build assets
    */
-  build_bucket: Bucket;
+  build_bucket: AppBucket;
 
   /**
    * Bucket to host all the Nullstack public folder
    */
-  public_bucket: Bucket;
+  public_bucket: AppBucket;
 
   /**
    * Nullstack application directory
@@ -89,7 +89,9 @@ type SSR = {
   app_dir: string;
 };
 
-type Props = cdk.StackProps & {
+export type BuildType = SSG | SSR | SPA;
+
+export type StackProps = BuildType & {
   /**
    * Environment
    *
@@ -99,13 +101,20 @@ type Props = cdk.StackProps & {
    */
   environment: string;
 
+  /**
+   * Region
+   *
+   * Example: "sa-east-1"
+   */
+  region: string;
+
   /**
    * Nullstack application enviroment variables
    */
   app_env: Record<string, string>;
-} & (SSG | SSR | SPA);
+} & BuildType;
 
-export class NullstackAppStack extends cdk.Stack {
+export class NullstackAppConstruct extends Construct {
   /* ---------- Helpers ---------- */
   getBucket({
     bucket_name,
@@ -145,8 +154,8 @@ export class NullstackAppStack extends cdk.Stack {
    */
   lambda_function: cdk.aws_lambda.Function;
 
-  constructor(scope: Construct, id: string, props: Props) {
-    super(scope, id, props);
+  constructor(scope: Construct, id: string, props: StackProps) {
+    super(scope, id);
 
     /* ---------- Constants ---------- */
     const { environment, build_type, app_env } = props;
@@ -240,7 +249,7 @@ export class NullstackAppStack extends cdk.Stack {
     /* ----------
      *  Lambdas
      * -------- */
-    const cdn = `https://${props.public_bucket.name}-${environment}.s3.${props.env?.region}.amazonaws.com`;
+    const cdn = `https://${props.public_bucket.name}-${environment}.s3.${props.region}.amazonaws.com`;
 
     // Create lambda that will the build bucket assets
     const lambda_function = new lambda.Function(

infrastructure/lib/lambda_content.js renamed to infrastructure/lib/nullstack-lambda.ts

@@ -1,11 +1,8 @@
 const serverless = require("@vendia/serverless-express");
 const { server } = require("./.production/server").default;
 
-server.less = Boolean(process.env.LAMBDA);
-
-if (!process.env.LAMBDA)
-  return server.listen(3000, () => {
-    console.log("Server is listening on port 3000");
-  });
+server.less = Boolean(process.env.LAMBDA === "true");
 
 exports.handler = serverless({ app: server, trimStageFromRequestPath: true });
+
+if (!server.less) server.listen(3000, () => console.log("Listening on :3000"));

infrastructure/package.json

@@ -25,22 +25,13 @@
   "scripts": {
     "build": "tsc --build tsconfig.json",
     "watch": "tsc -w",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "prepublishOnly": "npm run build",
-    "prebootstrap": "yarn synth",
-    "bootstrap": "cdk bootstrap",
-    "predeploy": "yarn bootstrap",
-    "deploy": "cdk deploy --require-approval never",
-    "destroy": "cdk destroy --force true",
-    "prereup": "yarn destroy",
-    "reup": "yarn deploy"
+    "prepublishOnly": "npm run build"
   },
   "devDependencies": {
     "@types/adm-zip": "^0.5.0",
     "@types/node": "^16.14.0",
     "aws-cdk": "2.82.0",
-    "ts-node": "^10.9.1",
-    "typescript": "~4.4.2"
+    "ts-node": "^10.9.1"
   },
   "peerDependencies": {
     "aws-cdk": "2.82.0",

infrastructure/src/index.ts

@@ -1,4 +1,16 @@
-import { NullstackAppStack } from "../lib/null-stack";
+import {
+  NullstackAppConstruct,
+  AppBucket,
+  BuildType as StackBuildType,
+  StackProps as Props,
+} from "../lib/null-stack";
+
 import { zip_nullstack } from "../utils/zip_nullstack";
 
-export { NullstackAppStack, zip_nullstack };
+export namespace NullstackProps {
+  export type NullstackAppBucket = AppBucket;
+  export type BuildType = StackBuildType;
+  export type StackProps = Props;
+}
+
+export { zip_nullstack, NullstackAppConstruct };

infrastructure/test/index.ts

@@ -0,0 +1,76 @@
+import * as cdk from "aws-cdk-lib";
+import path from "path";
+
+import { NullstackAppConstruct, NullstackProps, zip_nullstack } from "../src";
+
+const app = new cdk.App();
+const app_dir = path.join("..", "web");
+
+const ssg_bucket: NullstackProps.NullstackAppBucket = {
+  id: "Nullstack-App-Test-SSG-Build",
+  name: "nullstack-app-test-ssg-build",
+};
+
+const ssr_buckets = {
+  public_bucket: {
+    id: "Nullstack-App-Test-SSR-CDN",
+    name: "nullstack-app-test-ssr-cdn",
+  },
+  build_bucket: {
+    id: "Nullstack-App-Test-SSR-Build",
+    name: "nullstack-app-test-ssr-build",
+  },
+};
+
+const spa_bucket: NullstackProps.NullstackAppBucket = {
+  id: "Nullstack-App-Test-SPA-Build",
+  name: "nullstack-app-test-spa-build",
+};
+
+const ssg_props: NullstackProps.StackProps = {
+  environment: "development",
+  bucket: ssg_bucket,
+  region: "sa-east-1",
+  build_dir: path.join("..", "web", "ssg"),
+  app_env: {
+    NULLSTACK_PROJECT_NAME: "[dev] Web",
+    NULLSTACK_PROJECT_COLOR: "#D22365",
+  },
+  build_type: "ssg",
+};
+
+const ssr_props: NullstackProps.StackProps = {
+  environment: "development",
+  app_dir,
+  ...ssr_buckets,
+  region: "sa-east-1",
+  app_env: {
+    NULLSTACK_PROJECT_NAME: "[dev] Web",
+    NULLSTACK_PROJECT_COLOR: "#D22365",
+  },
+  build_type: "ssr",
+};
+
+const spa_props: NullstackProps.StackProps = {
+  environment: "development",
+  bucket: spa_bucket,
+  region: "sa-east-1",
+  build_dir: path.join("..", "web", "spa"),
+  app_env: {
+    NULLSTACK_PROJECT_NAME: "[dev] Web",
+    NULLSTACK_PROJECT_COLOR: "#D22365",
+  },
+  build_type: "spa",
+};
+
+(async () => {
+  await zip_nullstack(app_dir);
+
+  const stack = new cdk.Stack(app, "NullstackAppStack", {
+    env: { region: "sa-east-1" },
+  });
+
+  new NullstackAppConstruct(stack, "NullstackAppStackTestSSG", ssg_props);
+  new NullstackAppConstruct(stack, "NullstackAppStackTestSSR", ssr_props);
+  new NullstackAppConstruct(stack, "NullstackAppStackTestSPA", spa_props);
+})();