Skip to content

fix: check for valid schema before querying by constrained field #75

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.

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 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .trunk/trunk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ plugins:
# Many linters and tools depend on runtimes - configure them here. (https://docs.trunk.io/runtimes)
runtimes:
enabled:
- go@1.23.3
- go@1.24.0
- [email protected]
- [email protected]

Expand Down
29 changes: 20 additions & 9 deletions api.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ package modusdb

import (
"context"
"fmt"
"errors"
"reflect"

"github.com/hypermodeinc/dgraph/v24/dql"
"github.com/hypermodeinc/dgraph/v24/schema"
Expand All @@ -20,7 +21,7 @@ func Create[T any](ctx context.Context, engine *Engine, object T,
engine.mutex.Lock()
defer engine.mutex.Unlock()
if len(nsId) > 1 {
return 0, object, fmt.Errorf("only one namespace is allowed")
return 0, object, errors.New("only one namespace is allowed")
}
ctx, ns, err := getDefaultNamespace(ctx, engine, nsId...)
if err != nil {
Expand Down Expand Up @@ -59,7 +60,7 @@ func Upsert[T any](ctx context.Context, engine *Engine, object T,
engine.mutex.Lock()
defer engine.mutex.Unlock()
if len(nsId) > 1 {
return 0, object, false, fmt.Errorf("only one namespace is allowed")
return 0, object, false, errors.New("only one namespace is allowed")
}

ctx, ns, err := getDefaultNamespace(ctx, engine, nsId...)
Expand Down Expand Up @@ -131,7 +132,7 @@ func Get[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueField
defer engine.mutex.Unlock()
var obj T
if len(nsId) > 1 {
return 0, obj, fmt.Errorf("only one namespace is allowed")
return 0, obj, errors.New("only one namespace is allowed")
}
ctx, ns, err := getDefaultNamespace(ctx, engine, nsId...)
if err != nil {
Expand All @@ -142,18 +143,28 @@ func Get[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueField
}

if cf, ok := any(uniqueField).(ConstrainedField); ok {
return getByConstrainedField[T](ctx, ns, cf)
objType := reflect.TypeOf(obj)
sch, err := getSchema(ctx, ns)
if err != nil {
return 0, obj, err
}
for _, t := range sch.Types {
if t.Name == objType.Name() {
return getByConstrainedField[T](ctx, ns, cf)
}
}
return 0, obj, errors.New("type not found")
}

return 0, obj, fmt.Errorf("invalid unique field type")
return 0, obj, errors.New("invalid unique field type")
}

func Query[T any](ctx context.Context, engine *Engine, queryParams QueryParams,
nsId ...uint64) ([]uint64, []T, error) {
engine.mutex.Lock()
defer engine.mutex.Unlock()
if len(nsId) > 1 {
return nil, nil, fmt.Errorf("only one namespace is allowed")
return nil, nil, errors.New("only one namespace is allowed")
}
ctx, ns, err := getDefaultNamespace(ctx, engine, nsId...)
if err != nil {
Expand All @@ -169,7 +180,7 @@ func Delete[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueFie
defer engine.mutex.Unlock()
var zeroObj T
if len(nsId) > 1 {
return 0, zeroObj, fmt.Errorf("only one namespace is allowed")
return 0, zeroObj, errors.New("only one namespace is allowed")
}
ctx, ns, err := getDefaultNamespace(ctx, engine, nsId...)
if err != nil {
Expand Down Expand Up @@ -207,5 +218,5 @@ func Delete[T any, R UniqueField](ctx context.Context, engine *Engine, uniqueFie
return uid, obj, nil
}

return 0, zeroObj, fmt.Errorf("invalid unique field type")
return 0, zeroObj, errors.New("invalid unique field type")
}
34 changes: 34 additions & 0 deletions unit_test/api_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,40 @@ func TestFirstTimeUser(t *testing.T) {
require.Equal(t, "A", queriedUser2.Name)
require.Equal(t, "123", queriedUser2.ClerkId)

// Search for a non-existent record
_, _, err = modusdb.Get[User](context.Background(), engine, modusdb.ConstrainedField{
Key: "clerk_id",
Value: "456",
})
require.Error(t, err)
require.Equal(t, "no object found", err.Error())

_, _, err = modusdb.Delete[User](context.Background(), engine, gid)
require.NoError(t, err)

_, queriedUser3, err := modusdb.Get[User](context.Background(), engine, gid)
require.Error(t, err)
require.Equal(t, "no object found", err.Error())
require.Equal(t, queriedUser3, User{})
}

func TestGetBeforeObjectWrite(t *testing.T) {
ctx := context.Background()
engine, err := modusdb.NewEngine(modusdb.NewDefaultConfig(t.TempDir()))
require.NoError(t, err)
defer engine.Close()
ns, err := engine.CreateNamespace()
require.NoError(t, err)

_, _, err = modusdb.Get[User](ctx, engine, uint64(1), ns.ID())
require.Error(t, err)

_, _, err = modusdb.Get[User](ctx, engine, modusdb.ConstrainedField{
Key: "name",
Value: "test",
}, ns.ID())
require.Error(t, err)
require.Equal(t, "type not found", err.Error())
}

func TestCreateApi(t *testing.T) {
Expand Down Expand Up @@ -125,6 +151,14 @@ func TestCreateApiWithNonStruct(t *testing.T) {
_, _, err = modusdb.Create[*User](context.Background(), engine, &user, ns1.ID())
require.Error(t, err)
require.Equal(t, "expected struct, got ptr", err.Error())

_, _, err = modusdb.Create[[]string](context.Background(), engine, []string{"foo", "bar"}, ns1.ID())
require.Error(t, err)
require.Equal(t, "expected struct, got slice", err.Error())

_, _, err = modusdb.Create[float32](context.Background(), engine, 3.1415, ns1.ID())
require.Error(t, err)
require.Equal(t, "expected struct, got float32", err.Error())
}

func TestGetApi(t *testing.T) {
Expand Down
Loading