Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add offset shift vector check #2818

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

kmrmt
Copy link
Contributor

@kmrmt kmrmt commented Jan 29, 2025

Description

SSIA

Related Issue

Versions

  • Vald Version: v1.7.16
  • Go Version: v1.23.5
  • Rust Version: v1.83.0
  • Docker Version: v27.4.0
  • Kubernetes Version: v1.32.0
  • Helm Version: v3.16.3
  • NGT Version: v2.3.5
  • Faiss Version: v1.9.0

Checklist

Special notes for your reviewer

Summary by CodeRabbit

  • Tests

    • Enhanced internal validation by allowing flexible ordering in result comparisons.
  • Documentation

    • Removed redundant schema annotations from configuration files to streamline guidance.
  • Chores

    • Eliminated an obsolete configuration property from one schema to simplify deployment settings.

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

📝 Walkthrough

Walkthrough

This update refines vector comparison in the GetObject method by allowing three valid orderings for the returned vector. In addition, several YAML configuration files have been updated by removing schema annotation comments and an unused field, leading to a more streamlined configuration without affecting functionality or public interfaces.

Changes

File(s) Change Summary
tests/e2e/operation/stream.go Updated GetObject method: the vector comparison now checks for an exact match, a match with the first element moved to the end, or with the first two elements shifted.
charts/vald-benchmark-operator/schemas/job-values.yaml,
charts/vald-benchmark-operator/schemas/scenario-values.yaml
Removed schema comments for the target object (previously specifying required host and port fields); the structure remains unchanged.
charts/vald-benchmark-operator/values.yaml,
charts/vald-helm-operator/values.yaml
Removed schema annotations and descriptive comments for the name field while retaining the field itself.
charts/vald/schemas/mirror-target-values.yaml Removed the colocation field and its associated comment from the schema.
charts/vald/values.yaml Removed the schema description comment for the defaults object without altering its configuration.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant G as GetObject Method
    C->>G: Request object
    G->>G: Retrieve response vector (using resp.GetVector())
    G->>G: Compare received vector with expected vector
    alt Exact match or shifted match (1 or 2 elements)
        G->>C: Return object
    else No matching ordering
        G->>G: Log error "vector mismatch"
        G->>C: Return error
    end
Loading

Suggested labels

size/S, area/internal

Suggested reviewers

  • vankichi
  • hlts2

📜 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 a8b7a62 and 41b270a.

📒 Files selected for processing (6)
  • charts/vald-benchmark-operator/schemas/job-values.yaml (0 hunks)
  • charts/vald-benchmark-operator/schemas/scenario-values.yaml (0 hunks)
  • charts/vald-benchmark-operator/values.yaml (0 hunks)
  • charts/vald-helm-operator/values.yaml (0 hunks)
  • charts/vald/schemas/mirror-target-values.yaml (0 hunks)
  • charts/vald/values.yaml (0 hunks)
💤 Files with no reviewable changes (6)
  • charts/vald/schemas/mirror-target-values.yaml
  • charts/vald-benchmark-operator/values.yaml
  • charts/vald-helm-operator/values.yaml
  • charts/vald-benchmark-operator/schemas/scenario-values.yaml
  • charts/vald-benchmark-operator/schemas/job-values.yaml
  • charts/vald/values.yaml
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: runner / kubelinter for vald chart
  • GitHub Check: runner / kubelinter
  • GitHub Check: build / build
  • GitHub Check: runner / textlint
  • GitHub Check: Analyze (go)
  • GitHub Check: Cloudflare Pages

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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. (Beta)
  • @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.

@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/e2e/operation/stream.go (1)

1151-1155: LGTM! Consider enhancing the error message.

The implementation correctly handles the offset shift vector check by comparing against the original vector and its shifted variations. However, the error message could be more informative.

Consider improving the error message to indicate which variation was expected to match:

-				t.Errorf(
-					"got: %#v, expected: %#v",
-					resp.GetVector(),
-					ds.Train[idx],
-				)
+				t.Errorf(
+					"got: %#v, expected one of:\noriginal: %#v\nshift1: %#v\nshift2: %#v",
+					resp.GetVector(),
+					v,
+					append(v[1:], v[:1]...),
+					append(v[2:], v[:2]...),
+				)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3b5832 and 07d2ab8.

📒 Files selected for processing (1)
  • tests/e2e/operation/stream.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (41)
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log
  • GitHub Check: E2E test (Stream CRUD) for operator
  • GitHub Check: E2E test (Stream CRUD)
  • GitHub Check: detect-ci-container / detect
  • GitHub Check: dump-contexts-to-log

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 29, 2025
@vdaas-ci
Copy link
Collaborator

