@synopackageland/templates 0.9.4 → 0.9.6

package/templates/native-go/backend/internal/app/portal.go

@@ -3,28 +3,73 @@ package app
 import (
 	"context"
 	"encoding/json"
+	"errors"
+	"net/http"
 
 	"github.com/synopackageland/syno-pkg-land-sdk/api"
+	"github.com/synopackageland/syno-pkg-land-sdk/delegate"
 	"github.com/synopackageland/syno-pkg-land-sdk/portal"
 )
 
 // portalRoutes serves portal.status when dsm-package.yaml declares `portal`.
 // An administrator sets the alias with DSM's own AppPortal API from the UI;
-// the package only reads DSM's saved setting.
+// the package only reads DSM's saved setting. Below DSM 7.2 the executor
+// registers the App's entry (PortalExecutor): portal.status then reports it,
+// and portal.register and portal.unregister change it.
 func (cfg Config) portalRoutes() []api.Route {
 	if !cfg.Portal {
 		return nil
 	}
-	return []api.Route{api.Handle("portal.status", cfg.portalStatus)}
+	routes := []api.Route{api.Handle("portal.status", cfg.portalStatus)}
+	if cfg.PortalExecutor {
+		routes = append(routes,
+			api.HandleRequest("portal.register", cfg.portalChange(portal.Register)),
+			api.HandleRequest("portal.unregister", cfg.portalChange(portal.Unregister)))
+	}
+	return routes
 }
 
