feat(module,share): cross-app resource sharing module

pkg/module/share/testsuite/module.go

@@ -0,0 +1,47 @@
+package testsuite
+
+import (
+	"context"
+	"io/fs"
+	"testing"
+
+	"forge.cadoles.com/arcad/edge/pkg/app"
+	"forge.cadoles.com/arcad/edge/pkg/module"
+	"forge.cadoles.com/arcad/edge/pkg/module/share"
+	"github.com/pkg/errors"
+	"gitlab.com/wpetit/goweb/logger"
+)
+
+func TestModule(t *testing.T, newRepo NewTestRepoFunc) {
+	logger.SetLevel(logger.LevelDebug)
+
+	repo, err := newRepo("module")
+	if err != nil {
+		t.Fatalf("%+v", errors.WithStack(err))
+	}
+
+	server := app.NewServer(
+		module.ContextModuleFactory(),
+		module.ConsoleModuleFactory(),
+		share.ModuleFactory("test.app.edge", repo),
+	)
+
+	data, err := fs.ReadFile(testData, "testdata/share.js")
+	if err != nil {
+		t.Fatalf("%+v", errors.WithStack(err))
+	}
+
+	if err := server.Load("testdata/share.js", string(data)); err != nil {
+		t.Fatalf("%+v", errors.WithStack(err))
+	}
+
+	if err := server.Start(); err != nil {
+		t.Fatalf("%+v", errors.WithStack(err))
+	}
+
+	if _, err := server.ExecFuncByName(context.Background(), "testModule"); err != nil {
+		t.Fatalf("%+v", errors.WithStack(err))
+	}
+
+	server.Stop()
+}

pkg/module/share/testsuite/repository.go

@@ -0,0 +1,16 @@
+package testsuite
+
+import (
+	"testing"
+
+	"forge.cadoles.com/arcad/edge/pkg/module/share"
+)
+
+type NewTestRepoFunc func(testname string) (share.Repository, error)
+
+func TestRepository(t *testing.T, newRepo NewTestRepoFunc) {
+	t.Run("Cases", func(t *testing.T) {
+		t.Parallel()
+		runRepositoryTests(t, newRepo)
+	})
+}

pkg/module/share/testsuite/repository_cases.go

