Skip to content

fix: sanitize carriage returns in test_parameters - #119

Open
Oluwajuwon-O wants to merge 2 commits into
datakind:mainfrom
Oluwajuwon-O:feature/sanitize_carriage_returns
Open

fix: sanitize carriage returns in test_parameters#119
Oluwajuwon-O wants to merge 2 commits into
datakind:mainfrom
Oluwajuwon-O:feature/sanitize_carriage_returns

Conversation

@Oluwajuwon-O

@Oluwajuwon-O Oluwajuwon-O commented Aug 2, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR addresses the carriage-return sanitization issue described in the technical documentation:

Cross-platform test_parameters matching failure

DOT could fail to match configured tests when test_parameters contained carriage returns (\r / \r\n). The regex comparison in get_configured_tests_row() treated otherwise-identical JSON payloads as different, so tests did not register successfully—especially when parameters were authored or transferred with Windows-style line endings.

Resolution

  • Strip carriage returns from stored test_parameters text before comparison using REPLACE(test_parameters::text, '\r', '').
  • Keep the existing non-alphanumeric normalization so parameter matching remains stable across platforms.

In the Technical Documentation, this is addressed in Section 6.6.

Asana Task

Deployment Readiness*

Testing

Describe or check:

  • Created or updated unit, feature, and/or integration tests
  • Typical manual testing in the local env browser, dev pipeline, etc.

Deployment Notes

Describe or check:

  • No special deployment steps required

Rollback Plan

Describe or check:

  • Standard revert is sufficient (git revert)

Reviewer Guidance / Questions*

Screenshots / Testing Evidence*

SOC 2 Change Management Checklist

  • None of the below are true in this code
  • New roles/permissions are introduced without review and approval by the product manager
  • Hardcoded credentials, secrets, or API keys are present in this code
  • Secrets are being managed outside of the approved secrets management process (e.g., GitHub Secrets, environment variables)
  • PII or sensitive data handling is introduced or changed without being reviewed against our data classification policy
  • Sensitive data is written to logs
  • Input validation and sanitization is missing
  • An unnecessary attack surface has been introduced (e.g., unused endpoints, open ports, debug modes left enabled)
  • Common vulnerabilities have been introduced in the code (inc. any dependencies added or updated)
  • No review for common vulnerabilities has been conducted
  • Not tested in a non-production environment
  • Breaking changes to existing APIs or integrations with downstream consumers being notified
  • Performance impact has not been considered or acceptable
  • Appropriate audit logging is missing for any security-relevant actions introduced by this change
  • Log entries contain sensitive or PII data
  • All existing tests do not pass locally (./vendor/bin/pest)

Provide justification if you are submitting a PR with any boxes checked other than the first.


Reminder for Reviewers: By approving this PR you are confirming that you have reviewed the code for correctness, security, and compliance with our engineering and SOC 2 standards. Do not approve PRs where SOC 2 checklist items are checked without documented justification.

*Optional


@Oluwajuwon-O

Oluwajuwon-O commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator Author

The production query change needs a regression test. Please add a case where otherwise-identical test_parameters differ only by a carriage return, and confirm get_configured_tests_row resolves the existing configured test.

@Oluwajuwon-O
Oluwajuwon-O marked this pull request as ready for review August 6, 2026 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant