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.

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

Add support for changing type info of atree arrays (atree inlining branch) #376

Merged
merged 3 commits into from
Mar 8, 2024
Merged

Add support for changing type info of atree arrays (atree inlining branch) #376

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e029e43
Add Array.SetType() to allow updating TypeInfo
fxamacker Mar 5, 2024
a05f97e
Extract functionality of storeSlab for reuse
fxamacker Mar 8, 2024
8c7c31e
Reuse notifyParentIfNeeded in Array.SetType()
fxamacker Mar 8, 2024
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
34 changes: 34 additions & 0 deletions array.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3653,6 +3653,40 @@ func (a *Array) Type() TypeInfo {
return nil
}

func (a *Array) SetType(typeInfo TypeInfo) error {
extraData := a.root.ExtraData()
extraData.TypeInfo = typeInfo

a.root.SetExtraData(extraData)

if a.Inlined() {
// Array is inlined.
// Notify parent container so parent slab is saved in storage with updated TypeInfo of inlined array.
found, err := a.parentUpdater()
if err != nil {
return err
}
if !found {
a.parentUpdater = nil
}

return nil
fxamacker marked this conversation as resolved.
Show resolved Hide resolved
}

// Array is standalone.

slabID := a.SlabID()

// Store modified root slab in storage since typeInfo is part of extraData stored in root slab.
err := a.Storage.Store(slabID, a.root)
if err != nil {
// Wrap err as external error (if needed) because err is returned by SlabStorage interface.
return wrapErrorfAsExternalErrorIfNeeded(err, fmt.Sprintf("failed to store slab %s", slabID))
}

return nil
}

func (a *Array) String() string {
iterator, err := a.ReadOnlyIterator()
if err != nil {
Expand Down
249 changes: 249 additions & 0 deletions array_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"math"
"math/rand"
"reflect"
"runtime"
"strings"
"testing"

Expand Down Expand Up @@ -8480,3 +8481,251 @@ func TestArrayWithOutdatedCallback(t *testing.T) {
valueEqual(t, expectedValues, parentArray)
})
}

func TestArraySetType(t *testing.T) {
typeInfo := testTypeInfo{42}
newTypeInfo := testTypeInfo{43}
address := Address{1, 2, 3, 4, 5, 6, 7, 8}

t.Run("empty", func(t *testing.T) {
storage := newTestPersistentStorage(t)

// Create a new array in memory
array, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)
require.Equal(t, uint64(0), array.Count())
require.Equal(t, typeInfo, array.Type())
require.True(t, array.root.IsData())

// Modify type info of new array
err = array.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, newTypeInfo, array.Type())

// Commit new array to storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

testExistingArraySetType(t, array.SlabID(), storage.baseStorage, newTypeInfo, array.Count())
})

t.Run("data slab root", func(t *testing.T) {
storage := newTestPersistentStorage(t)

array, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)

arraySize := 10
for i := 0; i < arraySize; i++ {
v := Uint64Value(i)
err := array.Append(v)
require.NoError(t, err)
}

require.Equal(t, uint64(arraySize), array.Count())
require.Equal(t, typeInfo, array.Type())
require.True(t, array.root.IsData())

err = array.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, newTypeInfo, array.Type())

// Commit modified slabs in storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

testExistingArraySetType(t, array.SlabID(), storage.baseStorage, newTypeInfo, array.Count())
})

t.Run("metadata slab root", func(t *testing.T) {
storage := newTestPersistentStorage(t)

array, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)

arraySize := 10_000
for i := 0; i < arraySize; i++ {
v := Uint64Value(i)
err := array.Append(v)
require.NoError(t, err)
}

require.Equal(t, uint64(arraySize), array.Count())
require.Equal(t, typeInfo, array.Type())
require.False(t, array.root.IsData())

err = array.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, newTypeInfo, array.Type())

// Commit modified slabs in storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

testExistingArraySetType(t, array.SlabID(), storage.baseStorage, newTypeInfo, array.Count())
})

t.Run("inlined in parent container root data slab", func(t *testing.T) {
storage := newTestPersistentStorage(t)

parentArray, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)

childArray, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)

err = parentArray.Append(childArray)
require.NoError(t, err)

require.Equal(t, uint64(1), parentArray.Count())
require.Equal(t, typeInfo, parentArray.Type())
require.True(t, parentArray.root.IsData())
require.False(t, parentArray.Inlined())

