Add analytics properties when setting pref church (KIDS-1465)

[MaikelStuivenberg]

Summary by CodeRabbit

• New Features

  • Enhanced analytics tracking for church selection by adding contextual parameters.
  • Updated logic to ensure correct identifiers are used when setting the preferred church.

• Bug Fixes

  • Maintained user notifications for success and error outcomes through dialogs.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the PreferredChurchSelectionPage class within the preferred_church_selection_page.dart file. Key updates include the addition of new parameters for analytics tracking in the floatingActionButton widget and adjustments to the onTapConfirm method to correctly retrieve and use the churchId for setting the preferred church. These updates aim to enhance the analytics capabilities related to church selection.

Changes

File	Change Summary
lib/features/family/features/preferred_church/preferred_church_selection_page.dart	Added 'namespace' and 'name' parameters to AnalyticsEvent constructor; updated onTapConfirm method to use churchId from nameSpace.

Assessment against linked issues

Objective	Addressed	Explanation
Include church in Amplitude tracking when setting your preferred church (KIDS-1465)	✅

Possibly related PRs

• Feature: Create preferred church success modal (KIDS-1448) #1100: The addition of the preferredChurchSuccessDialogDone event in the AmplitudeEvents enum relates to the analytics tracking enhancements in the main PR, which also focuses on improving analytics for church selection.
• Feature: Select preferred church from a list (KIDS-1447) #1103: The new enum values added for tracking user interactions during the church selection process directly connect to the changes made in the main PR, which also enhances analytics related to church selection.
• Feature: Show preferred church in gratitude game (kids-1449) #1105: The invocation of the setPreferredChurchModalShown() method in the ProfilesCubit is relevant as it ties into the overall flow of managing the preferred church selection, which is a focus of the main PR.

Suggested labels

enhancement

Suggested reviewers

• Daniela510
• TammiLion

Poem

In a church so bright, we make our choice,
With analytics guiding, we rejoice!
Names and namespaces, all in a row,
Setting preferences, watch our love grow.
A tap, a click, the church we embrace,
In the heart of our community, we find our place! 🐇✨

---

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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)

lib/features/family/features/preferred_church/preferred_church_selection_page.dart (2)

124-128: LGTM! Consider adding a safety check for selectedIndex.

The addition of 'namespace' and 'name' parameters to the AnalyticsEvent aligns well with the PR objectives to enhance analytics tracking for preferred church selection. This change will provide valuable insights into user preferences.

For added robustness, consider adding a safety check for selectedIndex before accessing bloc.state.filteredOrganisations[selectedIndex]. Although the button should be disabled when no church is selected, it's a good practice to prevent potential index out of range errors. You could use the null-aware operator:

parameters: selectedIndex != -1
    ? {
        'namespace': bloc.state.filteredOrganisations[selectedIndex].nameSpace,
        'name': bloc.state.filteredOrganisations[selectedIndex].orgName,
      }
    : null,

This ensures that even if the button is accidentally enabled when it shouldn't be, the app won't crash.

---

Line range hint 136-138: LGTM! Consider extracting the selected organization to improve readability.

The changes correctly retrieve the churchId from the nameSpace property of the selected organization, which aligns with the PR objectives. This ensures that the correct identifier is used when setting the preferred church.

To improve code readability and reduce repetition, consider extracting the selected organization into a variable:

final selectedOrganization = bloc.state.filteredOrganisations[selectedIndex];
final churchId = selectedOrganization.nameSpace;
final success = await widget.setPreferredChurch(churchId);

if (success) {
  await showPreferredChurchSuccessDialog(
    context,
    selectedOrganization.orgName,
    onTap: () => Navigator.of(context)
      ..pop()
      ..pop(),
  );
}

This change would make the code more concise and easier to maintain.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d0767a7 and 3d00429.

📒 Files selected for processing (1)

• lib/features/family/features/preferred_church/preferred_church_selection_page.dart (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

lib/features/family/features/preferred_church/preferred_church_selection_page.dart (1)

Line range hint 1-190: Overall implementation looks good. Verify analytics event firing.

The changes successfully implement the addition of analytics properties when setting a preferred church, aligning well with the PR objectives. The code is well-structured and achieves the desired outcome.

To ensure the analytics event is firing correctly, please run the following verification script:

This script will help verify that the analytics event is correctly implemented and that no other conflicting or redundant events are present.