Merge pull request #28670 from overleaf/td-rename-validate-req

Rename validateReq to parseReq

GitOrigin-RevId: a935aaa3f89495e164ce5d10b0bd80436571440f

libraries/validation-tools/index.js

@@ -1,7 +1,7 @@
 const { ParamsError } = require('./Errors')
 const { z } = require('zod')
 const { zz } = require('./zodHelpers')
-const { validateReq } = require('./validateReq')
+const { parseReq } = require('./parseReq')
 const { validateSchema } = require('./validateSchema')
 const {
   handleValidationError,
@@ -12,7 +12,7 @@ module.exports = {
   z,
   zz,
   validateSchema,
-  validateReq,
+  parseReq,
   handleValidationError,
   createHandleValidationError,
   ParamsError,

libraries/validation-tools/parseReq.js

@@ -12,14 +12,14 @@ const { ParamsError } = require('./Errors')
  */
 
 /**
- * Validate a request against a zod schema
+ * Parse and validate a request against a Zod schema
  *
  * @template {ZodType} T
  * @param {Request} req - The Express request object
  * @param {T} schema - The Zod schema to validate against
  * @returns {output<T>} The validated request object
  */
-function validateReq(req, schema) {
+function parseReq(req, schema) {
   const parsed = schema.safeParse(req)
   if (parsed.success) {
     return parsed.data
@@ -31,4 +31,4 @@ function validateReq(req, schema) {
   }
 }
 
-module.exports = { validateReq }
+module.exports = { parseReq }

libraries/validation-tools/test/unit/src/validateReq.test.ts

@@ -1,10 +1,10 @@
-import { validateReq } from '../../../validateReq'
+import { parseReq } from '../../../parseReq'
 import { describe, expect, it } from 'vitest'
 import { z } from 'zod'
 import type { Request } from 'express'
 import { zz } from '../../../zodHelpers'
 
-describe('validateReq', () => {
+describe('parseReq', () => {
   describe('with a request that is valid for the schema', () => {
     it('should return the parsed request', () => {
       const req = {
@@ -25,7 +25,7 @@ describe('validateReq', () => {
         }),
       })
 
-      const result = validateReq(req, schema)
+      const result = parseReq(req, schema)
 
       expect(result).toEqual({
         params: {
@@ -46,7 +46,7 @@ describe('validateReq', () => {
       } as Request<{ id: string }>
 
       expect(() =>
-        validateReq(
+        parseReq(
           req,
           z.object({
             params: z.object({
@@ -65,7 +65,7 @@ describe('validateReq', () => {
       } as Request
 
       expect(() =>
-        validateReq(
+        parseReq(
           req,
           z.object({
             body: z.object({