Add more examples

Author: rmcdaniel

.env

@@ -1,6 +1,6 @@
 APP_NAME=Laravel
 APP_ENV=local
-APP_KEY=
+APP_KEY=base64:YzfitatnBPwXyR6TMQdaNkQ816HHtXePMyOM3EW9XgM=
 APP_DEBUG=true
 APP_URL=http://localhost
 
@@ -26,7 +26,7 @@ DB_CONNECTION=mysql
 DB_HOST=mysql
 DB_PORT=3306
 DB_DATABASE=sample
-DB_USERNAME=sail
+DB_USERNAME=laravel
 DB_PASSWORD=password
 
 SESSION_DRIVER=database
@@ -65,3 +65,9 @@ AWS_BUCKET=
 AWS_USE_PATH_STYLE_ENDPOINT=false
 
 VITE_APP_NAME="${APP_NAME}"
+
+SHARED_DB_HOST=mysql
+SHARED_DB_PORT=3306
+SHARED_DB_DATABASE=sample
+SHARED_DB_USERNAME=laravel
+SHARED_DB_PASSWORD=password

README.md

@@ -62,3 +62,19 @@ php artisan test
 ```
 
 That's it! You can now create and test workflows.
+
+----
+
+#### More Workflows to Explore
+
+In addition to the basic example workflow, you can try these other workflows included in this sample app:
+
+* `php artisan app:elapsed` – Demonstrates how to correctly track start and end times to measure execution duration.
+
+* `php artisan app:microservice` – A fully working example of a workflow that spans multiple Laravel applications using a shared database and queue.
+
+* `php artisan app:playwright` – Runs a Playwright automation, captures a WebM video, encodes it to MP4 using FFmpeg, and then cleans up the WebM file.
+
+* `php artisan app:webhook` – Showcases how to use the built-in webhook system for triggering workflows externally.
+
+Try them out to see Laravel Workflow in action across different use cases!

app/Console/Commands/Init.php

@@ -27,9 +27,6 @@ class Init extends Command
      */
     public function handle()
     {
-        $this->info('Setting APP_KEY...');
-        Artisan::call('key:generate');
-
         $this->info('Setting ASSET_URL...');
         $this->setAssetUrl();
 

app/Console/Commands/Microservice.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Workflows\Microservice\MicroserviceWorkflow;
+use Illuminate\Console\Command;
+use Workflow\WorkflowStub;
+
+class Microservice extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'app:microservice';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Runs a microservice workflow';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle()
+    {
+        $workflow = WorkflowStub::make(MicroserviceWorkflow::class);
+        $workflow->start();
+        while ($workflow->running());
+        $this->info($workflow->output());
+    }
+}

app/Models/StoredWorkflow.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Models;
+
+use Workflow\Models\StoredWorkflow as BaseStoredWorkflow;
+
+class StoredWorkflow extends BaseStoredWorkflow
+{
+    protected $connection = 'shared';
+}

app/Models/StoredWorkflowException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Models;
+
+use Workflow\Models\StoredWorkflowException as BaseStoredWorkflowException;
+
+class StoredWorkflowException extends BaseStoredWorkflowException
+{
+    protected $connection = 'shared';
+}

app/Models/StoredWorkflowLog.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Models;
+
+use Workflow\Models\StoredWorkflowLog as BaseStoredWorkflowLog;
+
+class StoredWorkflowLog extends BaseStoredWorkflowLog
+{
+    protected $connection = 'shared';
+}

app/Models/StoredWorkflowSignal.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Models;
+
+use Workflow\Models\StoredWorkflowSignal as BaseStoredWorkflowSignal;
+
+class StoredWorkflowSignal extends BaseStoredWorkflowSignal
+{
+    protected $connection = 'shared';
+}

app/Models/StoredWorkflowTimer.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Models;
+
+use Workflow\Models\StoredWorkflowTimer as BaseStoredWorkflowTimer;
+
+class StoredWorkflowTimer extends BaseStoredWorkflowTimer
+{
+    protected $connection = 'shared';
+}

app/Workflows/Microservice/MicroserviceActivity.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Workflows\Microservice;
+
+use Workflow\Activity;
+
+class MicroserviceActivity extends Activity
+{
+    public $queue = 'activity';
+}

app/Workflows/Microservice/MicroserviceOtherActivity.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Workflows\Microservice;
+
+use Workflow\Activity;
+
+class MicroserviceOtherActivity extends Activity
+{
+    public $queue = 'activity';
+}

app/Workflows/Microservice/MicroserviceWorkflow.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Workflows\Microservice;
+
+use Workflow\ActivityStub;
+use Workflow\Workflow;
+
+class MicroserviceWorkflow extends Workflow
+{
+    public function execute()
+    {
+        $result = yield ActivityStub::make(MicroserviceActivity::class);
+
+        $otherResult = yield ActivityStub::make(MicroserviceOtherActivity::class, 'other');
+
+        return 'workflow_' . $result . '_' . $otherResult;
+    }
+}

config/database.php

@@ -62,6 +62,26 @@
             ]) : [],
         ],
 
+        'shared' => [
+            'driver' => 'mysql',
+            'url' => env('SHARED_DB_URL'),
+            'host' => env('SHARED_DB_HOST', '127.0.0.1'),
+            'port' => env('SHARED_DB_PORT', '3306'),
+            'database' => env('SHARED_DB_DATABASE', 'laravel'),
+            'username' => env('SHARED_DB_USERNAME', 'root'),
+            'password' => env('SHARED_DB_PASSWORD', ''),
+            'unix_socket' => env('SHARED_DB_SOCKET', ''),
+            'charset' => env('SHARED_DB_CHARSET', 'utf8mb4'),
+            'collation' => env('SHARED_DB_COLLATION', 'utf8mb4_unicode_ci'),
+            'prefix' => '',
+            'prefix_indexes' => true,
+            'strict' => true,
+            'engine' => null,
+            'options' => extension_loaded('pdo_mysql') ? array_filter([
+                PDO::MYSQL_ATTR_SSL_CA => env('SHARED_MYSQL_ATTR_SSL_CA'),
+            ]) : [],
+        ],
+
         'mariadb' => [
             'driver' => 'mariadb',
             'url' => env('DB_URL'),

config/workflows.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'workflows_folder' => 'Workflows',
+
+    'base_model' => Illuminate\Database\Eloquent\Model::class,
+
+    'stored_workflow_model' => App\Models\StoredWorkflow::class,
+
+    'stored_workflow_exception_model' => App\Models\StoredWorkflowException::class,
+
+    'stored_workflow_log_model' => App\Models\StoredWorkflowLog::class,
+
+    'stored_workflow_signal_model' => App\Models\StoredWorkflowSignal::class,
+
+    'stored_workflow_timer_model' => App\Models\StoredWorkflowTimer::class,
+
+    'workflow_relationships_table' => 'workflow_relationships',
+
+    'serializer' => Workflow\Serializers\Y::class,
+
+    'prune_age' => '1 month',
+
+    'webhooks_route' => env('WORKFLOW_WEBHOOKS_ROUTE', 'webhooks'),
+
+    'webhook_auth' => [
+        'method' => env('WORKFLOW_WEBHOOKS_AUTH_METHOD', 'none'),
+
+        'signature' => [
+            'header' => env('WORKFLOW_WEBHOOKS_SIGNATURE_HEADER', 'X-Signature'),
+            'secret' => env('WORKFLOW_WEBHOOKS_SECRET'),
+        ],
+
+        'token' => [
+            'header' => env('WORKFLOW_WEBHOOKS_TOKEN_HEADER', 'Authorization'),
+            'token' => env('WORKFLOW_WEBHOOKS_TOKEN'),
+        ],
+    ],
+
+    'monitor' => env('WORKFLOW_MONITOR', false),
+
+    'monitor_url' => env('WORKFLOW_MONITOR_URL'),
+
+    'monitor_api_key' => env('WORKFLOW_MONITOR_API_KEY'),
+
+    'monitor_connection' => env('WORKFLOW_MONITOR_CONNECTION', config('queue.default')),
+
+    'monitor_queue' => env(
+        'WORKFLOW_MONITOR_QUEUE',
+        config('queue.connections.' . config('queue.default') . '.queue', 'default')
+    ),
+];

database/migrations/2022_01_01_000000_create_workflows_table.php

@@ -8,6 +8,8 @@
 
 final class CreateWorkflowsTable extends Migration
 {
+    protected $connection = 'shared';
+
     /**
      * Run the migrations.
      */

database/migrations/2022_01_01_000001_create_workflow_logs_table.php

@@ -8,6 +8,8 @@
 
 final class CreateWorkflowLogsTable extends Migration
 {
+    protected $connection = 'shared';
+
     /**
      * Run the migrations.
      */

database/migrations/2022_01_01_000002_create_workflow_signals_table.php

@@ -8,6 +8,8 @@
 
 final class CreateWorkflowSignalsTable extends Migration
 {
+    protected $connection = 'shared';
+
     /**
      * Run the migrations.
      */

database/migrations/2022_01_01_000003_create_workflow_timers_table.php

@@ -8,6 +8,8 @@
 
 final class CreateWorkflowTimersTable extends Migration
 {
+    protected $connection = 'shared';
+
     /**
      * Run the migrations.
      */

database/migrations/2022_01_01_000004_create_workflow_exceptions_table.php

@@ -8,6 +8,8 @@
 
 final class CreateWorkflowExceptionsTable extends Migration
 {
+    protected $connection = 'shared';
+
     /**
      * Run the migrations.
      */

database/migrations/2022_01_01_000005_create_workflow_relationships_table.php

@@ -8,6 +8,8 @@
 
 final class CreateWorkflowRelationshipsTable extends Migration
 {
+    protected $connection = 'shared';
+
     /**
      * Run the migrations.
      */

docker-compose.yml

@@ -3,8 +3,6 @@ services:
         build:
             context: ./.devcontainer/docker
             dockerfile: Dockerfile
-            args:
-                WWWGROUP: '${WWWGROUP}'
         extra_hosts:
             - 'host.docker.internal:host-gateway'
         ports:
@@ -17,6 +15,22 @@ services:
         depends_on:
             - mysql
             - redis
+    microservice:
+        build:
+            context: ./.devcontainer/docker
+            dockerfile: Dockerfile
+        extra_hosts:
+            - 'host.docker.internal:host-gateway'
+        ports:
+            - '8001:80'
+        volumes:
+            - './microservice:/var/www/html'
+        networks:
+            - laravel
+        depends_on:
+            - mysql
+            - redis
+        command: ["php", "artisan", "queue:listen", "shared", "--queue=activity"]
     mysql:
         image: 'mysql/mysql-server:8.0'
         ports: