Aug 5, 2024 · Aug 5, 2024 · Aug 5, 2024
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
 r.Route("/templates", func(r chi.Router) {
 r.Get("/system", api.systemNotificationTemplates)
 })
 r.Get("/dispatch-methods", api.notificationDispatchMethods)
 })
 })

diff --git a/coderd/notifications.go b/coderd/notifications.go
 httpapi.Write(r.Context(), rw, http.StatusOK, out)
 }

 // @Summary Get notification dispatch methods
 // @ID get-notification-dispatch-methods
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Notifications
 // @Success 200 {array} codersdk.NotificationMethodsResponse
 // @Router /notifications/dispatch-methods [get]
 func (api *API) notificationDispatchMethods(rw http.ResponseWriter, r *http.Request) {
 var methods []string
 for _, nm := range database.AllNotificationMethodValues() {
 methods = append(methods, string(nm))
 }

 httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.NotificationMethodsResponse{
 AvailableNotificationMethods: methods,
 DefaultNotificationMethod:    api.DeploymentValues.Notifications.Method.Value(),
 })
 }

 // @Summary Get user notification preferences
 // @ID get-user-notification-preferences
 // @Security CoderSessionToken
diff --git a/coderd/notifications_test.go b/coderd/notifications_test.go
 "testing"

 "github.com/stretchr/testify/require"
 "golang.org/x/exp/slices"

 "github.com/coder/serpent"

 "github.com/coder/coder/v2/coderd/coderdtest"
 "github.com/coder/coder/v2/coderd/database"
 "github.com/coder/coder/v2/coderd/notifications"
 "github.com/coder/coder/v2/codersdk"
 "github.com/coder/coder/v2/testutil"
 require.True(t, found, "dormant notification preference was not found")
 })
 }

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

 defaultOpts := createOpts(t)
 webhookOpts := createOpts(t)
 webhookOpts.DeploymentValues.Notifications.Method = serpent.String(database.NotificationMethodWebhook)

 tests := []struct {
 name            string
 opts            *coderdtest.Options
 expectedDefault string
 }{
 {
 name:            "default",
 opts:            defaultOpts,
 expectedDefault: string(database.NotificationMethodSmtp),
 },
 {
 name:            "non-default",
 opts:            webhookOpts,
 expectedDefault: string(database.NotificationMethodWebhook),
 },
 }

 var allMethods []string
 for _, nm := range database.AllNotificationMethodValues() {
 allMethods = append(allMethods, string(nm))
 }
 slices.Sort(allMethods)

 // nolint:paralleltest // Not since Go v1.22.
 for _, tc := range tests {
 t.Run(tc.name, func(t *testing.T) {
 t.Parallel()

 ctx := testutil.Context(t, testutil.WaitShort)
 api := coderdtest.New(t, tc.opts)
 _ = coderdtest.CreateFirstUser(t, api)

 resp, err := api.GetNotificationDispatchMethods(ctx)
 require.NoError(t, err)

 slices.Sort(resp.AvailableNotificationMethods)
 require.EqualValues(t, resp.AvailableNotificationMethods, allMethods)
 require.Equal(t, tc.expectedDefault, resp.DefaultNotificationMethod)
 })
 }
 }
diff --git a/codersdk/notifications.go b/codersdk/notifications.go
 Kind          string    `json:"kind"`
 }

 type NotificationMethodsResponse struct {
 AvailableNotificationMethods []string `json:"available"`
 DefaultNotificationMethod    string   `json:"default"`
 }

 type NotificationPreference struct {
 NotificationTemplateID uuid.UUID `json:"id" format:"uuid"`
 Disabled               bool      `json:"disabled"`
 return prefs, nil
 }

 // GetNotificationDispatchMethods the available and default notification dispatch methods.
 func (c *Client) GetNotificationDispatchMethods(ctx context.Context) (NotificationMethodsResponse, error) {
 res, err := c.Request(ctx, http.MethodGet, "/api/v2/notifications/dispatch-methods", nil)
 if err != nil {
 return NotificationMethodsResponse{}, err
 }
 defer res.Body.Close()

 if res.StatusCode != http.StatusOK {
 return NotificationMethodsResponse{}, ReadBodyAsError(res)
 }

 var resp NotificationMethodsResponse
 body, err := io.ReadAll(res.Body)
 if err != nil {
 return NotificationMethodsResponse{}, xerrors.Errorf("read response body: %w", err)
 }

 if err := json.Unmarshal(body, &resp); err != nil {
 return NotificationMethodsResponse{}, xerrors.Errorf("unmarshal response body: %w", err)
 }

 return resp, nil
 }

 type UpdateNotificationTemplateMethod struct {
 Method string `json:"method,omitempty" example:"webhook"`
 }
