Bug in resolving many local reference on a document of remote reference

[flaviolsousa]

I could not understand why occurs that... but here is the case.
PS: you could make a flow chart explaining what happens in this crazy code 😄

/public/MainDoc.yml

paths:
  $ref: 'ReferredDoc.yml#/definitions/FirstRef'

/public/ReferredDoc.yml

definitions:

  FirstRef:
    levelA:
      $ref: '#/definitions/LevelA'
    levelC_2:
      $ref: '#/definitions/LevelC'

  LevelA:
    levelB:
      $ref: '#/definitions/LevelB'

  LevelB:
    levelC:
      $ref: '#/definitions/LevelC'

  LevelC:
    name: item

Result:

{
  "paths": {
    "levelA": {
      "levelB": {
        "levelC": {
          "$ref": "#/definitions/LevelC"
        }
      }
    },
    "levelC_2": {
      "name": "item"
    }
  }
}

Here a code that simule the case:
https://github.com/flaviolsousa/validate-model-swagger-web

You need see this files:

• /public/homeService.js (function readYaml)
• /public/MainDoc.yml
• /public/ReferredDoc.yml

This problem in one of my documents occurs 19 times.
I am available to help them in what was needed.

Thanks in advance!

[whitlockjc]

This "crazy code" is being cleaned up but can you tell me what version of json-refs you're using?

[flaviolsousa]

I think is the last!

"json-refs": "^2.1.6"

Note: "Crazy Code" is a light joke in my country ... sorry if I offended. I spoke in order to indicate that is very complex code for me. Recursion, I'm in ... but detect circular references should not be an easy task.

[whitlockjc]

No offense taken. I am in the process of cleaning it up a little, more for performance than anything. Let me see if I an figure out what is up with your situation.

[diegode]

Reproduced here: #95

[whitlockjc]

This is a duplicate of #80.

[diegode]

@whitlockjc I think this is a different issue, since #80 happens only when restricting to resolve non-local references (i.e. with parameters -I relative -I remote), but this happens without using filters.
This is why I created a pull request to fix #80 (#94) but for this issue I created a pull request just to reproduce it (#95).

[whitlockjc]

I think the steps to reproduce #80 used filters but the problem is a general one. If you resolve only a portion of a remote document (Example: ReferredDoc.yml#/definitions/FirstRef), this problem arises. Both describe the same situation.

[whitlockjc]

And sorry for the places where I'm commenting that this is fixed locally. Basically, I've rewritten the resolution code locally to not only fix this issue (and more) but also to fix performance described in #87. The thing is it's a lot of work and I've got a good bit of local changes that fix things like this and #97 but it's not done so there's no commits on master yet.

I will be working on this over the next few days and hopefully fixing all outstanding issues around circular references, external references and performance.

[diegode]

@whitlockjc ok, I understand. Thank you! :)

[diegode]

@whitlockjc any update on this? please tell me if there's anything I can do to help.