-
Notifications
You must be signed in to change notification settings - Fork 15
fix: limit definitions based on use COMPASS-8941 #226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
d6f30e6
fix: limit definitions based on use COMPASS-8941
paula-stacho b0706f2
cleanup
paula-stacho aa931c6
fix typo
paula-stacho 8bbd80d
imports
paula-stacho 998e85e
dependencies
paula-stacho a2cf500
replace IIFE
paula-stacho 0d5dab8
cleanup clear
paula-stacho ab7267c
update test
paula-stacho File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import { ArraySchemaType, DocumentSchemaType, Schema as InternalSchema, SchemaType, SchemaField } from '../schema-analyzer'; | ||
| import { type ExpandedJSONSchema } from '../types'; | ||
| import { InternalTypeToStandardTypeMap, RELAXED_EJSON_DEFINITIONS } from './internalToStandard'; | ||
| import { InternalTypeToBsonTypeMap } from './internalToMongoDB'; | ||
| import { allowAbort } from './util'; | ||
|
|
||
| export const convertInternalToExpanded = (function() { | ||
| const usedDefinitions = new Set<string>(); | ||
paula-stacho marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| function clearUsedDefinitions() { | ||
| usedDefinitions.clear(); | ||
| } | ||
|
|
||
| function getUsedDefinitions() { | ||
| const filteredDefinitions = Object.fromEntries( | ||
| Object.entries(RELAXED_EJSON_DEFINITIONS).filter(([key]) => usedDefinitions.has(key)) | ||
| ); | ||
| return Object.freeze(filteredDefinitions); | ||
| } | ||
|
|
||
| function markUsedDefinition(ref: string) { | ||
| usedDefinitions.add(ref.split('/')[2]); | ||
| } | ||
|
|
||
| function getStandardType(internalType: string) { | ||
| const type = InternalTypeToStandardTypeMap[internalType]; | ||
| if (!type) throw new Error(`Encountered unknown type: ${internalType}`); | ||
| return { ...type }; | ||
| } | ||
|
|
||
| function getBsonType(internalType: string) { | ||
| const type = InternalTypeToBsonTypeMap[internalType]; | ||
| if (!type) throw new Error(`Encountered unknown type: ${internalType}`); | ||
| return type; | ||
| } | ||
|
|
||
| async function parseType(type: SchemaType, signal?: AbortSignal): Promise<ExpandedJSONSchema> { | ||
| await allowAbort(signal); | ||
| const schema: ExpandedJSONSchema = { | ||
| ...getStandardType(type.bsonType), | ||
| 'x-bsonType': getBsonType(type.bsonType), | ||
| 'x-metadata': getMetadata(type) | ||
| }; | ||
| if ('values' in type && type.values) { | ||
| schema['x-sampleValues'] = type.values; | ||
| } | ||
| if (schema.$ref) markUsedDefinition(schema.$ref); | ||
| switch (type.bsonType) { | ||
| case 'Array': | ||
| schema.items = await parseTypes((type as ArraySchemaType).types, signal); | ||
| break; | ||
| case 'Document': | ||
| Object.assign(schema, await parseFields((type as DocumentSchemaType).fields, signal)); | ||
| break; | ||
| } | ||
| return schema; | ||
| } | ||
|
|
||
| function getMetadata<TType extends SchemaField | SchemaType>({ | ||
| hasDuplicates, | ||
| probability, | ||
| count | ||
| }: TType) { | ||
| return { | ||
| ...(typeof hasDuplicates === 'boolean' ? { hasDuplicates } : {}), | ||
| probability, | ||
| count | ||
| }; | ||
| } | ||
|
|
||
| async function parseTypes(types: SchemaType[], signal?: AbortSignal): Promise<ExpandedJSONSchema> { | ||
| await allowAbort(signal); | ||
| const definedTypes = types.filter(type => type.bsonType.toLowerCase() !== 'undefined'); | ||
| const isSingleType = definedTypes.length === 1; | ||
| if (isSingleType) { | ||
| return parseType(definedTypes[0], signal); | ||
| } | ||
| const parsedTypes = await Promise.all(definedTypes.map(type => parseType(type, signal))); | ||
| return { | ||
| anyOf: parsedTypes | ||
| }; | ||
| } | ||
|
|
||
| async function parseFields( | ||
| fields: DocumentSchemaType['fields'], | ||
| signal?: AbortSignal | ||
| ): Promise<{ required: ExpandedJSONSchema['required']; properties: ExpandedJSONSchema['properties'] }> { | ||
| const required = []; | ||
| const properties: ExpandedJSONSchema['properties'] = {}; | ||
| for (const field of fields) { | ||
| if (field.probability === 1) required.push(field.name); | ||
| properties[field.name] = { | ||
| ...await parseTypes(field.types, signal), | ||
| 'x-metadata': getMetadata(field) | ||
| }; | ||
| } | ||
|
|
||
| return { required, properties }; | ||
| } | ||
|
|
||
| return async function convert( | ||
| internalSchema: InternalSchema, | ||
| options: { signal?: AbortSignal } = {} | ||
| ): Promise<ExpandedJSONSchema> { | ||
| clearUsedDefinitions(); | ||
| const { required, properties } = await parseFields(internalSchema.fields, options.signal); | ||
| const schema: ExpandedJSONSchema = { | ||
| type: 'object', | ||
| 'x-bsonType': 'object', | ||
| required, | ||
| properties, | ||
| $defs: getUsedDefinitions() | ||
| }; | ||
| return schema; | ||
| }; | ||
| })(); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.