Multipart file uploads fail validation with ActionDispatch::Request (UploadedFile isn't a Hash)

Abierto Apto para principiantes
#516 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
68/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
rails, ruby
Área
api

Línea de trabajo

Empieza en Validators::MultipartRequestBody#collect_file_uploads, que solo reemplaza valores donde value.key?(:tempfile). Ejecuta el repro con ActionDispatch::Request e inspecciona los objetos ActionDispatch::Http::UploadedFile que devuelve. Está listo cuando la solicitud de Rails se valida igual que la de Rack y una spec cubre ambos tipos de solicitud.

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

Descripción

Written by Claude

A multipart file field described as type: string, format: binary passes validation with a Rack::Request, but fails with an ActionDispatch::Request:

Request body invalid: value at `/file` is not a string

This affects Rails request specs that use assert_api_conform, since it validates the Rails request.

Cause

Validators::MultipartRequestBody#collect_file_uploads swaps in a placeholder string only for Rack's upload hashes (value.key?(:tempfile)). ActionDispatch::Request#POST converts those hashes into ActionDispatch::Http::UploadedFile objects. Those aren't hashes, so the placeholder never replaces them, and the schema sees an object where it expects a string. main has the same check.

Repro (openapi_first 4.2.1, actionpack 8.1.4.1)

# openapi.yaml
openapi: 3.1.0
info: { title: Upload, version: 1.0.0 }
paths:
  /uploads:
    post:
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required: [file]
              properties:
                file: { type: string, format: binary }
      responses:
        '204': { description: Stored }
require 'openapi_first'
require 'action_dispatch'
require 'rack/test'

definition = OpenapiFirst.load(File.join(__dir__, 'openapi.yaml'))
upload = Rack::Test::UploadedFile.new(StringIO.new('hello'), 'text/plain', original_filename: 'hello.txt')
body = Rack::Test::Utils.build_multipart('file' => upload)
content_type = "multipart/form-data; boundary=#{Rack::Test::MULTIPART_BOUNDARY}"
rack_env = Rack::MockRequest.env_for('/uploads', method: 'POST', input: body, 'CONTENT_TYPE' => content_type)
rails_env = Rack::MockRequest.env_for('/uploads', method: 'POST', input: body, 'CONTENT_TYPE' => content_type)

p definition.validate_request(Rack::Request.new(rack_env)).valid?            # => true
p definition.validate_request(ActionDispatch::Request.new(rails_env)).valid? # => false

Workaround

Validate a Rack::Request built over the same env. Rack keeps its parsed form hash in the env, so uploads arrive as hashes with :tempfile:

module ValidateAsRackRequest
  def assert_api_conform(status: nil, api: :default)
    rails_request = @request
    @request = Rack::Request.new(rails_request.env)
    super
  ensure
    @request = rails_request
  end
end

Possible fix

Treat any value that responds to tempfile as an upload, alongside Rack's hash. That covers ActionDispatch::Http::UploadedFile and Rack::Multipart::UploadedFile.

Lenguaje dominante
Ruby
Estrellas
222
Forks
27
Merge medio
17 h 15 min
PR fusionados (30 d)
6

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 ahx/openapi_first

Todos los issues de ahx/openapi_first

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.