Add Callouts preview accordion on SubspacesList default subspace template selector

[ccanos]

#6879

• moved the Callouts accordion from the CollaborationTemplatePreview to its own file as a component.
• Added that new component to SubspacesList

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced the InnovationFlowCalloutsPreview component for displaying callouts in an expandable format.
  • Enhanced the AdminChallengesPage GraphQL query to include detailed callout information.
  • Integrated the InnovationFlowCalloutsPreview component into the SubspaceListView for improved callout visualization.

• Bug Fixes

  • Updated state management in SubspaceListView to handle selected state toggling correctly.

• Refactor

  • Simplified the CollaborationTemplatePreview component by replacing the accordion structure with the new callouts preview component, improving maintainability.

[coderabbitai]

Walkthrough

The changes introduce a new React component, InnovationFlowCalloutsPreview, designed to display a preview of callouts within an innovation flow context. This component replaces the existing accordion-based logic in the CollaborationTemplatePreview component. Additionally, the GraphQL query for the admin page is updated to include new fields related to callouts. The SubspaceListView component is modified to utilize the new callouts preview component, enhancing its functionality. Overall, these changes streamline callout rendering and improve the data structure in the relevant components.

Changes

File	Change Summary
src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx	Introduced a new React component InnovationFlowCalloutsPreview, defined CalloutPreview type and InnovationFlowCalloutsPreviewProps interface, and implemented state management for selected callouts.
src/domain/journey/space/pages/SpaceSubspaces/AdminChallengesPage.graphql	Updated the AdminSpaceSubspacesPage GraphQL query to include a new callouts field with additional subfields under the templatesManager section.
src/domain/journey/space/pages/SpaceSubspaces/SubspaceListView.tsx	Added import for InnovationFlowCalloutsPreview, updated onSelectState logic, and integrated the new component into the JSX structure, passing relevant props.
src/domain/templates/components/Previews/CollaborationTemplatePreview.tsx	Removed accordion logic for callouts, replaced with InnovationFlowCalloutsPreview, updated CollaborationTemplatePreviewProps interface, and eliminated internal state management for selected callouts.

Possibly related PRs

• [Simple Homepage] Activity view - Recent Spaces + mobile support #7116: Integration of the InnovationFlowCalloutsPreview component into the SubspaceListView.
• Subspaces templates fixes #7127: Modifications to the useInnovationFlowSettings hook, potentially interacting with callouts functionality.
• Subspaces templates fixes #7130: Changes to the UpdateCalloutTemplate mutation, which may relate to callouts functionality.
• Hide pen button on closed link callout type #7201: Modifications to the CalloutView component, relevant for rendering callouts.
• BUGFix: Template Mappings bugs #7291: Bug fix related to importing tags for subspace templates, impacting callouts display.

Suggested labels

client, enhancement, UX

Suggested reviewers

• reactoholic

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (2)

62-63: Provide a fallback message when Whiteboard preview is not available

When the callout type is Whiteboard or WhiteboardCollection but no preview URI is available, returning null results in an empty accordion panel. Consider displaying a user-friendly message instead.

---

79-80: Consider displaying a loading indicator when callouts are loading

Currently, when loading is true, the component renders nothing. Providing a loading indicator would improve user experience during data fetch.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 523cdd1 and 61ef44d.

⛔ Files ignored due to path filters (2)

• src/core/apollo/generated/apollo-hooks.ts is excluded by !**/generated/**
• src/core/apollo/generated/graphql-schema.ts is excluded by !**/generated/**

📒 Files selected for processing (4)

• src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1 hunks)
• src/domain/journey/space/pages/SpaceSubspaces/AdminChallengesPage.graphql (1 hunks)
• src/domain/journey/space/pages/SpaceSubspaces/SubspaceListView.tsx (2 hunks)
• src/domain/templates/components/Previews/CollaborationTemplatePreview.tsx (3 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

src/domain/journey/space/pages/SpaceSubspaces/SubspaceListView.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

• We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
• Avoid flagging the absence of local error handling in cases where the global error handler suffices.
• Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

• Not Required: there's a skip
  {
  variables: { templateId: templateId! },
  skip: !templateId,
  }

Check for common security vulnerabilities such as:

• SQL Injection
• XSS (Cross-Site Scripting)
• CSRF (Cross-Site Request Forgery)
• Insecure dependencies
• Sensitive data exposure

src/domain/journey/space/pages/SpaceSubspaces/AdminChallengesPage.graphql (1)

Pattern src/**/*.{graphql,gql}: Review the GraphQL schema and queries for best practices, potential bugs, and adherence to the project's GraphQL standards.
Ensure that the schema is well-defined and queries are optimized.
Check for security vulnerabilities.

src/domain/templates/components/Previews/CollaborationTemplatePreview.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

• We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
• Avoid flagging the absence of local error handling in cases where the global error handler suffices.
• Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

• Not Required: there's a skip
  {
  variables: { templateId: templateId! },
  skip: !templateId,
  }

Check for common security vulnerabilities such as:

• SQL Injection
• XSS (Cross-Site Scripting)
• CSRF (Cross-Site Request Forgery)
• Insecure dependencies
• Sensitive data exposure

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

• We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
• Avoid flagging the absence of local error handling in cases where the global error handler suffices.
• Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

• Not Required: there's a skip
  {
  variables: { templateId: templateId! },
  skip: !templateId,
  }

Check for common security vulnerabilities such as:

• SQL Injection
• XSS (Cross-Site Scripting)
• CSRF (Cross-Site Request Forgery)
• Insecure dependencies
• Sensitive data exposure

🔇 Additional comments (8)

src/domain/templates/components/Previews/CollaborationTemplatePreview.tsx (4)

