Implemented account profile update #535

mike182uk · 2025-04-16T12:06:40Z

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

Implemented the logic needed for updating an account's profile data via the API

ref https://linear.app/ghost/issue/AP-1076 Implemented the logic needed for updating an account's profile data via the API

coderabbitai · 2025-04-16T12:06:47Z

"""

Walkthrough

This set of changes enhances the account profile update functionality across multiple layers of the codebase. The Account entity is refactored to encapsulate the username property, making it mutable via the updateProfile method and accessible through a getter. The ProfileUpdateParams interface now optionally includes username. The KnexAccountRepository's save method is updated to persist changes to the username field. The AccountService class introduces a new updateAccountProfile method, which updates the account only if the provided data differs from the current state, including checks for all profile fields. The HTTP API handler for account updates now invokes this service method, completing the previously unimplemented update logic. The test suites for both the entity and service are expanded or added to verify correct handling of the username and ensure updates occur only when necessary. Corresponding feature and step definition files are updated for clearer, more granular behavior-driven tests. Additionally, internal logic in dispatcher functions is simplified by removing early returns based on handle values.

Possibly related PRs

Migrating modification of Accounts to Entity layer #527: The main PR extends the account profile update functionality by adding username support and refining update handling, building directly upon the foundational entity-layer profile update method and encapsulation introduced in the retrieved PR.
Added endpoint for updating an account information #524: The main PR refactors and extends the existing account update feature and step definitions with more detailed verification and adds full implementation including username updates, while the retrieved PR introduces the initial account update endpoint and basic step definitions without the detailed verification or username handling; thus, the main PR builds directly upon and relates to the changes introduced in the retrieved PR.

Suggested reviewers

vershwal
"""

📜 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 7e601d3 and dc5de38.

📒 Files selected for processing (2)

src/dispatchers.ts (0 hunks)
src/dispatchers.unit.test.ts (0 hunks)

💤 Files with no reviewable changes (2)

src/dispatchers.unit.test.ts
src/dispatchers.ts

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

mike182uk · 2025-04-16T12:30:40Z

features/step_definitions/stepdefs.js

 });

 Then('the request is accepted with a {int}', function (statusCode) {
-    assert(this.response.ok);


I removed this as its not helpful, the assertion below is more useful

allouis

Nice, great tests

allouis · 2025-04-16T13:49:48Z

src/dispatchers.ts

        ctx: Context<ContextData>,
        handle: string,
    ) {
-        if (handle !== ACTOR_DEFAULT_HANDLE) return [];


Should we do this for the Actor dispatcher too?

Sure, updated in dc5de38

ref https://linear.app/ghost/issue/AP-1076 Implemented the logic needed for updating an account's profile data via the API

Implemented account profile update

7c5d95f

ref https://linear.app/ghost/issue/AP-1076 Implemented the logic needed for updating an account's profile data via the API

mike182uk temporarily deployed to staging April 16, 2025 12:07 — with GitHub Actions Inactive

mike182uk commented Apr 16, 2025

View reviewed changes

vershwal approved these changes Apr 16, 2025

View reviewed changes

allouis reviewed Apr 16, 2025

View reviewed changes

Handled empty image values

77d7ad5

mike182uk temporarily deployed to build April 16, 2025 15:25 — with GitHub Actions Inactive

mike182uk had a problem deploying to build April 16, 2025 15:26 — with GitHub Actions Failure

Remove index check from actor dispatcher

dc5de38

mike182uk force-pushed the mike-ap-1076 branch from 7e601d3 to dc5de38 Compare April 16, 2025 15:34

mike182uk temporarily deployed to build April 16, 2025 15:34 — with GitHub Actions Inactive

mike182uk temporarily deployed to staging April 16, 2025 15:41 — with GitHub Actions Inactive

mike182uk merged commit 9dfc6de into main Apr 16, 2025
7 checks passed

mike182uk deleted the mike-ap-1076 branch April 16, 2025 15:44

vershwal pushed a commit that referenced this pull request Apr 16, 2025

Implemented account profile update (#535)

5dfdff8

ref https://linear.app/ghost/issue/AP-1076 Implemented the logic needed for updating an account's profile data via the API

coderabbitai bot mentioned this pull request Apr 24, 2025

Refactored Account to improve types & reduce boilerplate #566

Merged

coderabbitai bot mentioned this pull request Jun 9, 2025

Moved AccountUpdatedEvent into Entity #802

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implemented account profile update #535

Implemented account profile update #535

Uh oh!

mike182uk commented Apr 16, 2025

Uh oh!

coderabbitai bot commented Apr 16, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

mike182uk Apr 16, 2025

Uh oh!

allouis left a comment

Uh oh!

allouis Apr 16, 2025

Uh oh!

mike182uk Apr 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Implemented account profile update #535

Implemented account profile update #535

Uh oh!

Conversation

mike182uk commented Apr 16, 2025

Uh oh!

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

Uh oh!

Walkthrough

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

mike182uk Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

allouis left a comment

Choose a reason for hiding this comment

Uh oh!

allouis Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

mike182uk Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai bot commented Apr 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)