diff --git a/docs/api/notifications.md b/docs/api/notifications.md
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1258,6 +1258,7 @@ func New(options Options) API {
		r.Route("/templates", func(r chi.Router) {
		r.Get("/system", api.systemNotificationTemplates)
		})
		r.Get("/dispatch-methods", api.notificationDispatchMethods)
		})
		})

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -144,6 +144,25 @@ func (api API) systemNotificationTemplates(rw http.ResponseWriter, r http.Requ
		httpapi.Write(r.Context(), rw, http.StatusOK, out)
		}

		// @Summary Get notification dispatch methods
		// @ID get-notification-dispatch-methods
		// @Security CoderSessionToken
		// @Produce json
		// @Tags Notifications
		// @Success 200 {array} codersdk.NotificationMethodsResponse
		// @Router /notifications/dispatch-methods [get]
		func (api API) notificationDispatchMethods(rw http.ResponseWriter, r http.Request) {
		var methods []string
		for _, nm := range database.AllNotificationMethodValues() {
		methods = append(methods, string(nm))
		}

		httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.NotificationMethodsResponse{
		AvailableNotificationMethods: methods,
		DefaultNotificationMethod: api.DeploymentValues.Notifications.Method.Value(),
		})
		}

		// @Summary Get user notification preferences
		// @ID get-user-notification-preferences
		// @Security CoderSessionToken
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,8 +5,12 @@ import (
		"testing"

		"github.com/stretchr/testify/require"
		"golang.org/x/exp/slices"

		"github.com/coder/serpent"

		"github.com/coder/coder/v2/coderd/coderdtest"
		"github.com/coder/coder/v2/coderd/database"
		"github.com/coder/coder/v2/coderd/notifications"
		"github.com/coder/coder/v2/codersdk"
		"github.com/coder/coder/v2/testutil"
Expand DownExpand Up		@@ -265,3 +269,52 @@ func TestNotificationPreferences(t *testing.T) {
		require.True(t, found, "dormant notification preference was not found")
		})
		}

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

		defaultOpts := createOpts(t)
		webhookOpts := createOpts(t)
		webhookOpts.DeploymentValues.Notifications.Method = serpent.String(database.NotificationMethodWebhook)

		tests := []struct {
		name string
		opts *coderdtest.Options
		expectedDefault string
		}{
		{
		name: "default",
		opts: defaultOpts,
		expectedDefault: string(database.NotificationMethodSmtp),
		},
		{
		name: "non-default",
		opts: webhookOpts,
		expectedDefault: string(database.NotificationMethodWebhook),
		},
		}

		var allMethods []string
		for _, nm := range database.AllNotificationMethodValues() {
		allMethods = append(allMethods, string(nm))
		}
		slices.Sort(allMethods)

		// nolint:paralleltest // Not since Go v1.22.
		for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
		t.Parallel()

		ctx := testutil.Context(t, testutil.WaitShort)
		api := coderdtest.New(t, tc.opts)
		_ = coderdtest.CreateFirstUser(t, api)

		resp, err := api.GetNotificationDispatchMethods(ctx)
		require.NoError(t, err)

		slices.Sort(resp.AvailableNotificationMethods)
		require.EqualValues(t, resp.AvailableNotificationMethods, allMethods)
		require.Equal(t, tc.expectedDefault, resp.DefaultNotificationMethod)
		})
		}
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,6 +27,11 @@ type NotificationTemplate struct {
		Kind string `json:"kind"`
		}

		type NotificationMethodsResponse struct {
		AvailableNotificationMethods []string `json:"available"`
		DefaultNotificationMethod string `json:"default"`
		}

		type NotificationPreference struct {
		NotificationTemplateID uuid.UUID `json:"id" format:"uuid"`
		Disabled bool `json:"disabled"`
Expand DownExpand Up		@@ -162,6 +167,31 @@ func (c *Client) UpdateUserNotificationPreferences(ctx context.Context, userID u
		return prefs, nil
		}

		// GetNotificationDispatchMethods the available and default notification dispatch methods.
		func (c *Client) GetNotificationDispatchMethods(ctx context.Context) (NotificationMethodsResponse, error) {
		res, err := c.Request(ctx, http.MethodGet, "/api/v2/notifications/dispatch-methods", nil)
		if err != nil {
		return NotificationMethodsResponse{}, err
		}
		defer res.Body.Close()

		if res.StatusCode != http.StatusOK {
		return NotificationMethodsResponse{}, ReadBodyAsError(res)
		}

		var resp NotificationMethodsResponse
		body, err := io.ReadAll(res.Body)
		if err != nil {
		return NotificationMethodsResponse{}, xerrors.Errorf("read response body: %w", err)
		}

		if err := json.Unmarshal(body, &resp); err != nil {
		return NotificationMethodsResponse{}, xerrors.Errorf("unmarshal response body: %w", err)
		}

		return resp, nil
		}

		type UpdateNotificationTemplateMethod struct {
		Method string `json:"method,omitempty" example:"webhook"`
		}
Expand Down