🐛 Fixed missing enable_comment_notifications property in member serializer #23146

dunknicoll · 2025-05-01T19:58:31Z

The enable_comment_notifications field isn't currently included in the serializeMember function of the members output serializer. This prevents automations from being able to utilise this value.

This small change adds in that field (as well as adding it in the SerializedMember type definition) which enables it to be available in the webhook payload which in turns allows automations to utilise it.

I don't forsee any particular unwanted side-effects as the field is non-nullable in the database and therefore always present but I welcome more thoughts on this.

I've added a small test to demonstrate the property is included as expected in the read response but I'd like to add more as I explore further into the codebase.

I've read and followed the Contributor Guide
I've explained my change
I've written an automated test to prove my change works

…lizer closes TryGhost#22858 By adding in the `enable_comment_notifications` property into both the `serializeMember` function and the SerializedMember type definition, this enables it to be correctly be presented in the webhook payload.

coderabbitai · 2025-05-01T19:58:38Z

Walkthrough

The changes introduce a new boolean property, enable_comment_notifications, to the serialized member output in the server-side serialization logic. This property is extracted from the member's JSON data and included in the object returned by the serializeMember function. The SerializedMember typedef is updated to reflect this new property. Corresponding unit tests are added to verify that the serialized output includes the enable_comment_notifications flag when appropriate. Additionally, a new factory function is implemented in the test data generator to facilitate the creation of member objects with comment notifications enabled, supporting the new test case.

Assessment against linked issues

Objective	Addressed	Explanation
Include comment notification preference (`enable_comment_notifications`) in the serialized member output for webhooks (e.g., `members.updated`) (#22858)	✅
Update serialization typedefs and test coverage for the new property (#22858)	✅
Provide test data generation utility for members with comment notifications enabled (#22858)	✅

📜 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 1ec2509 and f236343.

📒 Files selected for processing (3)

ghost/core/core/server/api/endpoints/utils/serializers/output/members.js (2 hunks)
ghost/core/test/unit/api/canary/utils/serializers/output/members.test.js (1 hunks)
ghost/core/test/utils/fixtures/data-generator.js (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

ghost/core/test/utils/fixtures/data-generator.js (2)

ghost/core/test/utils/fixture-utils.js (2)

_ (2-2)

ObjectId (6-6)

ghost/core/core/server/models/user.js (1)

ObjectId (2-2)

🔇 Additional comments (4)

ghost/core/test/utils/fixtures/data-generator.js (1)

1251-1259: Good implementation of the member factory function.

The new createMemberWithCommentNotificationsEnabled function follows the established pattern of other factory functions in this file, properly cloning the input and setting appropriate default values including the enable_comment_notifications flag.

ghost/core/test/unit/api/canary/utils/serializers/output/members.test.js (1)

80-92: Thorough test implementation.

The test case correctly verifies both the existence and value of the enable_comment_notifications property in the serialized output. This is a good practice as it ensures not only that the property is included but also that it's correctly set to true.

ghost/core/core/server/api/endpoints/utils/serializers/output/members.js (2)

171-171: Correctly added the property to member serialization.

Adding the enable_comment_notifications flag to the serialized member object ensures it will be available in the API response, which addresses the issue described in the PR.

256-256: Good documentation update.

The JSDoc typedef has been properly updated to include the new property, maintaining good API documentation practices.

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Merge branch 'main' into fix/22858-member-webhook-comment-settings

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.

GPG key ID: B5690EEEBB952194

Verified
Learn about vigilant mode

Loading
Loading status checks…

461b525

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

Uh oh!

🐛 Fixed missing enable_comment_notifications property in member serializer #23146

🐛 Fixed missing enable_comment_notifications property in member serializer #23146

dunknicoll commented May 1, 2025

Uh oh!

coderabbitai bot commented May 1, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

🐛 Fixed missing enable_comment_notifications property in member serializer #23146

Are you sure you want to change the base?

🐛 Fixed missing enable_comment_notifications property in member serializer #23146

Conversation

dunknicoll commented May 1, 2025

Uh oh!

Uh oh!

coderabbitai bot commented May 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Assessment against linked issues

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

coderabbitai bot commented May 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)