Added feature flag for updated notifications component

[mike182uk]

refs https://linear.app/ghost/issue/AP-900

Added feature flag for updated notifications component

[coderabbitai]

Walkthrough

This pull request updates the @tryghost/admin-x-activitypub package version from 0.6.8 to 0.6.9 in the package.json file. It introduces a new feature flag, notificationsV2, in the FEATURE_FLAGS array within the feature flags file, and updates the corresponding type definition. A new React component named NotificationsV2 is added, which renders a placeholder message wrapped in a layout component. Additionally, the default export of the Notifications view has been updated to conditionally render either NotificationsV1 or NotificationsV2 based on the state of the new feature flag.

Possibly related PRs

• Added ActivityPub soft feature flags #22361: Modifies the FEATURE_FLAGS array to handle feature flag changes, directly relating to the introduction of notificationsV2.
• Updated ActivityPub client app to not render when flag is off #22481: Adjusts component rendering logic by leveraging feature flags, similar to the conditional rendering implemented in this PR.
• Bumped @tryghost/admin-x-activitypub to 0.6.5 #22531: Updates the version of the @tryghost/admin-x-activitypub package, aligning with the version increment from 0.6.8 to 0.6.9.

Suggested labels

deploy-to-staging

Suggested reviewers

• peterzimon

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/admin-x-activitypub/src/lib/feature-flags.tsx

Oops! Something went wrong! :(

ESLint: 8.44.0

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/admin-x-activitypub".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/admin-x-activitypub/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

apps/admin-x-activitypub/src/views/Notifications/NotificationsV2.tsx

Oops! Something went wrong! :(

ESLint: 8.44.0

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/admin-x-activitypub".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/admin-x-activitypub/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

apps/admin-x-activitypub/src/views/Notifications/index.tsx

Oops! Something went wrong! :(

ESLint: 8.44.0

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/admin-x-activitypub".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/admin-x-activitypub/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e71ea94 and efbbb8f.

📒 Files selected for processing (4)

• apps/admin-x-activitypub/package.json (1 hunks)
• apps/admin-x-activitypub/src/lib/feature-flags.tsx (1 hunks)
• apps/admin-x-activitypub/src/views/Notifications/NotificationsV2.tsx (1 hunks)
• apps/admin-x-activitypub/src/views/Notifications/index.tsx (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

apps/admin-x-activitypub/src/views/Notifications/index.tsx (1)

apps/admin-x-activitypub/src/lib/feature-flags.tsx (1)

• useFeatureFlags (86-92)

🔇 Additional comments (5)

apps/admin-x-activitypub/src/lib/feature-flags.tsx (1)

5-7: Feature flag added correctly

The notificationsV2 feature flag has been properly added to the FEATURE_FLAGS array. This enables controlled rollout of the new notifications component.

apps/admin-x-activitypub/package.json (1)

3-3: Version bump is appropriate

The version bump from 0.6.8 to 0.6.9 follows semantic versioning principles for adding new functionality in a backward-compatible manner.

apps/admin-x-activitypub/src/views/Notifications/NotificationsV2.tsx (1)

5-13: Placeholder component implemented appropriately

The placeholder component is correctly implemented as a simple functional component with a placeholder message. This matches the PR's purpose of setting up a feature flag rather than implementing the full feature.

apps/admin-x-activitypub/src/views/Notifications/index.tsx (2)

1-10: Feature flag toggle implemented correctly

The implementation correctly uses the useFeatureFlags hook to conditionally render either the V1 or V2 component based on the feature flag status.

---

3-3:

Details

✅ Verification successful

Verify import path to prevent circular dependency

There might be a circular dependency issue with importing NotificationsV1 from './Notifications'. If this file is named index.tsx, then './Notifications' would refer back to this same file.

---

🏁 Script executed:

#!/bin/bash
# Check for the existence of a separate Notifications.tsx file

echo "Checking directory structure:"
ls -la apps/admin-x-activitypub/src/views/Notifications/

echo -e "\nChecking import references:"
grep -r "NotificationsV1" --include="*.tsx" --include="*.ts" apps/admin-x-activitypub/src/

Length of output: 851

---

Circular Dependency Check Passed

• The import statement in apps/admin-x-activitypub/src/views/Notifications/index.tsx (import NotificationsV1 from './Notifications';) correctly resolves to the separate Notifications.tsx file in the same directory.
• There is no circular dependency since the path does not point back to index.tsx.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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.