[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twice
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 77/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Lĩnh vực
- backend-api-design
Hướng nghiên cứu
Issue xác định Configuration#configure_faraday và Connection#deserialize là đường xử lý phân tích; hãy bắt đầu bằng cách đọc các phương thức này trong bộ tạo Ruby Nextgen và các mẫu client được tạo ra. Thêm hoặc tìm một kiểm thử hồi quy cho phản hồi JSON dạng chuỗi như "hello", sau đó chạy các kiểm thử client Ruby Nextgen liên quan. Hoàn tất khi phản hồi trả về chuỗi thành công mà không phát sinh ApiError.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
Description
Configuration#configure_faraday registers the :json response middleware, which decodes a JSON response body. Connection#deserialize then calls JSON.parse again on any body that is still a String. A response whose JSON value is a string ("hello") is decoded to hello by the middleware, the second parse fails, and a successful call raises ApiError.
openapi-generator version
master, 7.28.0-SNAPSHOT, 8a9fb722777e770e2c44b20b00bddbb51a0d525a
OpenAPI declaration file content or url
openapi: 3.0.3
info:
title: probes
version: 1.0.0
paths:
/greeting:
get:
operationId: getGreeting
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
/pets:
get:
operationId: listPets
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
components:
schemas:
Pet:
type: object
properties:
birthday:
type: string
format: date
code:
type: string
pattern: '^[a-z]+$'
Generation Details
java -jar openapi-generator-cli.jar generate -g ruby-nextgen -i spec.yaml -o out \
--additional-properties=gemName=petstore,moduleName=Petstore
Steps to reproduce
$LOAD_PATH.unshift 'out/lib'
require 'petstore'
# Replies to every request with a fixed JSON body.
class Reply < Faraday::Middleware
def initialize(app, body)
super(app)
@body = body
end
def call(env)
env.status = 200
env.body = @body
env.response_headers = Faraday::Utils::Headers.new('Content-Type' => 'application/json')
env.response = Faraday::Response.new(env)
end
end
client = Petstore::Client.new(base_url: 'http://localhost') { |c| c.use(Reply, '"hello"') }
begin
p client.greeting.list.data
rescue Petstore::ApiError => e
puts "#{e.class}: #{e.message}"
end
Actual (ruby 4.0.9, faraday 2.15.1):
Petstore::ApiError: invalid JSON in response body: unexpected character: 'hello' at line 1 column 1
Expected:
"hello"
Related issues/PRs
Raised by the automated review of #25717; the code is already on master and is not changed by that PR.
- Ngôn ngữ chính
- Java
- Star
- 26.9k
- Fork
- 7.8k
- Merge trung bình
- 2 ngày 23 phút
- Pull request đã merge (30 ngày)
- 177
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của OpenAPITools/openapi-generator
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Enhancement: Feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorCó thể đã có người làm @Inf1mum đã nhận 2 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
OpenAPITools/openapi-generator#25724 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayCó thể đã có người làm @Inf1mum đã nhận 2 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
OpenAPITools/openapi-generator#25723 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[BUG][JAVA] Deprecated properties only get @Deprecated on the getter (base, feign, native, microprofile)Có thể đã có người làm @Inf1mum đã nhận 11 ngày trước. Đang mởIssue: Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
OpenAPITools/openapi-generator#25567 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của OpenAPITools/openapi-generator
Issue tương tự
-
good first issue kernel
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
JackFurton/who-would-build-a-kernel-in-java#316 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
GTNewHorizons/Angelica#2370 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Long working directory path draws over the Console pane's buttons when the Console has no other tabsĐang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
HIDE_OVERLAY_WINDOWS permissionĐang mởproposal
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
beemdevelopment/Aegis#1861 ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
foam-foundation/foam3#5917 ·
Maintainer thường phản hồi trong vòng 1 ngày