mirror of
https://github.com/milvus-io/milvus.git
synced 2026-07-21 02:05:41 +00:00
issue: #47420 ## What this PR does Project-wide migration of raw `fmt.Errorf` / `errors.New` in function bodies onto the `merr` framework, plus the Sys-vs-Input error classification and the machinery it drives (retriability, fine-grained metrics, segcore unification), plus the convention docs and a linter that keeps it from regressing. Scope: storage, proxy, coordinators (root/data/query), query node, data node, `pkg/util` & `internal/util`, expression parser, message queue, streaming, and misc packages. Bare raw-error usages went from ~3000 to a ~340 allowlist (package-level sentinels / build-tag / test sites). --- ## How to review this PR It is large but the vast majority is mechanical. Changes fall into three tiers; spend review budget on Part 2 and Part 3. ### Part 1 — Mechanical standardization (low risk, verify by rule) Each converted call follows one of a small fixed set of rules. To review, check that each site obeys the matching rule rather than reading every line: | Pattern | Rule | |---|---| | `fmt.Errorf("...")` originating a new error | → `merr.WrapErrXxxMsg("...")` with a code matching the failure's meaning | | Adding context to an existing typed error | → `merr.Wrap(err, "...")` / `merr.Wrapf(...)` — **preserves** the inner code (never `WrapErr*Err`, which overwrites it) | | Errors inside the streaming subsystem | → `status.New*` factories (StreamingError), **not** merr — this is the component-internal dialect (see `docs/dev/error_handling_guide.md`) | | Low-level / control-flow signal caught by `errors.Is` | → kept as a package-level `errors.New` sentinel (lowercase, same-package) | Conventions are documented in `docs/dev/error_handling_guide.md` (how-to) and `docs/dev/error_sentinel_convention.md` (rules + audit). A `gocritic`/`ruleguard` rule (`rawmerrerror`, in `rules.go`) enforces "no raw `return errors.New/fmt.Errorf`" under `make verifiers`. ### Part 2 — Behavior changes (review these closely) These are the sites where the wire contract or runtime behavior changes, not just the source text. Listed by category; representative locations given, full set in the diff. **A. gRPC wire-code shifts: `UnexpectedError(1)/Code 65535` → typed code.** Where a handler previously returned a raw error (collapsed to `Code=65535` on the wire), it now returns a typed merr, so the client sees a real code. The most common shift is to `IllegalArgument(5)/Code 1100` (ParameterInvalid). Touch points include datanode task handlers (CreateTask/Query/Drop), proxy Upsert, querynode GetMetrics, datacoord CreateIndex, httpserver query-response builder, and typeutil schema validation. One code refinement: an index-param validation moved `1100` → `1101` (ParameterMissing). **Client/SDK assertions and any code that switched on `Code=65535` for these paths must be re-checked** (the go_client e2e assertions were already aligned in this PR). **B. Prometheus `status` label contract change (externally visible).** The proxy metric's coarse `fail` / `rejected` values are split into `fail_input` / `fail_system` and `rejected_user` / `rejected_system` (in `requestutil.ParseMetricLabel`; auth/privilege rejections count as `rejected_user`), so dashboards can attribute a failure to caller vs operator. **Dashboards/alerts querying `status="fail"` must migrate to `status=~"fail_.*"`, and `status="rejected"` to `status=~"rejected_.*"`.** The in-repo Grafana dashboard is already migrated; external dashboards built on the old values silently go empty after upgrade. This is the one change that requires an ops-side migration. **C. Retriability semantics.** - C1: `merr.Status(err)` now forces `Retriable=false` when the error is an `InputError` — a malformed request can never succeed on blind retry, so clients never get the self-contradictory "your input is wrong but you may retry". - C2: `retry.Do` short-circuits an `InputError` (non-retriable) — **but only when the caller did not pass a `RetryErr` predicate**. The check is an `if c.isRetryErr != nil { ... } else if InputError { ... }` *mutually exclusive* branch (`pkg/util/retry/retry.go`): an explicit `RetryErr` takes precedence and bypasses the InputError abort. `retry.Handle` deliberately does **not** apply the InputError abort (its callers signal abort via `shouldRetry=false`). Four flusher startup callsites that must retry through transient "not ready" errors were given explicit `RetryErr` escape hatches. **D. segcore (C++→Go) error classification.** A single shared Go-side table (`pkg/util/merr/segcore.go`) maps each segcore code to a merr sentinel + InputError/signal category, replacing scattered hand-written `if errorCode == ...` switches in the cgo wrappers. **Wire `Code` values change for every segcore pass-through error, not just the remapped ones.** Named sentinels remap (C++ `2003` → merr `2001`, `2033` → `2002`, Folly/Knowhere codes likewise); **all remaining pass-through codes (`2004`–`2043`, previously surfaced to clients as raw C++ enum values) now serialize as `2000`** (`ErrSegcore`), with the original C++ code preserved in the `Reason` text (`segcoreCode=...`); unknown/future codes collapse to `2000` as well (pinned by the `wire_code_projection` test). Transient segcore classes (object storage / file IO / OOM / mmap / FieldNotLoaded — 11 codes) now report `Retriable=true`. **Any client switching on raw segcore codes in the `2004`–`2043` range must be re-checked**; the in-Reason code remains available for diagnostics. Signal codes (PretendFinished / FollyCancel) are recognized centrally. `errors.Is`-based control flow on these (e.g. scheduler skip/retry) is preserved. **E. InputError classification (25 sentinels + dynamic marks).** 25 sentinels in `errors.go` carry `WithErrorType(InputError)` (the Collection / ResourceGroup / Database families, `ErrIndexDuplicate`, `ErrParameterInvalid`, `ErrPrivilegeNotAuthenticated`, `ErrImportFailed`, `ErrQueryPlan`, ...), plus dynamic marks for the 8 segcore input codes (ExprInvalid, DimNotMatch, MetricTypeInvalid, FieldIDInvalid, ...) and `WrapErrAsInputError`. The widest blast radius is `ErrParameterInvalid` (1100): ~2335 `WrapErrParameterInvalid*` callsites now classify as input / non-retriable. Because of C1/C2 this changes retriability for any path that returns these. **The audit to confirm no transient path was mis-marked is the single most important review item** (see Part 3). One reverse correction: storage field-stats parsing moved from `ErrParameterInvalid` (input) to `ErrDataIntegrity` — a corrupted stored stat is data corruption, not user input. ### Part 3 — Known risks & traps (called out proactively) 1. **`merr.Wrap` vs `WrapErr*Err` (code-masking).** `WrapErr*Err` builds a `wrappedMilvusError{sentinel: ErrServiceInternal}` whose `code()` returns the *outer* sentinel — it overwrites the inner typed code and hides the `errors.Is` chain. This is intentional (use it to *deliberately* downgrade), but it was a recurring conversion defect; the rule "add context with `merr.Wrap`, downgrade with `WrapErr*Err`" is enforced by convention and reviewed across the diff. 2. **InputError × `retry.Do` blast radius.** Marking a sentinel `InputError` makes any `retry.Do(...)` without a `RetryErr` predicate stop retrying it. Reviewers should sanity-check that no transient use of the 19 newly-marked sentinels (especially `ErrParameterInvalid`) sits inside a retry loop that needed to keep spinning. The known flusher cases were handled (see C2). 3. **The ~340 raw-error allowlist.** What remains as bare `errors.New` is, by design: package-level sentinels (caught by `errors.Is`), `//go:build test` sites, and out-of-band trees (`cmd/`, `tests/`, codegen, walimpls). The linter only bans the *direct-return* form; assignment-then-return escapes and the full no-exceptions ban are deferred to an AST-based linter (Tier 2, documented). 4. **segcore C++ second step deferred.** This PR unifies classification on the Go side; splitting the dual-semantic C++ codes at the source is a follow-up. --- ## Validation - `make verifiers`: Go side clean (gofmt + static-check across modules, including the new `rawmerrerror` rule with a 0-hit baseline repo-wide). - `make test-go`: passing; the one real regression introduced (a datanode `invalid_task_type` assertion shifting `1` → `5` from a ParameterInvalid conversion) was fixed in-tree. - go_client e2e CreateIndex assertions aligned to the new merr messages. --------- Signed-off-by: zhenshan.cao <zhenshan.cao@zilliz.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
738 lines
22 KiB
Go
738 lines
22 KiB
Go
// Licensed to the LF AI & Data foundation under one
|
|
// or more contributor license agreements. See the NOTICE file
|
|
// distributed with this work for additional information
|
|
// regarding copyright ownership. The ASF licenses this file
|
|
// to you under the Apache License, Version 2.0 (the
|
|
// "License"); you may not use this file except in compliance
|
|
// with the License. You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package datacoord
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/bytedance/mockey"
|
|
"github.com/cockroachdb/errors"
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/milvus-io/milvus-proto/go-api/v3/milvuspb"
|
|
"github.com/milvus-io/milvus/internal/datacoord/broker"
|
|
"github.com/milvus-io/milvus/internal/metastore/model"
|
|
"github.com/milvus-io/milvus/pkg/v3/proto/datapb"
|
|
"github.com/milvus-io/milvus/pkg/v3/proto/indexpb"
|
|
"github.com/milvus-io/milvus/pkg/v3/streaming/util/message"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/merr"
|
|
"github.com/milvus-io/milvus/pkg/v3/util/typeutil"
|
|
)
|
|
|
|
// --- Test createSnapshotV2AckCallback ---
|
|
|
|
func TestDDLCallbacks_CreateSnapshotV2AckCallback_Success(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
// Track if CreateSnapshot was called
|
|
createSnapshotCalled := false
|
|
|
|
// Mock snapshotManager.CreateSnapshot using mockey
|
|
mockCreateSnapshot := mockey.Mock((*snapshotManager).CreateSnapshot).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
name, description string,
|
|
compactionProtectionSeconds int64,
|
|
) (int64, error) {
|
|
createSnapshotCalled = true
|
|
assert.Equal(t, int64(100), collectionID)
|
|
assert.Equal(t, "test_snapshot", name)
|
|
assert.Equal(t, "test description", description)
|
|
assert.Equal(t, int64(3600), compactionProtectionSeconds)
|
|
return 1001, nil
|
|
}).Build()
|
|
defer mockCreateSnapshot.UnPatch()
|
|
|
|
// Create DDLCallbacks with real snapshotManager (mocked methods)
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
// Create test broadcast result using message builder
|
|
broadcastMsg := message.NewCreateSnapshotMessageBuilderV2().
|
|
WithHeader(&message.CreateSnapshotMessageHeader{
|
|
CollectionId: 100,
|
|
Name: "test_snapshot",
|
|
Description: "test description",
|
|
CompactionProtectionSeconds: 3600,
|
|
}).
|
|
WithBody(&message.CreateSnapshotMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
// Convert to typed broadcast message
|
|
typedMsg := message.MustAsBroadcastCreateSnapshotMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultCreateSnapshotMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
// Execute
|
|
err := callbacks.createSnapshotV2AckCallback(ctx, result)
|
|
|
|
// Verify
|
|
assert.NoError(t, err)
|
|
assert.True(t, createSnapshotCalled)
|
|
}
|
|
|
|
func TestDDLCallbacks_CreateSnapshotV2AckCallback_CreateError(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
expectedErr := errors.New("create snapshot error")
|
|
|
|
// Mock snapshotManager.CreateSnapshot to return error
|
|
mockCreateSnapshot := mockey.Mock((*snapshotManager).CreateSnapshot).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
name, description string,
|
|
compactionProtectionSeconds int64,
|
|
) (int64, error) {
|
|
return 0, expectedErr
|
|
}).Build()
|
|
defer mockCreateSnapshot.UnPatch()
|
|
|
|
// Create DDLCallbacks
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
// Create test broadcast result
|
|
broadcastMsg := message.NewCreateSnapshotMessageBuilderV2().
|
|
WithHeader(&message.CreateSnapshotMessageHeader{
|
|
CollectionId: 100,
|
|
Name: "test_snapshot",
|
|
Description: "test description",
|
|
}).
|
|
WithBody(&message.CreateSnapshotMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastCreateSnapshotMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultCreateSnapshotMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
// Execute
|
|
err := callbacks.createSnapshotV2AckCallback(ctx, result)
|
|
|
|
// Verify
|
|
assert.Error(t, err)
|
|
assert.Equal(t, expectedErr, err)
|
|
}
|
|
|
|
// --- Test dropSnapshotV2AckCallback ---
|
|
|
|
func TestDDLCallbacks_DropSnapshotV2AckCallback_Success(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
// Track if DropSnapshot was called
|
|
dropSnapshotCalled := false
|
|
|
|
// Mock snapshotManager.DropSnapshot using mockey
|
|
mockDropSnapshot := mockey.Mock((*snapshotManager).DropSnapshot).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
name string,
|
|
) error {
|
|
dropSnapshotCalled = true
|
|
assert.Equal(t, "test_snapshot", name)
|
|
assert.Equal(t, int64(100), collectionID)
|
|
return nil
|
|
}).Build()
|
|
defer mockDropSnapshot.UnPatch()
|
|
|
|
// Create DDLCallbacks
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
// Create test broadcast result
|
|
broadcastMsg := message.NewDropSnapshotMessageBuilderV2().
|
|
WithHeader(&message.DropSnapshotMessageHeader{
|
|
Name: "test_snapshot",
|
|
CollectionId: 100,
|
|
}).
|
|
WithBody(&message.DropSnapshotMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastDropSnapshotMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultDropSnapshotMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
// Execute
|
|
err := callbacks.dropSnapshotV2AckCallback(ctx, result)
|
|
|
|
// Verify
|
|
assert.NoError(t, err)
|
|
assert.True(t, dropSnapshotCalled)
|
|
}
|
|
|
|
func TestDDLCallbacks_DropSnapshotV2AckCallback_DropError(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
expectedErr := errors.New("drop snapshot error")
|
|
|
|
// Mock snapshotManager.DropSnapshot to return error
|
|
mockDropSnapshot := mockey.Mock((*snapshotManager).DropSnapshot).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
name string,
|
|
) error {
|
|
return expectedErr
|
|
}).Build()
|
|
defer mockDropSnapshot.UnPatch()
|
|
|
|
// Create DDLCallbacks
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
// Create test broadcast result
|
|
broadcastMsg := message.NewDropSnapshotMessageBuilderV2().
|
|
WithHeader(&message.DropSnapshotMessageHeader{
|
|
Name: "test_snapshot",
|
|
CollectionId: 100,
|
|
}).
|
|
WithBody(&message.DropSnapshotMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastDropSnapshotMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultDropSnapshotMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
// Execute
|
|
err := callbacks.dropSnapshotV2AckCallback(ctx, result)
|
|
|
|
// Verify
|
|
assert.Error(t, err)
|
|
assert.Equal(t, expectedErr, err)
|
|
}
|
|
|
|
// --- Test dropSnapshotsByCollectionV2AckCallback ---
|
|
|
|
func TestDDLCallbacks_DropSnapshotsByCollectionV2AckCallback_Success(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
dropCalled := false
|
|
var capturedCollectionID int64
|
|
|
|
mockDropByCollection := mockey.Mock((*snapshotManager).DropSnapshotsByCollection).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
) error {
|
|
dropCalled = true
|
|
capturedCollectionID = collectionID
|
|
return nil
|
|
}).Build()
|
|
defer mockDropByCollection.UnPatch()
|
|
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
broadcastMsg := message.NewDropSnapshotsByCollectionMessageBuilderV2().
|
|
WithHeader(&message.DropSnapshotsByCollectionMessageHeader{
|
|
CollectionId: 100,
|
|
}).
|
|
WithBody(&message.DropSnapshotsByCollectionMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastDropSnapshotsByCollectionMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultDropSnapshotsByCollectionMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
err := callbacks.dropSnapshotsByCollectionV2AckCallback(ctx, result)
|
|
|
|
assert.NoError(t, err)
|
|
assert.True(t, dropCalled)
|
|
assert.Equal(t, int64(100), capturedCollectionID)
|
|
}
|
|
|
|
func TestDDLCallbacks_DropSnapshotsByCollectionV2AckCallback_Error(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
expectedErr := errors.New("drop by collection error")
|
|
|
|
mockDropByCollection := mockey.Mock((*snapshotManager).DropSnapshotsByCollection).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
) error {
|
|
return expectedErr
|
|
}).Build()
|
|
defer mockDropByCollection.UnPatch()
|
|
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
broadcastMsg := message.NewDropSnapshotsByCollectionMessageBuilderV2().
|
|
WithHeader(&message.DropSnapshotsByCollectionMessageHeader{
|
|
CollectionId: 100,
|
|
}).
|
|
WithBody(&message.DropSnapshotsByCollectionMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastDropSnapshotsByCollectionMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultDropSnapshotsByCollectionMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
err := callbacks.dropSnapshotsByCollectionV2AckCallback(ctx, result)
|
|
|
|
assert.Error(t, err)
|
|
assert.Equal(t, expectedErr, err)
|
|
}
|
|
|
|
// --- Test restoreSnapshotV2AckCallback ---
|
|
|
|
func TestDDLCallbacks_RestoreSnapshotV2AckCallback_Success(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
// Track calls
|
|
readSnapshotDataCalled := false
|
|
restoreDataCalled := false
|
|
getRestoreStateCalled := false
|
|
|
|
// Mock snapshotManager.ReadSnapshotData
|
|
mockReadSnapshotData := mockey.Mock((*snapshotManager).ReadSnapshotData).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
collectionID int64,
|
|
name string,
|
|
) (*SnapshotData, error) {
|
|
readSnapshotDataCalled = true
|
|
assert.Equal(t, "test_snapshot", name)
|
|
return &SnapshotData{
|
|
SnapshotInfo: &datapb.SnapshotInfo{Name: name},
|
|
}, nil
|
|
}).Build()
|
|
defer mockReadSnapshotData.UnPatch()
|
|
|
|
// Mock snapshotManager.RestoreData
|
|
mockRestoreData := mockey.Mock((*snapshotManager).RestoreData).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
sourceCollectionID int64,
|
|
snapshotName string,
|
|
collectionID int64,
|
|
jobID int64,
|
|
pinID int64,
|
|
) (int64, error) {
|
|
restoreDataCalled = true
|
|
assert.Equal(t, "test_snapshot", snapshotName)
|
|
assert.Equal(t, int64(200), collectionID)
|
|
assert.Equal(t, int64(12345), jobID) // Verify jobID is passed from header
|
|
return jobID, nil
|
|
}).Build()
|
|
defer mockRestoreData.UnPatch()
|
|
|
|
// Mock snapshotManager.GetRestoreState to return completed immediately
|
|
mockGetRestoreState := mockey.Mock((*snapshotManager).GetRestoreState).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
jobID int64,
|
|
) (*datapb.RestoreSnapshotInfo, error) {
|
|
getRestoreStateCalled = true
|
|
assert.Equal(t, int64(12345), jobID)
|
|
return &datapb.RestoreSnapshotInfo{
|
|
State: datapb.RestoreSnapshotState_RestoreSnapshotCompleted,
|
|
Progress: 100,
|
|
}, nil
|
|
}).Build()
|
|
defer mockGetRestoreState.UnPatch()
|
|
|
|
// Create DDLCallbacks
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
// Create test broadcast result with pre-allocated jobID
|
|
broadcastMsg := message.NewRestoreSnapshotMessageBuilderV2().
|
|
WithHeader(&message.RestoreSnapshotMessageHeader{
|
|
SnapshotName: "test_snapshot",
|
|
CollectionId: 200,
|
|
JobId: 12345, // Pre-allocated jobID
|
|
SourceCollectionId: 100,
|
|
}).
|
|
WithBody(&message.RestoreSnapshotMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastRestoreSnapshotMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultRestoreSnapshotMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
// Execute
|
|
err := callbacks.restoreSnapshotV2AckCallback(ctx, result)
|
|
|
|
// Verify
|
|
assert.NoError(t, err)
|
|
// restoreSnapshotV2AckCallback no longer reads snapshot data directly.
|
|
assert.False(t, readSnapshotDataCalled)
|
|
assert.True(t, restoreDataCalled)
|
|
assert.False(t, getRestoreStateCalled)
|
|
}
|
|
|
|
func TestDDLCallbacks_RestoreSnapshotV2AckCallback_RestoreDataError(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
expectedErr := errors.New("restore data error")
|
|
|
|
// Mock snapshotManager.RestoreData to return error
|
|
mockRestoreData := mockey.Mock((*snapshotManager).RestoreData).To(func(
|
|
sm *snapshotManager,
|
|
ctx context.Context,
|
|
sourceCollectionID int64,
|
|
snapshotName string,
|
|
collectionID int64,
|
|
jobID int64,
|
|
pinID int64,
|
|
) (int64, error) {
|
|
return 0, expectedErr
|
|
}).Build()
|
|
defer mockRestoreData.UnPatch()
|
|
|
|
// Create DDLCallbacks
|
|
server := &Server{
|
|
snapshotManager: &snapshotManager{},
|
|
}
|
|
callbacks := &DDLCallbacks{Server: server}
|
|
|
|
// Create test broadcast result
|
|
broadcastMsg := message.NewRestoreSnapshotMessageBuilderV2().
|
|
WithHeader(&message.RestoreSnapshotMessageHeader{
|
|
SnapshotName: "test_snapshot",
|
|
CollectionId: 200,
|
|
JobId: 12345,
|
|
SourceCollectionId: 100,
|
|
}).
|
|
WithBody(&message.RestoreSnapshotMessageBody{}).
|
|
WithBroadcast([]string{"control_channel"}).
|
|
MustBuildBroadcast()
|
|
|
|
typedMsg := message.MustAsBroadcastRestoreSnapshotMessageV2(broadcastMsg)
|
|
|
|
result := message.BroadcastResultRestoreSnapshotMessageV2{
|
|
Message: typedMsg,
|
|
}
|
|
|
|
// Execute
|
|
err := callbacks.restoreSnapshotV2AckCallback(ctx, result)
|
|
|
|
// Verify
|
|
assert.Error(t, err)
|
|
assert.Equal(t, expectedErr, err)
|
|
}
|
|
|
|
// --- Test validateRestoreSnapshotResources ---
|
|
|
|
// newTestSnapshotMeta creates a snapshotMeta with initialized ConcurrentMaps for testing.
|
|
// If snapshots is non-nil, the entries are populated into the maps.
|
|
func newTestSnapshotMeta(snapshots map[string]*datapb.SnapshotInfo) *snapshotMeta {
|
|
sm := &snapshotMeta{
|
|
snapshotID2Info: typeutil.NewConcurrentMap[UniqueID, *datapb.SnapshotInfo](),
|
|
snapshotID2RefIndex: typeutil.NewConcurrentMap[UniqueID, *SnapshotRefIndex](),
|
|
snapshotName2ID: typeutil.NewConcurrentMap[UniqueID, *typeutil.ConcurrentMap[string, UniqueID]](),
|
|
collectionID2Snapshots: typeutil.NewConcurrentMap[UniqueID, typeutil.UniqueSet](),
|
|
}
|
|
for name, info := range snapshots {
|
|
collID := info.GetCollectionId()
|
|
nameMap, _ := sm.snapshotName2ID.GetOrInsert(collID, typeutil.NewConcurrentMap[string, UniqueID]())
|
|
nameMap.Insert(name, info.GetId())
|
|
sm.snapshotID2Info.Insert(info.GetId(), info)
|
|
}
|
|
return sm
|
|
}
|
|
|
|
// buildValidateTestServer creates a Server with mocked meta for validateRestoreSnapshotResources tests.
|
|
// snapshotFound controls whether GetSnapshot will find the snapshot.
|
|
func buildValidateTestServer(t *testing.T, snapshotFound bool) *Server {
|
|
mockBroker := broker.NewMockBroker(t)
|
|
var sm *snapshotMeta
|
|
if snapshotFound {
|
|
sm = newTestSnapshotMeta(map[string]*datapb.SnapshotInfo{
|
|
"snap1": {Id: 1, Name: "snap1", CollectionId: 100},
|
|
})
|
|
} else {
|
|
sm = newTestSnapshotMeta(nil)
|
|
}
|
|
return &Server{
|
|
broker: mockBroker,
|
|
meta: &meta{
|
|
snapshotMeta: sm,
|
|
indexMeta: &indexMeta{},
|
|
},
|
|
}
|
|
}
|
|
|
|
// buildBaseSnapshotData creates a SnapshotData with a default partition and one index.
|
|
func buildBaseSnapshotData() *SnapshotData {
|
|
return &SnapshotData{
|
|
SnapshotInfo: &datapb.SnapshotInfo{Name: "snap1", CollectionId: 100},
|
|
Collection: &datapb.CollectionDescription{
|
|
Partitions: map[string]int64{"_default": 1},
|
|
},
|
|
Indexes: []*indexpb.IndexInfo{
|
|
{IndexID: 1001, IndexName: "vec_idx", FieldID: 100},
|
|
},
|
|
}
|
|
}
|
|
|
|
// mockDescribeCollection mocks DescribeCollectionInternal to return success.
|
|
func mockDescribeCollection() *mockey.Mocker {
|
|
return mockey.Mock(mockey.GetMethod(&broker.MockBroker{}, "DescribeCollectionInternal")).To(
|
|
func(_ *broker.MockBroker, ctx context.Context, collectionID int64) (*milvuspb.DescribeCollectionResponse, error) {
|
|
return &milvuspb.DescribeCollectionResponse{
|
|
Status: merr.Success(),
|
|
CollectionID: collectionID,
|
|
CollectionName: "test_coll",
|
|
DbName: "default",
|
|
}, nil
|
|
}).Build()
|
|
}
|
|
|
|
// mockShowPartitions mocks ShowPartitions to return the given partition names.
|
|
func mockShowPartitions(names []string) *mockey.Mocker {
|
|
return mockey.Mock(mockey.GetMethod(&broker.MockBroker{}, "ShowPartitions")).To(
|
|
func(_ *broker.MockBroker, ctx context.Context, collectionID int64) (*milvuspb.ShowPartitionsResponse, error) {
|
|
ids := make([]int64, len(names))
|
|
for i := range names {
|
|
ids[i] = int64(i + 1)
|
|
}
|
|
return &milvuspb.ShowPartitionsResponse{
|
|
Status: merr.Success(),
|
|
PartitionNames: names,
|
|
PartitionIDs: ids,
|
|
}, nil
|
|
}).Build()
|
|
}
|
|
|
|
// mockGetIndexes mocks GetIndexesForCollection to return the given indexes.
|
|
func mockGetIndexes(indexes []*model.Index) *mockey.Mocker {
|
|
return mockey.Mock((*indexMeta).GetIndexesForCollection).To(
|
|
func(_ *indexMeta, collectionID int64, indexName string) []*model.Index {
|
|
return indexes
|
|
}).Build()
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_SnapshotNotFound(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, false) // snapshot NOT in map
|
|
|
|
snapshotData := buildBaseSnapshotData()
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, snapshotData)
|
|
|
|
assert.Error(t, err)
|
|
assert.Contains(t, err.Error(), "snap1")
|
|
assert.Contains(t, err.Error(), "does not exist")
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_CollectionNotFound(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m := mockey.Mock(mockey.GetMethod(&broker.MockBroker{}, "DescribeCollectionInternal")).To(
|
|
func(_ *broker.MockBroker, ctx context.Context, collectionID int64) (*milvuspb.DescribeCollectionResponse, error) {
|
|
return nil, errors.New("collection gone")
|
|
}).Build()
|
|
defer m.UnPatch()
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, buildBaseSnapshotData())
|
|
|
|
assert.Error(t, err)
|
|
assert.Contains(t, err.Error(), "collection 100 does not exist")
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_ShowPartitionsError(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
|
|
m2 := mockey.Mock(mockey.GetMethod(&broker.MockBroker{}, "ShowPartitions")).To(
|
|
func(_ *broker.MockBroker, ctx context.Context, collectionID int64) (*milvuspb.ShowPartitionsResponse, error) {
|
|
return nil, errors.New("rpc failure")
|
|
}).Build()
|
|
defer m2.UnPatch()
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, buildBaseSnapshotData())
|
|
|
|
assert.Error(t, err)
|
|
assert.Contains(t, err.Error(), "failed to get partitions")
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_PartitionNotFound(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
// Return partitions that do NOT include "_default"
|
|
m2 := mockShowPartitions([]string{"other_partition"})
|
|
defer m2.UnPatch()
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, buildBaseSnapshotData())
|
|
|
|
assert.Error(t, err)
|
|
assert.Contains(t, err.Error(), "_default")
|
|
assert.Contains(t, err.Error(), "does not exist in collection")
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_IndexNotFound(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
m2 := mockShowPartitions([]string{"_default"})
|
|
defer m2.UnPatch()
|
|
// Return empty indexes — snapshot expects vec_idx
|
|
m3 := mockGetIndexes([]*model.Index{})
|
|
defer m3.UnPatch()
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, buildBaseSnapshotData())
|
|
|
|
assert.Error(t, err)
|
|
assert.Contains(t, err.Error(), "index for field 100 does not exist")
|
|
assert.Contains(t, err.Error(), "vec_idx")
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_IndexFieldMismatch(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
m2 := mockShowPartitions([]string{"_default"})
|
|
defer m2.UnPatch()
|
|
// Index name matches but field ID does not
|
|
m3 := mockGetIndexes([]*model.Index{
|
|
{FieldID: 999, IndexName: "vec_idx"},
|
|
})
|
|
defer m3.UnPatch()
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, buildBaseSnapshotData())
|
|
|
|
assert.Error(t, err)
|
|
assert.Contains(t, err.Error(), "index for field 100 does not exist")
|
|
assert.Contains(t, err.Error(), "vec_idx")
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_Success(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
m2 := mockShowPartitions([]string{"_default"})
|
|
defer m2.UnPatch()
|
|
m3 := mockGetIndexes([]*model.Index{
|
|
{FieldID: 100, IndexName: "vec_idx"},
|
|
})
|
|
defer m3.UnPatch()
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, buildBaseSnapshotData())
|
|
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_SuccessNoIndexes(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
m2 := mockShowPartitions([]string{"_default"})
|
|
defer m2.UnPatch()
|
|
|
|
// No indexes in snapshot data
|
|
snapshotData := &SnapshotData{
|
|
SnapshotInfo: &datapb.SnapshotInfo{Name: "snap1", CollectionId: 100},
|
|
Collection: &datapb.CollectionDescription{
|
|
Partitions: map[string]int64{"_default": 1},
|
|
},
|
|
Indexes: []*indexpb.IndexInfo{},
|
|
}
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, snapshotData)
|
|
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
func TestValidateRestoreSnapshotResources_MultiplePartitionsAndIndexes(t *testing.T) {
|
|
ctx := context.Background()
|
|
server := buildValidateTestServer(t, true)
|
|
|
|
m1 := mockDescribeCollection()
|
|
defer m1.UnPatch()
|
|
m2 := mockShowPartitions([]string{"_default", "part_a", "part_b"})
|
|
defer m2.UnPatch()
|
|
m3 := mockGetIndexes([]*model.Index{
|
|
{FieldID: 100, IndexName: "vec_idx"},
|
|
{FieldID: 200, IndexName: "scalar_idx"},
|
|
})
|
|
defer m3.UnPatch()
|
|
|
|
snapshotData := &SnapshotData{
|
|
SnapshotInfo: &datapb.SnapshotInfo{Name: "snap1", CollectionId: 100},
|
|
Collection: &datapb.CollectionDescription{
|
|
Partitions: map[string]int64{
|
|
"_default": 1,
|
|
"part_a": 2,
|
|
"part_b": 3,
|
|
},
|
|
},
|
|
Indexes: []*indexpb.IndexInfo{
|
|
{IndexID: 1001, IndexName: "vec_idx", FieldID: 100},
|
|
{IndexID: 1002, IndexName: "scalar_idx", FieldID: 200},
|
|
},
|
|
}
|
|
|
|
err := server.validateRestoreSnapshotResources(ctx, 100, snapshotData)
|
|
|
|
assert.NoError(t, err)
|
|
}
|