Profile Report

typevald-agent-ngtvald-lb-gatewayvald-discoverervald-manager-index
cpu
heap
other images

@vdaas-ci
Copy link
Collaborator

Profile Report

typevald-agent-ngtvald-lb-gatewayvald-discoverervald-manager-index
cpu
heap
other images

@vankichi vankichi changed the title 🐛 add offset shift vector check Add offset shift vector check Jan 30, 2025
Copy link

cloudflare-workers-and-pages bot commented Jan 31, 2025

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: cc2be82
Status: ✅  Deploy successful!
Preview URL: https://8a602b1e.vald.pages.dev
Branch Preview URL: https://bugfix-e2e-add-getobject-off.vald.pages.dev

View logs

@kmrmt kmrmt requested review from a team, vankichi and datelier and removed request for a team January 31, 2025 04:16
vankichi
vankichi previously approved these changes Jan 31, 2025
@kmrmt kmrmt force-pushed the bugfix/e2e/add-getobject-offset-check branch from 586b933 to af3119c Compare February 12, 2025 02:49
datelier
datelier previously approved these changes Feb 12, 2025
@kmrmt kmrmt force-pushed the bugfix/e2e/add-getobject-offset-check branch 2 times, most recently from 47ed14c to 5d0aa64 Compare February 12, 2025 06:29
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/e2e/operation/stream.go (1)

1153-1158: Consider enhancing the error message for better debugging.

The current error message shows the vectors but doesn't indicate which comparison failed (original or shifted). Consider making it more descriptive.

-				t.Errorf(
-					"got: %#v, expected: %#v",
-					resp.GetVector(),
-					ds.Train[idx],
-				)
+				t.Errorf(
+					"vector mismatch - got: %#v, expected one of:\noriginal: %#v\nshift-1: %#v\nshift-2: %#v",
+					resp.GetVector(),
+					v,
+					append(v[1:], v[:1]...),
+					append(v[2:], v[:2]...),
+				)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 085a838 and 5d0aa64.

📒 Files selected for processing (1)
  • tests/e2e/operation/stream.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
tests/e2e/operation/stream.go (1)

1151-1152: LGTM! Enhanced vector comparison with offset shift checks.

The implementation correctly handles vector comparison with offset shifts, improving test coverage by verifying vectors in their original form and with shifted elements.

Also applies to: 1155-1155

@kmrmt kmrmt dismissed stale reviews from datelier, coderabbitai[bot], and vankichi via dc4f8ea February 12, 2025 11:43
@kmrmt kmrmt force-pushed the bugfix/e2e/add-getobject-offset-check branch from 5d0aa64 to dc4f8ea Compare February 12, 2025 11:43
@github-actions github-actions bot added size/XL and removed size/S labels Feb 12, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 12, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🔭 Outside diff range comments (1)
hack/go.mod.default (1)

149-149: 💡 Verification agent

🧩 Analysis chain

Verify stability of master branch dependencies.

Some dependencies are pointing to master/main branches which could lead to instability:

  • github.com/google/btree -> master
  • github.com/klauspost/compress -> master

Consider pinning these to specific versions for better stability and reproducibility.

Also applies to: 195-195


🏁 Script executed:

#!/bin/bash
# Check if these repositories have recent releases that could be used instead of master
gh api repos/google/btree/releases/latest --jq .tag_name
gh api repos/klauspost/compress/releases/latest --jq .tag_name

Length of output: 287


I'll gather additional information about the available tags for github.com/google/btree to check if there are any stable version tags that could be used instead of the master branch.


🏁 Script executed:

#!/bin/bash
# List all tags for the google/btree repository
gh api repos/google/btree/tags --jq ".[].name"

Length of output: 90


Replace master branch dependencies with stable versions

  • For github.com/google/btree, while there is no "latest release" returned, the repository has stable tags available (with v1.1.3 being the most recent).
  • For github.com/klauspost/compress, the latest stable release is v1.17.11.

It is advisable to update the dependency entries in hack/go.mod.default (lines 149 and 195) to use these stable versions instead of referencing the master branch to improve reproducibility and stability.

🧹 Nitpick comments (1)
hack/go.mod.default (1)

6-331: Consider automating dependency updates.

Most dependencies are marked with "upgrade" placeholder. Consider using tools like Dependabot or Renovate to automate dependency updates and security patches.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc4f8ea and a8b7a62.

