feat: SDKE-528 Implement Script To Preprocess Request Recordings #452
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add response body files for identify, log event, and config endpoints - Add mapping files for v1 identify, v2 log event, and v4 config
Script extracts JSON request bodies from WireMock mapping files and saves them as separate files for easier test data management.
- Add replace_field_value() function to recursively replace single field values - Add replace_fields_from_list() function to replace multiple fields from a list - Both functions support custom replacement values with default unit.ignore
- Add DEFAULT_REPLACE_FIELDS constant with 16 known dynamic fields
- Add --replace command line parameter to enable field replacement
- When enabled, replaces dynamic fields (IDs, timestamps, device info) with ${json-unit.ignore}
- Update script documentation and help text
- Add detailed steps for recording API requests with test code - Document extract_request_body.py and update_mapping_from_extracted.py scripts - Explain workflow for editing and maintaining test request bodies - Add best practices for recording only relevant API calls - Document benefits of the new workflow (dynamic field replacement, easier maintenance) - Clarify that recorded mappings need to be filtered to keep only relevant ones
denischilik
requested review from
BrandonStalnaker,
jamesnrokt and
nickolas-dimitrakas
Co-authored-by: Nickolas Dimitrakas <[email protected]>
thomson-t
approved these changes
Nov 17, 2025
| - `wiremock-recordings/mappings/*.json` - API request/response mappings | ||
| - `wiremock-recordings/__files/*` - Response body files | ||
|
|
||
| ### `extract_request_body.py` - Extract Request Body from WireMock Mapping |
Contributor
There was a problem hiding this comment.
Should we add python as well to the Prerequisites?
Contributor
Author
There was a problem hiding this comment.
We don’t need to list Python in the prerequisites because macOS already includes a system Python installation out of the box. Since the script is lightweight and doesn’t rely on any external libraries, it will run fine with the default Python that comes pre-installed on every Mac
BrandonStalnaker
approved these changes
Nov 17, 2025
denischilik
deleted the
feat/SDKE-528-Implement-Script-To-Preprocess-Request-Recordings
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
This change improves the integration testing workflow by adding automated preprocessing capabilities for WireMock request recordings. Previously, recorded API request bodies contained dynamic fields (timestamps, device IDs, UUIDs) that changed on every test run, requiring manual editing of mapping files. This made test maintenance time-consuming and error-prone.
What Has Changed
extract_request_body.pyscript:replace_field_value()- recursively replaces single field values in JSONreplace_fields_from_list()- replaces multiple fields from a predefined list--replacecommand line parameter to enable automatic replacement of 16 known dynamic fields${json-unit.ignore}placeholderslog_eventandidentifymappingsBenefits
Checklist
Additional Notes
The
--replaceparameter uses a default list of 16 dynamic fields commonly found in mParticle API requests. This list can be extended as needed for future test cases.Reference Issue (For employees only. Ignore if you are an outside contributor)