feat: Add input validation for use as a JS library #58
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.
Goal
When used via TypeScript, as we do in our commands, the uploader libraries have type information that prevent certain kinds of input. However, when used via JS – as is one of the use cases of this package – no such safety is in place. The goal is to add input checking at runtime to ensure early and helpful feedback to the user when invalid input is provided.
Design
I've implemented a set of reusable input checking functions. Each uploader has slightly different parameters that it supports so the exact validation method is composed of multiple calls to the input checkers specifying the kind of input allowed.
It also checks for unknown options, since this can (and has been) as source of confusion – for instance, passing
bundleUrl
into the Node uploader.Changeset
lib/InputValidators.ts
fileupload*()
methods to first validate the provided input. If invalid input is detected, these functions will reject a promise with the validation error.Testing