8000 [Tweak] OAS-10611 Create Benchmark for unmarshalling when reading documents with field name collision by enikon · Pull Request #660 · arangodb/go-driver · GitHub
[go: up one dir, main page]
Skip to content

[Tweak] OAS-10611 Create Benchmark for unmarshalling when reading documents with field name collision #660

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[Tweak] OAS-10611 Create Benchmark for unmarshalling when reading documents with field name collision #660

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6f3445c
Added benchmarks and test
Feb 12, 2025
551fa13
Merge branch 'master' into tweak/OAS-10611-create-benchmark-for-unmar…
Feb 13, 2025
94615b9
Merge branch 'master' into tweak/OAS-10611-create-benchmark-for-unmar…
Feb 14, 2025
6b1f86b
Merge branch 'master' into tweak/OAS-10611-create-benchmark-for-unmar…
Apr 11, 2025
2a794a1
Merge branch 'master' into tweak/OAS-10611-create-benchmark-for-unmar…
May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added benchmarks and test
  • Loading branch information
Mikołaj Kmieć committed Feb 12, 2025
commit 6f3445c8550b5604c1edf6074f9b804479f54a5c
300 changes: 300 additions & 0 deletions v2/tests/collections_document_read_unmarshal_test.go 8000
View file
Open in desktop
< 8000 td class="blob-num blob-num-addition empty-cell">
Original file line number Diff line number Diff line change
@@ -0,0 +1,300 @@
//
// DISCLAIMER
//
// Copyright 2023-2025 ArangoDB GmbH, Cologne, Germany
//
// 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.
//
// Copyright holder is ArangoDB GmbH, Cologne, Germany
//

package tests

import (
"context"
"fmt"
"math/rand"
"testing"

"github.com/stretchr/testify/require"

"github.com/arangodb/go-driver/v2/arangodb"
"github.com/arangodb/go-driver/v2/arangodb/shared"
)

func Test_CollectionDocumentsReadUnmarshalCollision(t *testing.T) {
Wrap(t, func(t *testing.T, client arangodb.Client) {
WithDatabase(t, client, nil, func(db arangodb.Database) {
WithCollection(t, db, nil, func(col arangodb.Collection) {
withContextT(t, defaultTestTimeout, func(ctx context.Context, tb testing.TB) {

type DocWithNoCode struct {
Name string `json:"name"`
}
< 8000 span class='blob-code-inner blob-code-marker ' data-code-marker="+"> doc_with_no_code := DocWithNoCode{
Name: "DocWithNoCode",
}
meta_with_no_code, err := col.CreateDocument(ctx, doc_with_no_code)
require.NoError(t, err)

type DocWithCode struct {
Name string `json:"name"`
Error string `json:"error"`
Code string `json:"code"`
}
doc_with_code := DocWithCode{
Name: "DocWithCode",
Code: "777",
}
meta_with_code, err := col.CreateDocument(ctx, doc_with_code)
require.NoError(t, err)

doc_with_code_2 := DocWithCode{
Name: "DocWithCode2",
Code: "222",
}
meta_with_code_2, err := col.CreateDocument(ctx, doc_with_code_2)
require.NoError(t, err)

type DocWithResponselike struct {
Rev string `json:"_rev,omitempty"`
Key string `json:"_key,omitempty"`
Name string `json:"name"`
Error bool `json:"error,omitempty"`
Code int `json:"code,omitempty"`
ErrorMessage string `json:"errorMessage,omitempty"`
ErrorNum int `json:"errorNum,omitempty"`
}
doc_with_responselike := DocWithResponselike{
Key: "key",
Name: "DocWithResponselike",
Code: 777,
}
meta_with_responselike, err := col.CreateDocument(ctx, doc_with_responselike)
require.NoError(t, err)

_, _, _, _ = meta_with_no_code, meta_with_code, meta_with_code_2, meta_with_responselike

t.Run("sanity check, proper doc should have no error", func(t *testing.T) {
var docRead DocWithNoCode
meta, err := col.ReadDocumentWithOptions(ctx, meta_with_no_code.Key, &docRead, nil)
require.NoError(t, err)
require.Equal(t, meta_with_no_code.Key, meta.Key)
})
t.Run("sanity check, proper doc that doesn't exist should have error", func(t *testing.T) {
var docRead DocWithNoCode
_, err := col.ReadDocumentWithOptions(ctx, "404", &docRead, nil)
require.Error(t, err)
require.Equal(t, 404, err.(shared.ArangoError).Code)
})
t.Run("doc with code should have no error", func(t *testing.T) {
var docRead DocWithCode
meta, err := col.ReadDocumentWithOptions(ctx, meta_with_code.Key, &docRead, nil)
require.NoError(t, err)
require.Equal(t, "777", docRead.Code)
require.Equal(t, meta_with_code.Key, meta.Key)
})
t.Run("doc with code that doesn't exist should have error", func(t *testing.T) {
var docRead DocWithCode
_, err := col.ReadDocumentWithOptions(ctx, "404", &docRead, nil)
require.Error(t, err)
require.Equal(t, 404, err.(shared.ArangoError).Code)
})
t.Run("doc with responselike format shouldn't have error", func(t *testing.T) {
var docRead DocWithResponselike
meta, err := col.ReadDocumentWithOptions(ctx, meta_with_responselike.Key, &docRead, nil)
require.NoError(t, err)
require.Equal(t, "key", docRead.Key)
require.Equal(t, meta_with_responselike.Key, meta.Key)
})
t.Run("doc with responselike format that doesn't exist should have error", func(t *testing.T) {
var docRead DocWithResponselike
_, err := col.ReadDocumentWithOptions(ctx, "404", &docRead, nil)
require.Error(t, err)
require.Equal(t, 404, err.(shared.ArangoError).Code)
})
t.Run("docs with code should exist", func(t *testing.T) {
docsKeys := []DocWithRev{
{
Key: meta_with_code.Key,
},
{
Key: meta_with_code_2.Key,
},
}

resp, err := col.ReadDocumentsWithOptions(ctx, &docsKeys, nil)
require.NoError(t, err)

var docRead DocWithCode

_, err = resp.Read(&docRead)
require.NoError(t, err)
require.Equal(t, "777", docRead.Code)

_, err = resp.Read(&docRead)
require.NoError(t, err)
require.Equal(t, "222", docRead.Code)

})

t.Run("docs with code that doesn't exist should return empty", func(t *testing.T) {
docsKeys := []DocWithRev{
{
Key: "404",
},
{
Key: "404_2",
},
}

resp, err := col.ReadDocumentsWithOptions(ctx, &docsKeys, nil)
require.NoError(t, err)

var docRead DocWithCode

_, err = resp.Read(&docRead)
require.Error(t, err)
require.Equal(t, 1202, err.(shared.ArangoError).ErrorNum)

_, err = resp.Read(&docRead)
require.Error(t, err)
require.Equal(t, 1202, err.(shared.ArangoError).ErrorNum)

})

t.Run("docs with code mixed existence", func(t *testing.T) {
docsKeys := []DocWithRev{
{
Key: "404",
},
{
Key: meta_with_code_2.Key,
},
}

resp, err := col.ReadDocumentsWithOptions(ctx, &docsKeys, nil)
require.NoError(t, err)

var docRead DocWithCode
_, err = resp.Read(&docRead)

require.Error(t, err)
require.Equal(t, 1202, err.(shared.ArangoError).ErrorNum)

_, err = resp.Read(&docRead)
require.NoError(t, err)
require.Equal(t, "222", docRead.Code)

})
})
})
})
})
}