7-9: Imports of new components are correctly added

The imports for InnovationFlowCalloutsPreview and its props are correctly specified.

---

18-18: Type definition for callouts is appropriate

The callouts property is correctly typed using InnovationFlowCalloutsPreviewProps['callouts'].

---

23-23: Function signature updated appropriately

The function signature for CollaborationTemplatePreview is correctly updated to match the updated props.

---

58-62: Correct integration of InnovationFlowCalloutsPreview component

The InnovationFlowCalloutsPreview component is integrated correctly with the appropriate props.

src/domain/journey/space/pages/SpaceSubspaces/AdminChallengesPage.graphql (1)

30-46: GraphQL query updated appropriately to include callouts

The callouts field is correctly added to the collaboration object with necessary subfields. The alias flowStateTagset is used appropriately.

src/domain/journey/space/pages/SpaceSubspaces/SubspaceListView.tsx (3)

40-40: Import of InnovationFlowCalloutsPreview component is correctly added

The import statement correctly brings in the InnovationFlowCalloutsPreview component.

---

230-232: Improved state toggling logic in onSelectState

The updated onSelectState function correctly toggles the selectedState when the same state is clicked again.

---

234-237: Integration of InnovationFlowCalloutsPreview component is correct

The InnovationFlowCalloutsPreview component is properly integrated with appropriate props.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1)

35-39: Consider strengthening type definitions

The props interface could benefit from stronger typing:

• selectedState could be typed as a union of possible flow state values
• callouts array could be marked as readonly to prevent accidental mutations

 export interface InnovationFlowCalloutsPreviewProps {
-  selectedState: string | undefined;
-  callouts: CalloutPreview[] | undefined;
+  selectedState: FlowState | undefined;
+  callouts: readonly CalloutPreview[] | undefined;
   loading?: boolean;
 }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61ef44d and 84b5029.

⛔ Files ignored due to path filters (1)

• src/core/apollo/generated/graphql-schema.ts is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

• We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
• Avoid flagging the absence of local error handling in cases where the global error handler suffices.
• Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

• Not Required: there's a skip
  {
  variables: { templateId: templateId! },
  skip: !templateId,
  }

Check for common security vulnerabilities such as:

• SQL Injection
• XSS (Cross-Site Scripting)
• CSRF (Cross-Site Request Forgery)
• Insecure dependencies
• Sensitive data exposure

🪛 Biome (1.9.4)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx

[error] 91-91: Avoid the use of spread (...) syntax on accumulators.

Spread syntax should be avoided on accumulators (like those in .reduce) because it causes a time complexity of O(n^2).
Consider methods such as .splice or .push instead.

(lint/performance/noAccumulatingSpread)

🔇 Additional comments (3)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (3)

41-46: LGTM! Clean styling implementation

The styled component follows MUI best practices and properly utilizes the theme system.

---

48-70: 🛠️ Refactor suggestion

Memoize the CalloutDescription component for better performance

Since this component is used within a mapping function, it should be memoized to prevent unnecessary re-renders.

-const CalloutDescription = ({ callout }: { callout: CalloutPreview }) => {
+const CalloutDescription = memo(({ callout }: { callout: CalloutPreview }) => {
   const { t } = useTranslation();
 
   switch (callout.type) {
     case CalloutType.Whiteboard:
     case CalloutType.WhiteboardCollection:
       if (callout.framing.whiteboard?.profile.preview?.uri) {
         return (
           <WhiteboardPreview
             whiteboard={callout.framing.whiteboard}
             displayName={callout.framing.profile.displayName}
           />
         );
       }
       return null;
     default:
       return callout.framing.profile.description?.trim() ? (
         <WrapperMarkdown>{callout.framing.profile.description}</WrapperMarkdown>
       ) : (
         <CaptionSmall>{t('common.noDescription')}</CaptionSmall>
       );
   }
-};
+});

---

115-115: 🛠️ Refactor suggestion

Optimize description rendering

The current implementation re-renders all descriptions when the accordion state changes. Consider moving the condition to the memo dependency.

-<AccordionDetails>{selectedCallout === callout.id && calloutDescriptions[callout.id]}</AccordionDetails>
+<AccordionDetails>{calloutDescriptions[callout.id]}</AccordionDetails>

And update the useMemo dependency:

 const calloutDescriptions = useMemo(
   // ... implementation
-  [visibleCallouts]
+  [visibleCallouts, selectedCallout]
 );

Likely invalid or redundant comment.

[hero101]

There is one previous comment that you have missed.
The rabbit has a good suggestion, we might have up to 10-15 items, which are not that many, but still it's up to you.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84b5029 and dfe128b.

📒 Files selected for processing (1)

• src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (1)

Pattern src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

• We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
• Avoid flagging the absence of local error handling in cases where the global error handler suffices.
• Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

• Not Required: there's a skip
  {
  variables: { templateId: templateId! },
  skip: !templateId,
  }

Check for common security vulnerabilities such as:

• SQL Injection
• XSS (Cross-Site Scripting)
• CSRF (Cross-Site Request Forgery)
• Insecure dependencies
• Sensitive data exposure

🔇 Additional comments (3)

src/domain/collaboration/callout/CalloutsPreview/InnovationFlowCalloutsPreview.tsx (3)

13-39: LGTM! Well-structured type definitions

The type definitions are clean, properly handle optional fields, and follow TypeScript best practices.

---

41-47: LGTM! Clean styled-component implementation

The styled component follows Material-UI patterns and properly utilizes theme variables.

---

48-70: LGTM! Properly memoized component with clean conditional rendering

The component is already memoized and handles different callout types effectively with proper fallbacks.