refactor: rename `request.validate` to `request.validateInput` #4139

metcoder95 · 2022-07-14T21:10:07Z

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

Eomm · 2022-07-16T06:20:55Z

docs/Reference/Request.md

+// or
+
+const validate = request
+                  .getSerializationFunction('body')


misprint: the serialization function

Eomm · 2022-07-16T06:21:25Z

docs/Reference/Request.md

+validate({ foo: 0.5 }) // false
+```
+
+See [.compilaValidationSchema(schema, [httpStatus])](#compileserializationschema)


Suggested change

See [.compilaValidationSchema(schema, [httpStatus])](#compileserializationschema)

See [.compilaValidationSchema(schema, [httpStatus])](#compilevalidationschema)

Eomm · 2022-07-16T06:21:54Z

docs/Reference/Request.md

+This function will compile a validation schema and
+return a function that can be used to validate data.
+The function returned (a.k.a. _validation function_) is compiled
+by using the provided `SchemaControler#ValidationCompiler`.


Should it be a link?

Eomm · 2022-07-16T06:22:53Z

docs/Reference/Request.md

+// or
+
+const validate = request
+                  .compileSerializationSchema({


misprint: the serialization is not involved here and it returns a string

Eomm · 2022-07-16T06:23:13Z

docs/Reference/Request.md

+
+Note that you should be careful when using this function, as it will cache
+the compiled valiadtion functions based on the schema provided. If the
+schemas provided is mutated or changed, the serialization functions will not


Suggested change

schemas provided is mutated or changed, the serialization functions will not

schemas provided are mutated or changed, the validation functions will not

Eomm · 2022-07-16T06:23:54Z

docs/Reference/Request.md

+the compiled valiadtion functions based on the schema provided. If the
+schemas provided is mutated or changed, the serialization functions will not
+detect that the schema has been altered and for instance it will reuse the
+previously compiled serialization function, as the cache is based on


Suggested change

previously compiled serialization function, as the cache is based on

previously compiled validation function, as the cache is based on

Eomm · 2022-07-16T06:24:14Z

docs/Reference/Request.md

+a totally new schema (object), otherwise the implementation won't benefit from
+the cache mechanism.
+
+:Using the following schema as example:


Suggested change

:Using the following schema as example:

Using the following schema as an example:

Eomm · 2022-07-16T06:24:33Z

docs/Reference/Request.md

+const validate = request.compileValidationSchema(schema1)
+
+// Later on...
+schema1.properties.foo.type. = 'integer'


Suggested change

schema1.properties.foo.type. = 'integer'

schema1.properties.foo.type = 'integer'

Note for myself: Do not write documentation late in the night 😅

Eomm · 2022-07-16T06:25:54Z

docs/Reference/Request.md

+validate({ hello: 'world' }) // false
+```
+
+Note that you should be careful when using this function, as it will cache


I wonder if we should just link a blog post (I volunteer to write it) to explain this.

I think it is too technical and the user may loose the focus on the "big picture"

Agree, didn’t find a way to make it less verbose. Actually I think a Blog post will explain pretty what’s about, happy to be part if I can be helpful somehow 🙂

Eomm · 2022-07-16T06:26:34Z

docs/Reference/Request.md

+// or
+
+request
+  .serializeInput({ hello: 'world'}, 'query') // false


Suggested change

.serializeInput({ hello: 'world'}, 'query') // false

.validateInput({ hello: 'world'}, 'query') // false

docs/Reference/Reply.md

Eomm · 2022-07-18T07:43:27Z

docs/Reference/Request.md

+                      } 
+                    } 
+                  }, 200)
+validate({ hello: 'world' }) // false


What about renaming it to validateInput? (as serializeInput)

We did not land this feature yet

Sure, I think it can follow the same pattern as with the serializeInput 👍

mcollina

lgtm

docs/Reference/Request.md

metcoder95 · 2022-07-18T21:10:37Z

@Eomm Adjusted the name of the method to validateInput, please have a look 🙂

@Fdawgs thanks a lot for the insights about the documentation, super helpful. I addressed them, let me know if there's any adjustment that needs to be done 👍

docs/Reference/Request.md

xtx1130 · 2022-07-19T06:39:19Z

Why need to rename validate to validateInput? This is not mentioned in the pr.

Checklist

run npm run test and npm run benchmark

tests and/or benchmarks are included

documentation is changed or added

commit message and code follows the Developer's Certification of Origin
and the Code of conduct

Eomm · 2022-07-19T06:50:30Z

Why need to rename validate to validateInput? This is not mentioned in the pr.

This feature is not yet shipped, so we can change it.

I suggested it because the reply object has the new serializeInput function to avoid the collision with the .serialize one.
So I think it was better to name "equally" the new functions

Co-authored-by: 小菜 <xtx1130@gmail.com>

lib/request.js

mcollina

lgtm

mcollina · 2022-07-19T08:04:39Z

@climba03003 is this good to land?

climba03003

It is a refactor on name and document update.

I believe it is good to go.

xtx1130

LGTM.
ref: #3970

github-actions · 2023-07-20T00:24:04Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

metcoder95 added 2 commits July 14, 2022 23:06

docs(reply): add documentation for new validation apis

2e6ceed

docs(reply): adjust serialization documentation

565d673

Eomm requested changes Jul 16, 2022

View reviewed changes

Eomm added the documentation Improvements or additions to documentation label Jul 16, 2022

mcollina reviewed Jul 16, 2022

View reviewed changes

docs/Reference/Reply.md Show resolved Hide resolved

docs/Reference/Reply.md Show resolved Hide resolved

Eomm reviewed Jul 18, 2022

View reviewed changes

mcollina approved these changes Jul 18, 2022

View reviewed changes

Fdawgs requested changes Jul 18, 2022

View reviewed changes

docs: address comments

5dedda9

github-actions bot removed the documentation Improvements or additions to documentation label Jul 18, 2022

metcoder95 added 2 commits July 18, 2022 23:05

refactor(request): rename from validate to validateInput

83ad44b

docs: adjust new renaming

54afa5d

metcoder95 changed the title ~~docs: adjust documentation for new request/reply APIs~~ refactor: rename request.validate to request.validateInput Jul 18, 2022

metcoder95 requested review from Fdawgs and Eomm July 18, 2022 21:08

refactor: change method name

9722691

xtx1130 suggested changes Jul 19, 2022

View reviewed changes

docs/Reference/Request.md Outdated Show resolved Hide resolved

Eomm approved these changes Jul 19, 2022

View reviewed changes

Update docs/Reference/Request.md

7cce487

Co-authored-by: 小菜 <xtx1130@gmail.com>

Fdawgs approved these changes Jul 19, 2022

View reviewed changes

mcollina requested changes Jul 19, 2022

View reviewed changes

lib/request.js Show resolved Hide resolved

mcollina approved these changes Jul 19, 2022

View reviewed changes

climba03003 approved these changes Jul 19, 2022

View reviewed changes

xtx1130 approved these changes Jul 19, 2022

View reviewed changes

mcollina merged commit 0ca63a0 into fastify:main Jul 19, 2022

Eomm mentioned this pull request Jul 20, 2022

AJV8 validation inside preHandler fastify/help#720

Closed

github-actions bot locked as resolved and limited conversation to collaborators Jul 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: rename `request.validate` to `request.validateInput` #4139

refactor: rename `request.validate` to `request.validateInput` #4139

metcoder95 commented Jul 14, 2022 •

edited

Eomm Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 16, 2022

metcoder95 Jul 16, 2022 •

edited

Eomm Jul 16, 2022

metcoder95 Jul 16, 2022

Eomm Jul 16, 2022

Eomm Jul 18, 2022

metcoder95 Jul 18, 2022

mcollina left a comment

metcoder95 commented Jul 18, 2022

xtx1130 commented Jul 19, 2022

Checklist

Eomm commented Jul 19, 2022

mcollina left a comment

mcollina commented Jul 19, 2022

climba03003 left a comment •

edited

xtx1130 left a comment •

edited

github-actions bot commented Jul 20, 2023

	See [.compilaValidationSchema(schema, [httpStatus])](#compileserializationschema)
	See [.compilaValidationSchema(schema, [httpStatus])](#compilevalidationschema)

	schemas provided is mutated or changed, the serialization functions will not
	schemas provided are mutated or changed, the validation functions will not

	previously compiled serialization function, as the cache is based on
	previously compiled validation function, as the cache is based on

	:Using the following schema as example:
	Using the following schema as an example:

	schema1.properties.foo.type. = 'integer'
	schema1.properties.foo.type = 'integer'

	.serializeInput({ hello: 'world'}, 'query') // false
	.validateInput({ hello: 'world'}, 'query') // false

refactor: rename request.validate to request.validateInput #4139

refactor: rename request.validate to request.validateInput #4139

Conversation

metcoder95 commented Jul 14, 2022 • edited

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

metcoder95 Jul 16, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcollina left a comment

Choose a reason for hiding this comment

metcoder95 commented Jul 18, 2022

xtx1130 commented Jul 19, 2022

Checklist

Eomm commented Jul 19, 2022

mcollina left a comment

Choose a reason for hiding this comment

mcollina commented Jul 19, 2022

climba03003 left a comment • edited

Choose a reason for hiding this comment

xtx1130 left a comment • edited

Choose a reason for hiding this comment

github-actions bot commented Jul 20, 2023

refactor: rename `request.validate` to `request.validateInput` #4139

refactor: rename `request.validate` to `request.validateInput` #4139

metcoder95 commented Jul 14, 2022 •

edited

metcoder95 Jul 16, 2022 •

edited

climba03003 left a comment •

edited

xtx1130 left a comment •

edited