Option group `requestComplexity` is described as accepting `-1` for every property, but `allowRegex` is a boolean

Abierto Apto para principiantes
  • ¿Algo no está bien?
#10,870 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
85/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
javascript, node.js
Área
backend, documentation

Línea de trabajo

Lee la descripción de requestComplexity en src/Options/index.js y compárala con la opción booleana allowRegex. Actualiza la redacción para especificar las propiedades numéricas y luego ejecuta npm run definitions para regenerar src/Options/Definitions.js y src/Options/docs.js. El trabajo estará terminado cuando las tres descripciones limiten correctamente las indicaciones sobre -1 a las propiedades numéricas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

New Issue Checklist
Issue Description

The description of the requestComplexity option group in src/Options/index.js ends with:

Each property can be set to -1 to disable that specific limit.

The group also contains requestComplexity.allowRegex, which is a boolean option (parsers.booleanParser). Setting it to -1 is rejected by the boolean validation, so the sentence only applies to the numeric limits (includeDepth, includeCount, subqueryDepth, subqueryLimit, queryDepth, graphQLDepth, graphQLFields, batchRequestLimit). The same sentence is replicated in the generated src/Options/Definitions.js and src/Options/docs.js.

Steps to reproduce

Start Parse Server with:

requestComplexity: { allowRegex: -1 }
Actual Outcome

Startup fails with the boolean validation error (requestComplexity.allowRegex must be a boolean.), although the option group description says each property can be set to -1.

Expected Outcome

The description is accurate for every property in the group, for example:

Each numeric property can be set to -1 to disable that specific limit.

Changed in src/Options/index.js and regenerated with npm run definitions.

Environment

Server

  • Parse Server version: 9.11.1-alpha.2
  • Operating system: n/a (documentation)
  • Local or remote host: n/a

Database

  • System (MongoDB or Postgres): n/a
  • Database version: n/a
  • Local or remote host: n/a

Client

  • SDK (iOS, Android, JavaScript, PHP, Unity, etc): n/a
  • SDK version: n/a
Logs

n/a

Lenguaje dominante
JavaScript
Estrellas
21.4k
Forks
4.8k
Merge medio
7 h 8 min
PR fusionados (30 d)
65

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de parse-community/parse-server

Todos los issues de parse-community/parse-server

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.