-
Notifications
You must be signed in to change notification settings - Fork 223
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Kavii Suri <kavii@Kaviis-MacBook-Pro.local> Co-authored-by: Niko Köser <koeserniko@gmail.com>
- Loading branch information
3 people
authored
Jun 7, 2023
1 parent
3f4d10d
commit 5e9ddeb
Showing
8 changed files
with
998 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,6 @@ linters: | |
| enable: | ||
| - 'asciicheck' | ||
| - 'bodyclose' | ||
| - 'depguard' | ||
| - 'dogsled' | ||
| - 'errcheck' | ||
| - 'errorlint' | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Webpush Notifications | ||
|
|
||
| [](https://pkg.go.dev/github.com/nikoksr/notify/service/webpush) | ||
|
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| Generate VAPID Public and Private Keys for the notification service. This can be done using many tools, one of which is [`GenerateVAPIDKeys`](https://pkg.go.dev/github.com/SherClockHolmes/webpush-go#GenerateVAPIDKeys) from [webpush-go](https://github.com/SherClockHolmes/webpush-go/). | ||
|
|
||
| ### Compatibility | ||
|
|
||
| This service is compatible with the [Web Push Protocol](https://tools.ietf.org/html/rfc8030) and [VAPID](https://tools.ietf.org/html/rfc8292). | ||
|
|
||
| For a list of compatible browsers, see [this](https://caniuse.com/push-api) for the Push API and [this](https://caniuse.com/notifications) for the Web Notifications. | ||
|
|
||
| ## Usage | ||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
|
|
||
| "github.com/nikoksr/notify" | ||
| "github.com/nikoksr/notify/service/webpush" | ||
| ) | ||
|
|
||
| const vapidPublicKey = "..." // Add a vapidPublicKey | ||
| const vapidPrivateKey = "..." // Add a vapidPrivateKey | ||
|
|
||
| func main() { | ||
| subscription := webpush.Subscription{ | ||
| Endpoint: "https://your-endpoint", | ||
| Keys: { | ||
| Auth: "...", | ||
| P256dh: "...", | ||
| }, | ||
| } | ||
|
|
||
| webpushSvc := webpush.New(vapidPublicKey, vapidPrivateKey) | ||
| webpushSvc.AddReceivers(subscription) | ||
|
|
||
| notifier := notify.NewWithServices(webpushSvc) | ||
|
|
||
| if err := notifier.Send(context.Background(), "TEST", "Message using golang notifier library"); err != nil { | ||
| log.Fatalf("notifier.Send() failed: %s", err.Error()) | ||
| } | ||
|
|
||
| log.Println("Notification sent successfully") | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| Package webpush provides a service for sending messages to viber. | ||
| Usage: | ||
| package main | ||
| import ( | ||
| "context" | ||
| "log" | ||
| "github.com/nikoksr/notify" | ||
| "github.com/nikoksr/notify/service/webpush" | ||
| ) | ||
| const vapidPublicKey = "..." // Add a vapidPublicKey | ||
| const vapidPrivateKey = "..." // Add a vapidPrivateKey | ||
| func main() { | ||
| subscription := webpush.Subscription{ | ||
| Endpoint: "https://your-endpoint", | ||
| Keys: { | ||
| Auth: "...", | ||
| P256dh: "...", | ||
| }, | ||
| } | ||
| webpushSvc := webpush.New(vapidPublicKey, vapidPrivateKey) | ||
| webpushSvc.AddReceivers(subscription) | ||
| notifier := notify.NewWithServices(webpushSvc) | ||
| if err := notifier.Send(context.Background(), "TEST", "Message using golang notifier library"); err != nil { | ||
| log.Fatalf("notifier.Send() failed: %s", err.Error()) | ||
| } | ||
| log.Println("Notification sent successfully") | ||
| } | ||
| */ | ||
| package webpush |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| package webpush | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
|
|
||
| "github.com/SherClockHolmes/webpush-go" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| type ( | ||
| // Urgency indicates the importance of the message. It's a type alias for webpush.Urgency. | ||
| Urgency = webpush.Urgency | ||
|
|
||
| // Options are optional settings for the sending of a message. It's a type alias for webpush.Options. | ||
| Options = webpush.Options | ||
|
|
||
| // Subscription is a JSON representation of a webpush subscription. It's a type alias for webpush.Subscription. | ||
| Subscription = webpush.Subscription | ||
|
|
||
| // messagePayload is the JSON payload that is sent to the webpush endpoint. | ||
| messagePayload struct { | ||
| Subject string `json:"subject"` | ||
| Message string `json:"message"` | ||
| Data map[string]interface{} `json:"data,omitempty"` | ||
| } | ||
|
|
||
| msgDataKey struct{} | ||
| msgOptionsKey struct{} | ||
| ) | ||
|
|
||
| // optionsKey is used as a context.Context key to optionally add options to the messagePayload payload. | ||
| var optionsKey = msgOptionsKey{} | ||
|
|
||
| // dataKey is used as a context.Context key to optionally add data to the messagePayload payload. | ||
| var dataKey = msgDataKey{} | ||
|
|
||
| // These are exposed Urgency constants from the webpush package. | ||
| var ( | ||
| // UrgencyVeryLow requires device state: on power and Wi-Fi | ||
| UrgencyVeryLow Urgency = webpush.UrgencyVeryLow | ||
|
|
||
| // UrgencyLow requires device state: on either power or Wi-Fi | ||
| UrgencyLow Urgency = webpush.UrgencyLow | ||
|
|
||
| // UrgencyNormal excludes device state: low battery | ||
| UrgencyNormal Urgency = webpush.UrgencyNormal | ||
|
|
||
| // UrgencyHigh admits device state: low battery | ||
| UrgencyHigh Urgency = webpush.UrgencyHigh | ||
| ) | ||
|
|
||
| // Service encapsulates the webpush notification system along with the internal state | ||
| type Service struct { | ||
| subscriptions []webpush.Subscription | ||
| options webpush.Options | ||
| } | ||
|
|
||
| // New returns a new instance of the Service | ||
| func New(vapidPublicKey string, vapidPrivateKey string) *Service { | ||
| return &Service{ | ||
| subscriptions: []webpush.Subscription{}, | ||
| options: webpush.Options{ | ||
| VAPIDPublicKey: vapidPublicKey, | ||
| VAPIDPrivateKey: vapidPrivateKey, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // AddReceivers adds one or more subscriptions to the Service. | ||
| func (s *Service) AddReceivers(subscriptions ...Subscription) { | ||
| s.subscriptions = append(s.subscriptions, subscriptions...) | ||
| } | ||
|
|
||
| // withOptions returns a new Options struct with the incoming options merged with the Service's options. The incoming | ||
| // options take precedence, except for the VAPID keys. Existing VAPID keys are only replaced if the incoming VAPID keys | ||
| // are not empty. | ||
| func (s *Service) withOptions(options Options) Options { | ||
| if options.VAPIDPublicKey == "" { | ||
| options.VAPIDPublicKey = s.options.VAPIDPublicKey | ||
| } | ||
| if options.VAPIDPrivateKey == "" { | ||
| options.VAPIDPrivateKey = s.options.VAPIDPrivateKey | ||
| } | ||
|
|
||
| return options | ||
| } | ||
|
|
||
| // WithOptions binds the options to the context so that they will be used by the Service.Send method automatically. Options | ||
| // are settings that allow you to customize the sending behavior of a message. | ||
| func WithOptions(ctx context.Context, options Options) context.Context { | ||
| return context.WithValue(ctx, optionsKey, options) | ||
| } | ||
|
|
||
| func optionsFromContext(ctx context.Context) Options { | ||
| if options, ok := ctx.Value(optionsKey).(Options); ok { | ||
| return options | ||
| } | ||
|
|
||
| return Options{} | ||
| } | ||
|
|
||
| // WithData binds the data to the context so that it will be used by the Service.Send method automatically. Data is a | ||
| // map[string]interface{} and acts as a metadata field that is sent along with the message payload. | ||
| func WithData(ctx context.Context, data map[string]interface{}) context.Context { | ||
| return context.WithValue(ctx, dataKey, data) | ||
| } | ||
|
|
||
| func dataFromContext(ctx context.Context) map[string]interface{} { | ||
| if data, ok := ctx.Value(dataKey).(map[string]interface{}); ok { | ||
| return data | ||
| } | ||
|
|
||
| return map[string]interface{}{} | ||
| } | ||
|
|
||
| // payloadFromContext returns a json encoded byte array of the messagePayload payload that is ready to be sent to the | ||
| // webpush endpoint. Internally, it uses the messagePayload and data from the context, and it combines it with the | ||
| // subject and message arguments into a single messagePayload. | ||
| func payloadFromContext(ctx context.Context, subject, message string) ([]byte, error) { | ||
| payload := messagePayload{ | ||
| Subject: subject, | ||
| Message: message, | ||
| } | ||
|
|
||
| payload.Data = dataFromContext(ctx) // Load optional data | ||
|
|
||
| payloadBytes, err := json.Marshal(payload) | ||
| if err != nil { | ||
| return nil, errors.Wrap(err, "failed to serialize messagePayload") | ||
| } | ||
|
|
||
| return payloadBytes, nil | ||
| } | ||
|
|
||
| // send is a wrapper that makes it primarily easier to defer the closing of the response body. | ||
| func (s *Service) send(ctx context.Context, message []byte, subscription *Subscription, options *Options) error { | ||
| res, err := webpush.SendNotificationWithContext(ctx, message, subscription, options) | ||
| if err != nil { | ||
| return errors.Wrapf(err, "failed to send messagePayload to webpush subscription %s", subscription.Endpoint) | ||
| } | ||
| defer res.Body.Close() | ||
|
|
||
| if res.StatusCode == http.StatusOK || res.StatusCode == http.StatusCreated { | ||
| return nil // Everything is fine | ||
| } | ||
|
|
||
| // Make sure to produce a helpful error message | ||
|
|
||
| baseErr := errors.Errorf( | ||
| "failed to send message to webpush subscription %s: unexpected status code %d", | ||
| subscription.Endpoint, res.StatusCode, | ||
| ) | ||
|
|
||
| body, err := io.ReadAll(res.Body) | ||
| if err != nil { | ||
| baseErr = errors.Wrap(errors.Wrap(err, "failed to read response body"), baseErr.Error()) | ||
| } else { | ||
| baseErr = fmt.Errorf("%w: %s", baseErr, body) | ||
| } | ||
|
|
||
| return baseErr | ||
| } | ||
|
|
||
| // Send sends a message to all the webpush subscriptions that have been added to the Service. The subject and message | ||
| // arguments are the subject and message of the messagePayload payload. The context can be used to optionally add | ||
| // options and data to the messagePayload payload. See the WithOptions and WithData functions. | ||
| func (s *Service) Send(ctx context.Context, subject, message string) error { | ||
| // Get the options from the context and merge them with the service's initial options | ||
| options := optionsFromContext(ctx) | ||
| options = s.withOptions(options) | ||
|
|
||
| payload, err := payloadFromContext(ctx, subject, message) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for _, subscription := range s.subscriptions { | ||
| subscription := subscription // Capture the subscription in the closure | ||
| if err := s.send(ctx, payload, &subscription, &options); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.