@@ -0,0 +1,344 @@
+package testsuite
+
+import (
+	"context"
+	"encoding/json"
+	"reflect"
+	"testing"
+	"time"
+
+	"forge.cadoles.com/arcad/edge/pkg/app"
+	"forge.cadoles.com/arcad/edge/pkg/module/share"
+	"github.com/pkg/errors"
+)
+
+type repositoryTestCase struct {
+	Name string
+	Skip bool
+	Run  func(ctx context.Context, t *testing.T, repo share.Repository) error
+}
+
+var repositoryTestCases = []repositoryTestCase{
+	{
+		Name: "Update resource attributes",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			origin := app.ID("test")
+			resourceID := share.ResourceID("test")
+
+			// Try to create resource without attributes
+			_, err := repo.UpdateAttributes(ctx, origin, resourceID)
+			if err == nil {
+				return errors.New("err should not be nil")
+			}
+
+			if !errors.Is(err, share.ErrAttributeRequired) {
+				return errors.Errorf("err: expected share.ErrAttributeRequired, got '%+v'", err)
+			}
+
+			attributes := []share.Attribute{
+				share.NewBaseAttribute("my_text_attr", share.TypeText, "foo"),
+				share.NewBaseAttribute("my_number_attr", share.TypeNumber, 5),
+				share.NewBaseAttribute("my_path_attr", share.TypePath, "/my/path"),
+				share.NewBaseAttribute("my_bool_attr", share.TypeBool, true),
+			}
+
+			resource, err := repo.UpdateAttributes(ctx, origin, resourceID, attributes...)
+			if err != nil {
+				return errors.WithStack(err)
+			}
+
+			isNil := reflect.ValueOf(resource).IsNil()
+			if isNil {
+				return errors.New("resource should not be nil")
+			}
+
+			if e, g := resourceID, resource.ID(); e != g {
+				return errors.Errorf("resource.ID(): expected '%v', got '%v'", e, g)
+			}
+
+			if e, g := origin, resource.Origin(); e != g {
+				return errors.Errorf("resource.Origin(): expected '%v', got '%v'", e, g)
+			}
+
+			if e, g := 4, len(resource.Attributes()); e != g {
+				return errors.Errorf("len(resource.Attributes()): expected '%v', got '%v'", e, g)
+			}
+
+			return nil
+		},
+	},
+	{
+		Name: "Find resources by attribute name",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			if err := loadTestData(ctx, "testdata/find_resources_by_attribute_name.json", repo); err != nil {
+				return errors.WithStack(err)
+			}
+
+			resources, err := repo.FindResources(ctx, share.WithName("my_number"))
+			if err != nil {
+				return errors.WithStack(err)
+			}
+
+			isNil := reflect.ValueOf(resources).IsNil()
+			if isNil {
+				return errors.New("resources should not be nil")
+			}
+
+			if e, g := 2, len(resources); e != g {
+				return errors.Errorf("len(resources): expected '%v', got '%v'", e, g)
+			}
+
+			return nil
+		},
+	},
+	{
+		Name: "Find resources by attribute type",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			if err := loadTestData(ctx, "testdata/find_resources_by_attribute_type.json", repo); err != nil {
+				return errors.WithStack(err)
+			}
+
+			resources, err := repo.FindResources(ctx, share.WithType(share.TypePath))
+			if err != nil {
+				return errors.WithStack(err)
+			}
+
+			isNil := reflect.ValueOf(resources).IsNil()
+			if isNil {
+				return errors.New("resources should not be nil")
+			}
+
+			if e, g := 1, len(resources); e != g {
+				return errors.Errorf("len(resources): expected '%v', got '%v'", e, g)
+			}
+
+			return nil
+		},
+	},
+	{
+		Name: "Find resources by attribute type and name",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			if err := loadTestData(ctx, "testdata/find_resources_by_attribute_type_and_name.json", repo); err != nil {
+				return errors.WithStack(err)
+			}
+
+			resources, err := repo.FindResources(ctx, share.WithType(share.TypeText), share.WithName("my_attr"))
+			if err != nil {
+				return errors.WithStack(err)
+			}
+
+			isNil := reflect.ValueOf(resources).IsNil()
+			if isNil {
+				return errors.New("resources should not be nil")
+			}
+
+			if e, g := 1, len(resources); e != g {
+				return errors.Errorf("len(resources): expected '%v', got '%v'", e, g)
+			}
+
+			return nil
+		},
+	},
+	{
+		Name: "Get resource",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			if err := loadTestData(ctx, "testdata/get_resource.json", repo); err != nil {
+				return errors.WithStack(err)
+			}
+
+			origin := app.ID("app1.edge.app")
+			resourceID := share.ResourceID("res-1")
+
+			resource, err := repo.GetResource(ctx, origin, resourceID)
+			if err != nil {
+				return errors.WithStack(err)
+			}
+
+			isNil := reflect.ValueOf(resource).IsNil()
+			if isNil {
+				return errors.New("resources should not be nil")
+			}
+
+			if e, g := origin, resource.Origin(); e != g {
+				return errors.Errorf("resource.Origin(): expected '%v', got '%v'", e, g)
+			}
+
+			if e, g := resourceID, resource.ID(); e != g {
+				return errors.Errorf("resource.ID(): expected '%v', got '%v'", e, g)
+			}
+
+			resource, err = repo.GetResource(ctx, origin, "unexistant-id")
+			if err == nil {
+				return errors.New("err should not be nil")
+			}
+
+			if !errors.Is(err, share.ErrNotFound) {
+				return errors.Errorf("err: expected share.ErrNotFound, got '%+v'", err)
+			}
+
+			return nil
+		},
+	},
+	{
+		Name: "Delete resource",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			if err := loadTestData(ctx, "testdata/delete_resource.json", repo); err != nil {
+				return errors.WithStack(err)
+			}
+
+			origin := app.ID("app1.edge.app")
+			resourceID := share.ResourceID("res-1")
+
+			// It should delete an existing resource
+			if err := repo.DeleteResource(ctx, origin, resourceID); err != nil {
+				return errors.WithStack(err)
+			}
+
+			_, err := repo.GetResource(ctx, origin, resourceID)
+			if err == nil {
+				return errors.New("err should not be nil")
+			}
+
+			// The resource should be deleted
+			if !errors.Is(err, share.ErrNotFound) {
+				return errors.Errorf("err: expected share.ErrNotFound, got '%+v'", err)
+			}
+
+			// It should not delete an unexistant resource
+			err = repo.DeleteResource(ctx, origin, resourceID)
+			if err == nil {
+				return errors.New("err should not be nil")
+			}
+
+			if !errors.Is(err, share.ErrNotFound) {
+				return errors.Errorf("err: expected share.ErrNotFound, got '%+v'", err)
+			}
+
+			otherOrigin := app.ID("app2.edge.app")
+
+			// It should not delete a resource with the same id and another origin
+			resource, err := repo.GetResource(ctx, otherOrigin, resourceID)
+			if err != nil {
+				return errors.New("err should not be nil")
+			}
+
+			if e, g := otherOrigin, resource.Origin(); e != g {
+				return errors.Errorf("resource.Origin(): expected '%v', got '%v'", e, g)
+			}
+
+			return nil
+		},
+	},
+	{
+		Name: "Delete attributes",
+		Skip: false,
+		Run: func(ctx context.Context, t *testing.T, repo share.Repository) error {
+			if err := loadTestData(ctx, "testdata/delete_attributes.json", repo); err != nil {
+				return errors.WithStack(err)
+			}
+
+			origin := app.ID("app1.edge.app")
+			resourceID := share.ResourceID("res-1")
+
+			// It should delete specified attributes
+			if err := repo.DeleteAttributes(ctx, origin, resourceID, "my_text", "my_bool"); err != nil {
+				return errors.WithStack(err)
+			}
+
+			resource, err := repo.GetResource(ctx, origin, resourceID)
+			if err != nil {
+				return errors.WithStack(err)
+			}
+
+			if e, g := 1, len(resource.Attributes()); e != g {
+				return errors.Errorf("len(resource.Attributes()): expected '%v', got '%v'", e, g)
+			}
+
+			attr := share.GetAttribute(resource, "my_number", share.TypeNumber)
+			if attr == nil {
+				return errors.New("attr shoudl not be nil")
+			}
+
+			return nil
+		},
+	},
+}
+
+func runRepositoryTests(t *testing.T, newRepo NewTestRepoFunc) {
+	for _, tc := range repositoryTestCases {
+		func(tc repositoryTestCase) {
+			t.Run(tc.Name, func(t *testing.T) {
+				t.Parallel()
+
+				if tc.Skip {
+					t.SkipNow()
+
+					return
+				}
+
+				ctx := context.Background()
+
+				repo, err := newRepo(tc.Name)
+				if err != nil {
+					t.Fatalf("%+v", errors.WithStack(err))
+				}
+
+				if err := tc.Run(ctx, t, repo); err != nil {
+					t.Errorf("%+v", errors.WithStack(err))
+				}
+			})
+		}(tc)
+	}
+}
+
+type jsonResource struct {
+	ID         string          `json:"id"`
+	Origin     string          `json:"origin"`
+	Attributes []jsonAttribute `json:"attributes"`
+}
+
+type jsonAttribute struct {
+	Name      string          `json:"name"`
+	Type      share.ValueType `json:"type"`
+	Value     any             `json:"value"`
+	CreatedAt time.Time       `json:"createdAt"`
+	UpdatedAt time.Time       `json:"updatedAt"`
+}
+
+func loadTestData(ctx context.Context, jsonFile string, repo share.Repository) error {
+	data, err := testData.ReadFile(jsonFile)
+	if err != nil {
+		return errors.WithStack(err)
+	}
+
+	var resources []jsonResource
+
+	if err := json.Unmarshal(data, &resources); err != nil {
+		return errors.WithStack(err)
+	}
+
+	for _, res := range resources {
+		attributes := make([]share.Attribute, len(res.Attributes))
+
+		for idx, attr := range res.Attributes {
+			attributes[idx] = share.NewBaseAttribute(
+				attr.Name,
+				attr.Type,
+				attr.Value,
+			)
+		}
+
+		_, err := repo.UpdateAttributes(ctx, app.ID(res.Origin), share.ResourceID(res.ID), attributes...)
+		if err != nil {
+			return errors.WithStack(err)
+		}
+	}
+
+	return nil
+}

pkg/module/share/testsuite/testdata.go

@@ -0,0 +1,6 @@
+package testsuite
+
+import "embed"
+
+//go:embed testdata/*
+var testData embed.FS

pkg/module/share/testsuite/testdata/delete_attributes.json

@@ -0,0 +1,11 @@
+[
+    {
+        "id": "res-1",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" },
+            { "name":"my_bool", "type": "bool", "value": true },
+            { "name":"my_number", "type": "number", "value": 5 }
+        ]
+    }
+]

pkg/module/share/testsuite/testdata/delete_resource.json

@@ -0,0 +1,16 @@
+[
+    {
+        "id": "res-1",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" }
+        ]
+    },
+    {
+        "id": "res-1",
+        "origin": "app2.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "foo" }
+        ]
+    }
+]

pkg/module/share/testsuite/testdata/find_resources_by_attribute_name.json

@@ -0,0 +1,29 @@
+[
+    {
+        "id": "res-1",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" },
+            { "name":"my_number", "type": "number", "value": 5 },
+            { "name":"my_bool", "type": "bool", "value": true },
+            { "name":"my_path", "type": "path", "value": "/my/icon.png" }
+        ]
+    },
+    {
+        "id": "res-2",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"other_text", "type": "text", "value": "foo" }
+        ]
+    },
+    {
+        "id": "res-1",
+        "origin": "app2.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" },
+            { "name":"my_number", "type": "number", "value": 5 },
+            { "name":"my_bool", "type": "bool", "value": true },
+            { "name":"my_path", "type": "path", "value": "/my/icon.png" }
+        ]
+    }
+]

