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

refactor(i): Remove datastore.Txn from private db methods #2518

Merged
merged 2 commits into from
Apr 15, 2024
Merged

refactor(i): Remove datastore.Txn from private db methods #2518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
322ba56
remove txn params from private db methods
nasdf Apr 12, 2024
d32c141
update db context docs
nasdf Apr 15, 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
13 changes: 6 additions & 7 deletions db/backup.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ import (
acpIdentity "github.com/sourcenetwork/defradb/acp/identity"
"github.com/sourcenetwork/defradb/client"
"github.com/sourcenetwork/defradb/client/request"
"github.com/sourcenetwork/defradb/datastore"
)

func (db *db) basicImport(ctx context.Context, txn datastore.Txn, filepath string) (err error) {
func (db *db) basicImport(ctx context.Context, filepath string) (err error) {
f, err := os.Open(filepath)
if err != nil {
return NewErrOpenFile(err, filepath)
Expand All @@ -50,7 +49,7 @@ func (db *db) basicImport(ctx context.Context, txn datastore.Txn, filepath strin
return err
}
colName := t.(string)
col, err := db.getCollectionByName(ctx, txn, colName)
col, err := db.getCollectionByName(ctx, colName)
if err != nil {
return NewErrFailedToGetCollection(colName, err)
}
Expand Down Expand Up @@ -119,19 +118,19 @@ func (db *db) basicImport(ctx context.Context, txn datastore.Txn, filepath strin
return nil
}

func (db *db) basicExport(ctx context.Context, txn datastore.Txn, config *client.BackupConfig) (err error) {
func (db *db) basicExport(ctx context.Context, config *client.BackupConfig) (err error) {
// old key -> new Key
keyChangeCache := map[string]string{}

cols := []client.Collection{}
if len(config.Collections) == 0 {
cols, err = db.getCollections(ctx, txn, client.CollectionFetchOptions{})
cols, err = db.getCollections(ctx, client.CollectionFetchOptions{})
if err != nil {
return NewErrFailedToGetAllCollections(err)
}
} else {
for _, colName := range config.Collections {
col, err := db.getCollectionByName(ctx, txn, colName)
col, err := db.getCollectionByName(ctx, colName)
if err != nil {
return NewErrFailedToGetCollection(colName, err)
}
Expand Down Expand Up @@ -233,7 +232,7 @@ func (db *db) basicExport(ctx context.Context, txn datastore.Txn, config *client
refFieldName = field.Name + request.RelatedObjectID
}
} else {
foreignCol, err := db.getCollectionByName(ctx, txn, field.Kind.Underlying())
foreignCol, err := db.getCollectionByName(ctx, field.Kind.Underlying())
if err != nil {
return NewErrFailedToGetCollection(field.Kind.Underlying(), err)
}
Expand Down
40 changes: 28 additions & 12 deletions db/backup_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,12 @@ func TestBasicExport_WithNormalFormatting_NoError(t *testing.T) {

txn, err := db.NewTxn(ctx, true)
require.NoError(t, err)

ctx = SetContextTxn(ctx, txn)
defer txn.Discard(ctx)

filepath := t.TempDir() + "/test.json"
err = db.basicExport(ctx, txn, &client.BackupConfig{Filepath: filepath})
err = db.basicExport(ctx, &client.BackupConfig{Filepath: filepath})
require.NoError(t, err)

b, err := os.ReadFile(filepath)
Expand Down Expand Up @@ -126,10 +128,12 @@ func TestBasicExport_WithPrettyFormatting_NoError(t *testing.T) {

txn, err := db.NewTxn(ctx, true)
require.NoError(t, err)

ctx = SetContextTxn(ctx, txn)
defer txn.Discard(ctx)

filepath := t.TempDir() + "/test.json"
err = db.basicExport(ctx, txn, &client.BackupConfig{Filepath: filepath, Pretty: true})
err = db.basicExport(ctx, &client.BackupConfig{Filepath: filepath, Pretty: true})
require.NoError(t, err)

b, err := os.ReadFile(filepath)
Expand Down Expand Up @@ -188,10 +192,12 @@ func TestBasicExport_WithSingleCollection_NoError(t *testing.T) {

txn, err := db.NewTxn(ctx, true)
require.NoError(t, err)

ctx = SetContextTxn(ctx, txn)
defer txn.Discard(ctx)

filepath := t.TempDir() + "/test.json"
err = db.basicExport(ctx, txn, &client.BackupConfig{Filepath: filepath, Collections: []string{"Address"}})
err = db.basicExport(ctx, &client.BackupConfig{Filepath: filepath, Collections: []string{"Address"}})
require.NoError(t, err)

b, err := os.ReadFile(filepath)
Expand Down Expand Up @@ -262,10 +268,12 @@ func TestBasicExport_WithMultipleCollectionsAndUpdate_NoError(t *testing.T) {

txn, err := db.NewTxn(ctx, true)
require.NoError(t, err)

ctx = SetContextTxn(ctx, txn)
defer txn.Discard(ctx)

filepath := t.TempDir() + "/test.json"
err = db.basicExport(ctx, txn, &client.BackupConfig{Filepath: filepath})
err = db.basicExport(ctx, &client.BackupConfig{Filepath: filepath})
require.NoError(t, err)

b, err := os.ReadFile(filepath)
Expand Down Expand Up @@ -324,6 +332,8 @@ func TestBasicExport_EnsureFileOverwrite_NoError(t *testing.T) {

txn, err := db.NewTxn(ctx, true)
require.NoError(t, err)

ctx = SetContextTxn(ctx, txn)
defer txn.Discard(ctx)

filepath := t.TempDir() + "/test.json"
Expand All @@ -335,7 +345,7 @@ func TestBasicExport_EnsureFileOverwrite_NoError(t *testing.T) {
)
require.NoError(t, err)

err = db.basicExport(ctx, txn, &client.BackupConfig{Filepath: filepath, Collections: []string{"Address"}})
err = db.basicExport(ctx, &client.BackupConfig{Filepath: filepath, Collections: []string{"Address"}})
require.NoError(t, err)

b, err := os.ReadFile(filepath)
Expand Down Expand Up @@ -370,6 +380,7 @@ func TestBasicImport_WithMultipleCollectionsAndObjects_NoError(t *testing.T) {

txn, err := db.NewTxn(ctx, false)
require.NoError(t, err)
ctx = SetContextTxn(ctx, txn)

filepath := t.TempDir() + "/test.json"

Expand All @@ -380,23 +391,24 @@ func TestBasicImport_WithMultipleCollectionsAndObjects_NoError(t *testing.T) {
)
require.NoError(t, err)

err = db.basicImport(ctx, txn, filepath)
err = db.basicImport(ctx, filepath)
require.NoError(t, err)
err = txn.Commit(ctx)
require.NoError(t, err)

txn, err = db.NewTxn(ctx, true)
require.NoError(t, err)
ctx = SetContextTxn(ctx, txn)

col1, err := db.getCollectionByName(ctx, txn, "Address")
col1, err := db.getCollectionByName(ctx, "Address")
require.NoError(t, err)

key1, err := client.NewDocIDFromString("bae-8096f2c1-ea4c-5226-8ba5-17fc4b68ac1f")
require.NoError(t, err)
_, err = col1.Get(ctx, acpIdentity.NoIdentity, key1, false)
require.NoError(t, err)

col2, err := db.getCollectionByName(ctx, txn, "User")
col2, err := db.getCollectionByName(ctx, "User")
require.NoError(t, err)

key2, err := client.NewDocIDFromString("bae-b94880d1-e6d2-542f-b9e0-5a369fafd0df")
Expand Down Expand Up @@ -429,6 +441,7 @@ func TestBasicImport_WithJSONArray_ReturnError(t *testing.T) {

txn, err := db.NewTxn(ctx, false)
require.NoError(t, err)
ctx = SetContextTxn(ctx, txn)

filepath := t.TempDir() + "/test.json"

Expand All @@ -439,7 +452,7 @@ func TestBasicImport_WithJSONArray_ReturnError(t *testing.T) {
)
require.NoError(t, err)

err = db.basicImport(ctx, txn, filepath)
err = db.basicImport(ctx, filepath)
require.ErrorIs(t, err, ErrExpectedJSONObject)
err = txn.Commit(ctx)
require.NoError(t, err)
Expand All @@ -464,6 +477,7 @@ func TestBasicImport_WithObjectCollection_ReturnError(t *testing.T) {

txn, err := db.NewTxn(ctx, false)
require.NoError(t, err)
ctx = SetContextTxn(ctx, txn)

filepath := t.TempDir() + "/test.json"

Expand All @@ -474,7 +488,7 @@ func TestBasicImport_WithObjectCollection_ReturnError(t *testing.T) {
)
require.NoError(t, err)

err = db.basicImport(ctx, txn, filepath)
err = db.basicImport(ctx, filepath)
require.ErrorIs(t, err, ErrExpectedJSONArray)
err = txn.Commit(ctx)
require.NoError(t, err)
Expand All @@ -499,6 +513,7 @@ func TestBasicImport_WithInvalidFilepath_ReturnError(t *testing.T) {

txn, err := db.NewTxn(ctx, false)
require.NoError(t, err)
ctx = SetContextTxn(ctx, txn)

filepath := t.TempDir() + "/test.json"

Expand All @@ -510,7 +525,7 @@ func TestBasicImport_WithInvalidFilepath_ReturnError(t *testing.T) {
require.NoError(t, err)

wrongFilepath := t.TempDir() + "/some/test.json"
err = db.basicImport(ctx, txn, wrongFilepath)
err = db.basicImport(ctx, wrongFilepath)
require.ErrorIs(t, err, os.ErrNotExist)
err = txn.Commit(ctx)
require.NoError(t, err)
Expand All @@ -535,6 +550,7 @@ func TestBasicImport_WithInvalidCollection_ReturnError(t *testing.T) {

txn, err := db.NewTxn(ctx, false)
require.NoError(t, err)
ctx = SetContextTxn(ctx, txn)

filepath := t.TempDir() + "/test.json"

Expand All @@ -545,7 +561,7 @@ func TestBasicImport_WithInvalidCollection_ReturnError(t *testing.T) {
)
require.NoError(t, err)

err = db.basicImport(ctx, txn, filepath)
err = db.basicImport(ctx, filepath)
require.ErrorIs(t, err, ErrFailedToGetCollection)
err = txn.Commit(ctx)
require.NoError(t, err)
Expand Down
Loading
Loading