Add function and console constructs

Author: mnapoli

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bref.sh/constructs",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",

src/function/ConsoleFunction.ts

@@ -0,0 +1,15 @@
+import { Stack } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { consoleLayer } from '../layers';
+import { PhpFunction, PhpFunctionProps } from './PhpFunction';
+
+export class ConsoleFunction extends PhpFunction {
+    constructor(scope: Construct, id: string, props: PhpFunctionProps) {
+        const layers = props.layers ?? [];
+        layers.unshift(consoleLayer(scope, Stack.of(scope).region));
+        super(scope, id, {
+            ...props,
+            layers,
+        });
+    }
+}

src/FpmFunction.ts src/function/PhpFpmFunction.tssrc/FpmFunction.ts renamed to src/function/PhpFpmFunction.ts

@@ -2,15 +2,15 @@ import { Function, FunctionProps, Runtime } from 'aws-cdk-lib/aws-lambda';
 import { Duration, Stack } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import { functionDefaults } from './defaults';
-import { fpmLayer } from './layers';
-import { packagePhpCode } from './package';
+import { fpmLayer } from '../layers';
+import { packagePhpCode } from '../package';
 
-export type FpmFunctionProps = Partial<FunctionProps> & {
+export type PhpFpmFunctionProps = Partial<FunctionProps> & {
     phpVersion?: '8.0' | '8.1' | '8.2';
 };
 
-export class FpmFunction extends Function {
-    constructor(scope: Construct, id: string, props: FpmFunctionProps = {}) {
+export class PhpFpmFunction extends Function {
+    constructor(scope: Construct, id: string, props: PhpFpmFunctionProps = {}) {
         const defaults = {
             description: 'HTTP application',
             runtime: Runtime.PROVIDED_AL2,

src/function/PhpFunction.ts

@@ -0,0 +1,47 @@
+import { Function, FunctionProps, Runtime } from 'aws-cdk-lib/aws-lambda';
+import { Duration, Stack } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { functionDefaults } from './defaults';
+import { functionLayer } from '../layers';
+import { packagePhpCode } from '../package';
+
+export type PhpFunctionProps = Partial<FunctionProps> & {
+    phpVersion?: '8.0' | '8.1' | '8.2';
+    handler: string;
+};
+
+export class PhpFunction extends Function {
+    constructor(scope: Construct, id: string, props: PhpFunctionProps) {
+        const defaults = {
+            runtime: Runtime.PROVIDED_AL2,
+            code: props.code ?? packagePhpCode(),
+            timeout: Duration.seconds(6),
+            memorySize: functionDefaults.memorySize,
+        };
+
+        // Put the layers aside for now, we set them after `super()`
+        const layers = props.layers ?? [];
+
+        super(scope, id, {
+            ...defaults,
+            // Provided props override defaults
+            ...props,
+            // But we force the layers to an empty array because we define them below
+            layers: [],
+        });
+
+        // Add layer afterwards so that we can use `this` to resolve the region
+        const region = Stack.of(this).region;
+        if (region.startsWith('${')) {
+            throw new Error(
+                'Cannot detect the AWS region. Bref needs the AWS region to know which AWS layer to use. In order to use Bref layers, you must explicitly set the region for the stack. See https://gist.github.com/mnapoli/7c7eab49444637426ce66a24df715a63'
+            );
+        }
+        const phpVersion = props.phpVersion ?? functionDefaults.phpVersion;
+        this.addLayers(
+            // Add the function layer first so that other layers can override it
+            functionLayer(scope, region, phpVersion, functionDefaults.platform),
+            ...layers
+        );
+    }
+}

src/defaults.ts src/function/defaults.tssrc/defaults.ts renamed to src/function/defaults.ts

@@ -3,5 +3,5 @@ export const functionDefaults = {
     phpVersion: '8.1',
     memorySize: 1024,
     platform: 'x86',
-    excludedPhpPaths: ['.git', 'cdk.out', 'node_modules', '.bref', 'tests'],
+    excludedPhpPaths: ['.git', '.idea', 'cdk.out', 'node_modules', '.bref', '.serverless', 'tests'],
 } as const;

src/index.ts

@@ -1,4 +1,13 @@
-import { FpmFunction, FpmFunctionProps } from './FpmFunction';
+import { ConsoleFunction } from './function/ConsoleFunction';
+import { PhpFpmFunction, PhpFpmFunctionProps } from './function/PhpFpmFunction';
+import { PhpFunction, PhpFunctionProps } from './function/PhpFunction';
 import { packagePhpCode } from './package';
 
-export { FpmFunction, FpmFunctionProps, packagePhpCode };
+export {
+    PhpFunction,
+    PhpFunctionProps,
+    PhpFpmFunction,
+    PhpFpmFunctionProps,
+    ConsoleFunction,
+    packagePhpCode,
+};

src/layers.ts

@@ -1,6 +1,19 @@
 import { ILayerVersion, LayerVersion } from 'aws-cdk-lib/aws-lambda';
 import { Construct } from 'constructs';
-import { fpmLayerArn } from '@bref.sh/layers';
+import { functionLayerArn, fpmLayerArn, consoleLayerArn } from '@bref.sh/layers';
+
+export function functionLayer(
+    scope: Construct,
+    region: string,
+    phpVersion: string,
+    platform: 'x86' | 'arm'
+): ILayerVersion {
+    return LayerVersion.fromLayerVersionArn(
+        scope,
+        'BrefFunctionLayer',
+        functionLayerArn(region, phpVersion, platform)
+    );
+}
 
 export function fpmLayer(
     scope: Construct,
@@ -14,3 +27,7 @@ export function fpmLayer(
         fpmLayerArn(region, phpVersion, platform)
     );
 }
+
+export function consoleLayer(scope: Construct, region: string): ILayerVersion {
+    return LayerVersion.fromLayerVersionArn(scope, 'BrefConsoleLayer', consoleLayerArn(region));
+}

src/package.ts

@@ -1,6 +1,6 @@
 import { AssetOptions } from 'aws-cdk-lib/aws-s3-assets';
 import { Code } from 'aws-cdk-lib/aws-lambda';
-import { functionDefaults } from './defaults';
+import { functionDefaults } from './function/defaults';
 
 /**
  * @param path Defaults to the current working directory.