pkg/module/share/testsuite/testdata/find_resources_by_attribute_type.json

@@ -0,0 +1,28 @@
+[
+    {
+        "id": "res-1",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" },
+            { "name":"my_number", "type": "number", "value": 5 },
+            { "name":"my_bool", "type": "bool", "value": true }
+        ]
+    },
+    {
+        "id": "res-2",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"other_text", "type": "text", "value": "foo" }
+        ]
+    },
+    {
+        "id": "res-1",
+        "origin": "app2.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" },
+            { "name":"my_number", "type": "number", "value": 5 },
+            { "name":"my_bool", "type": "bool", "value": true },
+            { "name":"my_path", "type": "path", "value": "/my/icon.png" }
+        ]
+    }
+]

pkg/module/share/testsuite/testdata/find_resources_by_attribute_type_and_name.json

@@ -0,0 +1,23 @@
+[
+    {
+        "id": "res-1",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_attr", "type": "text", "value": "bar" }
+        ]
+    },
+    {
+        "id": "res-2",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_attr", "type": "bool", "value": true }
+        ]
+    },
+    {
+        "id": "res-1",
+        "origin": "app2.edge.app",
+        "attributes": [
+            { "name":"my_attr", "type": "number", "value": 5 }
+        ]
+    }
+]

pkg/module/share/testsuite/testdata/get_resource.json

@@ -0,0 +1,16 @@
+[
+    {
+        "id": "res-1",
+        "origin": "app1.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "bar" }
+        ]
+    },
+    {
+        "id": "res-1",
+        "origin": "app2.edge.app",
+        "attributes": [
+            { "name":"my_text", "type": "text", "value": "foo" }
+        ]
+    }
+]

pkg/module/share/testsuite/testdata/share.js

@@ -0,0 +1,82 @@
+
+function testModule() {
+    var ctx = context.new();
+    var resourceId = "my-first-res";
+    var attributes = [
+        { name: "my_text", type: share.TYPE_TEXT, value: "my_text" },
+        { name: "my_number", type: share.TYPE_NUMBER, value: 5 }, 
+        { name: "my_path", type: share.TYPE_PATH, value: "/my/path" }, 
+        { name: "my_bool", type: share.TYPE_BOOL, value: true }, 
+    ]
+
+    // Create resource with attributes
+
+    var resource = share.upsertResource(
+        ctx, resourceId,
+        attributes[0],
+        attributes[1],
+        attributes[2],
+        attributes[3]
+    );
+
+    if (resource.id != resourceId) {
+        throw new Error("resource.id: expected '"+resourceId+"', got '"+resource.id+"'")
+    }
+
+    if (resource.origin != "test.app.edge") {
+        throw new Error("resource.origin: expected 'test.app.edge', got '"+resource.origin+"'")
+    }
+
+    if (resource.attributes.length != 4) {
+        throw new Error("resource.attributes.length: expected '1', got '"+resource.attributes.length+"'")
+    }
+
+    for(var attr, i = 0;( attr = attributes[i] ); i++) {
+        var exists = resource.has(attr.name, attr.type);
+        if (!exists) {
+            throw new Error("resource.has('"+attr.name+"'): expected 'true', got '"+hasAttr+"'")
+        }
+
+        var value = resource.get(attr.name, attr.type);
+        if (value != attr.value) {
+            throw new Error("value: expected '"+attr.value+"', got '"+value+"'")
+        }
+    }
+
+    // Test acces of unexistant attribute
+
+    var unexistantAttr = "unexistant_attr"
+
+    var exists = resource.has(unexistantAttr, share.TYPE_TEXT);
+    if (exists) {
+        throw new Error("attr '"+unexistantAttr+"' should not exist")
+    }
+
+    var expected = "foo"
+    var value = resource.get(unexistantAttr, share.TYPE_TEXT, expected);
+    if (value != expected) {
+        throw new Error("resource.get('"+attr.name+"',  share.TYPE_TEXT, '"+expected+"'): expected '"+expected+"', got '"+value+"'")
+    }
+
+    // Search resources
+
+    // With any attribute
+    var results = share.findResources(ctx, share.ANY_NAME, share.ANY_TYPE);
+    if (results.length != 1) {
+        throw new Error("results.length: expected '1', got '"+results.length+"'")
+    }
+
+    // With an unexistant attribute
+    var results = share.findResources(ctx, unexistantAttr, share.ANY_TYPE);
+    if (results.length != 0) {
+        throw new Error("results.length: expected '0', got '"+results.length+"'")
+    }
+
+    // With a wrong type
+    var results = share.findResources(ctx, "my_text", share.TYPE_NUMBER);
+    if (results.length != 0) {
+        throw new Error("results.length: expected '0', got '"+results.length+"'")
+    }
+}
+
+