fleet/server/datastore/mysql/invites.go
Victor Lyuboslavsky ea47ebfb32
Enabled support and validation of 'after' parameter for several endpoints (#15047)
Loom explaining changes:
https://www.loom.com/share/f05f241a77304c19bc6ba1d0702c7bd8?sid=ea86b282-0bda-4ba4-a6cf-4520f0db610d

#14571 

Enabled support and validation of 'after' parameter for the following
endpoints:
- GET /api/v1/fleet/carves

Setting 'after' parameter no longer returns SQL syntax error for the
following endpoints:
- GET /api/v1/fleet/carves
- GET /api/v1/fleet/invites
- GET /api/v1/fleet/labels
- GET /api/v1/fleet/packs
- GET /api/v1/fleet/global/policies
- GET /api/v1/fleet/teams/{id}/policies
- GET /api/v1/fleet/queries
- GET /api/v1/fleet/packs/{id}/scheduled
- GET /api/v1/fleet/teams
- GET /api/v1/fleet/users

API doc changes PR: https://github.com/fleetdm/fleet/pull/15061

- [x] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-09 13:18:29 -06:00

209 lines
6.6 KiB
Go

package mysql
import (
"context"
"database/sql"
"fmt"
"strings"
"github.com/fleetdm/fleet/v4/server/contexts/ctxerr"
"github.com/fleetdm/fleet/v4/server/fleet"
"github.com/jmoiron/sqlx"
)
var inviteSearchColumns = []string{"name", "email"}
// NewInvite generates a new invitation.
func (ds *Datastore) NewInvite(ctx context.Context, i *fleet.Invite) (*fleet.Invite, error) {
if err := fleet.ValidateRole(i.GlobalRole.Ptr(), i.Teams); err != nil {
return nil, err
}
err := ds.withRetryTxx(ctx, func(tx sqlx.ExtContext) error {
sqlStmt := `
INSERT INTO invites ( invited_by, email, name, position, token, sso_enabled, global_role )
VALUES ( ?, ?, ?, ?, ?, ?, ?)
`
result, err := tx.ExecContext(ctx, sqlStmt, i.InvitedBy, i.Email,
i.Name, i.Position, i.Token, i.SSOEnabled, i.GlobalRole)
if err != nil && isDuplicate(err) {
return ctxerr.Wrap(ctx, alreadyExists("Invite", i.Email))
} else if err != nil {
return ctxerr.Wrap(ctx, err, "create invite")
}
id, _ := result.LastInsertId()
i.ID = uint(id)
if len(i.Teams) == 0 {
i.Teams = []fleet.UserTeam{}
return nil
}
// Bulk insert teams
const valueStr = "(?,?,?),"
var args []interface{}
for _, userTeam := range i.Teams {
args = append(args, i.ID, userTeam.Team.ID, userTeam.Role)
}
sql := "INSERT INTO invite_teams (invite_id, team_id, role) VALUES " +
strings.Repeat(valueStr, len(i.Teams))
sql = strings.TrimSuffix(sql, ",")
if _, err := tx.ExecContext(ctx, sql, args...); err != nil {
return ctxerr.Wrap(ctx, err, "insert teams")
}
return nil
})
if err != nil {
return nil, err
}
return i, nil
}
// ListInvites lists all invites in the Fleet database. Supply query options
// using the opt parameter. See fleet.ListOptions
func (ds *Datastore) ListInvites(ctx context.Context, opt fleet.ListOptions) ([]*fleet.Invite, error) {
invites := []*fleet.Invite{}
query := "SELECT * FROM invites WHERE true"
query, params := searchLike(query, nil, opt.MatchQuery, inviteSearchColumns...)
query, params = appendListOptionsWithCursorToSQL(query, params, &opt)
err := sqlx.SelectContext(ctx, ds.reader(ctx), &invites, query, params...)
if err == sql.ErrNoRows {
return nil, ctxerr.Wrap(ctx, notFound("Invite"))
} else if err != nil {
return nil, ctxerr.Wrap(ctx, err, "select invite by ID")
}
if err := ds.loadTeamsForInvites(ctx, invites); err != nil {
return nil, ctxerr.Wrap(ctx, err, "load teams")
}
return invites, nil
}
// Invite returns Invite identified by id.
func (ds *Datastore) Invite(ctx context.Context, id uint) (*fleet.Invite, error) {
var invite fleet.Invite
err := sqlx.GetContext(ctx, ds.reader(ctx), &invite, "SELECT * FROM invites WHERE id = ?", id)
if err == sql.ErrNoRows {
return nil, ctxerr.Wrap(ctx, notFound("Invite").WithID(id))
} else if err != nil {
return nil, ctxerr.Wrap(ctx, err, "select invite by ID")
}
if err := ds.loadTeamsForInvites(ctx, []*fleet.Invite{&invite}); err != nil {
return nil, ctxerr.Wrap(ctx, err, "load teams")
}
return &invite, nil
}
// InviteByEmail finds an Invite with a particular email, if one exists.
func (ds *Datastore) InviteByEmail(ctx context.Context, email string) (*fleet.Invite, error) {
var invite fleet.Invite
err := sqlx.GetContext(ctx, ds.reader(ctx), &invite, "SELECT * FROM invites WHERE email = ?", email)
if err == sql.ErrNoRows {
return nil, ctxerr.Wrap(ctx, notFound("Invite").
WithMessage(fmt.Sprintf("with email %s", email)))
} else if err != nil {
return nil, ctxerr.Wrap(ctx, err, "sqlx get invite by email")
}
if err := ds.loadTeamsForInvites(ctx, []*fleet.Invite{&invite}); err != nil {
return nil, ctxerr.Wrap(ctx, err, "load teams")
}
return &invite, nil
}
// InviteByToken finds an Invite with a particular token, if one exists.
func (ds *Datastore) InviteByToken(ctx context.Context, token string) (*fleet.Invite, error) {
var invite fleet.Invite
err := sqlx.GetContext(ctx, ds.reader(ctx), &invite, "SELECT * FROM invites WHERE token = ?", token)
if err == sql.ErrNoRows {
return nil, ctxerr.Wrap(ctx, notFound("Invite").
WithMessage(fmt.Sprintf("with token %s", token)))
} else if err != nil {
return nil, ctxerr.Wrap(ctx, err, "sqlx get invite by token")
}
if err := ds.loadTeamsForInvites(ctx, []*fleet.Invite{&invite}); err != nil {
return nil, ctxerr.Wrap(ctx, err, "load teams")
}
return &invite, nil
}
func (ds *Datastore) DeleteInvite(ctx context.Context, id uint) error {
return ds.deleteEntity(ctx, invitesTable, id)
}
func (ds *Datastore) loadTeamsForInvites(ctx context.Context, invites []*fleet.Invite) error {
inviteIDs := make([]uint, 0, len(invites)+1)
// Make sure the slice is never empty for IN by filling a nonexistent ID
inviteIDs = append(inviteIDs, 0)
idToInvite := make(map[uint]*fleet.Invite, len(invites))
for _, u := range invites {
// Initialize empty slice so we get an array in JSON responses instead
// of null if it is empty
u.Teams = []fleet.UserTeam{}
// Track IDs for queries and matching
inviteIDs = append(inviteIDs, u.ID)
idToInvite[u.ID] = u
}
sql := `
SELECT ut.team_id AS id, ut.invite_id, ut.role, t.name
FROM invite_teams ut INNER JOIN teams t ON ut.team_id = t.id
WHERE ut.invite_id IN (?)
ORDER BY invite_id, team_id
`
sql, args, err := sqlx.In(sql, inviteIDs)
if err != nil {
return ctxerr.Wrap(ctx, err, "sqlx.In loadTeamsForInvites")
}
var rows []struct {
fleet.UserTeam
InviteID uint `db:"invite_id"`
}
if err := sqlx.SelectContext(ctx, ds.reader(ctx), &rows, sql, args...); err != nil {
return ctxerr.Wrap(ctx, err, "get loadTeamsForInvites")
}
// Map each row to the appropriate invite
for _, r := range rows {
invite := idToInvite[r.InviteID]
invite.Teams = append(invite.Teams, r.UserTeam)
}
return nil
}
func (ds *Datastore) UpdateInvite(ctx context.Context, id uint, i *fleet.Invite) (*fleet.Invite, error) {
return i, ds.withRetryTxx(ctx, func(tx sqlx.ExtContext) error {
_, err := tx.ExecContext(ctx,
`UPDATE invites SET invited_by = ?, email = ?, name = ?, position = ?, sso_enabled = ?, global_role = ? WHERE id = ?`,
i.InvitedBy, i.Email, i.Name, i.Position, i.SSOEnabled, i.GlobalRole, id,
)
if err != nil {
return ctxerr.Wrap(ctx, err, "updating invite")
}
_, err = tx.ExecContext(ctx, `DELETE FROM invite_teams WHERE invite_id = ?`, id)
if err != nil {
return ctxerr.Wrap(ctx, err, "deleting invite teams")
}
for _, team := range i.Teams {
_, err = tx.ExecContext(ctx, `INSERT INTO invite_teams(invite_id, team_id, role) VALUES(?, ?, ?)`, id, team.ID, team.Role)
if err != nil {
return ctxerr.Wrap(ctx, err, "updating invite teams")
}
}
return nil
})
}