retrieveSchema API no longer resolves references from rootSchema

[john-prillaman]

Prerequisites

• I have read the documentation

What theme are you using?

core

What is your question?

In version 5.0.0-beta.11 of the rjsf utils package the exported retrieveSchema API could be used such that references in the provided schema could be resolved from definitions in the provided rootSchema. With the recent updates which include the retrieveSchemaInternal this functionality no longer works.
I understand that the schema form does not support resolving references from an external schema, however this functionality was available from this utils method and the interface and documentation suggests that it should allow this.
Will this functionality be available in future releases or was this never the intended use?

[heath-freenome]

@john-prillaman Can you be more clear? The definition of retrieveSchema() API hasn't changed at since the initial 5.0.0-beta.1 release. It still takes a rootSchema as it's optional third parameter. Is there some sort of bug you are experiencing?

[john-prillaman]

In the 5.0.0-beta.1 references in the provided schema would be resolved from the given rootSchema. That functionality is no longer working.
For example a definition for a reference such as "$ref": "#/definitions/entity" must exists in the schema, where as in the beta version that definition could be resolved from the rootSchema and was not necessary to include that definition in the schema.

[heath-freenome]

@john-prillaman Can you provide a reproducible example of this issue using codesandbox.io, jsfiddle or some other tool? As far as I know, passing rootSchema will allow the ref look ups just fine

[john-prillaman]

I can work on using a tool but in the meantime this snippet of code should demonstrate the behavior.

const schema = {
    type: "object",
    properties: {
      entity: {
        $ref: "#/definitions/entity"
      }
    }
  };

  const rootSchema = {
    type: "object",
    definitions: {
      entity: {
        type: "string",
        title: "Entity"
      }
    }
  };
  const resolved = retrieveSchema(validator, schema, rootSchema)
  console.log(JSON.stringify(resolved));

Output using the beta version:
{"type":"object","properties":{"entity":{"type":"string","title":"Entity"}}}

Output using a newer version (seems to begin with the implementation of retrieveSchemaInternal):
{"type":"object","properties":{"entity":{"$ref":"#/definitions/entity"}}}

As you can see in my testing I find that in the second example the reference to the definition in the rootSchema has not been resolved.

[john-prillaman]

If you need to see this in codesandbox I have an example of the previous snippet running here:
https://codesandbox.io/s/rjfs-utils-retrieveschema-smt37m?file=/src/App.js

Appears that the last version to provide expected results is @rjsf/utils@5.0.0-beta.14

[heath-freenome]

@john-prillaman Thanks for the use case! I'll try to figure it out in the next week or so

[aiibe]

On version 5.13.0, the problem remains. I forked @john-prillaman code, and put definitions inside the schema itself.
https://codesandbox.io/s/rjfs-utils-retrieveschema-forked-7kghz7?file=/src/App.js

[heath-freenome]

@aiibe Thanks for pointing it out. My company has a slightly different issue that I'm hoping to fix at the beginning of October so I'll also fix this one

[john-prillaman]

Awesome, thank you!

[BlackBerryID]

@heath-freenome Hello. What about fields, that appears conditionally?
Example:

The field customerInformationSecondBlock resolves just with "$ref":

I made call this way: retrieveSchema(validator, jsonSchema, schemaWithDefinitions, formData);

[heath-freenome]

@BlackBerryID can you create a new issue with a reproducible test case... Thanks!