chore: mark Row response model's param with readonly by ChiragAgg5k · Pull Request #10409 · appwrite/appwrite

ChiragAgg5k · 2025-08-30T05:58:16Z

What does this PR do?

same behaviour as Document

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.)

Related PRs and Issues

(Related PR or issue)

Checklist

Have you read the Contributing Guidelines on issues?
If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

coderabbitai · 2025-08-30T05:58:22Z

📝 Walkthrough

Walkthrough

The change updates the Row model constructor (src/Appwrite/Utopia/Response/Model/Row.php) by adding readOnly => true to three field rules: $sequence (auto-incrementing ID), $tableId (Table ID), and $databaseId (Database ID). No other logic or files are modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

chore: add readonly param to sequence, databaseId and collectionId #10278 — Also modifies model field metadata to mark identifiers as readOnly across models and generators, aligning with this Row model update.

Suggested reviewers

abnegate

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.

🔧 PHPStan (2.1.17)

Note: Using configuration file /phpstan.neon.
Invalid entry in excludePaths:
Path "/app/sdks" is neither a directory, nor a file path, nor a fnmatch pattern.

If the excluded path can sometimes exist, append (?)
to its config entry to mark it as optional. Example:

parameters:
excludePaths:
analyseAndScan:
- app/sdks (?)

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch update-readonly-params

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.
- 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.
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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore or @coderabbit 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.

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Appwrite/Utopia/Response/Model/Row.php (2)
60-71: Consider marking timestamps as read-only for consistency

$createdAt and $updatedAt are server-managed; marking them read-only matches typical Document behavior and avoids client-side confusion.
             ->addRule('$createdAt', [
                 'type' => self::TYPE_DATETIME,
                 'description' => 'Row creation date in ISO 8601 format.',
                 'default' => '',
                 'example' => self::TYPE_DATETIME_EXAMPLE,
+                'readOnly' => true,
             ])
             ->addRule('$updatedAt', [
                 'type' => self::TYPE_DATETIME,
                 'description' => 'Row update date in ISO 8601 format.',
                 'default' => '',
                 'example' => self::TYPE_DATETIME_EXAMPLE,
+                'readOnly' => true,
             ])
33-38: Confirm intent for $id mutability

Document allows client-provided $id on create; should Row behave the same? If not, consider marking $id as read-only for parity with server-generated IDs here.

Happy to follow up with a small patch once you confirm the intended behavior.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between c7bbb6a and 73f5823.

⛔ Files ignored due to path filters (12)

app/config/specs/open-api3-1.8.x-client.json is excluded by !app/config/specs/**
app/config/specs/open-api3-1.8.x-console.json is excluded by !app/config/specs/**
app/config/specs/open-api3-1.8.x-server.json is excluded by !app/config/specs/**
app/config/specs/open-api3-latest-client.json is excluded by !app/config/specs/**
app/config/specs/open-api3-latest-console.json is excluded by !app/config/specs/**
app/config/specs/open-api3-latest-server.json is excluded by !app/config/specs/**
app/config/specs/swagger2-1.8.x-client.json is excluded by !app/config/specs/**
app/config/specs/swagger2-1.8.x-console.json is excluded by !app/config/specs/**
app/config/specs/swagger2-1.8.x-server.json is excluded by !app/config/specs/**
app/config/specs/swagger2-latest-client.json is excluded by !app/config/specs/**
app/config/specs/swagger2-latest-console.json is excluded by !app/config/specs/**
app/config/specs/swagger2-latest-server.json is excluded by !app/config/specs/**

📒 Files selected for processing (1)

src/Appwrite/Utopia/Response/Model/Row.php (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

src/Appwrite/Utopia/Response/Model/Row.php (1)

src/Appwrite/Utopia/Response/Model.php (1)

addRule (87-99)

🔇 Additional comments (3)

src/Appwrite/Utopia/Response/Model/Row.php (3)

44-45: Good: $sequence marked read-only

Correct for an auto-incremented field; prevents client writes and matches filter() casting.

Please regenerate the API spec/SDKs to ensure $sequence is excluded from create/update inputs.

51-52: Good: $tableId marked read-only

Consistent with path-param semantics and Document model behavior.

58-59: Good: $databaseId marked read-only

Also aligns with path-param semantics and Document model behavior.

github-actions · 2025-08-30T06:01:30Z

Security Scan Results for PR

Docker Image Scan Results

Package	Version	Vulnerability	Severity
golang.org/x/crypto	v0.31.0	CVE-2025-22869	HIGH
golang.org/x/oauth2	v0.24.0	CVE-2025-22868	HIGH
stdlib	1.22.10	CVE-2025-47907	HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

pkg-pr-new · 2025-08-30T06:01:34Z

Open in StackBlitz

npm i https://pkg.pr.new/appwrite/appwrite/@appwrite.io/console@10409

commit: 73f5823

github-actions · 2025-08-30T06:09:51Z

✨ Benchmark results

Requests per second: 1,213
Requests with 200 status code: 218,354
P99 latency: 0.161387919

⚡ Benchmark Comparison

Metric	This PR	Latest version
RPS	1,213	990
200	218,354	178,200
P99	0.161387919	0.197926068

chore: mark Row response model's param with readonly

73f5823

coderabbitai bot reviewed Aug 30, 2025

View reviewed changes

ItzNotABug approved these changes Aug 30, 2025

View reviewed changes

abnegate approved these changes Sep 1, 2025

View reviewed changes

abnegate merged commit 7b7e991 into 1.8.x Sep 1, 2025
73 of 74 checks passed

abnegate deleted the update-readonly-params branch September 1, 2025 08:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: mark Row response model's param with readonly#10409

chore: mark Row response model's param with readonly#10409
abnegate merged 1 commit into1.8.xfrom
update-readonly-params

ChiragAgg5k commented Aug 30, 2025

Uh oh!

coderabbitai bot commented Aug 30, 2025 •

edited

Loading

Walkthrough

Estimated code review effort

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

Status, Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

github-actions bot commented Aug 30, 2025

Uh oh!

pkg-pr-new bot commented Aug 30, 2025

Uh oh!

github-actions bot commented Aug 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

ChiragAgg5k commented Aug 30, 2025

What does this PR do?

Test Plan

Related PRs and Issues

Checklist

Uh oh!

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

Uh oh!

Walkthrough

Estimated code review effort

Possibly related PRs

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

Status, Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 30, 2025

Security Scan Results for PR

Docker Image Scan Results

Source Code Scan Results

Uh oh!

pkg-pr-new bot commented Aug 30, 2025

Uh oh!

github-actions bot commented Aug 30, 2025

✨ Benchmark results

⚡ Benchmark Comparison

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai bot commented Aug 30, 2025 •

edited

Loading