-func (cfg Config) portalStatus(_ context.Context, _ api.Caller, params json.RawMessage) (any, error) {
+// portalExecutor is a variable so tests can replace the executor.
+var portalExecutor = func(cfg Config) portal.Executor { return delegate.Local(cfg.PackageID) }
+
+func (cfg Config) portalStatus(ctx context.Context, _ api.Caller, params json.RawMessage) (any, error) {
 	if err := decodeParams(params, &struct{}{}); err != nil {
 		return nil, err
 	}
+	return cfg.readPortal(ctx), nil
+}
+
+func (cfg Config) readPortal(ctx context.Context) portal.Status {
 	path := cfg.PortalConfig
 	if path == "" {
 		path = portal.ConfigPath(cfg.PackageID)
 	}
-	return portal.Read(path, "SYNO.SDS."+cfg.PackageID+".Instance"), nil
+	s := portal.Read(path, "SYNO.SDS."+cfg.PackageID+".Instance")
+	if !cfg.PortalExecutor {
+		return s
+	}
+	// An unreadable entry is not a known one: WithEntry reports unavailable.
+	entry, _ := portal.ExecutorEntry(ctx, portalExecutor(cfg))
+	return portal.WithEntry(s, entry)
+}
+
+// portalChange forwards the administrator's DSM session; the executor checks
+// it again and keeps its refusal codes, such as PORTAL_FAILED.
+func (cfg Config) portalChange(change func(context.Context, portal.Executor, map[string]string) (string, error)) api.RequestHandler {
+	return func(ctx context.Context, caller api.Caller, req *http.Request, params json.RawMessage) (any, error) {
+		if !caller.Admin() {
+			return nil, errors.New("admin_required")
+		}
+		if err := decodeParams(params, &struct{}{}); err != nil {
+			return nil, err
+		}
+		auth, err := api.DSMSession(req)
+		if err != nil {
+			return nil, err
+		}
+		if _, err := change(ctx, portalExecutor(cfg), auth); err != nil {
+			return nil, err
+		}
+		return cfg.readPortal(ctx), nil
+	}
 }

package/templates/native-go/backend/internal/app/portal_test.go

@@ -1,9 +1,17 @@
 package app
 
 import (
+	"context"
+	"encoding/json"
+	"errors"
 	"os"
 	"path/filepath"
 	"testing"
+
+	"github.com/synopackageland/syno-pkg-land-sdk/api"
+	"github.com/synopackageland/syno-pkg-land-sdk/portal"
+
+	appapi "__PACKAGE__/internal/api"
 )
 
 func portalConfig(t *testing.T, saved string) Config {
@@ -53,3 +61,123 @@ func TestPortalStatusExistsOnlyForAPortalBuild(t *testing.T) {
 		t.Fatalf("%q", code)
 	}
 }
+
+// fakeEntry is the executor as the portal routes see it.
+type fakeEntry struct {
+	entry string
+	err   error
+	calls []string
+	auth  map[string]string
+}
+
+func (f *fakeEntry) Call(_ context.Context, op string, auth map[string]string, _, result any) error {
+	f.calls = append(f.calls, op)
+	if f.err != nil {
+		return f.err
+	}
+	switch op {
+	case "portal.register":
+		f.entry, f.auth = portal.EntryRegistered, auth
+	case "portal.unregister":
+		f.entry, f.auth = portal.EntryUnregistered, auth
+	}
+	key := "entry"
+	if op == "status" {
+		key = "portal"
+	}
+	b, _ := json.Marshal(map[string]string{key: f.entry})
+	return json.Unmarshal(b, result)
+}
+
+func executorPortalConfig(t *testing.T, saved string, executor *fakeEntry) Config {
+	cfg := portalConfig(t, saved)
+	cfg.PortalExecutor = true
+	previous := portalExecutor
+	portalExecutor = func(Config) portal.Executor { return executor }
+	t.Cleanup(func() { portalExecutor = previous })
+	return cfg
+}
+
+func sessionCall(t *testing.T, cfg Config, method string) (string, map[string]any) {
+	t.Helper()
+	permissions, err := appapi.Permissions()
+	if err != nil {
+		t.Fatal(err)
+	}
+	req := apiRequest(method, `{}`)
+	req.Header.Set("Cookie", "id=session")
+	req.Header.Set("X-SYNO-TOKEN", "token")
+	return serve(t, cfg, alice, req, permissions)
+}
+
+func TestExecutorPortalStatusReportsTheEntry(t *testing.T) {
+	saved := `{"alias":"hello-go","id":"SYNO.SDS.HelloGo.Instance"}`
+	for _, c := range []struct {
+		entry string
+		err   error
+		state any
+		alias any
+	}{
+		{portal.EntryRegistered, nil, "active", "hello-go"},
+		{portal.EntryCleanupRequired, nil, "active", "hello-go"},
+		{portal.EntryUnregistered, nil, "inactive", nil},
+		{"", errors.New("executor down"), "unavailable", nil},
+	} {
+		cfg := executorPortalConfig(t, saved, &fakeEntry{entry: c.entry, err: c.err})
+		code, out := call(t, cfg, bob, "portal.status", `{}`)
+		data := out["data"].(map[string]any)
+		if code != "" || data["state"] != c.state || data["alias"] != c.alias {
+			t.Fatalf("%s: %q %v", c.entry, code, data)
+		}
+		if c.err == nil && data["entry"] != c.entry {
+			t.Fatalf("%s: entry %v", c.entry, data)
+		}
+	}
+}
+
+func TestExecutorPortalRegisterAndUnregisterReturnTheFreshStatus(t *testing.T) {
+	executor := &fakeEntry{entry: portal.EntryUnregistered}
+	cfg := executorPortalConfig(t, `{"alias":"hello-go","id":"SYNO.SDS.HelloGo.Instance"}`, executor)
+	code, out := sessionCall(t, cfg, "portal.register")
+	if data, _ := out["data"].(map[string]any); code != "" || data["entry"] != portal.EntryRegistered || data["state"] != "active" {
+		t.Fatalf("register: %q %v", code, out)
+	}
+	if executor.auth["dsm_cookie"] != "session" {
+		t.Fatalf("register did not forward the DSM session: %v", executor.auth)
+	}
+	code, out = sessionCall(t, cfg, "portal.unregister")
+	if data, _ := out["data"].(map[string]any); code != "" || data["entry"] != portal.EntryUnregistered || data["state"] != "inactive" {
+		t.Fatalf("unregister: %q %v", code, out)
+	}
+}
+
+func TestExecutorPortalChangesNeedAnAdministratorsDSMSession(t *testing.T) {
+	executor := &fakeEntry{entry: portal.EntryUnregistered}
+	cfg := executorPortalConfig(t, "", executor)
+	for _, method := range []string{"portal.register", "portal.unregister"} {
+		if code, _ := call(t, cfg, bob, method, `{}`); code == "" {
+			t.Fatalf("%s: an ordinary user changed the entry", method)
+		}
+		if code, _ := call(t, cfg, alice, method, `{}`); code != "session_required" {
+			t.Fatalf("%s without a DSM session: %q", method, code)
+		}
+	}
+	if len(executor.calls) != 0 {
+		t.Fatalf("the executor was asked: %v", executor.calls)
+	}
+}
+
+func TestExecutorPortalRefusalKeepsTheExecutorsCode(t *testing.T) {
+	cfg := executorPortalConfig(t, "", &fakeEntry{err: &api.Error{Code: "PORTAL_FAILED", Message: "x"}})
+	if code, _ := sessionCall(t, cfg, "portal.register"); code != "PORTAL_FAILED" {
+		t.Fatalf("%q", code)
+	}
+}
+
+func TestPortalChangesExistOnlyInAnExecutorPortalBuild(t *testing.T) {
+	for _, method := range []string{"portal.register", "portal.unregister"} {
+		if code, _ := call(t, portalConfig(t, ""), alice, method, `{}`); code != "unknown_method" {
+			t.Fatalf("%s: %q", method, code)
+		}
+	}
+}

package/templates/native-go/backend/internal/app/routes.go

@@ -37,10 +37,12 @@ type Config struct {
 	DataDir string
 	// VolumeRoot is where /volumeN lives; empty means "/". Tests set it.
 	VolumeRoot string
-	// Portal serves portal.status; PortalConfig overrides DSM's saved
-	// AppPortal.json path in tests.
-	Portal       bool
-	PortalConfig string
+	// Portal serves portal.status; PortalExecutor adds the executor's entry
+	// below DSM 7.2. PortalConfig overrides DSM's saved AppPortal.json path in
+	// tests.
+	Portal         bool
+	PortalExecutor bool
+	PortalConfig   string
 }
 
 func Routes(cfg Config) []api.Route {

package/templates/native-go/backend/internal/app/uninstall.go

@@ -0,0 +1,19 @@
+package app
+
+import (
+	"os"
+	"path/filepath"
+)
+
+// Uninstall is the App's purge hook (dsm-package.yaml uninstall.purge): DSM
+// runs `api.cgi uninstall` as the package account before the executor is
+// removed, with the admin's "delete state" answer. Release here what the App
+// holds outside the package. With deleteState it deletes the state that
+// uninstall.state lists, the background job spool; package data stays for
+// DSM's own "remove data" option.
+func Uninstall(dataDir string, deleteState bool) error {
+	if !deleteState {
+		return nil
+	}
+	return os.RemoveAll(filepath.Join(dataDir, "background"))
+}

package/templates/native-go/backend/internal/app/uninstall_test.go

@@ -0,0 +1,33 @@
+package app
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func TestUninstallDeletesTheJobSpoolOnlyWhenAsked(t *testing.T) {
+	dir := t.TempDir()
+	spool := filepath.Join(dir, "background")
+	if err := os.MkdirAll(filepath.Join(spool, "inputs"), 0o700); err != nil {
+		t.Fatal(err)
+	}
+	if err := Uninstall(dir, false); err != nil {
+		t.Fatal(err)
+	}
+	if _, err := os.Stat(spool); err != nil {
+		t.Fatalf("kept state is gone: %v", err)
+	}
+	if err := Uninstall(dir, true); err != nil {
+		t.Fatal(err)
+	}
+	if _, err := os.Stat(spool); !os.IsNotExist(err) {
+		t.Fatalf("state not deleted: %v", err)
+	}
+	if _, err := os.Stat(dir); err != nil {
+		t.Fatalf("package data must stay: %v", err)
+	}
+	if err := Uninstall(dir, true); err != nil {
+		t.Fatalf("nothing left to delete: %v", err)
+	}
+}

package/templates/native-go/dsm-package.yaml

@@ -69,3 +69,21 @@ i18n:
 
 # Optional SDK capabilities; delegate/rootOps share administrator-approved executor setup.
 capabilities: {}
+
+# Optional uninstall hook. DSM runs `exec args` as the package account on a
+# real uninstall (not an upgrade), before the executor is removed, with
+# SYNOPKGLAND_DELETE_STATE=0|1 and SYNOPKGLAND_REMOVE_DATA=0|1 from the wizard.
+# A failure or timeout is logged (syslog tag synopkgland-uninstall, output in
+# var/uninstall-hook.log) and never blocks the uninstall. The backend's
+# `uninstall` mode deletes the background job spool when the admin ticks
+# "delete state"; add uninstall.state.jobs to i18n/messages in every language.
+# uninstall:
+#   purge:
+#     exec: ui/cgi/api.cgi
+#     args: [uninstall]
+#     timeout: 60            # seconds, 2..120
+#     # root: purge          # rootOps only: root/purge.sh runs as root at
+#     #                      # uninstall, and only while its approval stands
+#   state:
+#     items:
+#       - key: jobs          # i18n key uninstall.state.jobs

package/templates/native-go-delegate/backend/cmd/background-worker/main.go

@@ -37,7 +37,7 @@ func main() {
 	defer stop()
 	log.Printf("started as uid %s", strconv.Itoa(info.UID))
 	dataDir := "/var/packages/" + packageID + "/var"
-	service := &delegate.Service{Client: delegate.Local(packageID), Store: background.NewStore(dataDir + "/background"), StagingDir: dataDir + "/executor-staging"}
+	service := &delegate.Service{Client: delegate.Local(packageID), Store: background.NewStore(dataDir + "/background"), StagingDir: dataDir + "/executor-staging", Work: app.HashWork}
 	settings, err := app.ParseDelegateConfig(app.Config{DelegateScope: delegateScope, DelegateOperationsJSON: delegateOperationsJSON, DelegateDestinationsJSON: delegateDestinationsJSON, DelegateLifetime: delegateLifetime})
 	if err != nil {
 		log.Fatal(err)

package/templates/native-go-delegate/backend/internal/app/delegate_routes_test.go

@@ -22,6 +22,8 @@ func init() {
 	sampleParams["delegate.jobs.submit"] = `{"key":"download","url":"http://localhost/file","dest":"/home","name":"file"}`
 	sampleParams["delegate.jobs.list"] = `{}`
 	sampleParams["delegate.jobs.cancel"] = `{"id":"missing"}`
+	// delegate.status judges the caller's Application Privileges, so it needs the DSM session too.
+	sampleOutcome["delegate.status"] = "session_required"
 	sampleOutcome["delegate.create"] = "session_required"
 	sampleOutcome["delegate.list"] = "session_required"
 	sampleOutcome["delegate.revoke"] = "session_required"

package/templates/native-go-jobs/backend/internal/app/background_routes_test.go

@@ -35,11 +35,15 @@ func init() {
 	sampleParams["bg.jobs.list"] = `{}`
 	sampleParams["bg.jobs.get"] = id
 	sampleParams["bg.jobs.cancel"] = id
+	sampleParams["bg.jobs.pause"] = id
+	sampleParams["bg.jobs.resume"] = id
 	sampleParams["bg.jobs.result"] = id
 	sampleOutcome["bg.browse"] = "session_required"
 	sampleOutcome["bg.jobs.submit"] = "session_required"
 	sampleOutcome["bg.jobs.get"] = "not_found"
 	sampleOutcome["bg.jobs.cancel"] = "not_found"
+	sampleOutcome["bg.jobs.pause"] = "not_found"
+	sampleOutcome["bg.jobs.resume"] = "not_found"
 	sampleOutcome["bg.jobs.result"] = "not_found"
 }
 

package/templates/native-go-jobs/frontend/test/background-page.test.ts

@@ -18,3 +18,24 @@ test('a jobs project mounts the background panel for the signed-in user',async()
   expect(root.querySelector('[data-page="background"]')).not.toBeNull()
  }finally{app.unmount();root.remove()}
 })
+test('the background panel pauses a running job and resumes a paused one',async()=>{
+ const submitter={user:'alice',uid:'1024'}
+ const jobs=[{id:'run',name:'a.bin',state:'running',submitter},{id:'held',name:'b.bin',state:'paused',pauseReason:'user',submitter}]
+ const call=vi.fn(async(method:string):Promise<unknown>=>{
+  if(method==='app.status')return {package:'Jobs',version:'1',user:'alice',admin:false}
+  if(method==='bg.status')return {owner:submitter,admin:false,revision:1,worker:{username:'pkg',alive:true},limits:{maxInputBytes:1024,maxQueued:8,maxOwnerPending:4,maxOwnerBytes:4096,jobTimeoutSeconds:60}}
+  if(method==='bg.jobs.list')return {jobs}
+  if(method==='bg.schedules.list')return {schedules:[]}
+  return {}
+ })
+ const root=document.createElement('div');document.body.append(root)
+ const app=mount(root,{locale:'en',call,reopen:()=>()=>{}} as unknown as Context)
+ const button=(id:string,label:string)=>Array.from(root.querySelectorAll(`[data-job-id="${id}"] button`)).find(b=>b.textContent===label) as HTMLButtonElement|undefined
+ try{
+  await settle()
+  button('run','Pause')!.click();await settle()
+  expect(call).toHaveBeenCalledWith('bg.jobs.pause',{id:'run'})
+  button('held','Resume')!.click();await settle()
+  expect(call).toHaveBeenCalledWith('bg.jobs.resume',{id:'held'})
+ }finally{app.unmount();root.remove()}
+})

package/templates/native-go-vue/frontend/package-lock.json

@@ -7,8 +7,8 @@
       "name": "native-dsm-vue-app",
       "dependencies": {
         "@lucide/vue": "1.48.0",
-        "@synopackageland/sdk": "0.9.5",
-        "@synopackageland/ui": "0.9.1",
+        "@synopackageland/sdk": "0.9.7",
+        "@synopackageland/ui": "0.9.2",
         "vue": "3.5.43"
       },
       "devDependencies": {
@@ -1148,9 +1148,9 @@
       }
     },
     "node_modules/@synopackageland/sdk": {
-      "version": "0.9.5",
-      "resolved": "https://registry.npmjs.org/@synopackageland/sdk/-/sdk-0.9.5.tgz",
-      "integrity": "sha512-ikBQthpwj9EvpagykdY2WVCjrN1yXBgReQzrnljfggdsOqd8TRk9eUMF2rgY62oARZx0P1fxIRAzkSUBGS1Qgw==",
+      "version": "0.9.7",
+      "resolved": "https://registry.npmjs.org/@synopackageland/sdk/-/sdk-0.9.7.tgz",
+      "integrity": "sha512-uU0GvgMXmTRX4UMrm6NUDQEiPdVze1Y6uE/mwmM8kqrhnLhe90kt0RrcSoEpSj9KMH+bXACz1Dw3OBRygiA2wg==",
       "license": "MIT",
       "peerDependencies": {
         "@lucide/vue": "^1.48.0",
@@ -1167,9 +1167,9 @@
       }
     },
     "node_modules/@synopackageland/ui": {
-      "version": "0.9.1",
-      "resolved": "https://registry.npmjs.org/@synopackageland/ui/-/ui-0.9.1.tgz",
-      "integrity": "sha512-L2k0eeN9+TLPMh5+kMbq6pV8n0qqUq6Ynme/KSp3mCqDb1MXBdr8MbAGtxdbNYMj9QepbA9mccgygwI9fFoG5A==",
+      "version": "0.9.2",
+      "resolved": "https://registry.npmjs.org/@synopackageland/ui/-/ui-0.9.2.tgz",
+      "integrity": "sha512-GXYs6oVed0tIb4J5D5aDYoLJMs7haq0DBWKrPP1cLU6QKUQ6EKaIwqWHv0sVdu530FCARjcB1PrWwWVS9WOsvA==",
       "license": "MIT",
       "dependencies": {
         "@internationalized/date": "3.12.4",

package/templates/native-go-vue/frontend/package.json

@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "@lucide/vue": "1.48.0",
-    "@synopackageland/sdk": "0.9.5",
-    "@synopackageland/ui": "0.9.1",
+    "@synopackageland/sdk": "0.9.7",
+    "@synopackageland/ui": "0.9.2",
     "vue": "3.5.43"
   },
   "devDependencies": {