Update for Bref v3

Author: mnapoli

.github/workflows/ci.yml

@@ -15,13 +15,11 @@ jobs:
         strategy:
             matrix:
                 node:
-                    - 14
-                    - 16
-                    - 18
                     - 20
+                    - 22
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v6
+            - uses: actions/setup-node@v6
               with:
                   node-version: ${{ matrix.node }}
             - uses: actions/cache@v3
@@ -35,10 +33,10 @@ jobs:
         name: Lint
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v6
+            - uses: actions/setup-node@v6
               with:
-                  node-version: 18
+                  node-version: 22
             - uses: actions/cache@v3
               with:
                   path: ~/.npm
@@ -50,10 +48,10 @@ jobs:
         name: Check types
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v6
+            - uses: actions/setup-node@v6
               with:
-                  node-version: 18
+                  node-version: 22
             - uses: actions/cache@v3
               with:
                   path: ~/.npm

README.md

@@ -56,7 +56,7 @@ new PhpFpmFunction(this, 'MyFunction', {
 It inherits from the AWS CDK [`Function` construct](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) with these options set by default:
 
 - `handler`: `index.php` by default
-- `runtime`: `provided.al2`
+- `runtime`: `provided.al2023`
 - `code`: the code is automatically zipped from the current directory.
 - `layers`: the Bref layer is automatically added.
 - `memorySize`: `1024`
@@ -78,7 +78,7 @@ The following paths are always excluded: `.git`, `.idea`, `cdk.out`, `node_modul
 
 The construct also adds the following options:
 
-- `phpVersion` (default: `8.1`): the PHP version to use.
+- `phpVersion` (default: `8.4`): the PHP version to use.
 
 #### `PhpFunction`
 
@@ -92,7 +92,7 @@ new PhpFunction(this, 'MyFunction', {
 
 It inherits from the AWS CDK [`Function` construct](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) with these options set by default:
 
-- `runtime`: `provided.al2`
+- `runtime`: `provided.al2023`
 - `code`: the code is automatically zipped from the current directory.
 - `layers`: the Bref layer is automatically added.
 - `memorySize`: `1024`
@@ -115,7 +115,7 @@ The following paths are always excluded: `.git`, `.idea`, `cdk.out`, `node_modul
 
 The construct also adds the following options:
 
-- `phpVersion` (default: `8.1`): the PHP version to use.
+- `phpVersion` (default: `8.4`): the PHP version to use.
 
 #### `ConsoleFunction`
 
@@ -129,9 +129,9 @@ new ConsoleFunction(this, 'Artisan', {
 
 It inherits from the AWS CDK [`Function` construct](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html) with these options set by default:
 
-- `runtime`: `provided.al2`
+- `runtime`: `provided.al2023`
 - `code`: the code is automatically zipped from the current directory.
-- `layers`: the Bref layers are automatically added.
+- `layers`: the Bref layer is automatically added.
 - `memorySize`: `1024`
 - `timeout`: `6` (seconds)
 
@@ -152,4 +152,4 @@ The following paths are always excluded: `.git`, `.idea`, `cdk.out`, `node_modul
 
 The construct also adds the following options:
 
-- `phpVersion` (default: `8.1`): the PHP version to use.
+- `phpVersion` (default: `8.4`): the PHP version to use.

package.json

@@ -9,18 +9,18 @@
     "test": "vitest"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "^2.55.0",
+    "aws-cdk-lib": "^2.100.0",
     "constructs": "^10.0.0"
   },
   "dependencies": {
-    "@bref.sh/layers": "^2.0.95"
+    "@bref.sh/layers": "^3.0.0"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.195",
     "@types/node": "^18.11.3",
     "@typescript-eslint/eslint-plugin": "^5.40.1",
     "@typescript-eslint/parser": "^5.40.1",
-    "aws-cdk-lib": "^2.55.0",
+    "aws-cdk-lib": "^2.240.0",
     "constructs": "^10.0.0",
     "esbuild-node-tsc": "^1.8.5",
     "eslint": "8.22.0",

src/cache/Redis.ts

@@ -1,12 +1,10 @@
-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) {
         super(scope, id, props);
 
-        this.addLayers(consoleLayer(this, Stack.of(scope).region));
+        this.addEnvironment('BREF_RUNTIME', 'console');
     }
 }

src/function/ConsoleFunction.ts

@@ -2,18 +2,18 @@ import { Function, FunctionProps, Runtime } from 'aws-cdk-lib/aws-lambda';
 import { Duration, Stack } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import { functionDefaults, vpcDefaults } from './defaults';
-import { fpmLayer } from '../layers';
+import { phpLayer } from '../layers';
 import { packagePhpCode } from '../package';
 
 export type PhpFpmFunctionProps = Partial<FunctionProps> & {
-    phpVersion?: '8.0' | '8.1' | '8.2' | '8.3' | '8.4';
+    phpVersion?: '8.2' | '8.3' | '8.4' | '8.5';
 };
 
 export class PhpFpmFunction extends Function {
     constructor(scope: Construct, id: string, props: PhpFpmFunctionProps = {}) {
         const defaults = {
             description: 'HTTP application',
-            runtime: Runtime.PROVIDED_AL2,
+            runtime: Runtime.PROVIDED_AL2023,
             handler: props.handler ?? 'index.php',
             code: props.code ?? packagePhpCode(),
             // API Gateway has a 29s timeout
@@ -42,9 +42,10 @@ export class PhpFpmFunction extends Function {
         }
         const phpVersion = props.phpVersion ?? functionDefaults.phpVersion;
         this.addLayers(
-            // Add the FPM layer first so that other layers can override it
-            fpmLayer(this, region, phpVersion, props.architecture ?? functionDefaults.architecture),
+            // Add the PHP layer first so that other layers can override it
+            phpLayer(this, 'BrefPhpLayer', region, phpVersion, props.architecture ?? functionDefaults.architecture),
             ...layers
         );
+        this.addEnvironment('BREF_RUNTIME', 'fpm');
     }
 }

src/function/PhpFpmFunction.ts

@@ -2,21 +2,21 @@ import { Function, FunctionProps, Runtime } from 'aws-cdk-lib/aws-lambda';
 import { Duration, Stack } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import { functionDefaults, vpcDefaults } from './defaults';
-import { functionLayer } from '../layers';
+import { phpLayer } from '../layers';
 import { packagePhpCode } from '../package';
 import { IVpc } from 'aws-cdk-lib/aws-ec2';
 import { VpcForServerlessApp } from '../vpc/VpcForServerlessApp';
 
 export type PhpFunctionProps = Partial<FunctionProps> & {
-    phpVersion?: '8.0' | '8.1' | '8.2' | '8.3' | '8.4';
+    phpVersion?: '8.2' | '8.3' | '8.4' | '8.5';
     handler: string;
     vpc?: IVpc | VpcForServerlessApp;
 };
 
 export class PhpFunction extends Function {
     constructor(scope: Construct, id: string, props: PhpFunctionProps) {
         const defaults = {
-            runtime: Runtime.PROVIDED_AL2,
+            runtime: Runtime.PROVIDED_AL2023,
             code: props.code ?? packagePhpCode(),
             timeout: Duration.seconds(6),
             memorySize: functionDefaults.memorySize,
@@ -42,15 +42,12 @@ export class PhpFunction extends Function {
             );
         }
         const phpVersion = props.phpVersion ?? functionDefaults.phpVersion;
+        const arch = props.architecture ?? functionDefaults.architecture;
         this.addLayers(
-            // Add the function layer first so that other layers can override it
-            functionLayer(
-                this,
-                region,
-                phpVersion,
-                props.architecture ?? functionDefaults.architecture
-            ),
+            // Add the PHP layer first so that other layers can override it
+            phpLayer(this, 'BrefPhpLayer', region, phpVersion, arch),
             ...layers
         );
+        this.addEnvironment('BREF_RUNTIME', 'function');
     }
 }

src/function/PhpFunction.ts

@@ -4,7 +4,7 @@ import { Architecture } from 'aws-cdk-lib/aws-lambda';
 
 export const functionDefaults = {
     path: process.cwd(),
-    phpVersion: '8.1',
+    phpVersion: '8.4',
     memorySize: 1024,
     architecture: Architecture.X86_64,
     excludedPhpPaths: ['.git', '.idea', 'cdk.out', 'node_modules', '.bref', '.serverless', 'tests'],

src/function/defaults.ts

@@ -1,9 +1,7 @@
-import { Redis } from './cache/Redis';
 import { ConsoleFunction } from './function/ConsoleFunction';
 import { PhpFpmFunction, PhpFpmFunctionProps } from './function/PhpFpmFunction';
 import { PhpFunction, PhpFunctionProps } from './function/PhpFunction';
 import { packagePhpCode } from './package';
-import { VpcForServerlessApp } from './vpc/VpcForServerlessApp';
 
 export {
     PhpFunction,
@@ -12,6 +10,4 @@ export {
     PhpFpmFunctionProps,
     ConsoleFunction,
     packagePhpCode,
-    VpcForServerlessApp,
-    Redis,
 };

src/index.ts

@@ -1,9 +1,10 @@
 import { Architecture, ILayerVersion, LayerVersion } from 'aws-cdk-lib/aws-lambda';
 import { Construct } from 'constructs';
-import { functionLayerArn, fpmLayerArn, consoleLayerArn } from '@bref.sh/layers';
+import { layerArn } from '@bref.sh/layers';
 
-export function functionLayer(
+export function phpLayer(
     scope: Construct,
+    id: string,
     region: string,
     phpVersion: string,
     architecture: Architecture
@@ -12,26 +13,7 @@ export function functionLayer(
 
     return LayerVersion.fromLayerVersionArn(
         scope,
-        'Bref001FunctionLayer',
-        functionLayerArn(region, phpVersion, platform)
+        id,
+        layerArn(region, phpVersion, platform)
     );
 }
-
-export function fpmLayer(
-    scope: Construct,
-    region: string,
-    phpVersion: string,
-    architecture: Architecture
-): ILayerVersion {
-    const platform = architecture === Architecture.X86_64 ? 'x86' : 'arm';
-
-    return LayerVersion.fromLayerVersionArn(
-        scope,
-        'Bref101FpmLayer',
-        fpmLayerArn(region, phpVersion, platform)
-    );
-}
-
-export function consoleLayer(scope: Construct, region: string): ILayerVersion {
-    return LayerVersion.fromLayerVersionArn(scope, 'Bref201ConsoleLayer', consoleLayerArn(region));
-}