require.Equal(t, uint64(0), childArray.Count())
require.Equal(t, typeInfo, childArray.Type())
require.True(t, childArray.root.IsData())
require.True(t, childArray.Inlined())

err = childArray.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, newTypeInfo, childArray.Type())

// Commit modified slabs in storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

testExistingInlinedArraySetType(t, parentArray.SlabID(), 0, storage.baseStorage, newTypeInfo, childArray.Count())
})

t.Run("inlined in parent container non-root data slab", func(t *testing.T) {
storage := newTestPersistentStorage(t)

parentArray, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)

arraySize := 10_000
for i := 0; i < arraySize-1; i++ {
v := Uint64Value(i)
err := parentArray.Append(v)
require.NoError(t, err)
}

childArray, err := NewArray(storage, address, typeInfo)
require.NoError(t, err)

err = parentArray.Append(childArray)
require.NoError(t, err)

require.Equal(t, uint64(arraySize), parentArray.Count())
require.Equal(t, typeInfo, parentArray.Type())
require.False(t, parentArray.root.IsData())
require.False(t, parentArray.Inlined())

require.Equal(t, uint64(0), childArray.Count())
require.Equal(t, typeInfo, childArray.Type())
require.True(t, childArray.root.IsData())
require.True(t, childArray.Inlined())

err = childArray.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, newTypeInfo, childArray.Type())

// Commit modified slabs in storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

testExistingInlinedArraySetType(t, parentArray.SlabID(), arraySize-1, storage.baseStorage, newTypeInfo, childArray.Count())
})
}

func testExistingArraySetType(
t *testing.T,
id SlabID,
baseStorage BaseStorage,
expectedTypeInfo testTypeInfo,
expectedCount uint64,
) {
newTypeInfo := testTypeInfo{value: expectedTypeInfo.value + 1}

// Create storage from existing data
storage := newTestPersistentStorageWithBaseStorage(t, baseStorage)

// Load existing array by ID
array, err := NewArrayWithRootID(storage, id)
require.NoError(t, err)
require.Equal(t, expectedCount, array.Count())
require.Equal(t, expectedTypeInfo, array.Type())

// Modify type info of existing array
err = array.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, expectedCount, array.Count())
require.Equal(t, newTypeInfo, array.Type())

// Commit data in storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

// Create storage from existing data
storage2 := newTestPersistentStorageWithBaseStorage(t, storage.baseStorage)

// Load existing array again from storage
array2, err := NewArrayWithRootID(storage2, id)
require.NoError(t, err)
require.Equal(t, expectedCount, array2.Count())
require.Equal(t, newTypeInfo, array2.Type())
}

func testExistingInlinedArraySetType(
t *testing.T,
parentID SlabID,
inlinedChildIndex int,
baseStorage BaseStorage,
expectedTypeInfo testTypeInfo,
expectedCount uint64,
) {
newTypeInfo := testTypeInfo{value: expectedTypeInfo.value + 1}

// Create storage from existing data
storage := newTestPersistentStorageWithBaseStorage(t, baseStorage)

// Load existing array by ID
parentArray, err := NewArrayWithRootID(storage, parentID)
require.NoError(t, err)

element, err := parentArray.Get(uint64(inlinedChildIndex))
require.NoError(t, err)

childArray, ok := element.(*Array)
require.True(t, ok)

require.Equal(t, expectedCount, childArray.Count())
require.Equal(t, expectedTypeInfo, childArray.Type())

// Modify type info of existing array
err = childArray.SetType(newTypeInfo)
require.NoError(t, err)
require.Equal(t, expectedCount, childArray.Count())
require.Equal(t, newTypeInfo, childArray.Type())

// Commit data in storage
err = storage.FastCommit(runtime.NumCPU())
require.NoError(t, err)

// Create storage from existing data
storage2 := newTestPersistentStorageWithBaseStorage(t, storage.baseStorage)

// Load existing array again from storage
parentArray2, err := NewArrayWithRootID(storage2, parentID)
require.NoError(t, err)

element2, err := parentArray2.Get(uint64(inlinedChildIndex))
require.NoError(t, err)

childArray2, ok := element2.(*Array)
require.True(t, ok)

require.Equal(t, expectedCount, childArray2.Count())
require.Equal(t, newTypeInfo, childArray2.Type())
}
Loading