miller/pkg/transformers/nest.go
John Kerl f637633420
Tier-2 structured verb options: OptionSpec, initial migration (#2098) (#2111)
* Tier-2 structured verb options: OptionSpec, initial migration (#2098)

PR 3 of the AI-friendly roadmap (plans/plan-2098-llm.md).

Infrastructure:
- Add OptionSpec{Flag,Arg,Type,Desc,Repeatable,Values} to
  pkg/transformers/aaa_record_transformer.go alongside TransformerSetup.
  Type is one of: bool, string, int, float, csv-list, regex, filename,
  format, enum. For type=="enum", Values lists the valid choices.
- Add Options []OptionSpec to TransformerSetup (nil = not yet migrated).
- Emit Options in VerbInfoForJSON (omitempty so unmigrated verbs stay
  backward-compatible; agents check key presence for Tier-2 availability).
  UsageText is always present as the Tier-1 prose fallback.
- Add VerbOptionsNilCheck() in aaa_verb_options_check.go: progress report
  of migrated vs. unmigrated verbs, analogous to FLAG_TABLE.NilCheck().
- Wire verb-options-nil-check into mlr help (internal/docgen section).

Initial migration (5/70 verbs):
- nothing: empty Options (no verb-specific options, explicitly migrated)
- cat: -n (bool), -N (string), -g (csv-list), --filename, --filenum (bool)
- head: -g (csv-list), -n (int)
- tail: -g (csv-list), -n (int)
- tee: -a, -p (bool)

Tests:
- 5 new unit tests in aaa_transformer_json_test.go covering migrated/
  unmigrated paths, field population, JSON round-trip, and key-presence.
- Regression test case 0003: mlr help verb-options-nil-check golden output.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* Migrate all 70 verbs to structured OptionSpec; bump catalog schema to v2

Completes the Tier-2 migration started in the previous commit. Every verb
in TRANSFORMER_LOOKUP_TABLE now has a non-nil Options field.

- Workflow-migrated all 65 remaining verbs. Each Setup var now carries
  Options: []OptionSpec{...} with Flag/Arg/Type/Desc fields. Verbs with
  no verb-specific options (altkv, check, group-like, nothing, etc.) use
  an empty slice to signal "migrated but no options."
- Drop `omitempty` from VerbInfoForJSON.Options: empty slices were silently
  dropped, making migrated-no-option verbs indistinguishable from unmigrated
  ones in JSON. Without omitempty: null=unmigrated, []=migrated-no-options,
  [...]= migrated-with-options. Bump catalogSchemaVersion 1→2 for this shape
  change.
- Replace the two "unmigrated-verb" unit tests (which used stats1 as an
  example) with TestAllVerbsFullyMigrated (asserts every verb has non-nil
  Options) and TestAllVerbsHaveOptionsKeyInJSON (asserts every migrated
  verb emits the "options" key in JSON).
- Regenerate test/cases/cli-help/0003/expout: now reads
  "Verb options migration: 70/70 migrated."

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* remove a transitional helper

* git rms

* Render verb usage Options blocks from structured OptionSpec

Each verb's usage message and its Tier-2 OptionSpec list previously
duplicated the option text. New WriteVerbOptions (aaa_verb_usage.go)
renders the "Options:" block from the specs: aligned flag column,
descriptions word-wrapped at 80, uniform trailing -h|--help line.

- OptionSpec gains Aliases (JSON "aliases") so long-form spellings
  like join's --lk|--left-keep-field-names survive in both outputs
- All 70 verbs migrated; options literals hoisted to package-level
  vars (usage funcs can't reference their Setup var without a Go
  init cycle)
- Hand-written per-option details the specs had condensed away are
  merged into Desc, enriching the JSON catalog
- Non-option prose (examples, cross-references, dynamic accumulator
  listings) kept verbatim
- Regenerated the six usage-embedding regression expectations and
  the two affected doc pages

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Fix pre-existing usage-text bugs surfaced by the OptionSpec migration

- gap: usage said "One of -f or -g is required" but the parser takes
  -n or -g
- seqgen: drop description line copy-pasted from cat ("Passes input
  records directly to output...") which contradicted "Discards the
  input record stream"
- utf8-to-latin1: description read inverted ("from Latin-1 to UTF-8")
- sec2gmtdate: usage said "../c/mlr" instead of "mlr"
- top: document the accepted-but-undocumented --max flag
- stats2: add linreg-pca to the -a enum values, matching the runtime
  accumulator table

Regression expectations and docs regenerated accordingly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* Fix check usage sentence order; stats1 usage blank line to usage stream

- check: the description's second and third lines were swapped,
  reading "Consumes records without printing any output, / Useful for
  doing a well-formatted check on input data. / with the exception
  that warnings are printed to stderr."
- stats1: a bare fmt.Println() in the usage func wrote its blank line
  to process stdout instead of the usage output stream

Regression expectation and docs regenerated.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
2026-07-03 14:27:23 -04:00

704 lines
21 KiB
Go

package transformers
import (
"bytes"
"fmt"
"os"
"regexp"
"strconv"
"strings"
"github.com/johnkerl/miller/v6/pkg/cli"
"github.com/johnkerl/miller/v6/pkg/lib"
"github.com/johnkerl/miller/v6/pkg/mlrval"
"github.com/johnkerl/miller/v6/pkg/types"
)
const verbNameNest = "nest"
var nestOptions = []OptionSpec{
{Flag: "--explode", Type: "bool", Desc: "Explode field values into separate fields/records. One of --explode or --implode is required."},
{Flag: "--implode", Type: "bool", Desc: "Reverse of --explode. One of --explode or --implode is required."},
{Flag: "--values", Type: "bool", Desc: "Operate on field values. One of --values or --pairs is required."},
{Flag: "--pairs", Type: "bool", Desc: "Operate on field key-value pairs. One of --values or --pairs is required."},
{Flag: "--across-records", Type: "bool", Desc: "Explode/implode across records. One of --across-records or --across-fields is required."},
{Flag: "--across-fields", Type: "bool", Desc: "Explode/implode across fields. One of --across-records or --across-fields is required."},
{Flag: "-f", Arg: "{field name}", Type: "string", Desc: "Required field name to operate on."},
{Flag: "-r", Arg: "{field names}", Type: "regex", Desc: "Like -f but treat arguments as a regular expression. Match all field names and operate on each in record order. Example: -r '^[xy]$'."},
{Flag: "--nested-fs", Arg: "{string}", Type: "string", Desc: "Field separator for nested values. Defaults to \";\"."},
{Flag: "--nested-ps", Arg: "{string}", Type: "string", Desc: "Pair separator for nested key-value pairs. Defaults to \":\"."},
{Flag: "--evar", Arg: "{string}", Type: "string", Desc: "Shorthand for --explode --values --across-records --nested-fs {string}."},
{Flag: "--ivar", Arg: "{string}", Type: "string", Desc: "Shorthand for --implode --values --across-records --nested-fs {string}."},
}
var NestSetup = TransformerSetup{
Verb: verbNameNest,
UsageFunc: transformerNestUsage,
ParseCLIFunc: transformerNestParseCLI,
IgnoresInput: false,
Options: nestOptions,
}
func transformerNestUsage(
o *os.File,
) {
argv0 := "mlr"
verb := verbNameNest
fmt.Fprintf(o, "Usage: %s %s [options]\n", argv0, verb)
fmt.Fprintf(o, "Explodes specified field values into separate fields/records, or reverses this.\n")
WriteVerbOptions(o, nestOptions)
fmt.Fprintf(o, "Please use \"%s --usage-separator-options\" for information on specifying separators.\n",
argv0)
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, "Examples:\n")
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, " %s %s --explode --values --across-records -f x\n", argv0, verb)
fmt.Fprintf(o, " with input record \"x=a;b;c,y=d\" produces output records\n")
fmt.Fprintf(o, " \"x=a,y=d\"\n")
fmt.Fprintf(o, " \"x=b,y=d\"\n")
fmt.Fprintf(o, " \"x=c,y=d\"\n")
fmt.Fprintf(o, " Use --implode to do the reverse.\n")
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, " %s %s --explode --values --across-fields -f x\n", argv0, verb)
fmt.Fprintf(o, " with input record \"x=a;b;c,y=d\" produces output records\n")
fmt.Fprintf(o, " \"x_1=a,x_2=b,x_3=c,y=d\"\n")
fmt.Fprintf(o, " Use --implode to do the reverse.\n")
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, " %s %s --explode --pairs --across-records -f x\n", argv0, verb)
fmt.Fprintf(o, " with input record \"x=a:1;b:2;c:3,y=d\" produces output records\n")
fmt.Fprintf(o, " \"a=1,y=d\"\n")
fmt.Fprintf(o, " \"b=2,y=d\"\n")
fmt.Fprintf(o, " \"c=3,y=d\"\n")
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, " %s %s --explode --pairs --across-fields -f x\n", argv0, verb)
fmt.Fprintf(o, " with input record \"x=a:1;b:2;c:3,y=d\" produces output records\n")
fmt.Fprintf(o, " \"a=1,b=2,c=3,y=d\"\n")
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, "Notes:\n")
fmt.Fprintf(o, "* With --pairs, --implode doesn't make sense since the original field name has\n")
fmt.Fprintf(o, " been lost.\n")
fmt.Fprintf(o, "* The combination \"--implode --values --across-records\" is non-streaming:\n")
fmt.Fprintf(o, " no output records are produced until all input records have been read. In\n")
fmt.Fprintf(o, " particular, this means it won't work in `tail -f` contexts. But all other flag\n")
fmt.Fprintf(o, " combinations result in streaming (`tail -f` friendly) data processing.\n")
fmt.Fprintf(o, " If input is coming from `tail -f`, be sure to use `--records-per-batch 1`.\n")
fmt.Fprintf(o, "* It's up to you to ensure that the nested-fs is distinct from your data's IFS:\n")
fmt.Fprintf(o, " e.g. by default the former is semicolon and the latter is comma.\n")
fmt.Fprintf(o, "See also %s reshape.\n", argv0)
}
func transformerNestParseCLI(
pargi *int,
argc int,
args []string,
_ *cli.TOptions,
doConstruct bool, // false for first pass of CLI-parse, true for second pass
) (RecordTransformer, error) {
// Skip the verb name from the current spot in the mlr command line
argi := *pargi
verb := args[argi]
argi++
// Parse local flags
fieldName := ""
doRegexes := false
nestedFS := ";"
nestedPS := ":"
doExplode := true
doPairs := true
doAcrossFields := true
doExplodeSpecified := false
doPairsSpecified := false
doAcrossFieldsSpecified := false
evfs := ""
ivfs := ""
for argi < argc /* variable increment: 1 or 2 depending on flag */ {
opt := args[argi]
if !strings.HasPrefix(opt, "-") {
break // No more flag options to process
}
if args[argi] == "--" {
break // All transformers must do this so main-flags can follow verb-flags
}
argi++
switch opt {
case "-h", "--help":
transformerNestUsage(os.Stdout)
return nil, cli.ErrHelpRequested
case "-f":
s, err := cli.VerbGetStringArg(verb, opt, args, &argi, argc)
if err != nil {
return nil, err
}
fieldName = s
case "-r":
doRegexes = true
s, err := cli.VerbGetStringArg(verb, opt, args, &argi, argc)
if err != nil {
return nil, err
}
fieldName = s
case "--explode", "-e":
doExplode = true
doExplodeSpecified = true
case "--implode", "-i":
doExplode = false
doExplodeSpecified = true
case "--values", "-v":
doPairs = false
doPairsSpecified = true
case "--pairs", "-p":
doPairs = true
doPairsSpecified = true
case "--across-fields", "-F":
doAcrossFields = true
doAcrossFieldsSpecified = true
case "--across-records", "-R":
doAcrossFields = false
doAcrossFieldsSpecified = true
case "--nested-fs", "-S":
s, err := cli.VerbGetStringArg(verb, opt, args, &argi, argc)
if err != nil {
return nil, err
}
nestedFS = s
case "--nested-ps", "-P":
s, err := cli.VerbGetStringArg(verb, opt, args, &argi, argc)
if err != nil {
return nil, err
}
nestedPS = s
case "--evar":
s, err := cli.VerbGetStringArg(verb, opt, args, &argi, argc)
if err != nil {
return nil, err
}
evfs = s
doExplode = true
doExplodeSpecified = true
doPairs = false
doPairsSpecified = true
doAcrossFields = false
doAcrossFieldsSpecified = true
case "--ivar":
s, err := cli.VerbGetStringArg(verb, opt, args, &argi, argc)
if err != nil {
return nil, err
}
ivfs = s
doExplode = false
doExplodeSpecified = true
doPairs = false
doPairsSpecified = true
doAcrossFields = false
doAcrossFieldsSpecified = true
default:
transformerNestUsage(os.Stderr)
return nil, fmt.Errorf("%s %s: option \"%s\" not recognized", "mlr", verb, opt)
}
}
if evfs != "" {
doExplode = true
doPairs = false
doAcrossFields = false
nestedFS = evfs
}
if ivfs != "" {
doExplode = false
doPairs = false
doAcrossFields = false
nestedFS = ivfs
}
if fieldName == "" {
transformerNestUsage(os.Stderr)
return nil, fmt.Errorf("%s %s: -f or -r is required", "mlr", verb)
}
if !doExplodeSpecified {
transformerNestUsage(os.Stderr)
return nil, fmt.Errorf("%s %s: --explode or --implode is required", "mlr", verb)
}
if !doPairsSpecified {
transformerNestUsage(os.Stderr)
return nil, fmt.Errorf("%s %s: --values or --pairs is required", "mlr", verb)
}
if !doAcrossFieldsSpecified {
transformerNestUsage(os.Stderr)
return nil, fmt.Errorf("%s %s: --across-records or --across-fields is required", "mlr", verb)
}
if doPairs && !doExplode {
transformerNestUsage(os.Stderr)
return nil, fmt.Errorf("%s %s: --implode with --pairs doesn't make sense", "mlr", verb)
}
if doRegexes && !doExplode {
return nil, fmt.Errorf("mlr nest: -r is only supported with --explode, not --implode")
}
*pargi = argi
if !doConstruct { // All transformers must do this for main command-line parsing
return nil, nil
}
transformer, err := NewTransformerNest(
fieldName,
doRegexes,
nestedFS,
nestedPS,
doExplode,
doPairs,
doAcrossFields,
)
if err != nil {
return nil, err
}
return transformer, nil
}
type TransformerNest struct {
fieldName string
nestedFS string
nestedPS string
doRegexes bool
fieldRegex *regexp.Regexp // when doRegexes, for matching field names
// For implode across fields (when !doRegexes)
regex *regexp.Regexp
// For implode across records
otherKeysToOtherValuesToBuckets *lib.OrderedMap[*lib.OrderedMap[*tNestBucket]]
recordTransformerFunc RecordTransformerFunc
}
func NewTransformerNest(
fieldName string,
doRegexes bool,
nestedFS string,
nestedPS string,
doExplode bool,
doPairs bool,
doAcrossFields bool,
) (*TransformerNest, error) {
tr := &TransformerNest{
fieldName: fieldName,
doRegexes: doRegexes,
nestedFS: cli.SeparatorFromArg(nestedFS), // "pipe" -> "|", etc
nestedPS: cli.SeparatorFromArg(nestedPS),
}
// For implode across fields: regex to match exploded form (e.g. x_1, x_2)
if doRegexes {
fieldRegex, err := lib.CompileMillerRegex(fieldName)
if err != nil {
fmt.Fprintf(
os.Stderr,
"%s %s: cannot compile regex [%s]\n",
"mlr", verbNameNest, fieldName,
)
os.Exit(1)
}
tr.fieldRegex = fieldRegex
// implode uses fieldRegex directly when doRegexes
tr.regex = fieldRegex
} else {
regexString := "^" + fieldName + "_[0-9]+$"
regex, err := lib.CompileMillerRegex(regexString)
if err != nil {
fmt.Fprintf(
os.Stderr,
"%s %s: cannot compile regex [%s]\n",
"mlr", verbNameNest, regexString,
)
os.Exit(1)
}
tr.regex = regex
}
// For implode across records
tr.otherKeysToOtherValuesToBuckets = lib.NewOrderedMap[*lib.OrderedMap[*tNestBucket]]()
if doExplode {
if doPairs {
if doAcrossFields {
tr.recordTransformerFunc = tr.explodePairsAcrossFields
} else {
tr.recordTransformerFunc = tr.explodePairsAcrossRecords
}
} else {
if doAcrossFields {
tr.recordTransformerFunc = tr.explodeValuesAcrossFields
} else {
tr.recordTransformerFunc = tr.explodeValuesAcrossRecords
}
}
} else {
if doPairs {
lib.InternalCodingErrorIf(true)
// Should have been caught in CLI-parser.
} else {
if doAcrossFields {
tr.recordTransformerFunc = tr.implodeValuesAcrossFields
} else {
tr.recordTransformerFunc = tr.implodeValueAcrossRecords
}
}
}
return tr, nil
}
func (tr *TransformerNest) Transform(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
HandleDefaultDownstreamDone(inputDownstreamDoneChannel, outputDownstreamDoneChannel)
tr.recordTransformerFunc(inrecAndContext, outputRecordsAndContexts, inputDownstreamDoneChannel, outputDownstreamDoneChannel)
}
// getMatchingFieldNames returns field names matching tr.fieldRegex in record order.
// When !tr.doRegexes, returns [tr.fieldName] if present, else [].
func (tr *TransformerNest) getMatchingFieldNames(inrec *mlrval.Mlrmap) []string {
if !tr.doRegexes {
if inrec.Get(tr.fieldName) != nil {
return []string{tr.fieldName}
}
return nil
}
var names []string
for pe := inrec.Head; pe != nil; pe = pe.Next {
if tr.fieldRegex.MatchString(pe.Key) {
names = append(names, pe.Key)
}
}
return names
}
func (tr *TransformerNest) explodeValuesAcrossFields(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
if !inrecAndContext.EndOfStream {
inrec := inrecAndContext.Record
fieldNames := tr.getMatchingFieldNames(inrec)
if len(fieldNames) == 0 {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
for _, fieldName := range fieldNames {
originalEntry := inrec.GetEntry(fieldName)
if originalEntry == nil {
continue
}
recordEntry := originalEntry
mvalue := originalEntry.Value
svalue := mvalue.String()
// Not lib.SplitString so 'x=' will map to 'x_1=', rather than no field at all
pieces := strings.Split(svalue, tr.nestedFS)
i := 1
for _, piece := range pieces {
key := fieldName + "_" + strconv.Itoa(i)
value := mlrval.FromString(piece)
recordEntry = inrec.PutReferenceAfter(recordEntry, key, value)
i++
}
inrec.Unlink(originalEntry)
}
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
} else {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext) // emit end-of-stream marker
}
}
func (tr *TransformerNest) explodeValuesAcrossRecords(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
if !inrecAndContext.EndOfStream {
inrec := inrecAndContext.Record
fieldNames := tr.getMatchingFieldNames(inrec)
if len(fieldNames) == 0 {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
fieldName := fieldNames[0]
mvalue := inrec.Get(fieldName)
if mvalue == nil {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
svalue := mvalue.String()
// Not lib.SplitString so 'x=' will map to 'x=', rather than no field at all
pieces := strings.SplitSeq(svalue, tr.nestedFS)
for piece := range pieces {
outrec := inrec.Copy()
outrec.PutReference(fieldName, mlrval.FromString(piece))
*outputRecordsAndContexts = append(*outputRecordsAndContexts, types.NewRecordAndContext(outrec, &inrecAndContext.Context))
}
} else {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext) // emit end-of-stream marker
}
}
func (tr *TransformerNest) explodePairsAcrossFields(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
if !inrecAndContext.EndOfStream {
inrec := inrecAndContext.Record
fieldNames := tr.getMatchingFieldNames(inrec)
if len(fieldNames) == 0 {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
for _, fieldName := range fieldNames {
originalEntry := inrec.GetEntry(fieldName)
if originalEntry == nil {
continue
}
mvalue := originalEntry.Value
svalue := mvalue.String()
recordEntry := originalEntry
pieces := lib.SplitString(svalue, tr.nestedFS)
for _, piece := range pieces {
pair := strings.SplitN(piece, tr.nestedPS, 2)
if len(pair) == 2 { // there is a pair
recordEntry = inrec.PutReferenceAfter(
recordEntry,
pair[0],
mlrval.FromString(pair[1]),
)
} else { // there is not a pair
recordEntry = inrec.PutReferenceAfter(
recordEntry,
fieldName,
mlrval.FromString(piece),
)
}
}
inrec.Unlink(originalEntry)
}
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
} else {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext) // emit end-of-stream marker
}
}
func (tr *TransformerNest) explodePairsAcrossRecords(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
if !inrecAndContext.EndOfStream {
inrec := inrecAndContext.Record
fieldNames := tr.getMatchingFieldNames(inrec)
if len(fieldNames) == 0 {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
fieldName := fieldNames[0]
mvalue := inrec.Get(fieldName)
if mvalue == nil {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
svalue := mvalue.String()
pieces := lib.SplitString(svalue, tr.nestedFS)
for _, piece := range pieces {
outrec := inrec.Copy()
originalEntry := outrec.GetEntry(fieldName)
// Put the new field where the old one was -- unless there's already a field with the new
// name, in which case replace its value.
pair := strings.SplitN(piece, tr.nestedPS, 2)
if len(pair) == 2 { // there is a pair
outrec.PutReferenceAfter(originalEntry, pair[0], mlrval.FromString(pair[1]))
} else { // there is not a pair
outrec.PutReferenceAfter(originalEntry, fieldName, mlrval.FromString(piece))
}
outrec.Unlink(originalEntry)
*outputRecordsAndContexts = append(*outputRecordsAndContexts, types.NewRecordAndContext(outrec, &inrecAndContext.Context))
}
} else {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext) // emit end-of-stream marker
}
}
func (tr *TransformerNest) implodeValuesAcrossFields(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
if !inrecAndContext.EndOfStream {
inrec := inrecAndContext.Record
var previousEntry *mlrval.MlrmapEntry = nil
fieldCount := 0
var buffer bytes.Buffer
for pe := inrec.Head; pe != nil; /* increment in loop */ {
if tr.regex.MatchString(pe.Key) {
if fieldCount > 0 {
buffer.WriteString(tr.nestedFS)
}
buffer.WriteString(pe.Value.String())
fieldCount++
// Keep the location so we can implode in-place.
if previousEntry == nil {
previousEntry = pe.Prev
}
pnext := pe.Next
inrec.Unlink(pe)
pe = pnext
} else {
pe = pe.Next
}
}
if fieldCount > 0 {
newValue := mlrval.FromString(buffer.String())
if previousEntry == nil { // No record before the unlinked one, i.e. list-head.
inrec.PrependReference(tr.fieldName, newValue)
} else {
inrec.PutReferenceAfter(previousEntry, tr.fieldName, newValue)
}
}
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
} else {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext) // emit end-of-stream marker
}
}
func (tr *TransformerNest) implodeValueAcrossRecords(
inrecAndContext *types.RecordAndContext,
outputRecordsAndContexts *[]*types.RecordAndContext, // list of *types.RecordAndContext
inputDownstreamDoneChannel <-chan bool,
outputDownstreamDoneChannel chan<- bool,
) {
if !inrecAndContext.EndOfStream {
inrec := inrecAndContext.Record
originalEntry := inrec.GetEntry(tr.fieldName)
if originalEntry == nil {
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext)
return
}
fieldValueCopy := originalEntry.Value.Copy()
// Don't unset tr.fieldName in the record, so we can implode in-place at the end.
otherKeysJoined := inrec.GetKeysJoinedExcept(originalEntry)
var otherValuesToBuckets *lib.OrderedMap[*tNestBucket] = nil
iOtherValuesToBuckets := tr.otherKeysToOtherValuesToBuckets.Get(otherKeysJoined)
if iOtherValuesToBuckets == nil {
otherValuesToBuckets = lib.NewOrderedMap[*tNestBucket]()
tr.otherKeysToOtherValuesToBuckets.Put(otherKeysJoined, otherValuesToBuckets)
} else {
otherValuesToBuckets = iOtherValuesToBuckets
}
otherValuesJoined := inrec.GetValuesJoinedExcept(originalEntry)
bucket := otherValuesToBuckets.Get(otherValuesJoined)
if bucket == nil {
bucket = newNestBucket(inrec)
otherValuesToBuckets.Put(otherValuesJoined, bucket)
}
pair := mlrval.NewMlrmapAsRecord()
pair.PutReference(tr.fieldName, fieldValueCopy)
bucket.pairs = append(bucket.pairs, pair)
} else { // end of input stream
for pe := tr.otherKeysToOtherValuesToBuckets.Head; pe != nil; pe = pe.Next {
otherValuesToBuckets := pe.Value
for pf := otherValuesToBuckets.Head; pf != nil; pf = pf.Next {
var buffer bytes.Buffer
bucket := pf.Value
outrec := bucket.representative
bucket.representative = nil // ownership transfer
i := 0
for _, pr := range bucket.pairs {
if i > 0 {
buffer.WriteString(tr.nestedFS)
}
i++
buffer.WriteString(pr.Head.Value.String())
}
// tr.fieldName was already present so we'll overwrite it in-place here.
outrec.PutReference(tr.fieldName, mlrval.FromString(buffer.String()))
*outputRecordsAndContexts = append(*outputRecordsAndContexts, types.NewRecordAndContext(outrec, &inrecAndContext.Context))
}
}
*outputRecordsAndContexts = append(*outputRecordsAndContexts, inrecAndContext) // emit end-of-stream marker
}
}
type tNestBucket struct {
representative *mlrval.Mlrmap
pairs []*mlrval.Mlrmap
}
func newNestBucket(representative *mlrval.Mlrmap) *tNestBucket {
return &tNestBucket{
representative: representative,
pairs: []*mlrval.Mlrmap{},
}
}