feat(input_schema): Enable secret objects #515
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
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,42 @@ | ||
| import crypto from 'node:crypto'; | ||
|
|
||
| /** | ||
| * These keys are omitted from the field schema normalization process | ||
| * because they are not relevant for validation of values against the schema. | ||
| */ | ||
| const OMIT_KEYS = new Set(['title', 'description', 'sectionCaption', 'sectionDescription', 'nullable', 'example', 'editor']); | ||
MFori marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * Normalizes the field schema by removing irrelevant keys and sorting the remaining keys. | ||
| */ | ||
| function normalizeFieldSchema(value: any): any { | ||
| if (Array.isArray(value)) { | ||
| return value.map(normalizeFieldSchema); | ||
| } | ||
|
|
||
| if (value && typeof value === 'object') { | ||
| const result: Record<string, any> = {}; | ||
| Object.keys(value) | ||
| .filter((key) => !OMIT_KEYS.has(key)) | ||
| .sort() | ||
| .forEach((key) => { | ||
| result[key] = normalizeFieldSchema(value[key]); | ||
| }); | ||
| return result; | ||
| } | ||
|
|
||
| return value; | ||
| } | ||
|
|
||
| /** | ||
| * Generates a stable hash for the field schema. | ||
| * @param fieldSchema | ||
| */ | ||
| export function getFieldSchemaHash(fieldSchema: Record<string, any>): string { | ||
| try { | ||
| const stringifiedSchema = JSON.stringify(normalizeFieldSchema(fieldSchema)); | ||
| return crypto.createHash('sha256').update(stringifiedSchema).digest('base64'); | ||
MFori marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } catch (err) { | ||
| throw new Error(`The field schema could not be stringified for hash: ${err}`); | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can now validate these for
secretstrings too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not 100% sure here - wouldn't we end up applying the validation to the encrypted value in this case? (That would not be useful)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! I removed these three properties for now. We can add it later but would need to catch the Ajv errors