Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

fix(site): fix task link generation in AppStatuses component#20519

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
johnstcn wants to merge4 commits intomainfromcj/task-by-workspace-id
Closed
Show file tree
Hide file tree
Changes fromall 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
77 changes: 77 additions & 0 deletionscoderd/aitasks.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -544,6 +544,83 @@ func (api *API) taskGet(rw http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, rw, http.StatusOK, taskResp)
}

// @Summary Get AI task by workspace ID
// @Description: EXPERIMENTAL: this endpoint is experimental and not guaranteed to be stable.
// @ID get-task-by-workspace-id
// @Security CoderSessionToken
// @Tags Experimental
// @Param workspace path string true "Workspace ID" format(uuid)
// @Success 200 {object} codersdk.Task
// @Router /api/experimental/task/workspace/{workspace} [get]
//
// EXPERIMENTAL: This endpoint is experimental and not guaranteed to be stable.
// taskGetByWorkspaceID is an experimental endpoint to fetch a single AI task by workspace ID.
// It returns a synthesized task response including prompt and status.
func (api *API) taskGetByWorkspaceID(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
apiKey := httpmw.APIKey(r)
workspace := httpmw.WorkspaceParam(r)

// Get the task by workspace ID
task, err := api.Database.GetTaskByWorkspaceID(ctx, workspace.ID)
if err != nil {
if httpapi.Is404Error(err) {
httpapi.ResourceNotFound(rw)
return
}
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching task.",
Detail: err.Error(),
})
return
}

if !task.WorkspaceID.Valid {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching task.",
Detail: "Task workspace ID is invalid.",
})
return
}

data, err := api.workspaceData(ctx, []database.Workspace{workspace})
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching workspace resources.",
Detail: err.Error(),
})
return
}
if len(data.builds) == 0 || len(data.templates) == 0 {
httpapi.ResourceNotFound(rw)
return
}

appStatus := codersdk.WorkspaceAppStatus{}
if len(data.appStatuses) > 0 {
appStatus = data.appStatuses[0]
}

ws, err := convertWorkspace(
apiKey.UserID,
workspace,
data.builds[0],
data.templates[0],
api.Options.AllowWorkspaceRenames,
appStatus,
)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error converting workspace.",
Detail: err.Error(),
})
return
}

taskResp := taskFromDBTaskAndWorkspace(task, ws)
httpapi.Write(ctx, rw, http.StatusOK, taskResp)
}

// @Summary Delete AI task by ID
// @Description: EXPERIMENTAL: this endpoint is experimental and not guaranteed to be stable.
// @ID delete-task
Expand Down
98 changes: 98 additions & 0 deletionscoderd/aitasks_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1440,3 +1440,101 @@ func TestTasksNotification(t *testing.T) {
})
}
}

func TestTaskGetByWorkspaceID(t *testing.T) {
t.Parallel()

var (
taskPrompt = "Build a dashboard"
client, db = coderdtest.NewWithDatabase(t, nil)
owner = coderdtest.CreateFirstUser(t, client)

// Given: two "regular" non-owner users
memberUser, memberUserData = coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
anotherMemberUser, _ = coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)

// Given: a workspace with a related task
taskWorkspaceBuild = dbfake.WorkspaceBuild(t, db, database.WorkspaceTable{
OrganizationID: owner.OrganizationID,
OwnerID: memberUserData.ID,
}).Do()
taskWorkspace = taskWorkspaceBuild.Workspace
task = dbgen.Task(t, db, database.TaskTable{
OrganizationID: owner.OrganizationID,
OwnerID: memberUserData.ID,
TemplateVersionID: taskWorkspaceBuild.Build.TemplateVersionID,
WorkspaceID: uuid.NullUUID{
UUID: taskWorkspace.ID,
Valid: true,
},
Prompt: taskPrompt,
})

// Given: a regular workspace with no associated task
regularWorkspaceBuild = dbfake.WorkspaceBuild(t, db, database.WorkspaceTable{
OrganizationID: owner.OrganizationID,
OwnerID: memberUserData.ID,
}).Do()
regularWorkspace = regularWorkspaceBuild.Workspace
expClient = codersdk.NewExperimentalClient(memberUser)
anotherExpClient = codersdk.NewExperimentalClient(anotherMemberUser)
)

