refactor(dashboard): modularize demo workflow initialization and clean up unused code

- Introduced `useInitDemoWorkflow` hook to encapsulate demo workflow initialization logic.
- Removed unused imports and code related to workflow fetching in `InboxPlayground`.
- Updated `InboxConnectedGuide` to utilize the new hook for demo workflow setup.
- Cleaned up `CommunityEditionService` by removing unused member repository and switch organization use case.

Author: djabarovgeorge

apps/api/src/app/auth/services/system-organization.service.ts

@@ -1,13 +1,11 @@
 import { Inject, Injectable, OnModuleInit } from '@nestjs/common';
-import { CommunityOrganizationRepository, MemberRepository, UserEntity, UserRepository } from '@novu/dal';
+import { CommunityOrganizationRepository, UserEntity, UserRepository } from '@novu/dal';
 import { PinoLogger } from '@novu/application-generic';
 import { ApiServiceLevelEnum } from '@novu/shared';
 import { CreateOrganization } from '../../organization/usecases/create-organization/create-organization.usecase';
 import { CreateOrganizationCommand } from '../../organization/usecases/create-organization/create-organization.command';
 import { UserRegister } from '../usecases/register/user-register.usecase';
 import { UserRegisterCommand } from '../usecases/register/user-register.command';
-import { SwitchOrganization } from '../usecases/switch-organization/switch-organization.usecase';
-import { SwitchOrganizationCommand } from '../usecases/switch-organization/switch-organization.command';
 
 @Injectable()
 export class CommunityEditionService implements OnModuleInit {
@@ -16,12 +14,10 @@ export class CommunityEditionService implements OnModuleInit {
   private readonly COMMUNITY_EDITION_USER_EMAIL = '[email protected]';
 
   constructor(
-    private memberRepository: MemberRepository,
     @Inject('ORGANIZATION_REPOSITORY')
     private organizationRepository: CommunityOrganizationRepository,
     private createOrganizationUsecase: CreateOrganization,
     private userRegisterUsecase: UserRegister,
-    private switchOrganizationUsecase: SwitchOrganization,
     private userRepository: UserRepository,
     private logger: PinoLogger
   ) {}
@@ -41,7 +37,7 @@ export class CommunityEditionService implements OnModuleInit {
 
       if (communityEditionOrg) {
         this.logger.info(
-          'Self Hosted is already initialized, skipping Community Edition creation.' +
+          'Self Hosted is already initialized, skipping Community Edition creation. ' +
             `Organization already exists with ID: ${communityEditionOrg._id}`
         );
 

apps/dashboard/src/components/auth/inbox-playground.tsx

@@ -1,17 +1,15 @@
 import { useEnvironment } from '@/context/environment/hooks';
 import { useTriggerWorkflow } from '@/hooks/use-trigger-workflow';
 import { zodResolver } from '@hookform/resolvers/zod';
-import { IEnvironment, StepTypeEnum, WorkflowCreationSourceEnum } from '@novu/shared';
 import { useEffect, useState } from 'react';
 import { useForm } from 'react-hook-form';
 import { RiNotification2Fill } from 'react-icons/ri';
 import { useNavigate } from 'react-router-dom';
 import { z } from 'zod';
-import { createWorkflow } from '../../api/workflows';
 import { ONBOARDING_DEMO_WORKFLOW_ID } from '../../config';
 import { useAuth } from '../../context/auth/hooks';
-import { useFetchWorkflows } from '../../hooks/use-fetch-workflows';
 import { useTelemetry } from '../../hooks/use-telemetry';
+import { useInitDemoWorkflow } from '../../hooks/use-init-demo-workflow';
 import { ROUTES } from '../../utils/routes';
 import { TelemetryEvent } from '../../utils/telemetry';
 import { Button } from '../primitives/button';
@@ -92,30 +90,11 @@ export function InboxPlayground() {
   });
 
   const { triggerWorkflow, isPending } = useTriggerWorkflow();
-  const { data } = useFetchWorkflows({ query: ONBOARDING_DEMO_WORKFLOW_ID });
   const auth = useAuth();
   const [hasNotificationBeenSent, setHasNotificationBeenSent] = useState(false);
   const navigate = useNavigate();
   const telemetry = useTelemetry();
-
-  useEffect(() => {
-    if (!data) return;
-
-    /**
-     * We only want to create the demo workflow if it doesn't exist yet.
-     * This workflow will be used by the inbox preview examples
-     */
-    const initializeDemoWorkflow = async () => {
-      const workflow = data?.workflows.find((workflow) => workflow.workflowId?.includes(ONBOARDING_DEMO_WORKFLOW_ID));
-
-      if (!workflow) {
-        await createDemoWorkflow({ environment: currentEnvironment! });
-      }
-    };
-
-    initializeDemoWorkflow();
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [data]);
+  useInitDemoWorkflow(currentEnvironment!);
 
   const handleSendNotification = async () => {
     try {
@@ -249,40 +228,3 @@ export function InboxPlayground() {
     </div>
   );
 }
-
-async function createDemoWorkflow({ environment }: { environment: IEnvironment }) {
-  await createWorkflow({
-    environment,
-    workflow: {
-      name: 'Onboarding Demo Workflow',
-      description: 'A demo workflow to showcase the Inbox component',
-      workflowId: ONBOARDING_DEMO_WORKFLOW_ID,
-      steps: [
-        {
-          name: 'Inbox',
-          type: StepTypeEnum.IN_APP,
-          controlValues: {
-            subject: '{{payload.subject}}',
-            body: '{{payload.body}}',
-            avatar: window.location.origin + '/images/novu.svg',
-            primaryAction: {
-              label: '{{payload.primaryActionLabel}}',
-              redirect: {
-                target: '_self',
-                url: '/onboarding/inbox/embed',
-              },
-            },
-            secondaryAction: {
-              label: '{{payload.secondaryActionLabel}}',
-              redirect: {
-                target: '_self',
-                url: '/onboarding/inbox/embed',
-              },
-            },
-          },
-        },
-      ],
-      __source: WorkflowCreationSourceEnum.DASHBOARD,
-    },
-  });
-}

apps/dashboard/src/components/welcome/inbox-connected-guide.tsx

@@ -6,6 +6,7 @@ import { ONBOARDING_DEMO_WORKFLOW_ID } from '../../config';
 import { ROUTES } from '../../utils/routes';
 import { Button } from '../primitives/button';
 import { showErrorToast, showSuccessToast } from '../primitives/sonner-helpers';
+import { useInitDemoWorkflow } from '../../hooks/use-init-demo-workflow';
 
 type InboxConnectedGuideProps = {
   subscriberId: string;
@@ -15,6 +16,7 @@ type InboxConnectedGuideProps = {
 export function InboxConnectedGuide({ subscriberId, environment }: InboxConnectedGuideProps) {
   const navigate = useNavigate();
   const { triggerWorkflow, isPending } = useTriggerWorkflow(environment);
+  useInitDemoWorkflow(environment);
 
   async function handleSendNotification() {
     try {

apps/dashboard/src/hooks/use-init-demo-workflow.ts

@@ -0,0 +1,61 @@
+import { useEffect } from 'react';
+import { IEnvironment } from '@novu/shared';
+import { ONBOARDING_DEMO_WORKFLOW_ID } from '../config';
+import { useFetchWorkflows } from './use-fetch-workflows';
+import { createWorkflow } from '../api/workflows';
+import { StepTypeEnum, WorkflowCreationSourceEnum } from '@novu/shared';
+
+async function createDemoWorkflow({ environment }: { environment: IEnvironment }) {
+  await createWorkflow({
+    environment,
+    workflow: {
+      name: 'Onboarding Demo Workflow',
+      description: 'A demo workflow to showcase the Inbox component',
+      workflowId: ONBOARDING_DEMO_WORKFLOW_ID,
+      steps: [
+        {
+          name: 'Inbox',
+          type: StepTypeEnum.IN_APP,
+          controlValues: {
+            subject: '{{payload.subject}}',
+            body: '{{payload.body}}',
+            avatar: window.location.origin + '/images/novu.svg',
+            primaryAction: {
+              label: '{{payload.primaryActionLabel}}',
+              redirect: {
+                target: '_self',
+                url: '/onboarding/inbox/embed',
+              },
+            },
+            secondaryAction: {
+              label: '{{payload.secondaryActionLabel}}',
+              redirect: {
+                target: '_self',
+                url: '/onboarding/inbox/embed',
+              },
+            },
+          },
+        },
+      ],
+      __source: WorkflowCreationSourceEnum.DASHBOARD,
+    },
+  });
+}
+
+export function useInitDemoWorkflow(environment: IEnvironment) {
+  const { data } = useFetchWorkflows({ query: ONBOARDING_DEMO_WORKFLOW_ID });
+
+  useEffect(() => {
+    if (!data) return;
+
+    const initializeDemoWorkflow = async () => {
+      const workflow = data?.workflows.find((workflow) => workflow.workflowId?.includes(ONBOARDING_DEMO_WORKFLOW_ID));
+
+      if (!workflow) {
+        await createDemoWorkflow({ environment });
+      }
+    };
+
+    initializeDemoWorkflow();
+  }, [data, environment]);
+}