Merge branch 'coder:main' into main

.github/workflows/ci.yaml

@@ -271,6 +271,15 @@ jobs:
         # coderd/rbac/object_gen.go:1:1: syntax error: package statement must be first
         run: "make --output-sync -B gen"
 
+      - name: make update-golden-files
+        run: |
+          make clean/golden-files
+          # Notifications require DB, we could start a DB instance here but
+          # let's just restore for now.
+          git checkout -- coderd/notifications/testdata/rendered-templates
+          # As above, skip `-j` flag.
+          make --output-sync -B update-golden-files
+
       - name: Check for unstaged files
         run: ./scripts/check_unstaged.sh
 

.github/workflows/typos.toml

@@ -35,7 +35,6 @@ extend-exclude = [
 	# These files contain base64 strings that confuse the detector
 	"**XService**.ts",
 	"**identity.go",
-	"scripts/ci-report/testdata/**",
 	"**/*_test.go",
 	"**/*.test.tsx",
 	"**/pnpm-lock.yaml",

CONTRIBUTING.md

@@ -0,0 +1 @@
+https://coder.com/docs/CONTRIBUTING

Makefile

@@ -422,7 +422,9 @@ fmt/go:
 	echo "$(GREEN)==>$(RESET) $(BOLD)fmt/go$(RESET)"
 	# VS Code users should check out
 	# https://github.com/mvdan/gofumpt#visual-studio-code
-	go run mvdan.cc/gofumpt@v0.4.0 -w -l .
+	find . $(FIND_EXCLUSIONS) -type f -name '*.go' -print0 | \
+		xargs -0 grep --null -L "DO NOT EDIT" | \
+		xargs -0 go run mvdan.cc/gofumpt@v0.4.0 -w -l
 .PHONY: fmt/go
 
 fmt/ts:
@@ -511,9 +513,7 @@ TAILNETTEST_MOCKS := \
 	tailnet/tailnettest/workspaceupdatesprovidermock.go \
 	tailnet/tailnettest/subscriptionmock.go
 
-
-# all gen targets should be added here and to gen/mark-fresh
-gen: \
+GEN_FILES := \
 	tailnet/proto/tailnet.pb.go \
 	agent/proto/agent.pb.go \
 	provisionersdk/proto/provisioner.pb.go \
@@ -538,8 +538,14 @@ gen: \
 	examples/examples.gen.json \
 	$(TAILNETTEST_MOCKS) \
 	coderd/database/pubsub/psmock/psmock.go
+
+# all gen targets should be added here and to gen/mark-fresh
+gen: $(GEN_FILES)
 .PHONY: gen
 
+gen/db: $(DB_GEN_FILES)
+.PHONY: gen/db
+
 # Mark all generated files as fresh so make thinks they're up-to-date. This is
 # used during releases so we don't run generation scripts.
 gen/mark-fresh:
@@ -696,19 +702,33 @@ coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS)
 
 update-golden-files: \
 	cli/testdata/.gen-golden \
-	helm/coder/tests/testdata/.gen-golden \
-	helm/provisioner/tests/testdata/.gen-golden \
-	scripts/ci-report/testdata/.gen-golden \
-	enterprise/cli/testdata/.gen-golden \
-	enterprise/tailnet/testdata/.gen-golden \
-	tailnet/testdata/.gen-golden \
 	coderd/.gen-golden \
 	coderd/notifications/.gen-golden \
-	provisioner/terraform/testdata/.gen-golden
+	enterprise/cli/testdata/.gen-golden \
+	enterprise/tailnet/testdata/.gen-golden \
+	helm/coder/tests/testdata/.gen-golden \
+	helm/provisioner/tests/testdata/.gen-golden \
+	provisioner/terraform/testdata/.gen-golden \
+	tailnet/testdata/.gen-golden
 .PHONY: update-golden-files
 
