fix: added context with client and schema to slugify and source options #3711
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
| ) => string | Promise<string> | ||
|
|
||
| export type SlugifierFn = (source: string, schemaType: SlugSchemaType) => string | Promise<string> | ||
|
|
||
| // TODO: De-dupe with validation types |
| @@ -9,12 +9,16 @@ const defaultSlugify = (value: FIXME, type: SlugSchemaType): string => { | |||
| return value ? speakingurl(value, slugifyOpts) : '' | |||
| } | |||
|
|
|||
| export function slugify(sourceValue: FIXME, type: SlugSchemaType): Promise<string> { | |||
| export function slugify( | |||
There was a problem hiding this comment.
suggestion: same as above re: converting async function. I think we want the error to propagate on the returned promise (I do realise that this isn't "new" behavior, so feel free to ignore)
There was a problem hiding this comment.
(and by "above" I mean "below" 🙃)
| return {parentPath, parent, ...context} | ||
| } | ||
|
|
||
| function getNewFromSource( |
There was a problem hiding this comment.
suggestion: make this an async function? That way we make sure that any (current or future) sync errors triggered by either this function or the slugifier call are thrown on the returned promise. As a bonus, the Promise.resolve call in here can be removed too.
There was a problem hiding this comment.
Will do. Funny seeing eslint fight itself:
🤷
There was a problem hiding this comment.
Seems like we should turn off the require-await rule or replace it with @typescript/require-await which uses type information: https://typescript-eslint.io/rules/require-await/
Description
Extends the context object passed to
options.sourceandoptions.slugifywith getClient, schema, currentUser (and projectId and dataset for consistency with initial value context).Also fixes the context type for
options.isUniquewhich was duplicated in the definition, and missing some properties (they where available at runtime already though, via validation context).This is primarily to make it possible to use the client when using these options; a common thing in v2.
What to review
All the code.
Notes for release
Slug options
sourceandslugifyare now passed acontextparameter as the last argument. It containsgetClient,schemaandcurrentUser.