move to webpush package

coder · johnstcn · Mar 27, 2025 · Mar 17, 2025 · Mar 25, 2025 · Mar 25, 2025
commit 46c2cd8c612ca88b5e3cee156cdeb4d4a565092e
diff --git a/cli/server.go b/cli/server.go
@@ -62,9 +62,9 @@ import (
 	"github.com/coder/wgtunnel/tunnelsdk"
 
 	"github.com/coder/coder/v2/coderd/entitlements"
-	"github.com/coder/coder/v2/coderd/notifications/push"
 	"github.com/coder/coder/v2/coderd/notifications/reports"
 	"github.com/coder/coder/v2/coderd/runtimeconfig"
+	"github.com/coder/coder/v2/coderd/webpush"
 
 	"github.com/coder/coder/v2/buildinfo"
 	"github.com/coder/coder/v2/cli/clilog"
@@ -779,17 +779,17 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
 			// Manage push notifications.
 			experiments := coderd.ReadExperiments(options.Logger, options.DeploymentValues.Experiments.Value())
 			if experiments.Enabled(codersdk.ExperimentWebPush) {
-				webpusher, err := push.New(ctx, &options.Logger, options.Database)
+				webpusher, err := webpush.New(ctx, &options.Logger, options.Database)
 				if err != nil {
 					options.Logger.Error(ctx, "failed to create web push dispatcher", slog.Error(err))
 					options.Logger.Warn(ctx, "web push notifications will not work until the VAPID keys are regenerated")
-					webpusher = &push.NoopWebpusher{
+					webpusher = &webpush.NoopWebpusher{
 						Msg: "Web Push notifications are disabled due to a system error. Please contact your Coder administrator.",
 					}
 				}
 				options.WebpushDispatcher = webpusher
 			} else {
-				options.WebpushDispatcher = &push.NoopWebpusher{
+				options.WebpushDispatcher = &webpush.NoopWebpusher{
 					Msg: "Web Push notifications are an experimental feature and are disabled by default. Enable the 'web-push' experiment to use this feature.",
 				}
 			}

diff --git a/cli/server_regenerate_vapid_keypair.go b/cli/server_regenerate_vapid_keypair.go
@@ -13,7 +13,7 @@ import (
 	"github.com/coder/coder/v2/cli/cliui"
 	"github.com/coder/coder/v2/coderd/database"
 	"github.com/coder/coder/v2/coderd/database/awsiamrds"
-	"github.com/coder/coder/v2/coderd/notifications/push"
+	"github.com/coder/coder/v2/coderd/webpush"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/serpent"
 )
@@ -81,7 +81,7 @@ func (r *RootCmd) newRegenerateVapidKeypairCommand() *serpent.Command {
 				return xerrors.Errorf("VAPID keypair regeneration failed: %w", err)
 			}
 
-			if _, _, err := push.RegenerateVAPIDKeys(ctx, db); err != nil {
+			if _, _, err := webpush.RegenerateVAPIDKeys(ctx, db); err != nil {
 				return xerrors.Errorf("regenerate vapid keypair: %w", err)
 			}
 

diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -44,8 +44,8 @@ import (
 	"github.com/coder/coder/v2/coderd/cryptokeys"
 	"github.com/coder/coder/v2/coderd/entitlements"
 	"github.com/coder/coder/v2/coderd/idpsync"
-	"github.com/coder/coder/v2/coderd/notifications/push"
 	"github.com/coder/coder/v2/coderd/runtimeconfig"
+	"github.com/coder/coder/v2/coderd/webpush"
 
 	agentproto "github.com/coder/coder/v2/agent/proto"
 	"github.com/coder/coder/v2/buildinfo"
@@ -263,7 +263,7 @@ type Options struct {
 	Clock                 quartz.Clock
 
 	// WebpushDispatcher is a way to send notifications over Web Push.
-	WebpushDispatcher push.Dispatcher
+	WebpushDispatcher webpush.Dispatcher
 }
 
 // @title Coder API
@@ -550,7 +550,7 @@ func New(options *Options) *API {
 		UserQuietHoursScheduleStore: options.UserQuietHoursScheduleStore,
 		AccessControlStore:          options.AccessControlStore,
 		Experiments:                 experiments,
-		PushNotifier:                options.WebpushDispatcher,
+		WebpushDispatcher:           options.WebpushDispatcher,
 		healthCheckGroup:            &singleflight.Group[string, *healthsdk.HealthcheckReport]{},
 		Acquirer: provisionerdserver.NewAcquirer(
 			ctx,
@@ -585,7 +585,7 @@ func New(options *Options) *API {
 		WorkspaceProxy:        false,
 		UpgradeMessage:        api.DeploymentValues.CLIUpgradeMessage.String(),
 		DeploymentID:          api.DeploymentID,
-		WebPushPublicKey:      api.PushNotifier.PublicKey(),
+		WebPushPublicKey:      api.WebpushDispatcher.PublicKey(),
 		Telemetry:             api.Telemetry.Enabled(),
 	}
 	api.SiteHandler = site.New(&site.Options{
@@ -1505,8 +1505,8 @@ type API struct {
 	TailnetCoordinator                atomic.Pointer[tailnet.Coordinator]
 	NetworkTelemetryBatcher           *tailnet.NetworkTelemetryBatcher
 	TailnetClientService              *tailnet.ClientService
-	// PushNotifier is a way to send push notifications to users.
-	PushNotifier      push.Dispatcher
+	// WebpushDispatcher is a way to send notifications to users via Web Push.
+	WebpushDispatcher webpush.Dispatcher
 	QuotaCommitter    atomic.Pointer[proto.QuotaCommitter]
 	AppearanceFetcher atomic.Pointer[appearance.Fetcher]
 	// WorkspaceProxyHostsFn returns the hosts of healthy workspace proxies

diff --git a/coderd/coderdtest/coderdtest.go b/coderd/coderdtest/coderdtest.go
@@ -70,7 +70,6 @@ import (
 	"github.com/coder/coder/v2/coderd/httpmw"
 	"github.com/coder/coder/v2/coderd/notifications"
 	"github.com/coder/coder/v2/coderd/notifications/notificationstest"
-	"github.com/coder/coder/v2/coderd/notifications/push"
 	"github.com/coder/coder/v2/coderd/rbac"
 	"github.com/coder/coder/v2/coderd/rbac/policy"
 	"github.com/coder/coder/v2/coderd/runtimeconfig"
@@ -79,6 +78,7 @@ import (
 	"github.com/coder/coder/v2/coderd/unhanger"
 	"github.com/coder/coder/v2/coderd/updatecheck"
 	"github.com/coder/coder/v2/coderd/util/ptr"
+	"github.com/coder/coder/v2/coderd/webpush"
 	"github.com/coder/coder/v2/coderd/workspaceapps"
 	"github.com/coder/coder/v2/coderd/workspaceapps/appurl"
 	"github.com/coder/coder/v2/coderd/workspacestats"
@@ -162,7 +162,7 @@ type Options struct {
 	Logger       *slog.Logger
 	StatsBatcher workspacestats.Batcher
 
-	PushNotifier                       push.Dispatcher
+	WebpushDispatcher                  webpush.Dispatcher
 	WorkspaceAppsStatsCollectorOptions workspaceapps.StatsCollectorOptions
 	AllowWorkspaceRenames              bool
 	NewTicker                          func(duration time.Duration) (<-chan time.Time, func())
@@ -282,13 +282,13 @@ func NewOptions(t testing.TB, options *Options) (func(http.Handler), context.Can
 		require.NoError(t, err, "insert a deployment id")
 	}
 
-	if options.PushNotifier == nil {
+	if options.WebpushDispatcher == nil {
 		// nolint:gocritic // Gets/sets VAPID keys.
-		pushNotifier, err := push.New(dbauthz.AsNotifier(context.Background()), options.Logger, options.Database)
+		pushNotifier, err := webpush.New(dbauthz.AsNotifier(context.Background()), options.Logger, options.Database)
 		if err != nil {
 			panic(xerrors.Errorf("failed to create push notifier: %w", err))
 		}
-		options.PushNotifier = pushNotifier
+		options.WebpushDispatcher = pushNotifier
 	}
 
 	if options.DeploymentValues == nil {
@@ -541,7 +541,7 @@ func NewOptions(t testing.TB, options *Options) (func(http.Handler), context.Can
 			TrialGenerator:                     options.TrialGenerator,
 			RefreshEntitlements:                options.RefreshEntitlements,
 			TailnetCoordinator:                 options.Coordinator,
-			WebpushDispatcher:                  options.PushNotifier,
+			WebpushDispatcher:                  options.WebpushDispatcher,
 			BaseDERPMap:                        derpMap,
 			DERPMapUpdateFrequency:             150 * time.Millisecond,
 			CoordinatorResumeTokenProvider:     options.CoordinatorResumeTokenProvider,

diff --git a/coderd/notifications.go b/coderd/notifications.go
@@ -366,8 +366,8 @@ func (api *API) postUserWebpushSubscription(rw http.ResponseWriter, r *http.Requ
 			P256dh: req.P256DHKey,
 		},
 	}, &webpush.Options{
-		VAPIDPublicKey:  api.PushNotifier.PublicKey(),
-		VAPIDPrivateKey: api.PushNotifier.PrivateKey(),
+		VAPIDPublicKey:  api.WebpushDispatcher.PublicKey(),
+		VAPIDPrivateKey: api.WebpushDispatcher.PrivateKey(),
 	})
 	if err != nil {
 		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
@@ -448,7 +448,7 @@ func (api *API) postUserPushNotificationTest(rw http.ResponseWriter, r *http.Req
 	ctx := r.Context()
 	user := httpmw.UserParam(r)
 
-	if err := api.PushNotifier.Dispatch(ctx, user.ID, codersdk.WebpushMessage{
+	if err := api.WebpushDispatcher.Dispatch(ctx, user.ID, codersdk.WebpushMessage{
 		Title: "It's working!",
 		Body:  "You've subscribed to push notifications.",
 	}); err != nil {

diff --git a/coderd/notifications/push/push.go → coderd/webpush/webpush.go b/coderd/notifications/push/push.go → coderd/webpush/webpush.go
@@ -1,4 +1,4 @@
-package push
+package webpush
 
 import (
 	"context"

diff --git a/coderd/notifications/push/push_test.go → coderd/webpush/webpush_test.go b/coderd/notifications/push/push_test.go → coderd/webpush/webpush_test.go
@@ -1,4 +1,4 @@
-package push_test
+package webpush_test
 
 import (
 	"context"
@@ -16,7 +16,7 @@ import (
 	"github.com/coder/coder/v2/coderd/database/dbgen"
 	"github.com/coder/coder/v2/coderd/database/dbtestutil"
 	"github.com/coder/coder/v2/coderd/database/dbtime"
-	"github.com/coder/coder/v2/coderd/notifications/push"
+	"github.com/coder/coder/v2/coderd/webpush"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/testutil"
 )
@@ -242,16 +242,16 @@ func TestPush(t *testing.T) {
 	})
 }
 
-// setupPushTest creates a common test setup for push notification tests
-func setupPushTest(ctx context.Context, t *testing.T, handlerFunc func(w http.ResponseWriter, r *http.Request)) (push.Dispatcher, database.Store, string) {
+// setupPushTest creates a common test setup for webpush notification tests
+func setupPushTest(ctx context.Context, t *testing.T, handlerFunc func(w http.ResponseWriter, r *http.Request)) (webpush.Dispatcher, database.Store, string) {
 	logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}).Leveled(slog.LevelDebug)
 	db, _ := dbtestutil.NewDB(t)
 
 	server := httptest.NewServer(http.HandlerFunc(handlerFunc))
 	t.Cleanup(server.Close)
 
-	manager, err := push.New(ctx, &logger, db)
-	require.NoError(t, err, "Failed to create push manager")
+	manager, err := webpush.New(ctx, &logger, db)
+	require.NoError(t, err, "Failed to create webpush manager")
 
 	return manager, db, server.URL
 }