Add consistency test for ClientInfo update failure in PushPull #1000
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| /* | ||
| * Copyright 2024 The Yorkie Authors. All rights reserved. | ||
| * | ||
| * Licensed 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 packs_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/hex" | ||
| "fmt" | ||
| "log" | ||
| "net/http" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "connectrpc.com/connect" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/yorkie-team/yorkie/api/converter" | ||
| "github.com/yorkie-team/yorkie/api/types" | ||
| api "github.com/yorkie-team/yorkie/api/yorkie/v1" | ||
| "github.com/yorkie-team/yorkie/api/yorkie/v1/v1connect" | ||
| "github.com/yorkie-team/yorkie/client" | ||
| "github.com/yorkie-team/yorkie/pkg/document" | ||
| "github.com/yorkie-team/yorkie/pkg/document/time" | ||
| "github.com/yorkie-team/yorkie/server/backend" | ||
| "github.com/yorkie-team/yorkie/server/backend/database" | ||
| "github.com/yorkie-team/yorkie/server/backend/database/mongo" | ||
| "github.com/yorkie-team/yorkie/server/backend/housekeeping" | ||
| "github.com/yorkie-team/yorkie/server/clients" | ||
| "github.com/yorkie-team/yorkie/server/documents" | ||
| "github.com/yorkie-team/yorkie/server/packs" | ||
| "github.com/yorkie-team/yorkie/server/profiling/prometheus" | ||
| "github.com/yorkie-team/yorkie/server/rpc" | ||
| "github.com/yorkie-team/yorkie/test/helper" | ||
| ) | ||
|
|
||
| var ( | ||
| testRPCServer *rpc.Server | ||
| testRPCAddr = fmt.Sprintf("localhost:%d", helper.RPCPort) | ||
| testClient v1connect.YorkieServiceClient | ||
| testBackend *backend.Backend | ||
| ) | ||
|
|
||
| func TestMain(m *testing.M) { | ||
| met, err := prometheus.NewMetrics() | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| testBackend, err = backend.New(&backend.Config{ | ||
| AdminUser: helper.AdminUser, | ||
| AdminPassword: helper.AdminPassword, | ||
| UseDefaultProject: helper.UseDefaultProject, | ||
| ClientDeactivateThreshold: helper.ClientDeactivateThreshold, | ||
| SnapshotThreshold: helper.SnapshotThreshold, | ||
| AuthWebhookCacheSize: helper.AuthWebhookSize, | ||
| ProjectInfoCacheSize: helper.ProjectInfoCacheSize, | ||
| ProjectInfoCacheTTL: helper.ProjectInfoCacheTTL.String(), | ||
| AdminTokenDuration: helper.AdminTokenDuration, | ||
| }, &mongo.Config{ | ||
| ConnectionURI: helper.MongoConnectionURI, | ||
| YorkieDatabase: helper.TestDBName(), | ||
| ConnectionTimeout: helper.MongoConnectionTimeout, | ||
| PingTimeout: helper.MongoPingTimeout, | ||
| }, &housekeeping.Config{ | ||
| Interval: helper.HousekeepingInterval.String(), | ||
| CandidatesLimitPerProject: helper.HousekeepingCandidatesLimitPerProject, | ||
| ProjectFetchSize: helper.HousekeepingProjectFetchSize, | ||
| }, met) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| project, err := testBackend.DB.FindProjectInfoByID( | ||
| context.Background(), | ||
| database.DefaultProjectID, | ||
| ) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| testRPCServer, err = rpc.NewServer(&rpc.Config{ | ||
| Port: helper.RPCPort, | ||
| }, testBackend) | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| if err = testRPCServer.Start(); err != nil { | ||
| log.Fatalf("failed rpc listen: %s\n", err) | ||
| } | ||
| if err = helper.WaitForServerToStart(testRPCAddr); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
|
|
||
| authInterceptor := client.NewAuthInterceptor(project.PublicKey, "") | ||
|
|
||
| conn := http.DefaultClient | ||
| testClient = v1connect.NewYorkieServiceClient( | ||
| conn, | ||
| "http://"+testRPCAddr, | ||
| connect.WithInterceptors(authInterceptor), | ||
| ) | ||
|
|
||
| code := m.Run() | ||
|
|
||
| if err := testBackend.Shutdown(); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| testRPCServer.Shutdown(true) | ||
| os.Exit(code) | ||
| } | ||
|
|
||
| func TestPacks(t *testing.T) { | ||
| t.Run("pushpull consistency test", func(t *testing.T) { | ||
| ctx := context.Background() | ||
|
|
||
| projectInfo, err := testBackend.DB.FindProjectInfoByID( | ||
| ctx, | ||
| database.DefaultProjectID, | ||
| ) | ||
| assert.NoError(t, err) | ||
| project := projectInfo.ToProject() | ||
|
|
||
| activateResp, err := testClient.ActivateClient( | ||
| context.Background(), | ||
| connect.NewRequest(&api.ActivateClientRequest{ClientKey: helper.TestDocKey(t).String()})) | ||
| assert.NoError(t, err) | ||
|
|
||
| clientID, _ := hex.DecodeString(activateResp.Msg.ClientId) | ||
| resPack, err := testClient.AttachDocument( | ||
| context.Background(), | ||
| connect.NewRequest(&api.AttachDocumentRequest{ | ||
| ClientId: activateResp.Msg.ClientId, | ||
| ChangePack: &api.ChangePack{ | ||
| DocumentKey: helper.TestDocKey(t).String(), | ||
| Checkpoint: &api.Checkpoint{ServerSeq: 0, ClientSeq: 1}, | ||
| Changes: []*api.Change{{ | ||
| Id: &api.ChangeID{ | ||
| ClientSeq: 1, | ||
| Lamport: 1, | ||
| ActorId: clientID, | ||
| }, | ||
| }}, | ||
| }, | ||
| }, | ||
| )) | ||
| assert.NoError(t, err) | ||
|
|
||
| actorID, err := time.ActorIDFromBytes(clientID) | ||
| assert.NoError(t, err) | ||
|
|
||
| docID := types.ID(resPack.Msg.DocumentId) | ||
| docRefKey := types.DocRefKey{ | ||
| ProjectID: project.ID, | ||
| DocID: docID, | ||
| } | ||
|
|
||
| // 0. Check docInfo.ServerSeq and clientInfo.Checkpoint | ||
| docInfo, err := documents.FindDocInfoByRefKey(ctx, testBackend, docRefKey) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, int64(1), docInfo.ServerSeq) | ||
|
|
||
| clientInfo, err := clients.FindActiveClientInfo(ctx, testBackend.DB, types.ClientRefKey{ | ||
| ProjectID: project.ID, | ||
| ClientID: types.IDFromActorID(actorID), | ||
| }) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, int64(1), clientInfo.Checkpoint(docID).ServerSeq) | ||
| assert.Equal(t, uint32(1), clientInfo.Checkpoint(docID).ClientSeq) | ||
|
|
||
| // 1. Create a ChangePack with a single Change | ||
| pack, err := converter.FromChangePack(&api.ChangePack{ | ||
| DocumentKey: helper.TestDocKey(t).String(), | ||
| Checkpoint: &api.Checkpoint{ServerSeq: 0, ClientSeq: 2}, | ||
| Changes: []*api.Change{{ | ||
| Id: &api.ChangeID{ | ||
| ClientSeq: 2, | ||
| Lamport: 2, | ||
| ActorId: clientID, | ||
| }, | ||
| }}, | ||
| }) | ||
| assert.NoError(t, err) | ||
|
|
||
| // 2-1. An arbitrary failure occurs while updating clientInfo | ||
| _, err = packs.PushPull(ctx, testBackend, project, clientInfo, docInfo, pack, packs.PushPullOptions{ | ||
| Mode: types.SyncModePushPull, | ||
| Status: document.StatusAttached, | ||
| }, true) | ||
| assert.ErrorIs(t, err, packs.ErrCheckpointTest) | ||
|
|
||
| // 2-2. docInfo.ServerSeq increases from 1 to 2 | ||
| docInfo, err = documents.FindDocInfoByRefKey(ctx, testBackend, docRefKey) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, int64(2), docInfo.ServerSeq) | ||
|
|
||
| // 2-3. clientInfo.Checkpoint has not been updated | ||
| clientInfo, err = clients.FindActiveClientInfo(ctx, testBackend.DB, types.ClientRefKey{ | ||
| ProjectID: project.ID, | ||
| ClientID: types.IDFromActorID(actorID), | ||
| }) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, int64(1), clientInfo.Checkpoint(docID).ServerSeq) | ||
| assert.Equal(t, uint32(1), clientInfo.Checkpoint(docID).ClientSeq) | ||
|
|
||
| // 3-1. A duplicate request is sent | ||
| _, err = packs.PushPull(ctx, testBackend, project, clientInfo, docInfo, pack, packs.PushPullOptions{ | ||
| Mode: types.SyncModePushPull, | ||
| Status: document.StatusAttached, | ||
| }, false) | ||
| assert.NoError(t, err) | ||
|
|
||
| // 3-2. The server should detect the duplication and not update docInfo.ServerSeq | ||
| docInfo, err = documents.FindDocInfoByRefKey(ctx, testBackend, docRefKey) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, int64(2), docInfo.ServerSeq) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a comment for the exported variable
ErrCheckpointTest.The static analysis tool has flagged this line because exported variables in Go should have a comment describing their purpose. This is a best practice to maintain code readability and documentation.
Suggest adding a comment above the variable declaration:
Tools
GitHub Check: build