+clean/golden-files:
+	find . -type f -name '.gen-golden' -delete
+	find \
+		cli/testdata \
+		coderd/notifications/testdata \
+		coderd/testdata \
+		enterprise/cli/testdata \
+		enterprise/tailnet/testdata \
+		helm/coder/tests/testdata \
+		helm/provisioner/tests/testdata \
+		provisioner/terraform/testdata \
+		tailnet/testdata \
+		-type f -name '*.golden' -delete
+.PHONY: clean/golden-files
+
 cli/testdata/.gen-golden: $(wildcard cli/testdata/*.golden) $(wildcard cli/*.tpl) $(GO_SRC_FILES) $(wildcard cli/*_test.go)
-	go test ./cli -run="Test(CommandHelp|ServerYAML|ErrorExamples)" -update
+	go test ./cli -run="Test(CommandHelp|ServerYAML|ErrorExamples|.*Golden)" -update
 	touch "$@"
 
 enterprise/cli/testdata/.gen-golden: $(wildcard enterprise/cli/testdata/*.golden) $(wildcard cli/*.tpl) $(GO_SRC_FILES) $(wildcard enterprise/cli/*_test.go)
@@ -749,10 +769,6 @@ provisioner/terraform/testdata/version:
 	fi
 .PHONY: provisioner/terraform/testdata/version
 
-scripts/ci-report/testdata/.gen-golden: $(wildcard scripts/ci-report/testdata/*) $(wildcard scripts/ci-report/*.go)
-	go test ./scripts/ci-report -run=TestOutputMatchesGoldenFile -update
-	touch "$@"
-
 # Combine .gitignore with .prettierignore.include to generate .prettierignore.
 .prettierignore: .gitignore .prettierignore.include
 	echo "# Code generated by Makefile ($^). DO NOT EDIT." > "$@"

apiversion/doc.go

@@ -0,0 +1,26 @@
+// Package apiversion provides an API version type that can be used to validate
+// compatibility between two API versions.
+//
+// NOTE: API VERSIONS ARE NOT SEMANTIC VERSIONS.
+//
+// API versions are represented as major.minor where major and minor are both
+// positive integers.
+//
+// API versions are not directly tied to a specific release of the software.
+// Instead, they are used to represent the capabilities of the server. For
+// example, a server that supports API version 1.2 should be able to handle
+// requests from clients that support API version 1.0, 1.1, or 1.2.
+// However, a server that supports API version 2.0 is not required to handle
+// requests from clients that support API version 1.x.
+// Clients may need to negotiate with the server to determine the highest
+// supported API version.
+//
+// When making a change to the API, use the following rules to determine the
+// next API version:
+//  1. If the change is backward-compatible, increment the minor version.
+//     Examples of backward-compatible changes include adding new fields to
+//     a response or adding new endpoints.
+//  2. If the change is not backward-compatible, increment the major version.
+//     Examples of non-backward-compatible changes include removing or renaming
+//     fields.
+package apiversion

cli/cliui/table.go

@@ -9,6 +9,8 @@ import (
 	"github.com/fatih/structtag"
 	"github.com/jedib0t/go-pretty/v6/table"
 	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/v2/codersdk"
 )
 
 // Table creates a new table with standardized styles.
@@ -195,6 +197,12 @@ func renderTable(out any, sort string, headers table.Row, filterColumns []string
 				if val != nil {
 					v = val.Format(time.RFC3339)
 				}
+			case codersdk.NullTime:
+				if val.Valid {
+					v = val.Time.Format(time.RFC3339)
+				} else {
+					v = nil
+				}
 			case *int64:
 				if val != nil {
 					v = *val
@@ -204,8 +212,13 @@ func renderTable(out any, sort string, headers table.Row, filterColumns []string
 					v = val.String()
 				}
 			case fmt.Stringer:
-				if val != nil {
+				// Protect against typed nils since fmt.Stringer is an interface.
+				vv := reflect.ValueOf(v)
+				nilPtr := vv.Kind() == reflect.Ptr && vv.IsNil()
+				if val != nil && !nilPtr {
 					v = val.String()
+				} else if nilPtr {
+					v = nil
 				}
 			}
 

cli/cliui/table_test.go

@@ -1,6 +1,7 @@
 package cliui_test
 
 import (
+	"database/sql"
 	"fmt"
 	"log"
 	"strings"
@@ -11,6 +12,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/coder/coder/v2/cli/cliui"
+	"github.com/coder/coder/v2/codersdk"
 )
 
 type stringWrapper struct {
@@ -24,18 +26,20 @@ func (s stringWrapper) String() string {
 }
 
 type tableTest1 struct {
-	Name        string      `table:"name,default_sort"`
-	NotIncluded string      // no table tag
-	Age         int         `table:"age"`
-	Roles       []string    `table:"roles"`
-	Sub1        tableTest2  `table:"sub_1,recursive"`
-	Sub2        *tableTest2 `table:"sub_2,recursive"`
-	Sub3        tableTest3  `table:"sub 3,recursive"`
-	Sub4        tableTest2  `table:"sub 4"` // not recursive
+	Name        string         `table:"name,default_sort"`
+	AltName     *stringWrapper `table:"alt_name"`
+	NotIncluded string         // no table tag
+	Age         int            `table:"age"`
+	Roles       []string       `table:"roles"`
+	Sub1        tableTest2     `table:"sub_1,recursive"`
+	Sub2        *tableTest2    `table:"sub_2,recursive"`
+	Sub3        tableTest3     `table:"sub 3,recursive"`
+	Sub4        tableTest2     `table:"sub 4"` // not recursive
 
 	// Types with special formatting.
-	Time    time.Time  `table:"time"`
-	TimePtr *time.Time `table:"time_ptr"`
+	Time     time.Time         `table:"time"`
+	TimePtr  *time.Time        `table:"time_ptr"`
+	NullTime codersdk.NullTime `table:"null_time"`
 }
 
 type tableTest2 struct {
@@ -62,9 +66,10 @@ func Test_DisplayTable(t *testing.T) {
 	// Not sorted by name or age to test sorting.
 	in := []tableTest1{
 		{
-			Name:  "bar",
-			Age:   20,
-			Roles: []string{"a"},
+			Name:    "bar",
+			AltName: &stringWrapper{str: "bar alt"},
+			Age:     20,
+			Roles:   []string{"a"},
 			Sub1: tableTest2{
 				Name: stringWrapper{str: "bar1"},
 				Age:  21,
@@ -82,6 +87,12 @@ func Test_DisplayTable(t *testing.T) {
 			},
 			Time:    someTime,
 			TimePtr: nil,
+			NullTime: codersdk.NullTime{
+				NullTime: sql.NullTime{
+					Time:  someTime,
+					Valid: true,
+				},
+			},
 		},
 		{
 			Name:  "foo",
@@ -138,10 +149,10 @@ func Test_DisplayTable(t *testing.T) {
 		t.Parallel()
 
 		expected := `
-NAME  AGE  ROLES      SUB 1 NAME  SUB 1 AGE  SUB 2 NAME  SUB 2 AGE  SUB 3 INNER NAME  SUB 3 INNER AGE  SUB 4       TIME                  TIME PTR
-bar    20  [a]        bar1               21  <nil>       <nil>      bar3                           23  {bar4 24 }  2022-08-02T15:49:10Z  <nil>
-baz    30  []         baz1               31  <nil>       <nil>      baz3                           33  {baz4 34 }  2022-08-02T15:49:10Z  <nil>
-foo    10  [a, b, c]  foo1               11  foo2        12         foo3                           13  {foo4 14 }  2022-08-02T15:49:10Z  2022-08-02T15:49:10Z
+NAME  ALT NAME  AGE  ROLES      SUB 1 NAME  SUB 1 AGE  SUB 2 NAME  SUB 2 AGE  SUB 3 INNER NAME  SUB 3 INNER AGE  SUB 4       TIME                  TIME PTR              NULL TIME
+bar   bar alt    20  [a]        bar1               21  <nil>       <nil>      bar3                           23  {bar4 24 }  2022-08-02T15:49:10Z  <nil>                 2022-08-02T15:49:10Z
+baz   <nil>      30  []         baz1               31  <nil>       <nil>      baz3                           33  {baz4 34 }  2022-08-02T15:49:10Z  <nil>                 <nil>
+foo   <nil>      10  [a, b, c]  foo1               11  foo2        12         foo3                           13  {foo4 14 }  2022-08-02T15:49:10Z  2022-08-02T15:49:10Z  <nil>
 		`
 
 		// Test with non-pointer values.
@@ -165,10 +176,10 @@ foo    10  [a, b, c]  foo1               11  foo2        12         foo3
 		t.Parallel()
 
 		expected := `
-NAME  AGE  ROLES      SUB 1 NAME  SUB 1 AGE  SUB 2 NAME  SUB 2 AGE  SUB 3 INNER NAME  SUB 3 INNER AGE  SUB 4       TIME                  TIME PTR
-foo    10  [a, b, c]  foo1               11  foo2        12         foo3                           13  {foo4 14 }  2022-08-02T15:49:10Z  2022-08-02T15:49:10Z
-bar    20  [a]        bar1               21  <nil>       <nil>      bar3                           23  {bar4 24 }  2022-08-02T15:49:10Z  <nil>
-baz    30  []         baz1               31  <nil>       <nil>      baz3                           33  {baz4 34 }  2022-08-02T15:49:10Z  <nil>
+NAME  ALT NAME  AGE  ROLES      SUB 1 NAME  SUB 1 AGE  SUB 2 NAME  SUB 2 AGE  SUB 3 INNER NAME  SUB 3 INNER AGE  SUB 4       TIME                  TIME PTR              NULL TIME
+foo   <nil>      10  [a, b, c]  foo1               11  foo2        12         foo3                           13  {foo4 14 }  2022-08-02T15:49:10Z  2022-08-02T15:49:10Z  <nil>
+bar   bar alt    20  [a]        bar1               21  <nil>       <nil>      bar3                           23  {bar4 24 }  2022-08-02T15:49:10Z  <nil>                 2022-08-02T15:49:10Z
+baz   <nil>      30  []         baz1               31  <nil>       <nil>      baz3                           33  {baz4 34 }  2022-08-02T15:49:10Z  <nil>                 <nil>
 		`
 
 		out, err := cliui.DisplayTable(in, "age", nil)
@@ -235,12 +246,12 @@ Alice   25
 	t.Run("WithSeparator", func(t *testing.T) {
 		t.Parallel()
 		expected := `
-NAME  AGE  ROLES      SUB 1 NAME  SUB 1 AGE  SUB 2 NAME  SUB 2 AGE  SUB 3 INNER NAME  SUB 3 INNER AGE  SUB 4       TIME                  TIME PTR
-bar    20  [a]        bar1               21  <nil>       <nil>      bar3                           23  {bar4 24 }  2022-08-02T15:49:10Z  <nil>
----------------------------------------------------------------------------------------------------------------------------------------------------------------
-baz    30  []         baz1               31  <nil>       <nil>      baz3                           33  {baz4 34 }  2022-08-02T15:49:10Z  <nil>
----------------------------------------------------------------------------------------------------------------------------------------------------------------
-foo    10  [a, b, c]  foo1               11  foo2        12         foo3                           13  {foo4 14 }  2022-08-02T15:49:10Z  2022-08-02T15:49:10Z
+NAME  ALT NAME  AGE  ROLES      SUB 1 NAME  SUB 1 AGE  SUB 2 NAME  SUB 2 AGE  SUB 3 INNER NAME  SUB 3 INNER AGE  SUB 4       TIME                  TIME PTR              NULL TIME
+bar   bar alt    20  [a]        bar1               21  <nil>       <nil>      bar3                           23  {bar4 24 }  2022-08-02T15:49:10Z  <nil>                 2022-08-02T15:49:10Z
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+baz   <nil>      30  []         baz1               31  <nil>       <nil>      baz3                           33  {baz4 34 }  2022-08-02T15:49:10Z  <nil>                 <nil>
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+foo   <nil>      10  [a, b, c]  foo1               11  foo2        12         foo3                           13  {foo4 14 }  2022-08-02T15:49:10Z  2022-08-02T15:49:10Z  <nil>
 		`
 
 		var inlineIn []any

coderd/database/dbtestutil/postgres.go

@@ -464,14 +464,14 @@ func openContainer(t TBSubset, opts DBContainerOptions) (container, func(), erro
 // The user is responsible for calling the returned cleanup function.
 func OpenContainerized(t TBSubset, opts DBContainerOptions) (string, func(), error) {
 	container, containerCleanup, err := openContainer(t, opts)
+	if err != nil {
+		return "", nil, xerrors.Errorf("open container: %w", err)
+	}
 	defer func() {
 		if err != nil {
 			containerCleanup()
 		}
 	}()
-	if err != nil {
-		return "", nil, xerrors.Errorf("open container: %w", err)
-	}
 	dbURL := ConnectionParams{
 		Username: "postgres",
 		Password: "postgres",

coderd/database/migrations/000280_workspace_update_notification.down.sql

@@ -0,0 +1 @@
+DELETE FROM notification_templates WHERE id = 'd089fe7b-d5c5-4c0c-aaf5-689859f7d392';

coderd/database/migrations/000280_workspace_update_notification.up.sql

@@ -0,0 +1,30 @@
+INSERT INTO notification_templates
+	(id, name, title_template, body_template, "group", actions)
+VALUES (
+	'd089fe7b-d5c5-4c0c-aaf5-689859f7d392',
+	'Workspace Manually Updated',
+	E'Workspace ''{{.Labels.workspace}}'' has been manually updated',
+	E'Hello {{.UserName}},\n\n'||
+		E'A new workspace build has been manually created for your workspace **{{.Labels.workspace}}** by **{{.Labels.initiator}}** to update it to version **{{.Labels.version}}** of template **{{.Labels.template}}**.',
+    'Workspace Events',
+	'[
+		{
+			"label": "View workspace",
+			"url": "{{base_url}}/@{{.UserUsername}}/{{.Labels.workspace}}"
+		},
+		{
+			"label": "View template version",
+			"url": "{{base_url}}/templates/{{.Labels.organization}}/{{.Labels.template}}/versions/{{.Labels.version}}"
+		}
+	]'::jsonb
+);
+
+UPDATE notification_templates
+SET
+	actions = '[
+		{
+			"label": "View workspace",
+			"url": "{{base_url}}/@{{.UserUsername}}/{{.Labels.workspace}}"
+		}
+	]'::jsonb
+WHERE id = '281fdf73-c6d6-4cbb-8ff5-888baf8a2fff';

coderd/notifications/events.go

@@ -8,6 +8,7 @@ import "github.com/google/uuid"
 // Workspace-related events.
 var (
 	TemplateWorkspaceCreated           = uuid.MustParse("281fdf73-c6d6-4cbb-8ff5-888baf8a2fff")
+	TemplateWorkspaceManuallyUpdated   = uuid.MustParse("d089fe7b-d5c5-4c0c-aaf5-689859f7d392")
 	TemplateWorkspaceDeleted           = uuid.MustParse("f517da0b-cdc9-410f-ab89-a86107c420ed")
 	TemplateWorkspaceAutobuildFailed   = uuid.MustParse("381df2a9-c0c0-4749-420f-80a9280c66f9")
 	TemplateWorkspaceDormant           = uuid.MustParse("0ea69165-ec14-4314-91f1-69566ac3c5a0")

coderd/notifications/notifications_test.go

@@ -1048,6 +1048,22 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "TemplateWorkspaceManuallyUpdated",
+			id:   notifications.TemplateWorkspaceManuallyUpdated,
+			payload: types.MessagePayload{
+				UserName:     "Bobby",
+				UserEmail:    "bobby@coder.com",
+				UserUsername: "bobby",
+				Labels: map[string]string{
+					"organization": "bobby-organization",
+					"initiator":    "bobby",
+					"workspace":    "bobby-workspace",
+					"template":     "bobby-template",
+					"version":      "alpha",
+				},
+			},
+		},
 	}
 
 	// We must have a test case for every notification_template. This is enforced below: