refactor: introduce function for getting Schema Object type #10330
Conversation
|
|
||
| export const getSchemaObjectTypeLabel = (label) => label | ||
|
|
||
| export const getSchemaObjectType = (schema) => schema.type ?? "any" |
There was a problem hiding this comment.
To be consistent with JSON Schema 2020-12 processing, can we make the fallback type the string type?
| export const getSchemaObjectType = (schema) => schema.type ?? "any" | |
| export const getSchemaObjectType = (schema) => schema.type ?? "string" |
Also, may I suggest to make this function safe:
| export const getSchemaObjectType = (schema) => schema.type ?? "any" | |
| export const getSchemaObjectType = (schema) => schema?.type ?? "string" |
There was a problem hiding this comment.
Preferred alternative: What if both the functions would have the following signature?
getSchemaObjectType: (schema: object) -> string
getSchemaObjectTypeLabel: (schema: object) -> string
This would simplify their usage inside the code as it is now abstracted how the the type or label are computed from the schema.
Instead of
const typeLabel = fn.getSchemaObjectTypeLabel(immutableToJS(schema?.get("type")))you'll end up having
const typeLabel = fn.getSchemaObjectTypeLabel(immutableToJS(schema))If you further abstract and allow the functions to consume immutable along with POJO, it can look like:
const typeLabel = fn.getSchemaObjectTypeLabel(schema)NOTE: this applies both for Draft 5 and 2020-12 functions.
| @@ -635,3 +635,7 @@ const resolver = (arg1, arg2, arg3) => [arg1, JSON.stringify(arg2), JSON.stringi | |||
| export const memoizedCreateXMLExample = memoizeN(createXMLExample, resolver) | |||
|
|
|||
| export const memoizedSampleFromSchema = memoizeN(sampleFromSchema, resolver) | |||
|
|
|||
| export const getSchemaObjectTypeLabel = (label) => label | |||
There was a problem hiding this comment.
The input is type not a label.
| export const getSchemaObjectTypeLabel = (label) => label | |
| export const getSchemaObjectTypeLabel = (type) => type |
But anyway we can make this point-free by:
import identity from "lodash/identity"
export const getSchemaObjectTypeLabel = identity| const typeLabel = fn.jsonSchema202012.getType(immutableToJS(schema)) | ||
| const type = fn.jsonSchema202012.foldType(immutableToJS(schema?.get("type"))) | ||
| const itemType = fn.jsonSchema202012.foldType(immutableToJS(schema?.getIn(["items", "type"]))) | ||
| const typeLabel = fn.getSchemaObjectType(immutableToJS(schema)) |
There was a problem hiding this comment.
This looks a bit confusing. For getting a typeLabel we're using getSchemaObjectType. For actual type we're using getSchemaObjectTypeLabel. Shouldn't it be reversed?
536f636 to
c70aaaf
Compare
| @@ -154,3 +155,11 @@ export const inferType = (schema, processedSchemas = new WeakSet()) => { | |||
| export const getType = (schema) => { | |||
| return inferType(schema) | |||
| } | |||
|
|
|||
| export const getFoldType = (schema) => { | |||
| if (isImmutable(schema)) { | |||
There was a problem hiding this comment.
immutableToJS has the isImmutable check, so we should be able to skip checking it here.
Also, should we have a separate variable for the transformed schema, instead of reassigning?
Same for other places where this occurs.
src/core/plugins/json-schema-5/components/json-schema-components.jsx
Outdated
Show resolved
Hide resolved
src/core/plugins/json-schema-5/components/json-schema-components.jsx
Outdated
Show resolved
Hide resolved
src/core/plugins/json-schema-5/components/json-schema-components.jsx
Outdated
Show resolved
Hide resolved
|
This branch is out-of-date with main. Please rebase or merge the latest changes so we can check if the function works or not" |
use function for getting
schema object type/schema object typelabel depending on the OpenAPI versionAttribution: @robert-hebel-sb