Merge pull request #481 from fleetbase/feature/onboarding-wrapper-architecture

feat: Add wrapper component support to onboarding orchestrator

Caddyfile

@@ -8,6 +8,7 @@
 http://:8000 {
 	root * /fleetbase/api/public
 	encode zstd br gzip
+	
 	php_server {
 		resolve_root_symlink
 	}

api/app/Http/Kernel.php

@@ -40,7 +40,6 @@ class Kernel extends HttpKernel
         ],
 
         'api' => [
-            'throttle:api',
             \Illuminate\Routing\Middleware\SubstituteBindings::class,
         ],
     ];

api/config/logging.php

@@ -51,7 +51,7 @@ return [
     'channels' => [
         'stack' => [
             'driver' => 'stack',
-            'channels' => ['single'],
+            'channels' => ['single', 'stdout'],
             'ignore_exceptions' => false,
         ],
 

api/config/octane.php

@@ -105,8 +105,8 @@ return [
         OperationTerminated::class => [
             FlushOnce::class,
             FlushTemporaryContainerInstances::class,
-            // DisconnectFromDatabases::class,
-            // CollectGarbage::class,
+            DisconnectFromDatabases::class,
+            CollectGarbage::class,    
         ],
 
         WorkerErrorOccurred::class => [

console/app/app.js

@@ -2,6 +2,7 @@ import Application from '@ember/application';
 import Resolver from 'ember-resolver';
 import loadInitializers from 'ember-load-initializers';
 import config from '@fleetbase/console/config/environment';
+import './deprecation-workflow';
 
 export default class App extends Application {
     modulePrefix = config.modulePrefix;

console/app/components/onboarding/yield.hbs

@@ -1,7 +1,9 @@
 <section class="onboarding step-host">
     {{#if this.initialized}}
-        {{#if this.currentComponent}}
-            {{component this.currentComponent context=this.context orchestrator=this.orchestrator brand=@brand}}
+        {{#if this.orchestrator.wrapper}}
+            {{component (lazy-engine-component this.orchestrator.wrapper) currentStepComponent=this.currentComponent context=this.context orchestrator=this.orchestrator brand=@brand}}
+        {{else if this.currentComponent}}
+            {{component (lazy-engine-component this.currentComponent) context=this.context orchestrator=this.orchestrator brand=@brand}}
         {{/if}}
     {{else}}
         <div class="flex items-center justify-center min-h-24">

console/app/deprecation-workflow.js

@@ -0,0 +1,9 @@
+import setupDeprecationWorkflow from 'ember-cli-deprecation-workflow';
+
+setupDeprecationWorkflow({
+    workflow: [
+        { handler: 'silence', matchId: 'ember-concurrency.deprecate-decorator-task' },
+        { handler: 'silence', matchId: 'new-helper-names' },
+        { handler: 'silence', matchId: 'ember-data:deprecate-non-strict-relationships' },
+    ],
+});

console/app/services/onboarding-orchestrator.js

@@ -7,17 +7,31 @@ export default class OnboardingOrchestratorService extends Service {
     @service onboardingContext;
 
     @tracked flow = null;
+    @tracked wrapper = null;
     @tracked current = null;
     @tracked history = [];
     @tracked sessionId = null;
 
-    start(flowId = null, opts = {}) {
+    async start(flowId = null, opts = {}) {
         const flow = this.onboardingRegistry.getFlow(flowId ?? this.onboardingRegistry.defaultFlow);
         if (!flow) throw new Error(`Onboarding flow '${flowId}' not found`);
+        
         this.flow = flow;
+        this.wrapper = flow.wrapper || null;
         this.sessionId = opts.sessionId || null;
         this.history = [];
-        this.goto(flow.entry);
+
+        // Execute onFlowWillStart hook if defined
+        if (typeof this.flow.onFlowWillStart === 'function') {
+            await this.flow.onFlowWillStart(this.flow, this);
+        }
+
+        await this.goto(flow.entry);
+
+        // Execute onFlowDidStart hook if defined
+        if (typeof this.flow.onFlowDidStart === 'function') {
+            await this.flow.onFlowDidStart(this.flow, this);
+        }
     }
 
     async goto(stepId) {
@@ -25,27 +39,43 @@ export default class OnboardingOrchestratorService extends Service {
         const step = this.flow.steps.find((s) => s.id === stepId);
         if (!step) throw new Error(`Step '${stepId}' not found`);
 
+        // Execute onStepWillChange hook if defined
+        const previousStep = this.current;
+        if (typeof this.flow.onStepWillChange === 'function') {
+            await this.flow.onStepWillChange(step, previousStep, this);
+        }
+
+        // Guard function - skip step if guard returns false
         if (typeof step.guard === 'function' && !step.guard(this.onboardingContext)) {
             return this.next();
         }
 
+        // beforeEnter lifecycle hook
         if (typeof step.beforeEnter === 'function') {
             await step.beforeEnter(this.onboardingContext);
         }
 
         this.current = step;
+
+        // Execute onStepDidChange hook if defined
+        if (typeof this.flow.onStepDidChange === 'function') {
+            await this.flow.onStepDidChange(this.current, previousStep, this);
+        }
     }
 
     async next() {
         if (!this.flow || !this.current) return;
 
         const leaving = this.current;
+        
+        // afterLeave lifecycle hook
         if (typeof leaving.afterLeave === 'function') {
             await leaving.afterLeave(this.onboardingContext);
         }
 
         if (!this.history.includes(leaving)) this.history.push(leaving);
 
+        // Support both string and function for next property
         let nextId;
         if (typeof leaving.next === 'function') {
             nextId = leaving.next(this.onboardingContext);
@@ -53,8 +83,20 @@ export default class OnboardingOrchestratorService extends Service {
             nextId = leaving.next;
         }
 
+        // If no next step, flow is complete
         if (!nextId) {
+            // Execute onFlowWillEnd hook if defined
+            if (typeof this.flow.onFlowWillEnd === 'function') {
+                await this.flow.onFlowWillEnd(leaving, this);
+            }
+
             this.current = null; // finished
+
+            // Execute onFlowDidEnd hook if defined
+            if (typeof this.flow.onFlowDidEnd === 'function') {
+                await this.flow.onFlowDidEnd(leaving, this);
+            }
+
             return;
         }
 
@@ -68,4 +110,31 @@ export default class OnboardingOrchestratorService extends Service {
         this.history = this.history.slice(0, -1);
         await this.goto(prev.id);
     }
+
+    /**
+     * Get the current path (for flows with multiple paths)
+     * This is a helper method that can be used by flows to determine the current path
+     */
+    getCurrentPath() {
+        if (!this.flow || !this.flow.paths) return null;
+        
+        // Determine path based on context or current step
+        for (const [pathId, pathDef] of Object.entries(this.flow.paths)) {
+            if (pathDef.steps && pathDef.steps.some(s => s.id === this.current?.id)) {
+                return pathDef;
+            }
+        }
+        
+        return null;
+    }
+
+    /**
+     * Check if a step is in the current path
+     */
+    isStepInPath(stepId) {
+        const currentPath = this.getCurrentPath();
+        if (!currentPath) return true; // If no paths defined, all steps are valid
+        
+        return currentPath.steps?.some(s => s.id === stepId) ?? false;
+    }
 }

console/app/services/onboarding-registry.js

@@ -9,7 +9,7 @@ export default class OnboardingRegistryService extends Service {
         this.defaultFlow = flowId;
     }
 
-    registerFlow(flow) {
+    registerFlow(flow, options = {}) {
         if (!flow || !flow.id || !flow.entry || !Array.isArray(flow.steps)) {
             throw new Error('Invalid FlowDef: id, entry, steps are required');
         }
@@ -23,6 +23,11 @@ export default class OnboardingRegistryService extends Service {
             }
         }
         this.flows.set(flow.id, flow);
+
+        // If specified, set as default flow
+        if (options.default) {
+            this.defaultFlow = flow.id;
+        }
     }
 
     getFlow(id) {

console/app/templates/onboard.hbs

@@ -1,6 +1,3 @@
-<div class="flex items-center justify-center h-screen min-h-screen px-4 py-12 bg-gray-50 dark:bg-gray-900 sm:px-6 lg:px-8 overflow-y-scroll">
-    <div class="w-full max-w-md h-screen flex items-center justify-center py-4">
-        {{outlet}}
-    </div>
-    <Spacer @height="300px" />
+<div class="onboard-route-wrapper">
+    {{outlet}}
 </div>

console/config/environment.js

@@ -23,7 +23,7 @@ module.exports = function (environment) {
         APP: {
             autoboot: true,
             extensions: asArray(getenv('EXTENSIONS')),
-            disableRuntimeConfig: toBoolean(getenv('DISABLE_RUNTIME_CONFIG')),
+            disableRuntimeConfig: toBoolean(getenv('DISABLE_RUNTIME_CONFIG', environment === 'production')),
         },
 
         API: {

docker/Dockerfile

@@ -158,14 +158,14 @@ CMD ["php", "artisan", "queue:work"]
 # Application dev stage
 FROM base AS app-dev
 ENTRYPOINT ["docker-php-entrypoint"]
-CMD ["sh", "-c", "php artisan octane:frankenphp --max-requests=250 --port=8000 --host=0.0.0.0 --watch"]
+CMD ["sh", "-c", "php artisan octane:frankenphp --max-requests=1000 --port=8000 --host=0.0.0.0 --watch"]
 
 # Application release stage
 FROM base AS app-release
 ENTRYPOINT ["docker-php-entrypoint"]
-CMD ["sh", "-c", "php artisan octane:frankenphp --max-requests=250 --port=8000 --host=0.0.0.0"] 
+CMD ["sh", "-c", "php artisan octane:frankenphp --max-requests=1000 --port=8000 --host=0.0.0.0"] 
 
 # Application stage
 FROM base AS app
 ENTRYPOINT ["/sbin/ssm-parent", "-c", ".ssm-parent.yaml", "run", "--", "docker-php-entrypoint"]
-CMD ["sh", "-c", "php artisan octane:frankenphp --max-requests=250 --port=8000 --host=0.0.0.0"]
+CMD ["sh", "-c", "php artisan octane:frankenphp --max-requests=1000 --port=8000 --host=0.0.0.0"]