t.Run("OK", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitShort)
// When: we query a task by its associated workspace
got, err := expClient.TaskByWorkspaceID(ctx, taskWorkspace.ID)
require.NoError(t, err)

// Then: the correct task is returned
assert.Equal(t, task.ID, got.ID, "task id should match")
assert.Equal(t, taskWorkspace.ID, got.WorkspaceID.UUID, "workspace id should match")
assert.Equal(t, task.Name, got.Name, "task name should match")
assert.Equal(t, taskPrompt, got.InitialPrompt, "initial prompt should match")
})

t.Run("NotFound", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitShort)
// When: we query a random UUID that should not exist
nonexistentWorkspaceID := uuid.New()
_, err := expClient.TaskByWorkspaceID(ctx, nonexistentWorkspaceID)

// Then: we get a 404 Not Found error
require.Error(t, err)
var apiErr *codersdk.Error
require.ErrorAs(t, err, &apiErr)
require.Equal(t, http.StatusNotFound, apiErr.StatusCode())
})

t.Run("OtherUser", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitShort)
// When: we query a workspace owned by another user
_, err := anotherExpClient.TaskByWorkspaceID(ctx, taskWorkspace.ID)

// Then: we get a 404 Not Found error
require.Error(t, err)
var apiErr *codersdk.Error
require.ErrorAs(t, err, &apiErr)
require.Equal(t, http.StatusNotFound, apiErr.StatusCode())
})

t.Run("NoTask", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitShort)
// When: we query for a "regular" workspace with no task
_, err := expClient.TaskByWorkspaceID(ctx, regularWorkspace.ID)

// Then: we also get a 404 not found error
require.Error(t, err)
var apiErr *codersdk.Error
require.ErrorAs(t, err, &apiErr)
require.Equal(t, http.StatusNotFound, apiErr.StatusCode())
})
}
32 changes: 32 additions & 0 deletionscoderd/apidoc/docs.go
View file
Open in desktop

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

30 changes: 30 additions & 0 deletionscoderd/apidoc/swagger.json
View file
Open in desktop

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

7 changes: 7 additions & 0 deletionscoderd/coderd.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1043,6 +1043,13 @@ func New(options *Options) *API {
})
})
})
r.Route("/task/workspace/{workspace}", func(r chi.Router) {
r.Use(
apiKeyMiddleware,
httpmw.ExtractWorkspaceParam(options.Database),
)
r.Get("/", api.taskGetByWorkspaceID)
})
r.Route("/mcp", func(r chi.Router) {
r.Use(
apiKeyMiddleware,
Expand Down
21 changes: 21 additions & 0 deletionscodersdk/aitasks.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -281,6 +281,27 @@ func (c *ExperimentalClient) TaskByID(ctx context.Context, id uuid.UUID) (Task,
return task, nil
}

// TaskByWorkspaceID fetches a single experimental task by its workspace ID.
//
// Experimental: This method is experimental and may change in the future.
func (c *ExperimentalClient) TaskByWorkspaceID(ctx context.Context, workspaceID uuid.UUID) (Task, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/experimental/task/workspace/%s", workspaceID.String()), nil)
if err != nil {
return Task{}, err
}
defer res.Body.Close()
if res.StatusCode != http.StatusOK {
return Task{}, ReadBodyAsError(res)
}

var task Task
if err := json.NewDecoder(res.Body).Decode(&task); err != nil {
return Task{}, err
}

return task, nil
}

func splitTaskIdentifier(identifier string) (owner string, taskName string, err error) {
parts := strings.Split(identifier, "/")

Expand Down
31 changes: 31 additions & 0 deletionsdocs/reference/api/experimental.md
View file
Open in desktop

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

10 changes: 10 additions & 0 deletionssite/src/api/api.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2725,6 +2725,16 @@ class ExperimentalApiMethods {
return response.data;
};

getTaskByWorkspaceID = async (
workspaceId: string,
): Promise<TypesGen.Task> => {
const response = await this.axios.get<TypesGen.Task>(
`/api/experimental/task/workspace/${workspaceId}`,
);

return response.data;
};

deleteTask = async (user: string, id: string): Promise<void> => {
await this.axios.delete(`/api/experimental/tasks/${user}/${id}`);
};
Expand Down
Loading
Loading
[8]ページ先頭
©2009-2025 Movatter.jp