-
-
Notifications
You must be signed in to change notification settings - Fork 148
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Benchmarks for VersionVector Performance Analysis (#1150)
Introduces comprehensive benchmark tests to evaluate performance impact of retaining detached client's lamport in Version Vector. Tests compare three implementations across varying client scales to measure memory and speed implications of different version tracking approaches. - v052-bench (Lamport Clock implementation) - v0.5.6 (Version Vector - Removes detached clients) - v0.5.7 (Version Vector - Maintains detached clients) --------- Co-authored-by: Youngteac Hong <[email protected]>
- Loading branch information
1 parent
1b2718b
commit 2fa676d
Showing
4 changed files
with
244 additions
and
15 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,6 +36,7 @@ jobs: | |
| filters: | | ||
| build: '**' | ||
| bench: | ||
| - 'test/bench/**' | ||
| - 'pkg/**' | ||
| - 'server/**' | ||
| - 'client/**' | ||
|
|
||
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,225 @@ | ||
| //go:build bench | ||
|
|
||
| /* | ||
| * Copyright 2025 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 bench | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
| gotime "time" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "google.golang.org/protobuf/proto" | ||
|
|
||
| "github.com/yorkie-team/yorkie/api/converter" | ||
| "github.com/yorkie-team/yorkie/client" | ||
| "github.com/yorkie-team/yorkie/pkg/document" | ||
| "github.com/yorkie-team/yorkie/pkg/document/json" | ||
| "github.com/yorkie-team/yorkie/pkg/document/key" | ||
| "github.com/yorkie-team/yorkie/pkg/document/presence" | ||
| "github.com/yorkie-team/yorkie/server" | ||
| "github.com/yorkie-team/yorkie/server/logging" | ||
| "github.com/yorkie-team/yorkie/test/helper" | ||
| ) | ||
|
|
||
| var testServer *server.Yorkie | ||
|
|
||
| func startTestServer(snapshotInterval int64, snapshotThreshold int64) { | ||
| config := helper.TestConfig() | ||
| config.Backend.SnapshotInterval = snapshotInterval | ||
| config.Backend.SnapshotThreshold = snapshotThreshold | ||
|
|
||
| svr, err := server.New(config) | ||
| if err != nil { | ||
| logging.DefaultLogger().Fatal(err) | ||
| } | ||
| if err := svr.Start(); err != nil { | ||
| logging.DefaultLogger().Fatal(err) | ||
| } | ||
| testServer = svr | ||
| } | ||
|
|
||
| func createDocKey(b *testing.B, i int) key.Key { | ||
| return key.Key(fmt.Sprintf("vv-bench-%d-%d", i, gotime.Now().UnixMilli())) | ||
| } | ||
|
|
||
| func initializeClientAndDoc( | ||
| ctx context.Context, | ||
| b *testing.B, | ||
| docKey key.Key, | ||
| ) (*client.Client, *document.Document) { | ||
| c, err := client.Dial( | ||
| testServer.RPCAddr(), | ||
| ) | ||
| assert.NoError(b, err) | ||
| err = c.Activate(ctx) | ||
| assert.NoError(b, err) | ||
| d := document.New(docKey) | ||
| err = c.Attach(ctx, d) | ||
| assert.NoError(b, err) | ||
|
|
||
| return c, d | ||
| } | ||
|
|
||
| func initializeClientsAndDocs( | ||
| ctx context.Context, | ||
| b *testing.B, | ||
| n int, | ||
| docKey key.Key, | ||
| ) ([]*client.Client, []*document.Document) { | ||
| var clients []*client.Client | ||
| var docs []*document.Document | ||
| for i := 0; i < n; i++ { | ||
| c, d := initializeClientAndDoc(ctx, b, docKey) | ||
| clients = append(clients, c) | ||
| docs = append(docs, d) | ||
| } | ||
| return clients, docs | ||
| } | ||
|
|
||
| func benchmarkVV( | ||
| clientCnt int, | ||
| b *testing.B, | ||
| ) { | ||
| for i := 0; i < b.N; i++ { | ||
| ctx := context.Background() | ||
| docKey := createDocKey(b, i) | ||
|
|
||
| // 1. Activate n clients and attach all clients to the document. | ||
| clients, docs := initializeClientsAndDocs(ctx, b, clientCnt, docKey) | ||
| c1, cN := clients[0], clients[clientCnt-1] | ||
| d1, dN := docs[0], docs[clientCnt-1] | ||
|
|
||
| // 2.Initialize the text. | ||
| c1.Sync(ctx) | ||
| err := d1.Update(func(root *json.Object, p *presence.Presence) error { | ||
| root.SetNewText("text") | ||
| return nil | ||
| }) | ||
| assert.NoError(b, err) | ||
| c1.Sync(ctx) | ||
| cN.Sync(ctx) | ||
| assert.Equal(b, `{"text":[]}`, d1.Marshal()) | ||
| assert.Equal(b, `{"text":[]}`, dN.Marshal()) | ||
|
|
||
| // 3. Multi-Client Edit Test | ||
| // - With n clients connected | ||
| // - c1 performs text edits | ||
| // Measurements: | ||
| // - ChangePack size | ||
| // - Total document(snapshot) size | ||
| // - PushPull time | ||
| err = d1.Update(func(root *json.Object, p *presence.Presence) error { | ||
| root.GetText("text").Edit(0, 0, "a") | ||
| return nil | ||
| }) | ||
| assert.NoError(b, err) | ||
| assert.Equal(b, `{"text":[{"val":"a"}]}`, d1.Marshal()) | ||
|
|
||
| pack := d1.CreateChangePack() | ||
| pbPack, err := converter.ToChangePack(pack) | ||
| assert.NoError(b, err) | ||
| changePackSize := proto.Size(pbPack) | ||
| b.ReportMetric(float64(changePackSize), "1_changepack(bytes)") | ||
|
|
||
| snapshot, err := converter.SnapshotToBytes(d1.RootObject(), d1.AllPresences()) | ||
| assert.NoError(b, err) | ||
| snapshotSize := len(snapshot) | ||
| b.ReportMetric(float64(snapshotSize), "2_snapshot(bytes)") | ||
|
|
||
| start := gotime.Now() | ||
| assert.NoError(b, c1.Sync(ctx)) | ||
| assert.NoError(b, cN.Sync(ctx)) | ||
| duration := gotime.Since(start).Milliseconds() | ||
| assert.Equal(b, `{"text":[{"val":"a"}]}`, dN.Marshal()) | ||
| b.ReportMetric(float64(duration), "3_pushpull(ms)") | ||
|
|
||
| // 4. All clients detach from the document. | ||
| helper.CleanupClients(b, clients) | ||
|
|
||
| // 5. New clients attach to the document. | ||
| // Measurements: | ||
| // - Attach time (to load the existing document) | ||
| start = gotime.Now() | ||
| cN1, dN1 := initializeClientAndDoc(ctx, b, docKey) | ||
| duration = gotime.Since(start).Milliseconds() | ||
| assert.Equal(b, `{"text":[{"val":"a"}]}`, dN1.Marshal()) | ||
| b.ReportMetric(float64(duration), "4_attach(ms)") | ||
|
|
||
| cN2, dN2 := initializeClientAndDoc(ctx, b, docKey) | ||
| assert.Equal(b, `{"text":[{"val":"a"}]}`, dN2.Marshal()) | ||
|
|
||
| // 6. The new client edits the text. | ||
| // Measurements: | ||
| // - ChangePack size | ||
| // - Total document(snapshot) size | ||
| // - PushPull time | ||
| err = dN1.Update(func(root *json.Object, p *presence.Presence) error { | ||
| root.GetText("text").Edit(0, 0, "b") | ||
| return nil | ||
| }) | ||
| assert.NoError(b, err) | ||
| assert.Equal(b, `{"text":[{"val":"b"},{"val":"a"}]}`, dN1.Marshal()) | ||
|
|
||
| pack = dN1.CreateChangePack() | ||
| pbPack, err = converter.ToChangePack(pack) | ||
| assert.NoError(b, err) | ||
| changePackSize = proto.Size(pbPack) | ||
| b.ReportMetric(float64(changePackSize), "5_changepack_after_detach(bytes)") | ||
|
|
||
| snapshot, err = converter.SnapshotToBytes(dN1.RootObject(), dN1.AllPresences()) | ||
| assert.NoError(b, err) | ||
| snapshotSize = len(snapshot) | ||
| b.ReportMetric(float64(snapshotSize), "6_snapshot_after_detach(bytes)") | ||
|
|
||
| start = gotime.Now() | ||
| assert.NoError(b, cN1.Sync(ctx)) | ||
| assert.NoError(b, cN2.Sync(ctx)) | ||
| duration = gotime.Since(start).Milliseconds() | ||
| assert.Equal(b, `{"text":[{"val":"b"},{"val":"a"}]}`, dN2.Marshal()) | ||
| b.ReportMetric(float64(duration), "7_pushpull_after_detach(ms)") | ||
| } | ||
| } | ||
|
|
||
| func BenchmarkVersionVector(b *testing.B) { | ||
| err := logging.SetLogLevel("error") | ||
| assert.NoError(b, err) | ||
| startTestServer(100000, 100000) | ||
| defer func() { | ||
| if testServer == nil { | ||
| return | ||
| } | ||
|
|
||
| if err := testServer.Shutdown(true); err != nil { | ||
| logging.DefaultLogger().Error(err) | ||
| } | ||
| }() | ||
|
|
||
| b.Run("clients 10", func(b *testing.B) { | ||
| benchmarkVV(10, b) | ||
| }) | ||
|
|
||
| b.Run("clients 100", func(b *testing.B) { | ||
| benchmarkVV(100, b) | ||
| }) | ||
|
|
||
| b.Run("clients 1000", func(b *testing.B) { | ||
| benchmarkVV(1000, b) | ||
| }) | ||
| } |
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