func Benchmark_CollectionDocumentsReadUnmarshalWithCollision(b *testing.B) {
WrapB(b, func(b *testing.B, client arangodb.Client) {
WithDatabase(b, client, nil, func(db arangodb.Database) {
WithCollection(b, db, nil, func(col arangodb.Collection) {
withContextT(b, defaultTestTimeout, func(ctx context.Context, tb testing.TB) {
type DocWithCode struct {
Name string `json:"name"`
Error string `json:"error"`
Code string `json:"code"`
}

type Meta struct {
Key string `json:"_key,omitempty"`
}

N := 100
rng := rand.New(rand.NewSource(42))
metas := []Meta{}
for i := range N {
doc_with_code := DocWithCode{
Name: "DocWithCode",
Code: fmt.Sprintf("%d%03d", rng.Int()%1000, i),
Error: "error",
}
meta_with_code, _ := col.CreateDocument(ctx, doc_with_code)
metas = append(metas, Meta{Key: meta_with_code.Key})
}

b.Run("one_by_one", func(b *testing.B) {
var docRead DocWithCode
for i := range N {
_, _ = col.ReadDocumentWithOptions(ctx, metas[i].Key, &docRead, nil)
}
})

b.Run("bulk", func(b *testing.B) {
reader, _ := col.ReadDocumentsWithOptions(ctx, &metas, nil)
var docRead DocWithCode
for range N {
_, _ = reader.Read(&docRead)
}
})
})
})
})
})
}

func Benchmark_CollectionDocumentsReadUnmarshalWithoutCollision(b *testing.B) {
WrapB(b, func(b *testing.B, client arangodb.Client) {
WithDatabase(b, client, nil, func(db arangodb.Database) {
WithCollection(b, db, nil, func(col arangodb.Collection) {
withContextT(b, defaultTestTimeout, func(ctx context.Context, tb testing.TB) {
type DocWithCode struct {
Name string `json:"name"`
Error string `json:"erroo"`
Code string `json:"codd"`
}

type Meta struct {
Key string `json:"_key,omitempty"`
}

N := 100
rng := rand.New(rand.NewSource(42))
metas := []Meta{}
for i := range N {
doc_with_code := DocWithCode{
Name: "DocWithCode",
Code: fmt.Sprintf("%d%03d", rng.Int()%1000, i),
Error: "error",
}
meta_with_code, _ := col.CreateDocument(ctx, doc_with_code)
metas = append(metas, Meta{Key: meta_with_code.Key})
}

b.Run("one_by_one", func(b *testing.B) {
var docRead DocWithCode
for i := range N {
_, _ = col.ReadDocumentWithOptions(ctx, metas[i].Key, &docRead, nil)
}
})

b.Run("bulk", func(b *testing.B) {
reader, _ := col.ReadDocumentsWithOptions(ctx, &metas, nil)
var docRead DocWithCode
for range N {
_, _ = reader.Read(&docRead)
}
})
})
})
})
})
}
0