[Concourse] Navigation in pipeline files with VSCode Concourse CI extension doesn't work everytime

[OphyTe]

Sometimes, navigation through the outline view doesn't work anymore on the pipeline files ... I get the message "No symbols found in document pipeline.yaml' (my document is ok, it works on my Concourse instance).

I didn't know why yet. Maybe because of my use of yaml anchors and aliases ...

[kdvolder]

Does the problem seem deterministic? I.e. is it something that depends on the contents in the editor and allways happens when that editor content is the same? Or is more like something that feels a bit random, it works / doesn't work even though nothing is different about the editor content.

If it is deterministic, it would be very helpful to provide the exact editor content that causes the problem (or a cut down version of it). That should make it relatively easy then to reproduce, diagnose and fix.

[kdvolder]

Followed up on your hunch that it might have something to do with anchors and references. And... bingo :-)

This example reproduces the issue:

def: &stuff
  name: git
  type: git
  source:
    uri: 
resources:
- <<: *stuff
- name: git2
  type: git
  source:
    uri: git@github.com:kdvolder/7zip.git

When I delete the line - <<: *stuff the outline appears. Put the line back... it disapears again.

[OphyTe]

Thank you for you answer but it doesn't seem to be so simple.

Indeed, when I delete the lines with anchors or aliases, my outline view doesn't work better.
And on another project I do have a well working outline view for a pipeline.yaml with 1 anchor and 14 aliases ...

Here's a sample:

registries-pe: &registries-pe
  insecure_registries:
    - ((docker_pe.registre))
  username: ((docker_pe.utilisateur))
  password: ((docker_pe.mot_de_passe))
  registry_mirror: http://((docker_pe.registre))

resource_types:

  - name: kubernetes-resource
    type: docker-image
    source:
      repository: ((docker_pe.registre))/incubateur/concourse-kubernetes-resource
      tag: 1.16
      <<: *registries-pe

  - name: concourse-pipeline-resource
    type: docker-image
    source:
      repository: ((docker_pe.registre))/concourse/concourse-pipeline-resource
      tag: 1.1.0
      insecure_registries:
        - ((docker_pe.registre))
      <<: *registries-pe

[kdvolder]

Thanks for the extra examples. It is always nice to have more examples to demonstrate / reproduce a bug, as well as verify a potential fix. This is especially true if the examples are markedly different. So therefore... you said:

when I delete the lines with anchors or aliases, my outline view doesn't work better

So I take it you actually have a editor contents example that has a problem despite not using anchors and/or references? Can you please paste that example as it would be a bit different from the other examples we have already.

[OphyTe]

Here is an example (I rename it in .txt so I can upload it on github): pipeline.yaml

And here is the corresponding outline view and the non-working GoTo functionality:

[OphyTe]

I've just noticed that if if I disable the plugin, reload VSC and then finally reactivate the plugin, I get the outline back again (with the file without anchors and/or references) ...

The same process doesn't work with the file with anchors and/or references.

[kdvolder]

Looks to me like contents of the outline view is simply not being updated immediately in all cases.
I think this part of the logic is most likely due to vscode itself rather than our extension.

I'm not sure of the exact logic of when vscode refreshes the outline. Saving the file seems to be fairly robust way of 'forcing' an update. Sometimes it also refreshed quickly as I typed, sometimes there seems to be a lag. And sometimes, unless I do something l(like click in the editor or save it) it doesn't refresh.

However, from what I can tell so far, the problem with the outine being 'empty' is tied strictly to references and anchors. A file with no references / anchors in it seems to allways work fine... sometimes we have to do something to make it appear (save file etc).

And yes, you are right some examples with references in them do still seem to work fine. That's interesting too. But most important is... having some examples that makes it not work, with those I can debug the issue and figure out why it doesn't work... then hopefully fix that.

BTW: Ironically, all the examples that I've tried so far, only the first one that I posted myself... is one were it breaks outine for me. The other two you gave both seem to work just fine.

[OphyTe]

Hi @kdvolder,

I come back on this issue and after a lot of tests, I'm starting to think that the issue comes from the number of references and anchors used.

Indeed, on this file it works but on this one it doesn't!

[kdvolder]

Thanks for the extra example. That helps.