API for chat project sharing (experiment `chat-projects`). Builds on #30479 (merged). Owners share a project with users, groups, or the whole organization (the Everyone group, ID = organization ID). Chats in a shared project stay private. | Role | Project and instructions | Memories | ACL | Delete | |---------|--------------------------|------------|------|--------| | `use` | read | read/write | read | no | | `admin` | read/write | read/write | edit | no | Only the owner, and administrators whose role grants delete, can delete a project. - **API:** `GET`/`PATCH .../chats/projects/{project}/acl`, same shapes as `/chats/{chat}/acl`, plus SDK methods. Project responses include the caller's `permissions` (`update`, `delete`, `share`); the UI hides edit and delete accordingly. - **Listing:** `GET /chats/projects` returns owned and shared projects. Removes `GetChatProjectsByOwnerID`. - **Chat access:** creating a chat in a project, and loading its memory and instructions on each turn, requires the chat owner to own the project or have an ACL grant (`chatd.ChatProjectUsableBy`). Role grants don't count. If the grant is removed, existing chats lose memory and instructions on their next turn. - **Validation:** users and groups must be in the project's organization; keys must be canonical UUIDs; callers can't change their own role; the owner can't be added. Migration `000624` drops a user's grants when they leave the organization, so rejoining doesn't restore access. - **Instructions:** readers who can't edit get 403 instead of 404, and the UI hides editing. - **Agent prompt:** memories are visible to and editable by sharees, so the agent is told not to save secrets or personal details. Known gap: project deletion still detaches chats, and a sharee's open sidebar keeps showing them until reload. #30683 replaces this. Not included: share notifications, `/acl/available`, sharing UI. <details> <summary>Decision log</summary> - `use` grants memory read/write over HTTP, because agents in a sharee's chats can already write memories. Making the agent read-only for sharees was the alternative (@f0ssel chose sharees changing memories through use). - An administrator with `share` can grant themselves access and then use the project. Accepted to keep access control simple (@f0ssel). </details> > Generated by Coder Agents.
339 lines
11 KiB
Go
339 lines
11 KiB
Go
package coderd
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
"unicode/utf8"
|
|
|
|
"github.com/google/uuid"
|
|
"golang.org/x/xerrors"
|
|
|
|
"github.com/coder/coder/v2/coderd/audit"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/db2sdk"
|
|
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
|
"github.com/coder/coder/v2/coderd/httpapi"
|
|
"github.com/coder/coder/v2/coderd/httpmw"
|
|
"github.com/coder/coder/v2/coderd/rbac"
|
|
"github.com/coder/coder/v2/coderd/rbac/policy"
|
|
"github.com/coder/coder/v2/coderd/util/ptr"
|
|
"github.com/coder/coder/v2/coderd/util/slice"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
)
|
|
|
|
// @Summary List chat projects
|
|
// @ID list-chat-projects
|
|
// @Security CoderSessionToken
|
|
// @Tags Chats
|
|
// @Produce json
|
|
// @Success 200 {array} codersdk.ChatProject
|
|
// @Router /api/experimental/chats/projects [get]
|
|
// @x-apidocgen {"skip": true}
|
|
func (api *API) listChatProjects(rw http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
apiKey := httpmw.APIKey(r)
|
|
|
|
projects, err := api.Database.GetChatProjectsOwnedOrSharedWithUserID(ctx, apiKey.UserID)
|
|
if err != nil {
|
|
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to list chat projects.",
|
|
Detail: err.Error(),
|
|
})
|
|
return
|
|
}
|
|
httpapi.Write(ctx, rw, http.StatusOK, slice.List(projects, func(project database.ChatProject) codersdk.ChatProject {
|
|
return api.convertChatProject(r, project)
|
|
}))
|
|
}
|
|
|
|
// @Summary Create chat project
|
|
// @ID create-chat-project
|
|
// @Security CoderSessionToken
|
|
// @Tags Chats
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param organization path string true "Organization ID" format(uuid)
|
|
// @Param request body codersdk.CreateChatProjectRequest true "Create chat project request"
|
|
// @Success 201 {object} codersdk.ChatProject
|
|
// @Router /api/experimental/organizations/{organization}/chats/projects [post]
|
|
// @x-apidocgen {"skip": true}
|
|
func (api *API) postChatProject(rw http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
apiKey := httpmw.APIKey(r)
|
|
organization := httpmw.OrganizationParam(r)
|
|
|
|
var req codersdk.CreateChatProjectRequest
|
|
if !httpapi.Read(ctx, rw, r, &req) {
|
|
return
|
|
}
|
|
req.Name = strings.TrimSpace(req.Name)
|
|
req.Icon = strings.TrimSpace(req.Icon)
|
|
if req.Name == "" {
|
|
writeChatProjectFieldError(ctx, rw, "name", "Name is required.")
|
|
return
|
|
}
|
|
if !validateChatProjectFields(ctx, rw, req.Name, req.Description, req.Icon) {
|
|
return
|
|
}
|
|
if !api.Authorize(r, policy.ActionCreate, database.ChatProject{
|
|
OrganizationID: organization.ID,
|
|
OwnerID: apiKey.UserID,
|
|
}.RBACObject()) {
|
|
httpapi.Forbidden(rw)
|
|
return
|
|
}
|
|
|
|
aReq, commitAudit := audit.InitRequest[database.ChatProject](rw, &audit.RequestParams{
|
|
Audit: *api.Auditor.Load(),
|
|
Log: api.Logger,
|
|
Request: r,
|
|
Action: database.AuditActionCreate,
|
|
OrganizationID: organization.ID,
|
|
})
|
|
defer commitAudit()
|
|
|
|
var project database.ChatProject
|
|
err := api.Database.InTx(func(tx database.Store) error {
|
|
// The lock serializes a user's creates so concurrent requests cannot
|
|
// both observe room under the cap.
|
|
if err := tx.AcquireLock(ctx, database.GenLockID("chat-projects-owner:"+apiKey.UserID.String())); err != nil {
|
|
return xerrors.Errorf("lock chat projects: %w", err)
|
|
}
|
|
// The count spans the user's projects in every organization, and the
|
|
// caller was already authorized to create one.
|
|
//nolint:gocritic // See above.
|
|
count, err := tx.CountChatProjectsByOwnerID(dbauthz.AsSystemRestricted(ctx), apiKey.UserID)
|
|
if err != nil {
|
|
return xerrors.Errorf("count chat projects: %w", err)
|
|
}
|
|
if count >= maxChatProjectsPerOwner {
|
|
return errChatProjectLimit
|
|
}
|
|
project, err = tx.InsertChatProject(ctx, database.InsertChatProjectParams{
|
|
ID: uuid.NullUUID{},
|
|
OrganizationID: organization.ID,
|
|
OwnerID: apiKey.UserID,
|
|
Name: req.Name,
|
|
Description: req.Description,
|
|
Icon: req.Icon,
|
|
})
|
|
return err
|
|
}, nil)
|
|
if errors.Is(err, errChatProjectLimit) {
|
|
httpapi.Write(ctx, rw, http.StatusConflict, codersdk.Response{
|
|
Message: fmt.Sprintf("You can have at most %d chat projects. Delete a project to create another.", maxChatProjectsPerOwner),
|
|
})
|
|
return
|
|
}
|
|
if err != nil {
|
|
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to create chat project.",
|
|
Detail: err.Error(),
|
|
})
|
|
return
|
|
}
|
|
aReq.New = project
|
|
httpapi.Write(ctx, rw, http.StatusCreated, api.convertChatProject(r, project))
|
|
}
|
|
|
|
// @Summary Get chat project
|
|
// @ID get-chat-project
|
|
// @Security CoderSessionToken
|
|
// @Tags Chats
|
|
// @Produce json
|
|
// @Param organization path string true "Organization ID" format(uuid)
|
|
// @Param project path string true "Chat project ID" format(uuid)
|
|
// @Success 200 {object} codersdk.ChatProject
|
|
// @Router /api/experimental/organizations/{organization}/chats/projects/{project} [get]
|
|
// @x-apidocgen {"skip": true}
|
|
//
|
|
//nolint:revive // HTTP handler writes to ResponseWriter.
|
|
func (api *API) getChatProject(rw http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
project := httpmw.ChatProjectParam(r)
|
|
if !api.Authorize(r, policy.ActionRead, project.RBACObject()) {
|
|
httpapi.ResourceNotFound(rw)
|
|
return
|
|
}
|
|
httpapi.Write(ctx, rw, http.StatusOK, api.convertChatProject(r, project))
|
|
}
|
|
|
|
// @Summary Update chat project
|
|
// @ID update-chat-project
|
|
// @Security CoderSessionToken
|
|
// @Tags Chats
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param organization path string true "Organization ID" format(uuid)
|
|
// @Param project path string true "Chat project ID" format(uuid)
|
|
// @Param request body codersdk.UpdateChatProjectRequest true "Update chat project request"
|
|
// @Success 200 {object} codersdk.ChatProject
|
|
// @Router /api/experimental/organizations/{organization}/chats/projects/{project} [patch]
|
|
// @x-apidocgen {"skip": true}
|
|
func (api *API) patchChatProject(rw http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
project := httpmw.ChatProjectParam(r)
|
|
if !api.authorizeChatProjectChange(rw, r, policy.ActionUpdate, project.RBACObject()) {
|
|
return
|
|
}
|
|
|
|
aReq, commitAudit := audit.InitRequest[database.ChatProject](rw, &audit.RequestParams{
|
|
Audit: *api.Auditor.Load(),
|
|
Log: api.Logger,
|
|
Request: r,
|
|
Action: database.AuditActionWrite,
|
|
OrganizationID: project.OrganizationID,
|
|
})
|
|
defer commitAudit()
|
|
aReq.Old = project
|
|
|
|
var req codersdk.UpdateChatProjectRequest
|
|
if !httpapi.Read(ctx, rw, r, &req) {
|
|
return
|
|
}
|
|
if req.Name != nil {
|
|
*req.Name = strings.TrimSpace(*req.Name)
|
|
}
|
|
if req.Icon != nil {
|
|
*req.Icon = strings.TrimSpace(*req.Icon)
|
|
}
|
|
if req.Name != nil && *req.Name == "" {
|
|
writeChatProjectFieldError(ctx, rw, "name", "Name must not be blank.")
|
|
return
|
|
}
|
|
name := ptr.NilToDefault(req.Name, project.Name)
|
|
description := ptr.NilToDefault(req.Description, project.Description)
|
|
icon := ptr.NilToDefault(req.Icon, project.Icon)
|
|
if !validateChatProjectFields(ctx, rw, name, description, icon) {
|
|
return
|
|
}
|
|
|
|
updated, err := api.Database.UpdateChatProjectByID(ctx, database.UpdateChatProjectByIDParams{
|
|
ID: project.ID,
|
|
Name: name,
|
|
Description: description,
|
|
Icon: icon,
|
|
})
|
|
if err != nil {
|
|
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to update chat project.",
|
|
Detail: err.Error(),
|
|
})
|
|
return
|
|
}
|
|
aReq.New = updated
|
|
httpapi.Write(ctx, rw, http.StatusOK, api.convertChatProject(r, updated))
|
|
}
|
|
|
|
// @Summary Delete chat project
|
|
// @ID delete-chat-project
|
|
// @Security CoderSessionToken
|
|
// @Tags Chats
|
|
// @Param organization path string true "Organization ID" format(uuid)
|
|
// @Param project path string true "Chat project ID" format(uuid)
|
|
// @Success 204
|
|
// @Router /api/experimental/organizations/{organization}/chats/projects/{project} [delete]
|
|
// @x-apidocgen {"skip": true}
|
|
func (api *API) deleteChatProject(rw http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
project := httpmw.ChatProjectParam(r)
|
|
if !api.authorizeChatProjectChange(rw, r, policy.ActionDelete, project.RBACObject()) {
|
|
return
|
|
}
|
|
|
|
aReq, commitAudit := audit.InitRequest[database.ChatProject](rw, &audit.RequestParams{
|
|
Audit: *api.Auditor.Load(),
|
|
Log: api.Logger,
|
|
Request: r,
|
|
Action: database.AuditActionDelete,
|
|
OrganizationID: project.OrganizationID,
|
|
})
|
|
defer commitAudit()
|
|
aReq.Old = project
|
|
|
|
err := api.Database.DeleteChatProjectByID(ctx, project.ID)
|
|
if errors.Is(err, sql.ErrNoRows) || httpapi.Is404Error(err) {
|
|
httpapi.ResourceNotFound(rw)
|
|
return
|
|
}
|
|
if err != nil {
|
|
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
|
|
Message: "Failed to delete chat project.",
|
|
Detail: err.Error(),
|
|
})
|
|
return
|
|
}
|
|
rw.WriteHeader(http.StatusNoContent)
|
|
}
|
|
|
|
func (api *API) authorizeChatProjectChange(rw http.ResponseWriter, r *http.Request, action policy.Action, object rbac.Objecter) bool {
|
|
if !api.Authorize(r, policy.ActionRead, object) {
|
|
httpapi.ResourceNotFound(rw)
|
|
return false
|
|
}
|
|
if !api.Authorize(r, action, object) {
|
|
httpapi.Forbidden(rw)
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
|
|
func (api *API) convertChatProject(r *http.Request, project database.ChatProject) codersdk.ChatProject {
|
|
ctx := r.Context()
|
|
subject := httpmw.UserAuthorization(ctx)
|
|
obj := project.RBACObject()
|
|
// Denials are expected here, so this skips api.Authorize, which logs
|
|
// each one as a warning.
|
|
can := func(action policy.Action) bool {
|
|
return api.HTTPAuth.Authorizer.Authorize(ctx, subject, action, obj) == nil
|
|
}
|
|
return db2sdk.ChatProject(project, codersdk.ChatProjectPermissions{
|
|
Update: can(policy.ActionUpdate),
|
|
Delete: can(policy.ActionDelete),
|
|
Share: can(policy.ActionShare),
|
|
})
|
|
}
|
|
|
|
// maxChatProjectsPerOwner caps how many projects one user owns across all
|
|
// organizations.
|
|
const maxChatProjectsPerOwner = 100
|
|
|
|
var errChatProjectLimit = xerrors.New("chat project limit reached")
|
|
|
|
const (
|
|
// The project name is embedded in every generation's system prompt and
|
|
// memory tool descriptions, so it is kept short.
|
|
chatProjectNameMaxChars = 64
|
|
chatProjectDescriptionMaxChars = 1024
|
|
chatProjectIconMaxChars = 256
|
|
)
|
|
|
|
// validateChatProjectFields writes a 400 response and returns false when a
|
|
// sanitized field exceeds its limit.
|
|
func validateChatProjectFields(ctx context.Context, rw http.ResponseWriter, name, description, icon string) bool {
|
|
if utf8.RuneCountInString(name) > chatProjectNameMaxChars {
|
|
writeChatProjectFieldError(ctx, rw, "name", fmt.Sprintf("Name must be at most %d characters.", chatProjectNameMaxChars))
|
|
return false
|
|
}
|
|
if utf8.RuneCountInString(description) > chatProjectDescriptionMaxChars {
|
|
writeChatProjectFieldError(ctx, rw, "description", fmt.Sprintf("Description must be at most %d characters.", chatProjectDescriptionMaxChars))
|
|
return false
|
|
}
|
|
if utf8.RuneCountInString(icon) > chatProjectIconMaxChars {
|
|
writeChatProjectFieldError(ctx, rw, "icon", fmt.Sprintf("Icon must be at most %d characters.", chatProjectIconMaxChars))
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
|
|
func writeChatProjectFieldError(ctx context.Context, rw http.ResponseWriter, field, detail string) {
|
|
httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
|
|
Message: detail,
|
|
Validations: []codersdk.ValidationError{{Field: field, Detail: detail}},
|
|
})
|
|
}
|