Skip to content

feat: scoped tasks #248

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

Open
jason-lynch wants to merge 3 commits into
base: feat/PLAT-347/migrations
Choose a base branch
from
+1,706 −218
Open

feat: scoped tasks #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f28d49
feat: incorporate scope into tasks
jason-lynch Jan 13, 2026
e3a314d
feat: add task and task log migration
jason-lynch Jan 14, 2026
1ad0c8b
fix: small bug fixes
jason-lynch Jan 15, 2026
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
40 changes: 35 additions & 5 deletions api/apiv1/design/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ var Task = g.Type("Task", func() {
g.Description("The parent task ID of the task.")
g.Example("439eb515-e700-4740-b508-4a3f12ec4f83")
})
g.Attribute("scope", g.String, func() {
g.Enum("database", "host")
g.Description("The scope of the task (database or host).")
g.Example("database")
})
g.Attribute("entity_id", g.String, func() {
g.Description("The entity ID (database_id or host_id) that this task belongs to.")
g.Example("02f1a7db-fca8-4521-b57a-2a375c1ced51")
})
g.Attribute("database_id", g.String, func() {
g.Description("The database ID of the task.")
g.Example("02f1a7db-fca8-4521-b57a-2a375c1ced51")
Expand Down Expand Up @@ -55,9 +64,11 @@ var Task = g.Type("Task", func() {
g.Example("failed to connect to database")
})

g.Required("database_id", "task_id", "created_at", "type", "status")
g.Required("scope", "entity_id", "task_id", "created_at", "type", "status")

g.Example(map[string]any{
"scope": "database",
"entity_id": "storefront",
"completed_at": "2025-06-18T16:52:35Z",
"created_at": "2025-06-18T16:52:05Z",
"database_id": "storefront",
Expand Down Expand Up @@ -88,8 +99,17 @@ var TaskLogEntry = g.Type("TaskLogEntry", func() {
})

var TaskLog = g.Type("TaskLog", func() {
g.Attribute("scope", g.String, func() {
g.Enum("database", "host")
g.Description("The scope of the task (database or host).")
g.Example("database")
})
g.Attribute("entity_id", g.String, func() {
g.Description("The entity ID (database_id or host_id) that this task log belongs to.")
g.Example("02f1a7db-fca8-4521-b57a-2a375c1ced51")
})
g.Attribute("database_id", g.String, func() {
g.Description("The database ID of the task log.")
g.Description("The database ID of the task log. Deprecated: use entity_id instead.")
g.Example("02f1a7db-fca8-4521-b57a-2a375c1ced51")
})
g.Attribute("task_id", g.String, func() {
Expand All @@ -109,12 +129,13 @@ var TaskLog = g.Type("TaskLog", func() {
g.Description("Entries in the task log.")
})

g.Required("database_id", "task_id", "task_status", "entries")
g.Required("scope", "entity_id", "task_id", "task_status", "entries")

g.Example("node_backup task log", func() {
g.Description("The task log from a 'node_backup' task. These messages are produced by pgbackrest.")
g.Value(map[string]any{
"database_id": "storefront",
"scope": "database",
"entity_id": "storefront",
"entries": []map[string]any{
{
"message": "P00 INFO: backup command begin 2.55.1: --config=/opt/pgedge/configs/pgbackrest.backup.conf --exec-id=198-b17fae6e --log-level-console=info --no-log-timestamp --pg1-path=/opt/pgedge/data/pgdata --pg1-user=pgedge --repo1-cipher-type=none --repo1-path=/backups/databases/storefront/n1 --repo1-retention-full=7 --repo1-retention-full-type=time --repo1-type=posix --stanza=db --start-fast --type=full",
Expand Down Expand Up @@ -178,7 +199,8 @@ var TaskLog = g.Type("TaskLog", func() {
g.Example("update task log", func() {
g.Description("This is the task log of an update task. This example excludes many entries for brevity.")
g.Value(map[string]any{
"database_id": "storefront",
"scope": "database",
"entity_id": "storefront",
"entries": []map[string]any{
{
"message": "refreshing current state",
Expand Down Expand Up @@ -247,6 +269,8 @@ var ListDatabaseTasksResponse = g.Type("ListDatabaseTasksResponse", func() {
{
"completed_at": "2025-06-18T17:54:36Z",
"created_at": "2025-06-18T17:54:28Z",
"scope": "database",
"entity_id": "storefront",
"database_id": "storefront",
"instance_id": "storefront-n1-689qacsi",
"status": "completed",
Expand All @@ -256,6 +280,8 @@ var ListDatabaseTasksResponse = g.Type("ListDatabaseTasksResponse", func() {
{
"completed_at": "2025-06-18T17:54:04Z",
"created_at": "2025-06-18T17:53:17Z",
"scope": "database",
"entity_id": "storefront",
"database_id": "storefront",
"status": "completed",
"task_id": "0197842c-7c4f-7a8c-829e-7405c2a41c8c",
Expand All @@ -264,6 +290,8 @@ var ListDatabaseTasksResponse = g.Type("ListDatabaseTasksResponse", func() {
{
"completed_at": "2025-06-18T17:23:28Z",
"created_at": "2025-06-18T17:23:14Z",
"scope": "database",
"entity_id": "storefront",
"database_id": "storefront",
"status": "completed",
"task_id": "01978410-fb5d-7cd2-bbd2-66c0bf929dc0",
Expand All @@ -272,6 +300,8 @@ var ListDatabaseTasksResponse = g.Type("ListDatabaseTasksResponse", func() {
{
"completed_at": "2025-06-18T16:52:35Z",
"created_at": "2025-06-18T16:52:05Z",
"scope": "database",
"entity_id": "storefront",
"database_id": "storefront",
"status": "completed",
"task_id": "019783f4-75f4-71e7-85a3-c9b96b345d77",
Expand Down
14 changes: 11 additions & 3 deletions api/apiv1/gen/control_plane/service.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 14 additions & 2 deletions api/apiv1/gen/control_plane/views/view.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion api/apiv1/gen/http/control_plane/client/encode_decode.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 26 additions & 4 deletions api/apiv1/gen/http/control_plane/client/types.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions api/apiv1/gen/http/control_plane/server/encode_decode.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 27 additions & 5 deletions api/apiv1/gen/http/control_plane/server/types.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading