Files
probo/pkg/proboctl/commontrackerpattern/set_description.go
Émile Ré 31c4a0b39c Add proboctl catalog upsert, link, and describe commands
Operators previously had no way to curate the global tracker catalog
beyond inspection and banner-scoped resets. Add three proboctl commands
backed by small coredata helpers:

- common-third-party upsert: create or update a vendor keyed by slug,
  with partial-merge so an unset flag never blanks an existing column.
- common-tracker-pattern link/unlink: repoint catalog rows at a common
  third party (re-arming enrichment and remapping the uncategorised org
  trackers so the mapping worker re-resolves the vendor) or detach them.
  Unlinking skips enrichment and remap since there is no new vendor.
- common-tracker-pattern set-description: write a description, mark the
  row enriched, and backfill linked org patterns lacking one.

Signed-off-by: Émile Ré <emile@probo.com>
2026-06-10 17:49:40 +02:00

110 lines
3.2 KiB
Go

// 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 commontrackerpattern
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/proboctl/cmdutil"
)
func newCmdSetDescription(f *cmdutil.Factory) *cobra.Command {
var (
flagDescription string
flagYes bool
)
cmd := &cobra.Command{
Use: "set-description <gid>",
Short: "Set a common tracker pattern's description and backfill org patterns",
Long: "Write a description on a common tracker pattern and mark it enriched so " +
"the enrichment worker leaves it alone, then backfill the description onto " +
"every linked org tracker pattern that does not already have one.",
Args: cobra.ExactArgs(1),
}
cmd.Flags().StringVar(&flagDescription, "description", "", "Description to set (required)")
cmd.Flags().BoolVar(&flagYes, "yes", false, "Skip confirmation")
_ = cmd.MarkFlagRequired("description")
cmd.RunE = func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
if flagDescription == "" {
return fmt.Errorf("--description must not be empty")
}
id, err := gid.ParseGID(args[0])
if err != nil {
return fmt.Errorf("invalid GID %q: %w", args[0], err)
}
if !flagYes {
return fmt.Errorf("about to set the description on %s; pass --yes to proceed", id.String())
}
pgClient, err := f.PgClient()
if err != nil {
return err
}
out := f.IOStreams.Out
var backfilled int64
if err := pgClient.WithTx(
ctx,
func(ctx context.Context, tx pg.Tx) error {
var pattern coredata.CommonTrackerPattern
if err := pattern.LoadByID(ctx, tx, id); err != nil {
if errors.Is(err, coredata.ErrResourceNotFound) {
return fmt.Errorf("no common tracker pattern found for %q", args[0])
}
return fmt.Errorf("cannot load common tracker pattern: %w", err)
}
if err := pattern.SetEnriched(ctx, tx, flagDescription, nil); err != nil {
return fmt.Errorf("cannot set common tracker pattern description: %w", err)
}
var tps coredata.TrackerPatterns
backfilled, err = tps.BackfillDescriptionByCommonTrackerPatternID(ctx, tx, id, flagDescription)
if err != nil {
return err
}
return nil
},
); err != nil {
return err
}
_, _ = fmt.Fprintf(out, "Set description on %s, backfilled %d org tracker pattern(s).\n", id.String(), backfilled)
return nil
}
return cmd
}