📒 Files selected for processing (10)
  • charts/vald-benchmark-operator/schemas/job-values.yaml (0 hunks)
  • charts/vald-benchmark-operator/schemas/scenario-values.yaml (0 hunks)
  • charts/vald-benchmark-operator/values.yaml (0 hunks)
  • charts/vald-helm-operator/values.yaml (0 hunks)
  • charts/vald/schemas/mirror-target-values.yaml (0 hunks)
  • charts/vald/values.yaml (0 hunks)
  • example/client/go.mod (3 hunks)
  • example/client/go.mod.default (1 hunks)
  • go.mod (8 hunks)
  • hack/go.mod.default (1 hunks)
💤 Files with no reviewable changes (6)
  • charts/vald/schemas/mirror-target-values.yaml
  • charts/vald-benchmark-operator/schemas/job-values.yaml
  • charts/vald-benchmark-operator/schemas/scenario-values.yaml
  • charts/vald-helm-operator/values.yaml
  • charts/vald-benchmark-operator/values.yaml
  • charts/vald/values.yaml
✅ Files skipped from review due to trivial changes (1)
  • example/client/go.mod.default
🚧 Files skipped from review as they are similar to previous changes (2)
  • example/client/go.mod
  • go.mod
🔇 Additional comments (4)
hack/go.mod.default (4)

16-16: LGTM: Version pinned with explanation.

The version for cloud.google.com/go/storage is correctly pinned to v1.47.0 with a reference to the issue (#11283) explaining why.


134-134: LGTM: Version pinned with explanation.

The version for github.com/goccy/go-json is correctly pinned to v0.10.3 with a reference to the issue (#529) explaining why.


332-341: LGTM: Kubernetes dependencies are properly versioned.

All Kubernetes dependencies are correctly pinned to v0.32.0, ensuring consistency across the k8s ecosystem.


3-3: Verify Go version compatibility.

The Go version has been updated to 1.24.0. Please ensure all dependencies and code are compatible with this version.

✅ Verification successful

🌐 Web query:

Is Go 1.24.0 released and stable? What are the breaking changes?

💡 Result:

Go 1.24 was officially released on February 11, 2025[1][4], and is considered stable based on its official release status and inclusion of performance improvements[1][9]. Here are the key details:

Stability & Release Status

  • Stable release: Available for download from go.dev/dl[1]
  • Maintained compatibility: Maintains Go 1 compatibility promise for existing code[9]
  • Support timeline: Supported until two subsequent major releases (likely until Go 1.26)[4]

Breaking Changes

While most changes maintain backward compatibility, these could impact existing code:

  1. Compiler Restrictions

    • Methods can no longer be defined on cgo-generated types via aliases[9]
      Example error case:
    type MyCType C.struct_original // Previously allowed via alias
    func (m *MyCType) NewMethod() {} // Now causes compiler error
  2. Linker Behavior

    • Default generation of build IDs/UUIDs on ELF/macOS platforms[9]
      This affects reproducible builds unless disabled with -B none linker flag
  3. FIPS Configuration

    • Deprecated GOFIPS=1 in favor of GODEBUG=fips140=on[5]
      Old method will be removed in Go 1.25
  4. Runtime Experiments
    New map/mutex implementations enabled by default but can be disabled via:

    GOEXPERIMENT="noswissmap,nospinbitmutex"

Notable Non-Breaking Changes

  • Performance: ~2-3% CPU overhead reduction from new map implementation and memory optimizations[1][9]
  • WebAssembly: WASI reactor support and go:wasmexport directive[1]
  • Testing: New testing.B.Loop benchmark pattern replaces manual b.N loops[1]

For most users upgrading from Go 1.23 or earlier versions, no code changes should be required unless using cgo type aliases or relying on linker build ID behavior[1][9]. Always test with go vet and check your CI/CD pipelines for reproducibility flags if needed[9].

Citations:


Go 1.24.0 is confirmed as stable and officially released.
Your module file hack/go.mod.default specifying go 1.24.0 aligns with the stable release. Notable breaking changes (e.g., restrictions on cgo alias types and certain linker behavior) are documented, so ensure your code and dependencies don’t rely on features affected by these changes.

  • Verified that Go 1.24.0 is stable as of its February 11, 2025 release.
  • No issues found directly in the module file; however, please test your full codebase for compatibility with any breaking changes.

coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 12, 2025
@kmrmt kmrmt force-pushed the bugfix/e2e/add-getobject-offset-check branch from a8b7a62 to 41b270a Compare February 12, 2025 14:25
@github-actions github-actions bot added size/S and removed size/S labels Feb 12, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 12, 2025
@kmrmt kmrmt force-pushed the bugfix/e2e/add-getobject-offset-check branch from 41b270a to 65d83a8 Compare February 13, 2025 03:17
@github-actions github-actions bot added size/S and removed size/S labels Feb 13, 2025
@github-actions github-actions bot added size/S and removed size/S labels Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants