wiremock/wiremock

stub recording should support Content-Encoding: deflate (compression)

Open

#1,989 opened on Oct 17, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (1,368 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,766 stars)
PR merge metrics
 (Avg merge 1d 15h) (33 merged PRs in 30d)

Description

Which version of WireMock you're using: 2.34.0

Steps to reproduce:

  1. Configure a server to compress content with content-encoding: deflate
  2. Record a conversation with this server
  3. Attempt to use this recorded conversation to play back a response

The problem is then that the recorded content is compressed, but the content-encoding: deflate header has been removed. http clients then do not attempt to decompress the content and it is unusable by the application.

This is due to a bug in SutbMappingJsonRecorder: withoutContentEncodingAndContentLength removes these headers always, but the bodyDecompressedIfRequired method only decompresses gzip content. So there is really one bug here (removing headers should be done only if the content encoding is understood and the content is decompressed) and one implied feature request (we should support deflate, it's pretty easy).

Contributor guide

Research direction
Investigate the StubMappingJsonRecorder class, specifically the methods withoutContentEncodingAndContentLength and bodyDecompressedIfRequired. Understand how gzip decompression is implemented and extend it to support deflate. Ensure that the Content Encoding header is only removed after successful decompression.
Tech stack
java
Domain
apitesting
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaHTTPGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65