Merge pull request #321 from hjotha/submit/describer-suppress-default-anchor-fragments

fix: suppress default anchor fragments in describe

Author: ako

mdl-examples/bug-tests/320-describer-suppress-default-anchor-fragments.mdl

@@ -0,0 +1,55 @@
+-- ============================================================================
+-- Bug #320: DESCRIBE emitted default anchor fragments redundantly
+-- ============================================================================
+--
+-- Symptom (before fix):
+--   `describe microflow` printed `@anchor` lines for every activity, even
+--   when every from/to side matched the MDL default for that flow shape:
+--     - regular sequence flows default to `from: right, to: left`
+--     - true branches of IF default to `from: right, to: left`
+--     - false branches of IF default to `from: bottom, to: top`
+--   Output looked like
+--     log info node 'X' 'a';
+--     @anchor(from: right, to: left)         -- noise: this is the default
+--     log info node 'X' 'b';
+--   producing verbose, non-author-friendly DESCRIBE output and noisy
+--   `mxcli diff-local` runs after a roundtrip.
+--
+-- After fix:
+--   `emitAnchorAnnotation` and `emitSplitAnchorAnnotation` (in
+--   cmd_microflows_show_helpers.go) suppress fragments that match the
+--   default and skip the entire annotation when all sides are defaults.
+--   Non-default sides (e.g. `to: top` on a return) are still emitted.
+--
+-- Usage:
+--   mxcli exec mdl-examples/bug-tests/320-describer-suppress-default-anchor-fragments.mdl -p app.mpr
+--
+--   mxcli -p app.mpr -c "describe microflow BugTest320.MF_LinearDefaults"
+--   The output must contain NO `@anchor` line — every flow uses defaults.
+--
+--   mxcli -p app.mpr -c "describe microflow BugTest320.MF_NonDefaultReturn"
+--   The output must keep `@anchor(to: top)` on the return statement.
+-- ============================================================================
+
+create module BugTest320;
+
+-- Linear flow, all defaults — describe must emit zero @anchor lines.
+create microflow BugTest320.MF_LinearDefaults ()
+begin
+  log info node 'BugTest320' 'a';
+  log info node 'BugTest320' 'b';
+  log info node 'BugTest320' 'c';
+end;
+/
+
+-- One non-default `to: top` on the return — describe must keep that fragment.
+create microflow BugTest320.MF_NonDefaultReturn (
+  $value: integer
+)
+returns boolean as $ok
+begin
+  log info node 'BugTest320' 'check';
+  @anchor(to: top)
+  return $value > 0;
+end;
+/

mdl/executor/cmd_microflows_anchor_if_test.go

@@ -10,9 +10,12 @@
 package executor
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/mendixlabs/mxcli/mdl/ast"
+	"github.com/mendixlabs/mxcli/model"
+	"github.com/mendixlabs/mxcli/sdk/microflows"
 )
 
 // buildWithAnchors is a test helper that builds the flow graph for a simple
@@ -163,6 +166,48 @@ func TestBuilder_AnchorTrueBranchTo_EmptyThenIfWithElse(t *testing.T) {
 	}
 }
 
+func TestDescribe_FalseBranchFromTop_IfWithoutElseIsDefault(t *testing.T) {
+	body := []ast.MicroflowStatement{
+		&ast.IfStmt{
+			Condition: &ast.LiteralExpr{Kind: ast.LiteralBoolean, Value: true},
+			ThenBody: []ast.MicroflowStatement{
+				&ast.LogStmt{Level: ast.LogInfo, Message: &ast.LiteralExpr{Kind: ast.LiteralString, Value: "inside"}},
+			},
+			Annotations: &ast.ActivityAnnotations{
+				FalseBranchAnchor: &ast.FlowAnchors{From: ast.AnchorSideTop, To: ast.AnchorSideUnset},
+			},
+		},
+		&ast.ReturnStmt{},
+	}
+
+	fb := &flowBuilder{posX: 100, posY: 100, spacing: HorizontalSpacing}
+	oc := fb.buildFlowGraph(body, nil)
+
+	var split microflows.MicroflowObject
+	for _, obj := range oc.Objects {
+		if _, ok := obj.(*microflows.ExclusiveSplit); ok {
+			split = obj
+			break
+		}
+	}
+	if split == nil {
+		t.Fatal("expected exclusive split")
+	}
+
+	flowsByOrigin := map[model.ID][]*microflows.SequenceFlow{}
+	flowsByDest := map[model.ID][]*microflows.SequenceFlow{}
+	for _, flow := range oc.Flows {
+		flowsByOrigin[flow.OriginID] = append(flowsByOrigin[flow.OriginID], flow)
+		flowsByDest[flow.DestinationID] = append(flowsByDest[flow.DestinationID], flow)
+	}
+
+	var lines []string
+	emitAnchorAnnotation(split, flowsByOrigin, flowsByDest, &lines, "")
+	if len(lines) != 0 {
+		t.Fatalf("expected false branch from-top default anchor to be omitted, got %q", strings.Join(lines, "\n"))
+	}
+}
+
 func TestBuilder_AnchorToTopOnReturnPreservedInsideElse(t *testing.T) {
 	// Minimal case: single-statement ELSE whose only statement is a RETURN
 	// carrying @anchor(to: top). The flow from the split to that return's

mdl/executor/cmd_microflows_describe_anchor_test.go

@@ -50,6 +50,38 @@ func TestEmitAnchorAnnotation_FromAndTo(t *testing.T) {
 	}
 }
 
+func TestEmitAnchorAnnotation_OmitsDefaultRightToLeft(t *testing.T) {
+	activity := &microflows.ActionActivity{
+		BaseActivity: microflows.BaseActivity{
+			BaseMicroflowObject: microflows.BaseMicroflowObject{
+				BaseElement: model.BaseElement{ID: "act-default"},
+			},
+		},
+	}
+	incoming := &microflows.SequenceFlow{
+		DestinationID:              "act-default",
+		DestinationConnectionIndex: AnchorLeft,
+	}
+	outgoing := &microflows.SequenceFlow{
+		OriginID:              "act-default",
+		OriginConnectionIndex: AnchorRight,
+	}
+
+	flowsByOrigin := map[model.ID][]*microflows.SequenceFlow{
+		"act-default": {outgoing},
+	}
+	flowsByDest := map[model.ID][]*microflows.SequenceFlow{
+		"act-default": {incoming},
+	}
+
+	var lines []string
+	emitAnchorAnnotation(activity, flowsByOrigin, flowsByDest, &lines, "")
+
+	if len(lines) != 0 {
+		t.Fatalf("expected default anchor line to be omitted, got %v", lines)
+	}
+}
+
 func TestEmitAnchorAnnotation_NoFlowsSkipsEmission(t *testing.T) {
 	activity := &microflows.ActionActivity{
 		BaseActivity: microflows.BaseActivity{
@@ -66,6 +98,53 @@ func TestEmitAnchorAnnotation_NoFlowsSkipsEmission(t *testing.T) {
 	}
 }
 
+func TestEmitAnchorAnnotation_IgnoresLoopBodyTailOutgoingFlow(t *testing.T) {
+	activity := &microflows.ActionActivity{
+		BaseActivity: microflows.BaseActivity{
+			BaseMicroflowObject: microflows.BaseMicroflowObject{
+				BaseElement: model.BaseElement{ID: "body-act"},
+			},
+		},
+	}
+	loop := &microflows.LoopedActivity{
+		BaseMicroflowObject: microflows.BaseMicroflowObject{
+			BaseElement: model.BaseElement{ID: "loop-1"},
+		},
+		ObjectCollection: &microflows.MicroflowObjectCollection{
+			Objects: []microflows.MicroflowObject{activity},
+		},
+	}
+
+	flowsByOrigin := map[model.ID][]*microflows.SequenceFlow{
+		"body-act": {
+			{
+				OriginID:              "body-act",
+				DestinationID:         "loop-1",
+				OriginConnectionIndex: AnchorLeft,
+			},
+		},
+	}
+	flowsByDest := map[model.ID][]*microflows.SequenceFlow{
+		"body-act": {
+			{
+				DestinationID:              "body-act",
+				DestinationConnectionIndex: AnchorLeft,
+			},
+		},
+	}
+	activityMap := map[model.ID]microflows.MicroflowObject{
+		"body-act": activity,
+		"loop-1":   loop,
+	}
+
+	var lines []string
+	emitAnchorAnnotationWithActivityMap(activity, flowsByOrigin, flowsByDest, activityMap, &lines, "")
+
+	if len(lines) != 0 {
+		t.Fatalf("expected loop body tail flow to be ignored, got %v", lines)
+	}
+}
+
 func TestAnchorRoundtripViaParserBuilder(t *testing.T) {
 	// Build an AST with an @anchor on a statement, run it through the builder,
 	// and verify the resulting SequenceFlow has the right anchors. Then the

mdl/executor/cmd_microflows_describe_concurrent_test.go

@@ -26,7 +26,7 @@ func TestFormatMicroflowActivities_Concurrent_NoRace(t *testing.T) {
 	// Build two distinct microflows whose activities are anchored to
 	// different sides. If the two describe calls share state, one will
 	// emit the other's anchor keyword.
-	mfA := mkRaceMicroflow("mfa-start", "mfa-log", "mfa-end", AnchorRight)
+	mfA := mkRaceMicroflow("mfa-start", "mfa-log", "mfa-end", AnchorTop)
 	mfB := mkRaceMicroflow("mfb-start", "mfb-log", "mfb-end", AnchorBottom)
 
 	e := newTestExecutor()
@@ -50,8 +50,8 @@ func TestFormatMicroflowActivities_Concurrent_NoRace(t *testing.T) {
 	}
 	wg.Wait()
 
-	wantA := "@anchor(from: right, to: left)"
-	wantB := "@anchor(from: bottom, to: left)"
+	wantA := "@anchor(from: top)"
+	wantB := "@anchor(from: bottom)"
 	for i, got := range resultsA {
 		if !strings.Contains(got, wantA) {
 			t.Errorf("worker %d (A) missing %q in output:\n%s", i, wantA, got)