feat: add ODP Schema validation example for FileTypes to publish checks #3373
Conversation
|
Removed vultr server and associated DNS entries |
| const sortedValidationChecks = failingChecks | ||
| .concat(warningChecks) | ||
| .concat(passingChecks) | ||
| .concat(notApplicableChecks); |
There was a problem hiding this comment.
Anyone have a more clever suggestion for how to sort in a custom order by "status" ? This is explicit and easy-to-read, but a bit lengthy and I feel like there's probably some cool one-liner I'm missing?
There was a problem hiding this comment.
Yeah I can think of a few ways!
Map.groupBy is pretty new but seems to have decent coverage https://caniuse.com/?search=map.groupby
I think it would then just be Map.groupBy(passingChecks, (check) => check.status)).
If we hit browser compatibility issues here we could import groupBy from lodash, or use a reduce().
Docs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/groupBy
There was a problem hiding this comment.
Ah just realised we're in the API here on Node 18 - I don't think Map.groupBy() would be available.
Lodash or reduce() would be the way to go here 👍
…ss/validate-files-against-schema
jessicamcinchak
changed the title
There was a problem hiding this comment.
All looking very good, a few small comments / suggestions here and there 👍
Link to exact node(s) with unsupported variables
Nice idea! Yep let's pick this up once we have this function ready for search.
Link to ODP Schema definitions (could even be Issue template?)
Another great idea 💡
| const sortedValidationChecks = failingChecks | ||
| .concat(warningChecks) | ||
| .concat(passingChecks) | ||
| .concat(notApplicableChecks); |
There was a problem hiding this comment.
Yeah I can think of a few ways!
Map.groupBy is pretty new but seems to have decent coverage https://caniuse.com/?search=map.groupby
I think it would then just be Map.groupBy(passingChecks, (check) => check.status)).
If we hit browser compatibility issues here we could import groupBy from lodash, or use a reduce().
Docs: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/groupBy
| const sortedValidationChecks = failingChecks | ||
| .concat(warningChecks) | ||
| .concat(passingChecks) | ||
| .concat(notApplicableChecks); |
There was a problem hiding this comment.
Ah just realised we're in the API here on Node 18 - I don't think Map.groupBy() would be available.
Lodash or reduce() would be the way to go here 👍
|
|
||
| const getFileUploadNodeFns = (flowGraph: FlowGraph): string[] => { | ||
| const fileUploadNodes = Object.entries(flowGraph).filter( | ||
| (entry): entry is [string, Node] => |
There was a problem hiding this comment.
So, as of TS 5.5 I think we can lose the entry is [string, Node] here and it should be inferred from isComponentType().
Docs: https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#inferred-type-predicates
There was a problem hiding this comment.
Yep, you're correct this is just properly inferred from isComponentType() - removed unnecessary verbose-ness!
| @@ -23,7 +25,7 @@ type AlteredNode = { | |||
|
|
|||
| type ValidationResponse = { | |||
| title: string; | |||
| status: "Pass" | "Fail" | "Not applicable"; | |||
| status: "Pass" | "Fail" | "Warn" | "Not applicable"; | |||
There was a problem hiding this comment.
I was expecting to see this change also picked up in docs.yaml, but it looks like we've missed adding in the validationChecks property.
Happy for this to be picked up here, or in a follow up PR 👍
There was a problem hiding this comment.
Thanks for spotting this, Swagger docs now updated ✅
Relies on theopensystemslab/planx-core#436
Changes:
FileUploadand/orFileUploadAndLabelnodes to the ODP Schema'sFileTypeenum valuesFileUploadAndLabelcomponent is used in info-only mode with a hidden dropzoneWhat this doesn't do yet / future design scope: