Added endpoint for updating an account information#524
Merged
Conversation
## Walkthrough
This change introduces the ability to update account information via a new HTTP PUT endpoint at `/.ghost/activitypub/account`. The update functionality is restricted to users with Owner or Administrator roles. The implementation includes a new handler function, `createUpdateAccountHandler`, which validates the incoming request body against a JSON schema defined with the `zod` library. The required fields for an account update are `name`, `bio`, `username`, `avatarUrl`, and `bannerImageUrl`. If validation fails, the handler responds with a 400 status code; if the account is not found, it returns a 404. The actual update logic is not yet implemented and marked as a TODO. Additionally, a feature test scenario is added to verify the update functionality, and the step definitions for authenticated requests are enhanced to support sending JSON data in POST or PUT requests.
## Possibly related PRs
- TryGhost/ActivityPub#427: The main PR adds a new PUT route for updating account information with role checks for Owner and Administrator, while the retrieved PR modifies the `requireRole` middleware to accept multiple roles including Owner and Administrator for broader authorization; thus, the main PR builds upon the role-checking enhancement introduced in the retrieved PR.
## Suggested reviewers
- allouisTip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
features/account-update.feature(1 hunks)features/step_definitions/stepdefs.js(2 hunks)src/app.ts(2 hunks)src/http/api/account.ts(3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/app.ts (2)
src/instrumentation.ts (1)
spanWrapper(48-60)src/http/api/account.ts (1)
createUpdateAccountHandler(377-399)
🔇 Additional comments (7)
features/account-update.feature (1)
1-14: LGTM: Feature test is well-structured and clear.The feature test appropriately describes a scenario for updating account information with all necessary fields (name, bio, username, avatarUrl, bannerImageUrl) and verifies a successful response.
src/app.ts (2)
112-112: LGTM: Import is correctly added.The import for
createUpdateAccountHandleris appropriately added to the existing list of imports.
967-971: LGTM: Route configuration is correctly implemented.The new PUT route for updating account information is properly configured:
- Correct endpoint path:
/.ghost/activitypub/account- Appropriate role authorization (Owner or Administrator)
- Properly wrapped with
spanWrapperfor instrumentationThis matches the pattern used by other API routes in the application.
src/http/api/account.ts (2)
10-10: LGTM: Zod import added for schema validation.The import of the
zodlibrary is correctly added for schema validation.
21-27: LGTM: Well-defined schema for account updates.The
UpdateAccountSchemaproperly defines the required fields for account updates with appropriate types.features/step_definitions/stepdefs.js (2)
648-649: LGTM: Step pattern correctly updated to handle data payload.The step definition pattern has been properly updated to optionally capture data for the request.
673-688: LGTM: Request options properly constructed with data handling.The implementation correctly:
- Creates a proper options object with method and headers
- Adds Content-Type header and stringifies the JSON body when data is provided
- Passes the options to fetchActivityPub
This enables the feature test to send JSON data with authenticated requests.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ref https://linear.app/ghost/issue/AP-1076/