Add proboctl catalog and banner reset commands
Add operator commands to proboctl for iterating on the cookie-banner agents. The global catalog groups (common-tracker-pattern, common-third-party) list/filter/sort/show the catalogs using the shared coredata cursor layer, and common-tracker-pattern reenrich re-describes selected rows by running the enricher in-process (so it completes synchronously rather than racing the async queue); a --cfg-file flag reuses probod's config to wire the agent. --linked-banner/--linked-org target exactly the catalog rows a banner or org depends on. The cookie-banner reset-trackers command is tenant-scoped (it derives a coredata.Scope from the banner/org GID) and rebuilds a banner's uncategorised, non-excluded patterns from detected_trackers, decomposing derived globs back into exacts, then re-arms the analysis and mapping workers. --mapping-only skips the rebuild. A DB-backed test covers the rebuild, link clearing, and preservation of categorised/excluded patterns. Signed-off-by: Émile Ré <emile@probo.com>
This commit is contained in:
Émile Ré
109
pkg/proboctl/commonthirdparty/commonthirdparty.go
vendored
Normal file
109
pkg/proboctl/commonthirdparty/commonthirdparty.go
vendored
Normal file
@@ -0,0 +1,109 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package commonthirdparty
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"go.gearno.de/kit/pg"
|
||||
"go.probo.inc/probo/pkg/coredata"
|
||||
"go.probo.inc/probo/pkg/gid"
|
||||
"go.probo.inc/probo/pkg/page"
|
||||
"go.probo.inc/probo/pkg/proboctl/cmdutil"
|
||||
)
|
||||
|
||||
// NewCmdCommonThirdParty is the entry point for inspecting the global
|
||||
// common third party catalog.
|
||||
func NewCmdCommonThirdParty(f *cmdutil.Factory) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "common-third-party <command>",
|
||||
Aliases: []string{"ctp3"},
|
||||
Short: "Inspect the global common third party catalog",
|
||||
}
|
||||
|
||||
cmd.AddCommand(newCmdList(f))
|
||||
cmd.AddCommand(newCmdShow(f))
|
||||
cmd.AddCommand(newCmdDomains(f))
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
// resolveCommonThirdParty loads a common third party by GID or slug.
|
||||
func resolveCommonThirdParty(ctx context.Context, conn pg.Querier, value string) (coredata.CommonThirdParty, error) {
|
||||
var party coredata.CommonThirdParty
|
||||
|
||||
if id, err := gid.ParseGID(value); err == nil {
|
||||
if err := party.LoadByID(ctx, conn, id); err != nil {
|
||||
if errors.Is(err, coredata.ErrResourceNotFound) {
|
||||
return party, fmt.Errorf("no common third party found for %q", value)
|
||||
}
|
||||
|
||||
return party, fmt.Errorf("cannot load common third party: %w", err)
|
||||
}
|
||||
|
||||
return party, nil
|
||||
}
|
||||
|
||||
if err := party.LoadBySlug(ctx, conn, value); err != nil {
|
||||
if errors.Is(err, coredata.ErrResourceNotFound) {
|
||||
return party, fmt.Errorf("no common third party found for %q (pass a slug or GID)", value)
|
||||
}
|
||||
|
||||
return party, fmt.Errorf("cannot load common third party: %w", err)
|
||||
}
|
||||
|
||||
return party, nil
|
||||
}
|
||||
|
||||
// parseOrderBy maps the --sort/--order flags to a page.OrderBy. Name
|
||||
// defaults to ascending; the time fields default to descending.
|
||||
func parseOrderBy(sort, order string) (page.OrderBy[coredata.CommonThirdPartyOrderField], error) {
|
||||
var (
|
||||
field coredata.CommonThirdPartyOrderField
|
||||
defaultDesc bool
|
||||
zero page.OrderBy[coredata.CommonThirdPartyOrderField]
|
||||
)
|
||||
|
||||
switch sort {
|
||||
case "name":
|
||||
field = coredata.CommonThirdPartyOrderFieldName
|
||||
case "created":
|
||||
field, defaultDesc = coredata.CommonThirdPartyOrderFieldCreatedAt, true
|
||||
case "updated":
|
||||
field, defaultDesc = coredata.CommonThirdPartyOrderFieldUpdatedAt, true
|
||||
default:
|
||||
return zero, fmt.Errorf("invalid --sort value %q: valid values are name, created, updated", sort)
|
||||
}
|
||||
|
||||
direction := page.OrderDirectionAsc
|
||||
if defaultDesc {
|
||||
direction = page.OrderDirectionDesc
|
||||
}
|
||||
|
||||
switch order {
|
||||
case "":
|
||||
case "asc":
|
||||
direction = page.OrderDirectionAsc
|
||||
case "desc":
|
||||
direction = page.OrderDirectionDesc
|
||||
default:
|
||||
return zero, fmt.Errorf("invalid --order value %q: valid values are asc, desc", order)
|
||||
}
|
||||
|
||||
return page.OrderBy[coredata.CommonThirdPartyOrderField]{Field: field, Direction: direction}, nil
|
||||
}
|
||||
87
pkg/proboctl/commonthirdparty/domains.go
vendored
Normal file
87
pkg/proboctl/commonthirdparty/domains.go
vendored
Normal file
@@ -0,0 +1,87 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package commonthirdparty
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"go.gearno.de/kit/pg"
|
||||
clicmdutil "go.probo.inc/probo/pkg/cmd/cmdutil"
|
||||
"go.probo.inc/probo/pkg/coredata"
|
||||
"go.probo.inc/probo/pkg/proboctl/cmdutil"
|
||||
)
|
||||
|
||||
func newCmdDomains(f *cmdutil.Factory) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "domains <gid|slug>",
|
||||
Short: "List the domains of a common third party",
|
||||
Args: cobra.ExactArgs(1),
|
||||
}
|
||||
|
||||
output := clicmdutil.AddOutputFlag(cmd)
|
||||
|
||||
cmd.RunE = func(cmd *cobra.Command, args []string) error {
|
||||
if err := clicmdutil.ValidateOutputFlag(output); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
pgClient, err := f.PgClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var domains coredata.CommonThirdPartyDomains
|
||||
|
||||
if err := pgClient.WithConn(
|
||||
cmd.Context(),
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
party, err := resolveCommonThirdParty(ctx, conn, args[0])
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := domains.LoadByCommonThirdPartyID(ctx, conn, party.ID); err != nil {
|
||||
return fmt.Errorf("cannot load domains: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if *output == clicmdutil.OutputJSON {
|
||||
return clicmdutil.PrintJSON(f.IOStreams.Out, domains)
|
||||
}
|
||||
|
||||
if len(domains) == 0 {
|
||||
_, _ = fmt.Fprintln(f.IOStreams.Out, "No domains found.")
|
||||
return nil
|
||||
}
|
||||
|
||||
table := clicmdutil.NewTable("DOMAIN", "ID")
|
||||
for _, d := range domains {
|
||||
table.Row(d.Domain, d.ID.String())
|
||||
}
|
||||
|
||||
_, _ = fmt.Fprintln(f.IOStreams.Out, table.Render())
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
return cmd
|
||||
}
|
||||
143
pkg/proboctl/commonthirdparty/list.go
vendored
Normal file
143
pkg/proboctl/commonthirdparty/list.go
vendored
Normal file
@@ -0,0 +1,143 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package commonthirdparty
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"go.gearno.de/kit/pg"
|
||||
clicmdutil "go.probo.inc/probo/pkg/cmd/cmdutil"
|
||||
"go.probo.inc/probo/pkg/coredata"
|
||||
"go.probo.inc/probo/pkg/page"
|
||||
"go.probo.inc/probo/pkg/proboctl/cmdutil"
|
||||
)
|
||||
|
||||
func newCmdList(f *cmdutil.Factory) *cobra.Command {
|
||||
var (
|
||||
flagName string
|
||||
flagCategory string
|
||||
flagKeyword string
|
||||
flagSort string
|
||||
flagOrder string
|
||||
flagLimit int
|
||||
)
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "list",
|
||||
Short: "List common third parties with filters and sorting",
|
||||
Args: cobra.NoArgs,
|
||||
}
|
||||
|
||||
output := clicmdutil.AddOutputFlag(cmd)
|
||||
|
||||
cmd.Flags().StringVar(&flagName, "name", "", "Filter by name substring")
|
||||
cmd.Flags().StringVar(&flagCategory, "category", "", "Filter by category")
|
||||
cmd.Flags().StringVar(&flagKeyword, "keyword", "", "Filter by name/slug substring")
|
||||
cmd.Flags().StringVar(&flagSort, "sort", "name", "Sort field: name, created, updated")
|
||||
cmd.Flags().StringVar(&flagOrder, "order", "", "Sort order: asc, desc (default depends on field)")
|
||||
cmd.Flags().IntVarP(&flagLimit, "limit", "L", 50, "Maximum rows to return (0 for all)")
|
||||
|
||||
cmd.RunE = func(cmd *cobra.Command, args []string) error {
|
||||
if err := clicmdutil.ValidateOutputFlag(output); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
orderBy, err := parseOrderBy(flagSort, flagOrder)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
filter := coredata.NewCommonThirdPartyFilter(optionalString(flagName))
|
||||
|
||||
if flagCategory != "" {
|
||||
cat := coredata.ThirdPartyCategory(flagCategory)
|
||||
if !cat.IsValid() {
|
||||
return fmt.Errorf("invalid --category value %q", flagCategory)
|
||||
}
|
||||
|
||||
filter.WithCategory(&cat)
|
||||
}
|
||||
|
||||
if flagKeyword != "" {
|
||||
filter.WithKeyword(&flagKeyword)
|
||||
}
|
||||
|
||||
pgClient, err := f.PgClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var parties coredata.CommonThirdParties
|
||||
|
||||
if err := pgClient.WithConn(
|
||||
cmd.Context(),
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
rows, err := cmdutil.Paginate(
|
||||
ctx,
|
||||
orderBy,
|
||||
flagLimit,
|
||||
func(ctx context.Context, cursor *page.Cursor[coredata.CommonThirdPartyOrderField]) ([]*coredata.CommonThirdParty, error) {
|
||||
var ts coredata.CommonThirdParties
|
||||
if err := ts.Load(ctx, conn, cursor, filter); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return ts, nil
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
parties = rows
|
||||
|
||||
return nil
|
||||
},
|
||||
); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if *output == clicmdutil.OutputJSON {
|
||||
return clicmdutil.PrintJSON(f.IOStreams.Out, parties)
|
||||
}
|
||||
|
||||
if len(parties) == 0 {
|
||||
_, _ = fmt.Fprintln(f.IOStreams.Out, "No common third parties found.")
|
||||
return nil
|
||||
}
|
||||
|
||||
table := clicmdutil.NewTable("ID", "NAME", "SLUG", "CATEGORY")
|
||||
for _, p := range parties {
|
||||
table.Row(p.ID.String(), p.Name, p.Slug, string(p.Category))
|
||||
}
|
||||
|
||||
_, _ = fmt.Fprintln(f.IOStreams.Out, table.Render())
|
||||
_, _ = fmt.Fprintf(f.IOStreams.ErrOut, "Showing %d common third parties.\n", len(parties))
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
||||
func optionalString(s string) *string {
|
||||
if s == "" {
|
||||
return nil
|
||||
}
|
||||
|
||||
return &s
|
||||
}
|
||||
122
pkg/proboctl/commonthirdparty/show.go
vendored
Normal file
122
pkg/proboctl/commonthirdparty/show.go
vendored
Normal file
@@ -0,0 +1,122 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
// copyright notice and this permission notice appear in all copies.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
||||
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
||||
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
||||
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
||||
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
package commonthirdparty
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/charmbracelet/lipgloss"
|
||||
"github.com/spf13/cobra"
|
||||
"go.gearno.de/kit/pg"
|
||||
clicmdutil "go.probo.inc/probo/pkg/cmd/cmdutil"
|
||||
"go.probo.inc/probo/pkg/coredata"
|
||||
"go.probo.inc/probo/pkg/proboctl/cmdutil"
|
||||
)
|
||||
|
||||
func newCmdShow(f *cmdutil.Factory) *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "show <gid|slug>",
|
||||
Short: "Show a single common third party with its domains and linked pattern count",
|
||||
Args: cobra.ExactArgs(1),
|
||||
}
|
||||
|
||||
output := clicmdutil.AddOutputFlag(cmd)
|
||||
|
||||
cmd.RunE = func(cmd *cobra.Command, args []string) error {
|
||||
if err := clicmdutil.ValidateOutputFlag(output); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
pgClient, err := f.PgClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var (
|
||||
party coredata.CommonThirdParty
|
||||
domains coredata.CommonThirdPartyDomains
|
||||
patternCount int
|
||||
)
|
||||
|
||||
if err := pgClient.WithConn(
|
||||
cmd.Context(),
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
party, err = resolveCommonThirdParty(ctx, conn, args[0])
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := domains.LoadByCommonThirdPartyID(ctx, conn, party.ID); err != nil {
|
||||
return fmt.Errorf("cannot load domains: %w", err)
|
||||
}
|
||||
|
||||
var patterns coredata.CommonTrackerPatterns
|
||||
if err := patterns.LoadByCommonThirdPartyID(ctx, conn, party.ID); err != nil {
|
||||
return fmt.Errorf("cannot load linked patterns: %w", err)
|
||||
}
|
||||
|
||||
patternCount = len(patterns)
|
||||
|
||||
return nil
|
||||
},
|
||||
); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if *output == clicmdutil.OutputJSON {
|
||||
return clicmdutil.PrintJSON(f.IOStreams.Out, map[string]any{
|
||||
"thirdParty": party,
|
||||
"domains": domains,
|
||||
"linkedPatternCount": patternCount,
|
||||
})
|
||||
}
|
||||
|
||||
out := f.IOStreams.Out
|
||||
label := lipgloss.NewStyle().Foreground(lipgloss.Color("242")).Width(20)
|
||||
row := func(name, value string) {
|
||||
_, _ = fmt.Fprintf(out, "%s%s\n", label.Render(name), value)
|
||||
}
|
||||
|
||||
row("ID:", party.ID.String())
|
||||
row("Name:", party.Name)
|
||||
row("Slug:", party.Slug)
|
||||
row("Category:", string(party.Category))
|
||||
|
||||
if party.WebsiteURL != nil {
|
||||
row("Website:", *party.WebsiteURL)
|
||||
}
|
||||
|
||||
domainNames := make([]string, 0, len(domains))
|
||||
for _, d := range domains {
|
||||
domainNames = append(domainNames, d.Domain)
|
||||
}
|
||||
|
||||
if len(domainNames) > 0 {
|
||||
row("Domains:", strings.Join(domainNames, ", "))
|
||||
} else {
|
||||
row("Domains:", "(none)")
|
||||
}
|
||||
|
||||
row("Linked patterns:", fmt.Sprintf("%d", patternCount))
|
||||
row("Created:", party.CreatedAt.Format("2006-01-02 15:04:05"))
|
||||
row("Updated:", party.UpdatedAt.Format("2006-01-02 15:04:05"))
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
return cmd
|
||||
}
|
||||
Reference in New Issue
Block a user