Fix Index Length 0

[fogelito]

Summary by CodeRabbit

• Bug Fixes

  • Improved validation to prevent empty or zero values from being used as index lengths for string attributes.

• Tests

  • Added new tests to verify correct handling of zero index lengths and validation errors when index length exceeds allowed limits.
  • Updated existing tests to enhance coverage of index validation scenarios.

[coderabbitai]

Walkthrough

The changes update the logic for determining index length in the Index validator to ignore empty values, and enhance tests to cover scenarios involving zero index lengths. The test suite is expanded with a new method and constructor calls are updated to include an additional parameter.

Changes

File(s)	Change Summary
src/Database/Validator/Index.php	Modified index length determination logic to use non-empty values, changing fallback behavior for empty values.
tests/e2e/Adapter/Scopes/IndexTests.php	Added a new test for zero index length, updated constructor calls to include an extra parameter for index array support.

Sequence Diagram(s)

sequenceDiagram
    participant Test as IndexTests
    participant Adapter as DatabaseAdapter
    participant Validator as IndexValidator

    Test->>Adapter: getInternalIndexesKeys()
    Test->>Adapter: getSupportForIndexArray()
    Test->>Validator: new IndexValidator(keys, arraySupport)
    Test->>Validator: validate index with zero length
    Validator-->>Test: throws exception if invalid
    Test->>Validator: validate index with valid length
    Validator-->>Test: index created successfully
    Test->>Validator: update attribute to larger size
    Validator-->>Test: throws exception if index length exceeds maximum

Loading

Estimated code review effort

2 (10–30 minutes)

Possibly related PRs

• Validate create index array #628: Adds support for array index validation and passes the array index support flag to the Index validator constructor; both PRs modify the Index validator constructor and its validation behavior.

Suggested reviewers

• abnegate

Poem

In the warren of code, a hop and a leap,
Index lengths checked, no secrets to keep.
Zeroes now handled, exceptions in tow,
With new tests a-bounding, the coverage will grow.
🐇✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1be186 and b743f4a.

📒 Files selected for processing (2)

• src/Database/Validator/Index.php (1 hunks)
• tests/e2e/Adapter/Scopes/IndexTests.php (3 hunks)

🔇 Additional comments (3)

src/Database/Validator/Index.php (1)

199-199: Approve index length validation change

The update from the null‐coalescing operator to an !empty() check ensures that an explicit 0 length falls back to the attribute’s full size rather than being treated as a valid zero‐length index. Downstream in src/Database/Database.php, lengths equal to the attribute size are then nulled out as before, so no zero‐length index will ever be generated.

• In src/Database/Validator/Index.php (around line 199):

$indexLength = !empty($lengths[$attributePosition])
    ? $lengths[$attributePosition]
    : $attributeSize;

• In src/Database/Database.php: lengths matching attribute size are reset to null for VAR_STRING types.
• ARRAY attributes continue using ARRAY_INDEX_LENGTH (255) as before.

No further changes required.

tests/e2e/Adapter/Scopes/IndexTests.php (2)

168-169: Constructor parameter addition is correct.

The addition of getSupportForIndexArray() parameter to the Index validator constructor calls aligns with the updated constructor signature and properly passes the database adapter's array index support capability.

Also applies to: 243-244

---

301-327: Well-designed test for zero-length index behavior.

This test method effectively validates the new zero-length index handling:

1. Large attribute test (lines 310-315): Confirms that zero-length on a 1000-size attribute falls back to attribute size, exceeding max index length
2. Small attribute test (lines 318-319): Verifies zero-length works when the fallback size is within limits
3. Attribute update test (lines 321-326): Ensures existing zero-length indexes are properly validated when attributes are resized

The test logic correctly reflects the behavior change where 0 in lengths array now falls back to attribute size rather than being used literally.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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