docs(backpack,beachcomber,boardwalk,bonfire,bouncer): compile README Go examples via src= (quick-261118-qsd)
- backpack: Greeter and ExampleApp_Publish replace the whole-file fence - beachcomber: Post's Searchable methods plus a new SearchIndexSchema, a Plugin.Boot that installs the gate, and the existing gate/search regions - boardwalk: new example_test.go; the mount region runs in ExampleHandler - bonfire: importPostsCommand and acmeMain (the binary's main as a function returning the exit code), run by ExampleExecute; ExampleCatalog_Has - bouncer: users/FindByID and ExampleNewJWTGuard; RefreshRoute run by TestDocsRefreshRoute on a production compass config
This commit is contained in:
@@ -42,6 +42,17 @@ func (p *Post) ToSearchableArray(ctx context.Context, db *gorm.DB) (map[string]a
|
||||
}, nil
|
||||
}
|
||||
|
||||
// SearchIndexSchema is the schema a missing index is created with.
|
||||
func (Post) SearchIndexSchema() map[string]any {
|
||||
return map[string]any{
|
||||
"fields": []map[string]any{
|
||||
{"name": "id", "type": "string"},
|
||||
{"name": "blog_id", "type": "int64"},
|
||||
{"name": "title", "type": "string"},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// memoryEngine is a toy engine: it matches Q against the title and ignores
|
||||
// FilterBy, so its answers are loose candidates, as a stale index's are.
|
||||
type memoryEngine struct {
|
||||
@@ -120,6 +131,19 @@ func ExampleFrom() {
|
||||
// true
|
||||
}
|
||||
|
||||
// Plugin is the acme.blog plugin.
|
||||
type Plugin struct{}
|
||||
|
||||
// Boot builds the search service and installs its kill-switch.
|
||||
func (p *Plugin) Boot(app *backpack.App) error {
|
||||
svc, err := beachcomber.From(app)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
installGate(svc)
|
||||
return nil
|
||||
}
|
||||
|
||||
// installGate turns search sync on only while the blog's search setting is
|
||||
// on; a failed read counts as off.
|
||||
func installGate(svc *beachcomber.Service) {
|
||||
@@ -167,7 +191,10 @@ func TestDocsSearch(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
svc, err := beachcomber.From(app)
|
||||
if err := (&Plugin{}).Boot(app); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
svc, err := beachcomber.From(app) // the service Boot built
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@@ -175,7 +202,6 @@ func TestDocsSearch(t *testing.T) {
|
||||
// test installs the toy engine directly, so the global engine list the
|
||||
// package's own tests check stays unchanged.
|
||||
beachcomber.DocsUseEngine(svc, memory)
|
||||
installGate(svc)
|
||||
ctx := t.Context()
|
||||
indexed := func() int {
|
||||
memory.mu.Lock()
|
||||
@@ -255,4 +281,9 @@ func TestDocsDeclarations(t *testing.T) {
|
||||
if err != nil || doc["id"] != "5" || doc["blog_id"] != int64(7) {
|
||||
t.Fatalf("ToSearchableArray = %v, %v", doc, err)
|
||||
}
|
||||
var _ beachcomber.IndexSchemaProvider = Post{}
|
||||
fields, _ := p.SearchIndexSchema()["fields"].([]map[string]any)
|
||||
if len(fields) != 3 || fields[0]["name"] != "id" {
|
||||
t.Fatalf("SearchIndexSchema fields = %v", fields)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user