docs(flare,kiosk,lagoon): compile README Go examples via src= (quick-261118-qsd)
- flare: send region run by TestDocsNotifyReply against a loopback TLS push service; blogSubscriptions and the publish-source region run by TestDocsSubscriptionSource on a Postgres container (skips under -short) - kiosk: write, newest and client regions run by TestDocsWriteManifest (a copy of the literal fixture), ExampleVersionsResponse and TestDocsBlogReleases (httptest registry); the CheckT fence reuses TestPluginManifest - lagoon: new open region run by TestDocsOpenFromApp (DocsDSN added to export_docs_test.go); the model, create-post, on-database, publish and migrations fences reuse the Database pages' targets
This commit is contained in:
@@ -43,10 +43,10 @@ Use cases:
|
||||
|
||||
Send a push to one stored subscription:
|
||||
|
||||
```go
|
||||
```go src=modules/flare/example_test.go#send
|
||||
svc, err := flare.From(app)
|
||||
if err != nil {
|
||||
return err
|
||||
return false, err
|
||||
}
|
||||
payload := []byte(`{"title":"New comment","body":"Someone replied to your post"}`)
|
||||
err = svc.Pusher().Send(ctx, flare.Subscription{
|
||||
@@ -56,24 +56,29 @@ err = svc.Pusher().Send(ctx, flare.Subscription{
|
||||
}, payload, flare.SendOptions{Urgency: "normal"})
|
||||
if errors.Is(err, flare.ErrSubscriptionGone) {
|
||||
// The browser unsubscribed: delete the row.
|
||||
return true, nil
|
||||
}
|
||||
```
|
||||
|
||||
Publish a subscription source from a plugin's `Boot`, so operator commands can read the stored subscriptions of a user:
|
||||
|
||||
```go
|
||||
```go src=modules/flare/example_test.go#blogSubscriptions
|
||||
// blogSubscriptions reads the blog's stored push subscriptions for
|
||||
// operator commands such as websockets:test-push.
|
||||
type blogSubscriptions struct{ db *gorm.DB }
|
||||
```
|
||||
|
||||
```go src=modules/flare/example_test.go#blogSubscriptions.Subscriptions
|
||||
func (s blogSubscriptions) Subscriptions(ctx context.Context, userID uint) ([]flare.SubscriptionInfo, error) {
|
||||
var user models.User
|
||||
var user User
|
||||
if err := s.db.WithContext(ctx).First(&user, userID).Error; err != nil {
|
||||
if errors.Is(err, gorm.ErrRecordNotFound) {
|
||||
return nil, flare.ErrUserNotFound
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
var rows []models.PushSubscription
|
||||
if err := s.db.WithContext(ctx).Where("user_id = ?", userID).Find(&rows).Error; err != nil {
|
||||
var rows []PushSubscription
|
||||
if err := s.db.WithContext(ctx).Where("user_id = ?", userID).Order("id").Find(&rows).Error; err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out := make([]flare.SubscriptionInfo, 0, len(rows))
|
||||
@@ -87,8 +92,9 @@ func (s blogSubscriptions) Subscriptions(ctx context.Context, userID uint) ([]fl
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
```
|
||||
|
||||
// In Boot:
|
||||
```go src=modules/flare/example_test.go#publish-source
|
||||
if err := app.Publish[flare.SubscriptionSource](blogSubscriptions{db: gdb}); err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -148,4 +154,4 @@ Both commands print their own failure messages and return `bonfire.Reported` err
|
||||
go test ./modules/flare/...
|
||||
```
|
||||
|
||||
`TestRFC8291AppendixA` fixes the RFC's salt and application server key and compares the output with the RFC's published bytes. The send tests run an `httptest.NewTLSServer` push service with `127.0.0.1` in the allowlist; it verifies the VAPID token with the key from `k=` and decrypts the body as a browser would. Pass the test server's client to `flare.NewVAPIDPusher` or `flare.Service.SetHTTPClient` so it trusts the test certificate.
|
||||
`TestRFC8291AppendixA` fixes the RFC's salt and application server key and compares the output with the RFC's published bytes. The send tests run an `httptest.NewTLSServer` push service with `127.0.0.1` in the allowlist; it verifies the VAPID token with the key from `k=` and decrypts the body as a browser would. Pass the test server's client to `flare.NewVAPIDPusher` or `flare.Service.SetHTTPClient` so it trusts the test certificate. `TestDocsSubscriptionSource` runs the subscription source shown above on a Postgres container and skips under `-short`.
|
||||
|
||||
Reference in New Issue
Block a user