docs(lighthouse,postcard,signpost): compile README Go examples via src= (quick-261118-qsd)
This commit is contained in:
@@ -79,18 +79,10 @@ centrifugo:
|
||||
|
||||
A plugin imports the driver package for its side effect, builds the service at Boot, installs a user lookup and registers its channel authorizers:
|
||||
|
||||
```go
|
||||
package acme
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"git.golem15.com/golem15/summercms/modules/backpack"
|
||||
"git.golem15.com/golem15/summercms/modules/lighthouse"
|
||||
_ "git.golem15.com/golem15/summercms/modules/lighthouse/centrifugo"
|
||||
)
|
||||
|
||||
func (p *Plugin) Boot(app *backpack.App) error {
|
||||
```go src=modules/lighthouse/example_test.go#RoomsPlugin.Boot
|
||||
// Boot builds the realtime service, installs the user lookup and registers
|
||||
// the room authorizer.
|
||||
func (p *RoomsPlugin) Boot(app *backpack.App) error {
|
||||
svc, err := lighthouse.From(app)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -112,8 +104,9 @@ func (p *Plugin) Boot(app *backpack.App) error {
|
||||
|
||||
and mounts the driver's routes once:
|
||||
|
||||
```go
|
||||
func (p *Plugin) Routes(r pact.Router) error {
|
||||
```go src=modules/lighthouse/example_test.go#RoomsPlugin.Routes
|
||||
// Routes mounts the driver's routes once.
|
||||
func (p *RoomsPlugin) Routes(r pact.Router) error {
|
||||
return lighthouse.Mount(r, p.realtime.Driver(), lighthouse.Surfaces{
|
||||
UserAuth: surf.Use("jwt.auth"),
|
||||
ServerToServer: surf.Use(),
|
||||
@@ -124,10 +117,10 @@ func (p *Plugin) Routes(r pact.Router) error {
|
||||
|
||||
A model package stays free of realtime code; the plugin binds the model at Boot:
|
||||
|
||||
```go
|
||||
err := lighthouse.Bind[models.Post](svc, lighthouse.Binding[models.Post]{
|
||||
```go src=modules/lighthouse/example_test.go#bind
|
||||
return lighthouse.Bind[Post](svc, lighthouse.Binding[Post]{
|
||||
Alias: "blog.post",
|
||||
Channels: func(ctx context.Context, tx *gorm.DB, p *models.Post) ([]string, error) {
|
||||
Channels: func(ctx context.Context, tx *gorm.DB, p *Post) ([]string, error) {
|
||||
return []string{"blog:" + strconv.FormatUint(uint64(p.BlogID), 10)}, nil
|
||||
},
|
||||
})
|
||||
@@ -135,21 +128,20 @@ err := lighthouse.Bind[models.Post](svc, lighthouse.Binding[models.Post]{
|
||||
|
||||
A bulk import suppresses the per-row events and publishes one summary after commit:
|
||||
|
||||
```go
|
||||
err := lighthouse.WithoutBroadcasting[models.Post](ctx, func(ctx context.Context) error {
|
||||
return lagoon.Transaction(ctx, gdb, func(ctx context.Context, tx *gorm.DB) error {
|
||||
for _, p := range posts {
|
||||
if err := tx.Create(&p).Error; err != nil {
|
||||
```go src=modules/lighthouse/example_test.go#bulk
|
||||
return lighthouse.WithoutBroadcasting[Post](ctx, func(ctx context.Context) error {
|
||||
return lagoon.Transaction(ctx, db, func(ctx context.Context, tx *gorm.DB) error {
|
||||
for _, title := range titles {
|
||||
if err := tx.Create(&Post{BlogID: 7, Title: title}).Error; err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return svc.Emit(ctx, tx, lighthouse.Broadcast{
|
||||
Channels: []string{"blog:7"},
|
||||
Event: "blog.bulk_updated",
|
||||
Event: "blog.posts_imported",
|
||||
Payload: struct {
|
||||
Reason string `json:"reason"`
|
||||
Count int `json:"count"`
|
||||
}{"import", len(posts)},
|
||||
Count int `json:"count"`
|
||||
}{len(titles)},
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -157,7 +149,7 @@ err := lighthouse.WithoutBroadcasting[models.Post](ctx, func(ctx context.Context
|
||||
|
||||
Tests select the memory driver and read what was published:
|
||||
|
||||
```go
|
||||
```go src=modules/lighthouse/example_test.go#publications
|
||||
mem := svc.Driver().(*lighthouse.MemoryDriver)
|
||||
for _, pub := range mem.Publications() {
|
||||
fmt.Println(pub.Method, pub.Channels, pub.Event)
|
||||
|
||||
Reference in New Issue
Block a user