Skip to content

Addition of dereferencedCache has broken deeply nested external dependencies #226

Closed
@mummybot

Description

@mummybot

The addition of the dereferencedCache in PR #195 has broken deeply nested external dependencies if a local dependency exists in the root schema.

Given the following schema:

// schema.json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "definitions": {
    "country": {
      "type": "string",
      "enum": {
        "$ref": "./country-codes.json"
      }
    },
    "foreignCountry": {
      "type": "string",
      "enum": {
        "$ref": "#/definitions/countries"  // This being a local dependency prevents ./external-fail.json from resolving in nested schema.
      }
    },
    "externalFail": {
      "$ref": "./external-fail.json"
    }
  },
  "properties": {
    "pageOne": {
      "$ref": "./pageOne.json"
    }
  }
}
// pageOne.json
{
  "type": "object",
  "properties": {
    "nestedProperty": {
      "$ref": "./schema.json#/definitions/country",
      "#bespokeKey": {
        "append": {
          "component": "Callout",
          "props": {
            "type": "warning"
          },
          "on": [
            "GB",
            [
              "PROHIBITED",
              {
                "$ref": "./external-fail.json"
              }
           ]
          ]
        }
      },
      "not": {
        "enum": {
          "$ref": "./external-fail.json"
        }
      }
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "nestedProperty": {
            "type": "string",
            "enum": {
              "$ref": "./external-success.json"
            }
          }
        }
      },
      "then": {
        "required": ["otherBooleanProperty"],
        "properties": {
          "otherBooleanProperty": {
            "type": "boolean"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "nestedProperty": {
            "type": "string",
            "enum": {
              "$ref": "./external-success.json"
            }
          },
          "otherBooleanProperty": {
            "const": false
          }
        }
      },
      "then": {
        "properties": {
          "nestedOtherProperty": {
            "$ref": "./schema.json#/definitions/country",
            "#bespokeKey": {
              "append": {
                "component": "Callout",
                "props": {
                  "type": "warning"
                },
                "on": [
                  [
                    "PROHIBITED",
                    {
                      "$ref": "./external-fail.json"
                    }
                  ]
                ]
              }
            },
            "not": {
              "enum": {
                "$ref": "./external-fail.json"
              }
            }
          }
        }
      }
    }
  ]
}
// external-fail.json
["AU", "US", "GB"]

Expected

//...
    "nestedProperty": {
      "type": "string",
      "enum": ["JP", "US", "GB", "AU"],
      "#bespokeKey": {
        "append": {
          "component": "Callout",
          "props": {
            "type": "warning"
          },
          "on": [
            "GB",
            [
              "PROHIBITED",
              ["AU", "US", "GB"]
            ]
          ]
        }
      },
      "not": {
        "enum": ["AU", "US", "GB"]
      }
    }
  },
//...

Actual

//...
    "nestedProperty": {
      "type": "string",
      "enum": ["JP", "US", "GB", "AU"],
      "#bespokeKey": {
        "append": {
          "component": "Callout",
          "props": {
            "type": "warning"
          },
          "on": [
            "GB",
            [
              "PROHIBITED",
              {
                "$ref": "./external-fail.json"
              }
            ]
          ]
        }
      },
      "not": {
        "enum": {
          "$ref": "./external-fail.json"
        }
      }
    }
//...

If I comment out https://github.com/APIDevTools/json-schema-ref-parser/blob/master/lib/dereference.js#L177 then it all works (by not adding to cache and therefore not skipping).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions