apidom-reference: regression in AsyncAPI 2.x dereferencing

[char0n]

TODO:

• address regression in AsyncAPI 2.x
• address regression in OpenAPI 2.0
• address regression in OpenAPI 3.0
• address regression in OpenAPI 3.1

---

Steps To Reproduce

Given the following AsyncAPI definition:

asyncapi: '2.4.0'
info:
  title: Base API
  version: '1.0.0'
  description: ""
channels:
  c:
    publish:
      message:
        $ref: 'https://test-fake-url.com/apis/test/1#/components/messages/someMessage'

With https://test-fake-url.com/apis/test/1 linking to this file:

asyncapi: '2.4.0'
info:
  title: Components
  version: '1.0.0'
  description: ""

components:
  messages:
    someMessage:
      contentType: application/json
      payload:
        $ref: "#/components/schemas/somePayload"
  schemas:
    somePayload:
      type: object
      properties:
        sentAt:
          $ref: "#/components/schemas/sentAt"
    sentAt:
      type: string
      format: date-time
      description: Date and time when the message was sent.

When calling dereference, up to now we would have gotten back the following (no $refs, everything fully inlined)

"asyncapi": "2.4.0"
"info":
  "title": "Base API"
  "version": "1.0.0"
  "description": ""
"channels":
  "c":
    "publish":
      "message":
        "contentType": "application/json"
        "payload":
          "type": "object"
          "properties":
            "sentAt":
              "type": "string"
              "format": "date-time"
              "description": "Date and time when the message was sent."

However, now we get we get the following ($ref to sentAt) which causes additional problems as the local definition for sentAt is not present

"asyncapi": "2.4.0"
"info":
  "title": "Base API"
  "version": "1.0.0"
  "description": ""
"channels":
  "c":
    "publish":
      "message":
        "contentType": "application/json"
        "payload":
          "type": "object"
          "properties":
            "sentAt":
              "$ref": "#/components/schemas/sentAt"

[char0n]

I could successfully reproduce.

[char0n]

The issue is related to refractor cache.

The workaround for now is to perform dereference in replace or error mode:

const actual = await dereference(<PATH>, {
  parse: { mediaType: mediaTypes.latest('json') },
  dereference: { circular: '<error | replace>' },
});

[char0n]

Bug fix needs to applied to all dereferencing strategies.

[char0n]

All dereference strategies has been fixed.