Skip to content

Feat expose sequence#9870

Merged
abnegate merged 8 commits into1.8.xfrom
feat-expose-sequence
May 27, 2025
Merged

Feat expose sequence#9870
abnegate merged 8 commits into1.8.xfrom
feat-expose-sequence

Conversation

@abnegate
Copy link
Copy Markdown
Member

@abnegate abnegate commented May 23, 2025 •
edited by coderabbitai bot
Loading

What does this PR do?

(Provide a description of what this PR does and why it's needed.)

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?

Summary by CodeRabbit

  • New Features

    • Introduced a new $sequence field to documents, providing an automatically incrementing ID visible in document responses.

  • Tests

    • Updated tests to verify the presence of the new $sequence field in all relevant document operations and responses.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 23, 2025 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (3)
  • main
  • 1.6.x
  • 1.7.x

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new integer attribute $sequence was added to the Document model, including its rule definition and default value. The filter logic was updated to retain $sequence in document responses. Corresponding end-to-end database tests were updated to expect the presence of the $sequence field in document outputs and assertions.

Changes

File(s) Change Summary
src/Appwrite/Utopia/Response/Model/Document.php Added $sequence attribute rule to the Document model; updated filter logic to retain $sequence in filtered document responses.
tests/e2e/Services/Databases/DatabasesBase.php Updated test assertions to expect presence of $sequence in document bodies across create, list, get, and relationship test methods.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant DocumentModel

    Client->>API: Create/List/Get Document
    API->>DocumentModel: Construct/Filter Document
    DocumentModel-->>API: Document with $sequence attribute
    API-->>Client: Response includes $sequence
Loading

Poem

A hop, a skip, a sequence anew,
Now every document counts as it grew.
Tests now cheer, their checks in place,
For $sequence appears in every case.
With numbers that climb, and code that’s neat—
The database march is now complete!
🐇✨

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

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.

@github-actions
Copy link
Copy Markdown

github-actions bot commented May 23, 2025 •
edited
Loading

Security Scan Results for PR

Docker Image Scan Results

Package Version Vulnerability Severity
binutils 2.42-r0 CVE-2025-0840 HIGH
libexpat 2.6.4-r0 CVE-2024-8176 HIGH
libxml2 2.12.7-r0 CVE-2024-56171 HIGH
libxml2 2.12.7-r0 CVE-2025-24928 HIGH
libxml2 2.12.7-r0 CVE-2025-27113 HIGH
libxml2 2.12.7-r0 CVE-2025-32414 HIGH
libxml2 2.12.7-r0 CVE-2025-32415 HIGH
sqlite-libs 3.45.3-r1 CVE-2025-29087 HIGH
xz 5.6.2-r0 CVE-2025-31115 HIGH
xz-libs 5.6.2-r0 CVE-2025-31115 HIGH
golang.org/x/crypto v0.31.0 CVE-2025-22869 HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

@github-actions
Copy link
Copy Markdown

github-actions bot commented May 23, 2025 •
edited
Loading

✨ Benchmark results

  • Requests per second: 932
  • Requests with 200 status code: 167,877
  • P99 latency: 0.20679448

⚡ Benchmark Comparison

Metric This PR Latest version
RPS 932 1,183
200 167,877 213,008
P99 0.20679448 0.159165492

@abnegate abnegate changed the base branch from main to 1.8.x May 27, 2025 01:27
@abnegate abnegate merged commit 4ffa89f into 1.8.x May 27, 2025
38 checks passed
@abnegate abnegate deleted the feat-expose-sequence branch May 27, 2025 02:40
@coderabbitai coderabbitai bot mentioned this pull request Jun 11, 2025
Merged
2 tasks
This was referenced Jul 4, 2025
Closed
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jul 29, 2025
Merged
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Aug 27, 2025
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@abnegate @ArnabChatterjee20k