@kirschbaum-development/sst-laravel 0.3.2 → 0.3.4

package/README.md

@@ -88,6 +88,21 @@ const app = new LaravelService('MyLaravelApp', {
 
 Check all the `web` options [here](https://github.com/kirschbaum-development/sst-laravel/blob/main/docs/api.md#web).
 
+#### Load balancer health check
+
+Laravel ships a built-in `/up` health endpoint. Point the load balancer at it via `web.healthCheck` — a shortcut over `loadBalancer.health` that targets the default forward port for you:
+
+```js
+const app = new LaravelService('MyLaravelApp', {
+  web: {
+    domain: { name: 'app.example.com' },
+    healthCheck: { path: '/up' },
+  },
+});
+```
+
+All [`loadBalancer.health` options](https://sst.dev/docs/component/aws/service/#loadbalancer-health) are supported (`interval`, `timeout`, `healthyThreshold`, `unhealthyThreshold`, `successCodes`). If you set `web.loadBalancer` explicitly, `healthCheck` is ignored — configure `loadBalancer.health` directly there.
+
 ### Reverb
 
 You can deploy a dedicated Laravel Reverb service for WebSocket traffic. Reverb runs as a worker-style container using `php artisan reverb:start`, but SST Laravel also attaches a load balancer so you can give it its own public domain.
@@ -514,7 +529,6 @@ In case your specified environment file does not contain the `APP_URL` variable,
 * Ability to extend base Docker images;
 * Add support for Inertia SSR;
 * Add support for Octane with FrankedPHP;
-* Add support for Laravel Reverb;
 * Dev mode;
 * ...what else are we missing?
 

package/dist/bin/cli.js

@@ -4,6 +4,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { initCommand } from './commands/init.js';
 import { deployCommand } from './commands/deploy.js';
+import { commandRunCommand } from './commands/command-run.js';
 import { sshCommand } from './commands/ssh.js';
 import { logsCommand } from './commands/logs.js';
 import { githubIamCommand } from './commands/github-iam.js';
@@ -21,6 +22,7 @@ program
     .version(version);
 program.addCommand(initCommand);
 program.addCommand(deployCommand);
+program.addCommand(commandRunCommand);
 program.addCommand(sshCommand);
 program.addCommand(logsCommand);
 program.addCommand(githubIamCommand);

package/dist/bin/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../bin/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,cAAc,CAAC,CAAC;AACpE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1E,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;AAEpC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,uCAAuC,CAAC;KACpD,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC/B,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;AACrC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACnC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACnC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEnC,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../bin/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,cAAc,CAAC,CAAC;AACpE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1E,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;AAEpC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,aAAa,CAAC;KACnB,WAAW,CAAC,uCAAuC,CAAC;KACpD,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;AACtC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC/B,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;AACrC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACnC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACnC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEnC,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/bin/commands/command-run.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+export declare function buildCommandToRun(commandParts: string[], raw: boolean): string;
+export declare const commandRunCommand: Command;

package/dist/bin/commands/command-run.js

@@ -0,0 +1,69 @@
+import { Command } from 'commander';
+import { ECSClient } from '@aws-sdk/client-ecs';
+import { spawn } from 'child_process';
+import { findClusterArn, findTask } from '../utils/ecs.js';
+export function buildCommandToRun(commandParts, raw) {
+    if (commandParts.length === 0) {
+        throw new Error('Command is required.');
+    }
+    const command = commandParts.join(' ');
+    return raw ? command : `php artisan ${command}`;
+}
+export const commandRunCommand = new Command('command:run')
+    .description('Run a command in a running ECS task')
+    .argument('<command...>', 'Artisan command signature and options to run')
+    .allowUnknownOption(true)
+    .option('-s, --stage <stage>', 'SST stage name (required)')
+    .option('-c, --cluster <cluster>', 'ECS cluster name (optional, auto-detected from SST config)')
+    .option('-r, --region <region>', 'AWS region', process.env.AWS_REGION || 'us-east-1')
+    .option('--service <service>', 'Service to run the command against (web, worker, or worker name)', 'web')
+    .option('--container <container>', 'Container name override')
+    .option('--raw', 'Run the provided command instead of prefixing it with "php artisan"', false)
+    .action(async (commandParts, options) => {
+    try {
+        const region = options.region;
+        const stage = options.stage;
+        if (!stage) {
+            console.error('Error: Stage is required. Use --stage flag to specify the SST stage.');
+            process.exit(1);
+        }
+        const ecsClient = new ECSClient({ region });
+        const clusterArn = await findClusterArn(ecsClient, stage, options.cluster);
+        const matchingTask = await findTask(ecsClient, clusterArn, options.service, 'Select a task to run the command in:');
+        const taskId = matchingTask.taskArn?.split('/').pop();
+        const containerName = options.container || matchingTask.containers?.[0]?.name;
+        const command = buildCommandToRun(commandParts, options.raw);
+        if (!taskId) {
+            console.error('Error: Could not determine ECS task ID.');
+            process.exit(1);
+        }
+        if (!containerName) {
+            console.error('Error: Could not determine ECS container name.');
+            process.exit(1);
+        }
+        console.log(`Running command in task: ${taskId}`);
+        console.log(`Container: ${containerName}`);
+        console.log(`Command: ${command}`);
+        console.log('');
+        const awsCommand = spawn('aws', [
+            'ecs',
+            'execute-command',
+            '--cluster', clusterArn,
+            '--task', taskId,
+            '--container', containerName,
+            '--interactive',
+            '--command', command,
+        ], {
+            stdio: 'inherit',
+            env: { ...process.env, AWS_REGION: region },
+        });
+        awsCommand.on('exit', (code) => {
+            process.exit(code || 0);
+        });
+    }
+    catch (error) {
+        console.error('Error:', error.message);
+        process.exit(1);
+    }
+});
+//# sourceMappingURL=command-run.js.map

package/dist/bin/commands/command-run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-run.js","sourceRoot":"","sources":["../../../bin/commands/command-run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAW3D,MAAM,UAAU,iBAAiB,CAAC,YAAsB,EAAE,GAAY;IACpE,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEvC,OAAO,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,OAAO,EAAE,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC;KACxD,WAAW,CAAC,qCAAqC,CAAC;KAClD,QAAQ,CAAC,cAAc,EAAE,8CAA8C,CAAC;KACxE,kBAAkB,CAAC,IAAI,CAAC;KACxB,MAAM,CAAC,qBAAqB,EAAE,2BAA2B,CAAC;KAC1D,MAAM,CAAC,yBAAyB,EAAE,4DAA4D,CAAC;KAC/F,MAAM,CAAC,uBAAuB,EAAE,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW,CAAC;KACpF,MAAM,CAAC,qBAAqB,EAAE,kEAAkE,EAAE,KAAK,CAAC;KACxG,MAAM,CAAC,yBAAyB,EAAE,yBAAyB,CAAC;KAC5D,MAAM,CAAC,OAAO,EAAE,qEAAqE,EAAE,KAAK,CAAC;KAC7F,MAAM,CAAC,KAAK,EAAE,YAAsB,EAAE,OAA0B,EAAE,EAAE;IACnE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE5B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,sEAAsE,CAAC,CAAC;YACtF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3E,MAAM,YAAY,GAAG,MAAM,QAAQ,CACjC,SAAS,EACT,UAAU,EACV,OAAO,CAAC,OAAO,EACf,sCAAsC,CACvC,CAAC;QAEF,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QACtD,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;QAC9E,MAAM,OAAO,GAAG,iBAAiB,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAE7D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;YACzD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;YAChE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,4BAA4B,MAAM,EAAE,CAAC,CAAC;QAClD,OAAO,CAAC,GAAG,CAAC,cAAc,aAAa,EAAE,CAAC,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,EAAE,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEhB,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,EAAE;YAC9B,KAAK;YACL,iBAAiB;YACjB,WAAW,EAAE,UAAU;YACvB,QAAQ,EAAE,MAAM;YAChB,aAAa,EAAE,aAAa;YAC5B,eAAe;YACf,WAAW,EAAE,OAAO;SACrB,EAAE;YACD,KAAK,EAAE,SAAS;YAChB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE;SAC5C,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YAC7B,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAG,KAAe,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/docs/api.md

@@ -259,7 +259,25 @@ web: {
 
 #### `web.health`
 - **Type:** `ServiceArgs["health"]`
-- **Description:** Health check configuration for the web service.
+- **Description:** ECS container-level health check for the web service. Distinct from `web.healthCheck` (load balancer).
+
+#### `web.healthCheck`
+- **Type:** `Input<LaravelHealthCheck>`
+- **Description:** Load balancer health check applied to the default forward port (`8080/http`). Shorthand so you don't have to override the full `loadBalancer` config just to set a path. Ignored when `loadBalancer` is provided — configure `loadBalancer.health` directly in that case.
+
+**Example:**
+```typescript
+web: {
+  domain: { name: 'app.example.com' },
+  healthCheck: {
+    path: '/up',
+    successCodes: '200',
+    interval: '30 seconds',
+    healthyThreshold: 2,
+    unhealthyThreshold: 3,
+  },
+}
+```
 
 #### `web.executionRole`
 - **Type:** `ServiceArgs["executionRole"]`

package/laravel-sst.ts

@@ -132,11 +132,72 @@ export interface LaravelServiceArgs {
     >;
 }
 
+/**
+ * Shorthand for the load balancer health check applied to the default forward
+ * port. Mirrors the inner shape of SST's `loadBalancer.health` entry, minus the
+ * per-port keying which the package fills in for you.
+ *
+ * Not used when {@link LaravelWebArgs.loadBalancer} is provided — in that case
+ * configure `loadBalancer.health` directly.
+ */
+export interface LaravelHealthCheck {
+    /**
+     * The URL path the load balancer pings for health checks.
+     * @default `"/"`
+     */
+    path?: Input<string>;
+    /**
+     * Time between health check requests. Between `5 seconds` and `300 seconds`.
+     * @default `"30 seconds"`
+     */
+    interval?: Input<`${number} ${'second' | 'seconds' | 'minute' | 'minutes'}`>;
+    /**
+     * Per-request timeout. Between `2 seconds` and `120 seconds`.
+     * @default `"5 seconds"`
+     */
+    timeout?: Input<`${number} ${'second' | 'seconds' | 'minute' | 'minutes'}`>;
+    /**
+     * Consecutive successes required to mark a target healthy. Between 2 and 10.
+     * @default `5`
+     */
+    healthyThreshold?: Input<number>;
+    /**
+     * Consecutive failures required to mark a target unhealthy. Between 2 and 10.
+     * @default `2`
+     */
+    unhealthyThreshold?: Input<number>;
+    /**
+     * HTTP response codes treated as successful (e.g. `"200"`, `"200-299"`).
+     * @default `"200"`
+     */
+    successCodes?: Input<string>;
+}
+
 export interface LaravelWebArgs extends LaravelServiceArgs {
     /**
      * Custom domain for the web layer. (if you don't provide a domain name, you will be able to use the load balancer domain for testing (http only))
      */
     domain?: LaravelDomain;
+
+    /**
+     * Load balancer health check for the web service. The package wires this
+     * to the default forward port (`8080/http`), so you only specify the
+     * check itself — not the per-port key.
+     *
+     * Distinct from {@link LaravelServiceArgs.health}, which is the ECS
+     * container-level health check.
+     *
+     * Ignored when `loadBalancer` is set — configure `loadBalancer.health`
+     * yourself in that case.
+     *
+     * @example
+     * ```js
+     * web: {
+     *   healthCheck: { path: '/up' },
+     * }
+     * ```
+     */
+    healthCheck?: Input<LaravelHealthCheck>;
 }
 
 export interface LaravelReverbArgs extends LaravelServiceArgs {
@@ -415,6 +476,13 @@ export class LaravelService extends Component {
                                   ports: getDefaultPublicPorts(
                                       args.web?.domain,
                                   ),
+                                  ...(args.web?.healthCheck
+                                      ? {
+                                            health: {
+                                                '8080/http': args.web.healthCheck,
+                                            },
+                                        }
+                                      : {}),
                               },
 
                     dev: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kirschbaum-development/sst-laravel",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "type": "module",
   "description": "An unofficial extension of SST to deploy containerized Laravel applications to AWS Fargate.",
   "main": "laravel-sst.ts",