Oct 1, 2024 · Oct 1, 2024 · Oct 1, 2024 · Oct 1, 2024 · Oct 1, 2024 · Oct 1, 2024
diff --git a/cli/notifications_test.go b/cli/notifications_test.go
 t.Helper()

 dt := coderdtest.DeploymentValues(t)
 dt.Experiments = []string{string(codersdk.ExperimentNotifications)}
 return &coderdtest.Options{
 DeploymentValues: dt,
 }
diff --git a/cli/server.go b/cli/server.go

 "cdr.dev/slog"
 "cdr.dev/slog/sloggers/sloghuman"
 "github.com/coder/coder/v2/coderd/entitlements"
 "github.com/coder/coder/v2/coderd/notifications/reports"
 "github.com/coder/coder/v2/coderd/runtimeconfig"
 "github.com/coder/pretty"
 "github.com/coder/quartz"
 "github.com/coder/retry"
 "github.com/coder/serpent"
 "github.com/coder/wgtunnel/tunnelsdk"

 "github.com/coder/coder/v2/coderd/entitlements"
 "github.com/coder/coder/v2/coderd/notifications/reports"
 "github.com/coder/coder/v2/coderd/runtimeconfig"

 "github.com/coder/coder/v2/buildinfo"
 "github.com/coder/coder/v2/cli/clilog"
 "github.com/coder/coder/v2/cli/cliui"
 options.OIDCConfig = oc
 }

 experiments := coderd.ReadExperiments(
 options.Logger, options.DeploymentValues.Experiments.Value(),
 )

 // We'll read from this channel in the select below that tracks shutdown.  If it remains
 // nil, that case of the select will just never fire, but it's important not to have a
 // "bare" read on this channel.
 return xerrors.Errorf("write config url: %w", err)
 }

 // Manage notifications.
 cfg := options.DeploymentValues.Notifications
 metrics := notifications.NewMetrics(options.PrometheusRegistry)
 helpers := templateHelpers(options)

 // The enqueuer is responsible for enqueueing notifications to the given store.
 enqueuer, err := notifications.NewStoreEnqueuer(cfg, options.Database, helpers, logger.Named("notifications.enqueuer"), quartz.NewReal())
 if err != nil {
 return xerrors.Errorf("failed to instantiate notification store enqueuer: %w", err)
 }
 options.NotificationsEnqueuer = enqueuer

 // The notification manager is responsible for:
 //   - creating notifiers and managing their lifecycles (notifiers are responsible for dequeueing/sending notifications)
 //   - keeping the store updated with status updates
 notificationsManager, err := notifications.NewManager(cfg, options.Database, helpers, metrics, logger.Named("notifications.manager"))
 if err != nil {
 return xerrors.Errorf("failed to instantiate notification manager: %w", err)
 }

 // nolint:gocritic // TODO: create own role.
 notificationsManager.Run(dbauthz.AsSystemRestricted(ctx))

 // Run report generator to distribute periodic reports.
 notificationReportGenerator := reports.NewReportGenerator(ctx, logger.Named("notifications.report_generator"), options.Database, options.NotificationsEnqueuer, quartz.NewReal())
 defer notificationReportGenerator.Close()

 // Since errCh only has one buffered slot, all routines
 // sending on it must be wrapped in a select/default to
 // avoid leaving dangling goroutines waiting for the
 options.WorkspaceUsageTracker = tracker
 defer tracker.Close()

 // Manage notifications.
 var (
 notificationsManager *notifications.Manager
 )
 if experiments.Enabled(codersdk.ExperimentNotifications) {
 cfg := options.DeploymentValues.Notifications
 metrics := notifications.NewMetrics(options.PrometheusRegistry)
 helpers := templateHelpers(options)

 // The enqueuer is responsible for enqueueing notifications to the given store.
 enqueuer, err := notifications.NewStoreEnqueuer(cfg, options.Database, helpers, logger.Named("notifications.enqueuer"), quartz.NewReal())
 if err != nil {
 return xerrors.Errorf("failed to instantiate notification store enqueuer: %w", err)
 }
 options.NotificationsEnqueuer = enqueuer

 // The notification manager is responsible for:
 //   - creating notifiers and managing their lifecycles (notifiers are responsible for dequeueing/sending notifications)
 //   - keeping the store updated with status updates
 notificationsManager, err = notifications.NewManager(cfg, options.Database, helpers, metrics, logger.Named("notifications.manager"))
 if err != nil {
 return xerrors.Errorf("failed to instantiate notification manager: %w", err)
 }

 // nolint:gocritic // TODO: create own role.
 notificationsManager.Run(dbauthz.AsSystemRestricted(ctx))

 // Run report generator to distribute periodic reports.
 notificationReportGenerator := reports.NewReportGenerator(ctx, logger.Named("notifications.report_generator"), options.Database, options.NotificationsEnqueuer, quartz.NewReal())
 defer notificationReportGenerator.Close()
 }

 // Wrap the server in middleware that redirects to the access URL if
 // the request is not to a local IP.
 var handler http.Handler = coderAPI.RootHandler
 // Cancel any remaining in-flight requests.
 shutdownConns()

 if notificationsManager != nil {
 // Stop the notification manager, which will cause any buffered updates to the store to be flushed.
 // If the Stop() call times out, messages that were sent but not reflected as such in the store will have
 // their leases expire after a period of time and will be re-queued for sending.
 // See CODER_NOTIFICATIONS_LEASE_PERIOD.
 cliui.Info(inv.Stdout, "Shutting down notifications manager..."+"\n")
 err = shutdownWithTimeout(notificationsManager.Stop, 5*time.Second)
 if err != nil {
 cliui.Warnf(inv.Stderr, "Notifications manager shutdown took longer than 5s, "+
 "this may result in duplicate notifications being sent: %s\n", err)
 } else {
 cliui.Info(inv.Stdout, "Gracefully shut down notifications manager\n")
 }
 // Stop the notification manager, which will cause any buffered updates to the store to be flushed.
 // If the Stop() call times out, messages that were sent but not reflected as such in the store will have
 // their leases expire after a period of time and will be re-queued for sending.
 // See CODER_NOTIFICATIONS_LEASE_PERIOD.
 cliui.Info(inv.Stdout, "Shutting down notifications manager..."+"\n")
 err = shutdownWithTimeout(notificationsManager.Stop, 5*time.Second)
 if err != nil {
 cliui.Warnf(inv.Stderr, "Notifications manager shutdown took longer than 5s, "+
 "this may result in duplicate notifications being sent: %s\n", err)
 } else {
 cliui.Info(inv.Stdout, "Gracefully shut down notifications manager\n")
 }

 // Shut down provisioners before waiting for WebSockets
diff --git a/coderd/coderd.go b/coderd/coderd.go
 "tailscale.com/util/singleflight"

 "cdr.dev/slog"
 "github.com/coder/quartz"
 "github.com/coder/serpent"

 "github.com/coder/coder/v2/coderd/entitlements"
 "github.com/coder/coder/v2/coderd/idpsync"
 "github.com/coder/coder/v2/coderd/runtimeconfig"
 "github.com/coder/quartz"
 "github.com/coder/serpent"

 agentproto "github.com/coder/coder/v2/agent/proto"
 "github.com/coder/coder/v2/buildinfo"
 })
 })
 r.Route("/notifications", func(r chi.Router) {
 r.Use(
 apiKeyMiddleware,
 httpmw.RequireExperiment(api.Experiments, codersdk.ExperimentNotifications),
 )
 r.Use(apiKeyMiddleware)
 r.Get("/settings", api.notificationsSettings)
 r.Put("/settings", api.putNotificationsSettings)
 r.Route("/templates", func(r chi.Router) {
diff --git a/coderd/notifications/manager.go b/coderd/notifications/manager.go

 runOnce  sync.Once
 stopOnce sync.Once
 doneOnce sync.Once
 stop     chan any
 done     chan any

 // events, creating a notifier, and publishing bulk dispatch result updates to the store.
 func (m *Manager) loop(ctx context.Context) error {
 defer func() {
 close(m.done)
 m.doneOnce.Do(func() {
 close(m.done)
 })
 m.log.Info(context.Background(), "notification manager stopped")
 }()

 // If the notifier hasn't been started, we don't need to wait for anything.
 // This is only really during testing when we want to enqueue messages only but not deliver them.
 if m.notifier == nil {
 close(m.done)
 m.doneOnce.Do(func() {
 close(m.done)
 })
 } else {
 m.notifier.stop()
 }
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
 t.Helper()

 dt := coderdtest.DeploymentValues(t)
 dt.Experiments = []string{string(codersdk.ExperimentNotifications)}
 return &coderdtest.Options{
 DeploymentValues: dt,
 }
diff --git a/coderd/notifications/reports/generator.go b/coderd/notifications/reports/generator.go
 return nil
 }

 err = reportFailedWorkspaceBuilds(ctx, logger,db, enqueuer, clk)
 err = reportFailedWorkspaceBuilds(ctx, logger,tx, enqueuer, clk)
 if err != nil {
 return xerrors.Errorf("unable to generate reports with failed workspace builds: %w", err)
 }
diff --git a/coderd/notifications_test.go b/coderd/notifications_test.go
 t.Helper()

 dt := coderdtest.DeploymentValues(t)
 dt.Experiments = []string{string(codersdk.ExperimentNotifications)}
 return &coderdtest.Options{
 DeploymentValues: dt,
 }
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
 // users to opt-in to via --experimental='*'.
 // Experiments that are not ready for consumption by all users should
 // not be included here and will be essentially hidden.
 var ExperimentsAll = Experiments{ExperimentNotifications}
 var ExperimentsAll = Experiments{}

 // Experiments is a list of experiments.
 // Multiple experiments may be enabled at the same time.
diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go

 "github.com/google/uuid"
 "github.com/hashicorp/yamux"
 "golang.org/x/exp/maps"
 "golang.org/x/exp/slices"
 "golang.org/x/xerrors"
 "nhooyr.io/websocket"

 type ProvisionerKeyTags map[string]string

 func (p ProvisionerKeyTags) String() string {
 keys := maps.Keys(p)
 slices.Sort(keys)
 tags := []string{}
 forkey, value := rangep {
 tags = append(tags, fmt.Sprintf("%s=%s", key,value))
 for_, key := rangekeys {
 tags = append(tags, fmt.Sprintf("%s=%s", key,p[key]))
 }
 return strings.Join(tags, " ")
 }
diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md
 # Appearance (enterprise)
 # Appearance (enterprise) (premium)

 Customize the look of your Coder deployment to meet your enterprise
 requirements.
 export CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
 coder-server
 ```

 ## Up next

 - [Enterprise](../enterprise.md)
diff --git a/docs/admin/audit-logs.md b/docs/admin/audit-logs.md

 ## Enabling this feature

 This feature is only available withan enterprise license.
 [Learn more](../enterprise.md)
 This feature is only available witha
 [Premium or Enterprise license](https://coder.com/pricing).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,7 +20,6 @@ func createOpts(t testing.T) coderdtest.Options {
		t.Helper()

		dt := coderdtest.DeploymentValues(t)
		dt.Experiments = []string{string(codersdk.ExperimentNotifications)}
		return &coderdtest.Options{
		DeploymentValues: dt,
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -56,15 +56,16 @@ import (

		"cdr.dev/slog"
		"cdr.dev/slog/sloggers/sloghuman"
		"github.com/coder/coder/v2/coderd/entitlements"
		"github.com/coder/coder/v2/coderd/notifications/reports"
		"github.com/coder/coder/v2/coderd/runtimeconfig"
		"github.com/coder/pretty"
		"github.com/coder/quartz"
		"github.com/coder/retry"
		"github.com/coder/serpent"
		"github.com/coder/wgtunnel/tunnelsdk"

		"github.com/coder/coder/v2/coderd/entitlements"
		"github.com/coder/coder/v2/coderd/notifications/reports"
		"github.com/coder/coder/v2/coderd/runtimeconfig"

		"github.com/coder/coder/v2/buildinfo"
		"github.com/coder/coder/v2/cli/clilog"
		"github.com/coder/coder/v2/cli/cliui"
Expand DownExpand Up		@@ -679,10 +680,6 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.
		options.OIDCConfig = oc
		}

		experiments := coderd.ReadExperiments(
		options.Logger, options.DeploymentValues.Experiments.Value(),
		)

		// We'll read from this channel in the select below that tracks shutdown. If it remains
		// nil, that case of the select will just never fire, but it's important not to have a
		// "bare" read on this channel.
Expand DownExpand Up		@@ -946,6 +943,33 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.
		return xerrors.Errorf("write config url: %w", err)
		}

		// Manage notifications.
		cfg := options.DeploymentValues.Notifications
		metrics := notifications.NewMetrics(options.PrometheusRegistry)
		helpers := templateHelpers(options)

		// The enqueuer is responsible for enqueueing notifications to the given store.
		enqueuer, err := notifications.NewStoreEnqueuer(cfg, options.Database, helpers, logger.Named("notifications.enqueuer"), quartz.NewReal())
		if err != nil {
		return xerrors.Errorf("failed to instantiate notification store enqueuer: %w", err)
		}
		options.NotificationsEnqueuer = enqueuer

		// The notification manager is responsible for:
		// - creating notifiers and managing their lifecycles (notifiers are responsible for dequeueing/sending notifications)
		// - keeping the store updated with status updates
		notificationsManager, err := notifications.NewManager(cfg, options.Database, helpers, metrics, logger.Named("notifications.manager"))
		if err != nil {
		return xerrors.Errorf("failed to instantiate notification manager: %w", err)
		}

		// nolint:gocritic // TODO: create own role.
		notificationsManager.Run(dbauthz.AsSystemRestricted(ctx))

		// Run report generator to distribute periodic reports.
		notificationReportGenerator := reports.NewReportGenerator(ctx, logger.Named("notifications.report_generator"), options.Database, options.NotificationsEnqueuer, quartz.NewReal())
		defer notificationReportGenerator.Close()

		// Since errCh only has one buffered slot, all routines
		// sending on it must be wrapped in a select/default to
		// avoid leaving dangling goroutines waiting for the
Expand DownExpand Up		@@ -1002,38 +1026,6 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.
		options.WorkspaceUsageTracker = tracker
		defer tracker.Close()

		// Manage notifications.
		var (
		notificationsManager *notifications.Manager
		)
		if experiments.Enabled(codersdk.ExperimentNotifications) {
		cfg := options.DeploymentValues.Notifications
		metrics := notifications.NewMetrics(options.PrometheusRegistry)
		helpers := templateHelpers(options)

		// The enqueuer is responsible for enqueueing notifications to the given store.
		enqueuer, err := notifications.NewStoreEnqueuer(cfg, options.Database, helpers, logger.Named("notifications.enqueuer"), quartz.NewReal())
		if err != nil {
		return xerrors.Errorf("failed to instantiate notification store enqueuer: %w", err)
		}
		options.NotificationsEnqueuer = enqueuer

		// The notification manager is responsible for:
		// - creating notifiers and managing their lifecycles (notifiers are responsible for dequeueing/sending notifications)
		// - keeping the store updated with status updates
		notificationsManager, err = notifications.NewManager(cfg, options.Database, helpers, metrics, logger.Named("notifications.manager"))
		if err != nil {
		return xerrors.Errorf("failed to instantiate notification manager: %w", err)
		}

		// nolint:gocritic // TODO: create own role.
		notificationsManager.Run(dbauthz.AsSystemRestricted(ctx))

		// Run report generator to distribute periodic reports.
		notificationReportGenerator := reports.NewReportGenerator(ctx, logger.Named("notifications.report_generator"), options.Database, options.NotificationsEnqueuer, quartz.NewReal())
		defer notificationReportGenerator.Close()
		}

		// Wrap the server in middleware that redirects to the access URL if
		// the request is not to a local IP.
		var handler http.Handler = coderAPI.RootHandler
Expand DownExpand Up		@@ -1153,19 +1145,17 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.
		// Cancel any remaining in-flight requests.
		shutdownConns()

		if notificationsManager != nil {
		// Stop the notification manager, which will cause any buffered updates to the store to be flushed.
		// If the Stop() call times out, messages that were sent but not reflected as such in the store will have
		// their leases expire after a period of time and will be re-queued for sending.
		// See CODER_NOTIFICATIONS_LEASE_PERIOD.
		cliui.Info(inv.Stdout, "Shutting down notifications manager..."+"\n")
		err = shutdownWithTimeout(notificationsManager.Stop, 5*time.Second)
		if err != nil {
		cliui.Warnf(inv.Stderr, "Notifications manager shutdown took longer than 5s, "+
		"this may result in duplicate notifications being sent: %s\n", err)
		} else {
		cliui.Info(inv.Stdout, "Gracefully shut down notifications manager\n")
		}
		// Stop the notification manager, which will cause any buffered updates to the store to be flushed.
		// If the Stop() call times out, messages that were sent but not reflected as such in the store will have
		// their leases expire after a period of time and will be re-queued for sending.
		// See CODER_NOTIFICATIONS_LEASE_PERIOD.
		cliui.Info(inv.Stdout, "Shutting down notifications manager..."+"\n")
		err = shutdownWithTimeout(notificationsManager.Stop, 5*time.Second)
		if err != nil {
		cliui.Warnf(inv.Stderr, "Notifications manager shutdown took longer than 5s, "+
		"this may result in duplicate notifications being sent: %s\n", err)
		} else {
		cliui.Info(inv.Stdout, "Gracefully shut down notifications manager\n")
		}

		// Shut down provisioners before waiting for WebSockets
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,11 +37,12 @@ import (
		"tailscale.com/util/singleflight"

		"cdr.dev/slog"
		"github.com/coder/quartz"
		"github.com/coder/serpent"

		"github.com/coder/coder/v2/coderd/entitlements"
		"github.com/coder/coder/v2/coderd/idpsync"
		"github.com/coder/coder/v2/coderd/runtimeconfig"
		"github.com/coder/quartz"
		"github.com/coder/serpent"

		agentproto "github.com/coder/coder/v2/agent/proto"
		"github.com/coder/coder/v2/buildinfo"
Expand DownExpand Up		@@ -1257,10 +1258,7 @@ func New(options Options) API {
		})
		})
		r.Route("/notifications", func(r chi.Router) {
		r.Use(
		apiKeyMiddleware,
		httpmw.RequireExperiment(api.Experiments, codersdk.ExperimentNotifications),
		)
		r.Use(apiKeyMiddleware)
		r.Get("/settings", api.notificationsSettings)
		r.Put("/settings", api.putNotificationsSettings)
		r.Route("/templates", func(r chi.Router) {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -54,6 +54,7 @@ type Manager struct {

		runOnce sync.Once
		stopOnce sync.Once
		doneOnce sync.Once
		stop chan any
		done chan any

Expand DownExpand Up		@@ -153,7 +154,9 @@ func (m *Manager) Run(ctx context.Context) {
		// events, creating a notifier, and publishing bulk dispatch result updates to the store.
		func (m *Manager) loop(ctx context.Context) error {
		defer func() {
		close(m.done)
		m.doneOnce.Do(func() {
		close(m.done)
		})
		m.log.Info(context.Background(), "notification manager stopped")
		}()

Expand DownExpand Up		@@ -364,7 +367,9 @@ func (m *Manager) Stop(ctx context.Context) error {
		// If the notifier hasn't been started, we don't need to wait for anything.
		// This is only really during testing when we want to enqueue messages only but not deliver them.
		if m.notifier == nil {
		close(m.done)
		m.doneOnce.Do(func() {
		close(m.done)
		})
		} else {
		m.notifier.stop()
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1187,7 +1187,6 @@ func createOpts(t testing.T) coderdtest.Options {
		t.Helper()

		dt := coderdtest.DeploymentValues(t)
		dt.Experiments = []string{string(codersdk.ExperimentNotifications)}
		return &coderdtest.Options{
		DeploymentValues: dt,
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -49,7 +49,7 @@ func NewReportGenerator(ctx context.Context, logger slog.Logger, db database.Sto
		return nil
		}

		err = reportFailedWorkspaceBuilds(ctx, logger,db, enqueuer, clk)
		err = reportFailedWorkspaceBuilds(ctx, logger,tx, enqueuer, clk)
		if err != nil {
		return xerrors.Errorf("unable to generate reports with failed workspace builds: %w", err)
		}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2901,7 +2901,7 @@ const (
		// users to opt-in to via --experimental='*'.
		// Experiments that are not ready for consumption by all users should
		// not be included here and will be essentially hidden.
		var ExperimentsAll = Experiments{ExperimentNotifications}
		var ExperimentsAll = Experiments{}

		// Experiments is a list of experiments.
		// Multiple experiments may be enabled at the same time.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,6 +12,8 @@ import (

		"github.com/google/uuid"
		"github.com/hashicorp/yamux"
		"golang.org/x/exp/maps"
		"golang.org/x/exp/slices"
		"golang.org/x/xerrors"
		"nhooyr.io/websocket"

Expand DownExpand Up		@@ -278,9 +280,11 @@ func (c *Client) ServeProvisionerDaemon(ctx context.Context, req ServeProvisione
		type ProvisionerKeyTags map[string]string

		func (p ProvisionerKeyTags) String() string {
		keys := maps.Keys(p)
		slices.Sort(keys)
		tags := []string{}
		forkey, value := rangep {
		tags = append(tags, fmt.Sprintf("%s=%s", key,value))
		for_, key := rangekeys {
		tags = append(tags, fmt.Sprintf("%s=%s", key,p[key]))
		}
		return strings.Join(tags, " ")
		}
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,4 @@
		# Appearance (enterprise)
		# Appearance (enterprise) (premium)

		Customize the look of your Coder deployment to meet your enterprise
		requirements.
Expand DownExpand Up		@@ -93,7 +93,3 @@ For CLI, use,
		export CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
		coder-server
		```

		## Up next

		- [Enterprise](../enterprise.md)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -122,5 +122,5 @@ entry:

		## Enabling this feature

		This feature is only available withan enterprise license.
		[Learn more](../enterprise.md)
		This feature is only available witha
		[Premium or Enterprise license](https://coder.com/pricing).