From 5cb85ff58fd07135efd52c3fd3ba56881170b88b Mon Sep 17 00:00:00 2001
From: Kevin Ansfield <kevin@ghost.org>
Date: Thu, 28 Mar 2024 16:10:59 +0000
Subject: [PATCH] Replaced setup/done screen with onboarding checklist (#19952)

part of https://linear.app/tryghost/issue/IPC-81/remove-setupdone-screen-from-signup-flow

- when the `onboardingChecklist` flag is enabled the `setup/done` screen shown after install or signup will initiate the onboarding checklist and redirect straight to the dashboard effectively replacing the previous onboarding flow
---
 ghost/admin/app/routes/setup/done.js            | 15 +++++++++++++++
 ghost/admin/app/services/onboarding.js          |  6 ++++++
 ghost/admin/tests/acceptance/onboarding-test.js | 14 +++++++++++++-
 3 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/ghost/admin/app/routes/setup/done.js b/ghost/admin/app/routes/setup/done.js
index 540273c3ba..5cec63abfe 100644
--- a/ghost/admin/app/routes/setup/done.js
+++ b/ghost/admin/app/routes/setup/done.js
@@ -2,9 +2,24 @@ import Route from '@ember/routing/route';
 import {inject as service} from '@ember/service';
 
 export default class SetupFinishingTouchesRoute extends Route {
+    @service feature;
+    @service onboarding;
+    @service router;
+    @service session;
     @service settings;
     @service themeManagement;
 
+    beforeModel() {
+        if (!this.session.user.isOwnerOnly) {
+            return;
+        }
+
+        if (this.feature.onboardingChecklist) {
+            this.onboarding.startChecklist();
+            return this.router.transitionTo('dashboard');
+        }
+    }
+
     model() {
         this.themeManagement.setPreviewType('homepage');
         this.themeManagement.updatePreviewHtmlTask.perform();
diff --git a/ghost/admin/app/services/onboarding.js b/ghost/admin/app/services/onboarding.js
index 057f58cf96..56f8d868f8 100644
--- a/ghost/admin/app/services/onboarding.js
+++ b/ghost/admin/app/services/onboarding.js
@@ -26,6 +26,7 @@ export default class OnboardingService extends Service {
     get isChecklistShown() {
         return this.feature.onboardingChecklist
             && this.session.user.isOwnerOnly
+            && this.checklistStarted
             && !this.checklistCompleted
             && !this.checklistDismissed;
     }
@@ -105,6 +106,11 @@ export default class OnboardingService extends Service {
         await this._saveSettings(settings);
     }
 
+    @action
+    async reset() {
+        await this._saveSettings(undefined);
+    }
+
     /* private */
 
     async _saveSettings(settings) {
diff --git a/ghost/admin/tests/acceptance/onboarding-test.js b/ghost/admin/tests/acceptance/onboarding-test.js
index 0ae9190939..7e7d38084f 100644
--- a/ghost/admin/tests/acceptance/onboarding-test.js
+++ b/ghost/admin/tests/acceptance/onboarding-test.js
@@ -27,10 +27,22 @@ describe('Acceptance: Onboarding', function () {
             return await authenticateSession();
         });
 
-        it('dashboard shows the checklist', async function () {
+        it('dashboard does not show checklist by default', async function () {
             await visit('/dashboard');
             expect(currentURL()).to.equal('/dashboard');
 
+            // onboarding isn't shown
+            expect(find('[data-test-dashboard="onboarding-checklist"]'), 'checklist').to.not.exist;
+
+            // other default dashboard elements are visible
+            expect(find('[data-test-dashboard="header"]'), 'header').to.exist;
+            expect(find('[data-test-dashboard="attribution"]'), 'attribution section').to.exist;
+        });
+
+        it('dashboard shows the checklist after accessing setup/done', async function () {
+            await visit('/setup/done');
+            expect(currentURL()).to.equal('/dashboard');
+
             // main onboarding list is visible
             expect(find('[data-test-dashboard="onboarding-checklist"]'), 'checklist').to.exist;