Skip to content

Updated ActivityPub client app to not render when flag is off#22481

Merged
sagzy merged 1 commit intomainfrom
not-render-app-when-flag-is-off-3
Mar 13, 2025
Merged

Updated ActivityPub client app to not render when flag is off#22481
sagzy merged 1 commit intomainfrom
not-render-app-when-flag-is-off-3

Conversation

@sagzy
Copy link
Contributor

@sagzy sagzy commented Mar 13, 2025

ref https://linear.app/ghost/issue/AP-836

  • if the ActivityPub feature flag is off, the client app should not render anything
  • this PR does not include Ghost Admin changes, to make sure we can ship @tryghost/admin-x-activitypub changes independently without breaking current behaviour

ref https://linear.app/ghost/issue/AP-836

if the ActivityPub feature flag is off, the client app should not render anything
this PR does not include Ghost Admin changes, to make sure we can ship @tryghost/admin-x-activitypub changes independently without breaking current behaviour
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 13, 2025

Walkthrough

This pull request makes two primary changes. First, it updates the package version in the package.json file from 0.5.7 to 0.5.8, representing a minor release update. Second, it adds an optional property activityPubEnabled to the App component’s interface and modifies the component’s rendering logic. Now, when activityPubEnabled is explicitly set to false, the component returns null instead of rendering its usual content. These changes affect the handling and toggling of ActivityPub functionality within the admin application.

Possibly related PRs

Suggested labels

deploy-to-staging

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

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 53d19de and c01ac8a.

📒 Files selected for processing (2)
  • apps/admin-x-activitypub/package.json (1 hunks)
  • apps/admin-x-activitypub/src/App.tsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Unit tests (Node 22.13.1)
  • GitHub Check: Unit tests (Node 20.11.1)
  • GitHub Check: Unit tests (Node 18.12.1)
🔇 Additional comments (3)
apps/admin-x-activitypub/src/App.tsx (2)

10-10: Good addition of the optional flag.

The optional activityPubEnabled property is a clean way to implement the feature flag control.


13-16: Well-implemented conditional rendering.

The conditional logic to return null when activityPubEnabled is explicitly false aligns perfectly with the PR objective to not render when the flag is off. Using strict equality (===) ensures that only explicit false values trigger the non-rendering behavior, while undefined values (for backward compatibility) will allow the component to render.

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

3-3: Appropriate version increment.

The version bump from 0.5.7 to 0.5.8 follows semantic versioning principles, correctly reflecting a minor enhancement that adds functionality without breaking backward compatibility.

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

@sagzy sagzy enabled auto-merge (squash) March 13, 2025 11:12
@sagzy sagzy merged commit eb1fc54 into main Mar 13, 2025
22 checks passed
@sagzy sagzy deleted the not-render-app-when-flag-is-off-3 branch March 13, 2025 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant