`MergeYaml` edge case: keeps comment at the end of the doc after appending an entry

[BoykoAlex]

See the test below:

    @Test
    void insertInSequenceEntriesWithDeepSearchWithComment_1() {
        rewriteRun(
          spec -> spec.recipe(new MergeYaml(
            "$..containers",
            "imagePullPolicy: Always",
            true,
            null,
            null,
            null,
            null
          )),
          yaml(
            """
              kind: Pod
              spec:
                containers:
                  - name: <container name>  # comment
              """,
            """
              kind: Pod
              spec:
                containers:
                  - name: <container name>  # comment
                    imagePullPolicy: Always
              """
          )
        );
    }

This fails because # comment is in DocumentEnd node rather than the yaml block. Not sure what to propose... I'd probably try to keep the inline comment as part of the entry... Or perhaps have a special case for the comment at the end of the document if this would be a less intrusive fix.

[greg-at-moderne]

Thanks for reporting this. It's even more interesting.
With the following input:

kind: Pod
spec:
  containers:
    - name: <container name>  # comment
t1: t1 # t1
t2: t2 # t2

the logic gets even more confused with the comments:

kind: Pod
spec:
  containers:
    - name: <container name> # t1
      imagePullPolicy: Always  # comment
t1: t1 # t1
t2: t2 # t2

There's definitely built-in support for handling the trailing comments and moving them around, but I think it's imperfect and is not handling the case like this.

[dilu24x7]

Even I see the same with this test for insertMode: After for MegeYaml

@Test
    void insertAfter() {
        rewriteRun(
          spec -> spec.recipe(new MergeYaml(
            "$",
            //language=yaml
            """
              A: a
              B:
                A: b
              """,
            null,
            null,
            null,
            After,
            "first",
            null
          )),
          yaml(
            """
              first:
              second: 2
              third: 3
              fourth: 4
              """,
            """
              first:
              A: a
              B:
                A: b
              second: 2
              third: 3
              fourth: 4
              """
          )
        );
    }

Tried using this recipe within my declarative recipe and these properties are not getting considered (both insertMode and insertProperty) and same when I tried insertMode: Before

[github-actions]

This issue is stale because it has not had any activity for 60 days. Remove question label or comment or this will be closed in two weeks. Issues may be reopened when there is renewed interest.