Skip to content

Hide build logs older than 30 days #4436

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 9, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
7 changes: 5 additions & 2 deletions coderd/database/databasefake/databasefake.go
Original file line number Diff line number Diff line change
Expand Up @@ -821,14 +821,17 @@ func (q *fakeQuerier) GetLatestWorkspaceBuildsByWorkspaceIDs(_ context.Context,
return returnBuilds, nil
}

func (q *fakeQuerier) GetWorkspaceBuildByWorkspaceID(_ context.Context,
params database.GetWorkspaceBuildByWorkspaceIDParams,
func (q *fakeQuerier) GetWorkspaceBuildsByWorkspaceID(_ context.Context,
params database.GetWorkspaceBuildsByWorkspaceIDParams,
) ([]database.WorkspaceBuild, error) {
q.mutex.RLock()
defer q.mutex.RUnlock()

history := make([]database.WorkspaceBuild, 0)
for _, workspaceBuild := range q.workspaceBuilds {
if workspaceBuild.CreatedAt.Before(params.Since) {
continue
}
if workspaceBuild.WorkspaceID.String() == params.WorkspaceID.String() {
history = append(history, workspaceBuild)
}
Expand Down
2 changes: 1 addition & 1 deletion coderd/database/querier.go

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

23 changes: 13 additions & 10 deletions coderd/database/queries.sql.go

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

3 changes: 2 additions & 1 deletion coderd/database/queries/workspacebuilds.sql
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,14 @@ WHERE
workspace_id = $1
AND build_number = $2;

-- name: GetWorkspaceBuildByWorkspaceID :many
-- name: GetWorkspaceBuildsByWorkspaceID :many
SELECT
*
FROM
workspace_builds
WHERE
workspace_builds.workspace_id = $1
AND workspace_builds.created_at > @since
AND CASE
-- This allows using the last element on a page as effectively a cursor.
-- This is an important option for scripts that need to paginate without
Expand Down
15 changes: 6 additions & 9 deletions coderd/workspaceapps_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -299,10 +299,9 @@ func TestWorkspaceApplicationAuth(t *testing.T) {
require.Equal(t, u.String(), gotLocation.Query().Get("redirect_uri"))

// Load the application auth-redirect endpoint.
qp := codersdk.WithQueryParams(map[string]string{
"redirect_uri": u.String(),
})
resp, err = client.Request(ctx, http.MethodGet, "/api/v2/applications/auth-redirect", nil, qp)
resp, err = client.Request(ctx, http.MethodGet, "/api/v2/applications/auth-redirect", nil, codersdk.WithQueryParam(
"redirect_uri", u.String(),
))
require.NoError(t, err)
defer resp.Body.Close()

Expand Down Expand Up @@ -434,15 +433,13 @@ func TestWorkspaceApplicationAuth(t *testing.T) {
c := c
t.Run(c.name, func(t *testing.T) {
t.Parallel()
qp := map[string]string{}
if c.redirectURI != "" {
qp["redirect_uri"] = c.redirectURI
}

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancel()

resp, err := client.Request(ctx, http.MethodGet, "/api/v2/applications/auth-redirect", nil, codersdk.WithQueryParams(qp))
resp, err := client.Request(ctx, http.MethodGet, "/api/v2/applications/auth-redirect", nil,
codersdk.WithQueryParam("redirect_uri", c.redirectURI),
)
require.NoError(t, err)
defer resp.Body.Close()
require.Equal(t, http.StatusBadRequest, resp.StatusCode)
Expand Down
21 changes: 19 additions & 2 deletions coderd/workspacebuilds.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"fmt"
"net/http"
"strconv"
"time"

"github.com/go-chi/chi/v5"
"github.com/google/uuid"
Expand Down Expand Up @@ -75,6 +76,21 @@ func (api *API) workspaceBuilds(rw http.ResponseWriter, r *http.Request) {
return
}

var since time.Time

sinceParam := r.URL.Query().Get("since")
if sinceParam != "" {
var err error
since, err = time.Parse(time.RFC3339, sinceParam)
if err != nil {
httpapi.Write(r.Context(), rw, http.StatusBadRequest, codersdk.Response{
Message: "bad `since` format, must be RFC3339",
Detail: err.Error(),
})
return
}
}

var workspaceBuilds []database.WorkspaceBuild
// Ensure all db calls happen in the same tx
err := api.Database.InTx(func(store database.Store) error {
Expand All @@ -97,13 +113,14 @@ func (api *API) workspaceBuilds(rw http.ResponseWriter, r *http.Request) {
}
}

req := database.GetWorkspaceBuildByWorkspaceIDParams{
req := database.GetWorkspaceBuildsByWorkspaceIDParams{
WorkspaceID: workspace.ID,
AfterID: paginationParams.AfterID,
OffsetOpt: int32(paginationParams.Offset),
LimitOpt: int32(paginationParams.Limit),
Since: database.Time(since),
}
workspaceBuilds, err = store.GetWorkspaceBuildByWorkspaceID(ctx, req)
workspaceBuilds, err = store.GetWorkspaceBuildsByWorkspaceID(ctx, req)
if xerrors.Is(err, sql.ErrNoRows) {
err = nil
}
Expand Down
13 changes: 13 additions & 0 deletions coderd/workspacebuilds_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,19 @@ func TestWorkspaceBuilds(t *testing.T) {
require.Equal(t, int32(1), builds[0].BuildNumber)
require.Equal(t, user.Username, builds[0].InitiatorUsername)
require.NoError(t, err)

// Test since
builds, err = client.WorkspaceBuilds(ctx,
codersdk.WorkspaceBuildsRequest{WorkspaceID: workspace.ID, Since: database.Now().Add(time.Minute)},
)
require.NoError(t, err)
require.Len(t, builds, 0)

builds, err = client.WorkspaceBuilds(ctx,
codersdk.WorkspaceBuildsRequest{WorkspaceID: workspace.ID, Since: database.Now().Add(-time.Hour)},
)
require.NoError(t, err)
require.Len(t, builds, 1)
})

t.Run("PaginateNonExistentRow", func(t *testing.T) {
Expand Down
9 changes: 5 additions & 4 deletions codersdk/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,13 @@ type Client struct {

type RequestOption func(*http.Request)

func WithQueryParams(params map[string]string) RequestOption {
func WithQueryParam(key, value string) RequestOption {
return func(r *http.Request) {
q := r.URL.Query()
for k, v := range params {
q.Add(k, v)
if value == "" {
return
}
q := r.URL.Query()
q.Add(key, value)
r.URL.RawQuery = q.Encode()
}
}
Expand Down
8 changes: 6 additions & 2 deletions codersdk/workspaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,15 @@ func (c *Client) getWorkspace(ctx context.Context, id uuid.UUID, opts ...Request
type WorkspaceBuildsRequest struct {
WorkspaceID uuid.UUID
Pagination
Since time.Time
}

func (c *Client) WorkspaceBuilds(ctx context.Context, req WorkspaceBuildsRequest) ([]WorkspaceBuild, error) {
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/workspaces/%s/builds", req.WorkspaceID),
nil, req.Pagination.asRequestOption())
res, err := c.Request(
ctx, http.MethodGet,
fmt.Sprintf("/api/v2/workspaces/%s/builds", req.WorkspaceID),
nil, req.Pagination.asRequestOption(), WithQueryParam("since", req.Since.Format(time.RFC3339)),
)
if err != nil {
return nil, err
}
Expand Down
3 changes: 2 additions & 1 deletion site/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -406,9 +406,10 @@ export const regenerateUserSSHKey = async (userId = "me"): Promise<TypesGen.GitS

export const getWorkspaceBuilds = async (
workspaceId: string,
since: Date,
): Promise<TypesGen.WorkspaceBuild[]> => {
const response = await axios.get<TypesGen.WorkspaceBuild[]>(
`/api/v2/workspaces/${workspaceId}/builds`,
`/api/v2/workspaces/${workspaceId}/builds?since=${since.toISOString()}`,
)
return response.data
}
Expand Down
1 change: 1 addition & 0 deletions site/src/api/typesGenerated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,7 @@ export interface WorkspaceBuild {
// From codersdk/workspaces.go
export interface WorkspaceBuildsRequest extends Pagination {
readonly WorkspaceID: string
readonly Since: string
}

// From codersdk/workspaces.go
Expand Down
8 changes: 7 additions & 1 deletion site/src/xServices/workspace/workspaceXService.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { getErrorMessage } from "api/errors"
import dayjs from "dayjs"
import { workspaceScheduleBannerMachine } from "xServices/workspaceSchedule/workspaceScheduleBannerXService"
import { assign, createMachine, send } from "xstate"
import * as API from "../../api/api"
Expand Down Expand Up @@ -670,7 +671,12 @@ export const workspaceMachine = createMachine(
},
getBuilds: async (context) => {
if (context.workspace) {
return await API.getWorkspaceBuilds(context.workspace.id)
// For now, we only retrieve the last month of builds to minimize
// page bloat. We should add pagination in the future.
return await API.getWorkspaceBuilds(
context.workspace.id,
dayjs().add(-30, "day").toDate(),
)
} else {
throw Error("Cannot get builds without id")
}
Expand Down