[go: up one dir, main page]
Page MenuHomePhabricator
Create Task
Maniphest T373381

Validate requests in chart-renderer service
Open, HighPublic3 Estimated Story Points
Actions

Description

The chart-renderer service accepts a JSON blob that it expects to follow a certain format, but it doesn't currently validate this. We should validate this input, perhaps using the express-validator NPM package.

Acceptance Criteria
  • Requests made to the chart-renderer service are validated (using the schema definition from T372307)
  • Requests that fail validation are logged
  • The decision around which library we are using has been recorded in the codebase as a decision record. The decision record should capture why we choose Zod for validation as opposed to "just" TypeScript, and other libraries we considered and rejedcted.

Related Objects

Event Timeline

• Catrope created this task.Mon, Aug 26, 6:21 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMon, Aug 26, 6:21 PM
aude subscribed.Mon, Aug 26, 6:22 PM

https://zod.dev/ could be useful for validation in the service

• Catrope added a comment.Mon, Aug 26, 6:22 PM

@aude suggests using https://zod.dev/

CCiufo-WMF triaged this task as Medium priority.Mon, Aug 26, 6:28 PM
CCiufo-WMF updated the task description. (Show Details)
CCiufo-WMF set the point value for this task to 3.
CCiufo-WMF moved this task from Needs Triage to Estimated on the Charts board.
CCiufo-WMF moved this task from Estimated to Sprint 5 on the Charts board.Mon, Aug 26, 6:45 PM
CCiufo-WMF edited projects, added Charts (Sprint 5); removed Charts.
CCiufo-WMF moved this task from Incoming to Ready for Dev on the Charts (Sprint 5) board.
LGoto assigned this task to • Catrope.Mon, Aug 26, 6:49 PM
• Catrope moved this task from Ready for Dev to Doing on the Charts (Sprint 5) board.Wed, Sep 4, 4:11 PM
CodeReviewBot added a project: Patch-For-Review.Wed, Sep 4, 6:10 PM

catrope opened https://gitlab.wikimedia.org/repos/mediawiki/services/chart-renderer/-/merge_requests/21

Validate CLI and service input using zod

• Catrope moved this task from Doing to Code Review on the Charts (Sprint 5) board.Wed, Sep 4, 6:10 PM
Jdlrobson updated the task description. (Show Details)Wed, Sep 4, 10:18 PM
Jdlrobson subscribed.

Following our discussion today I added an acceptance criteria about capturing our decision to use Zod. Let me know if you have any concerns about doing that as part of this ticket! We'll backfill other decisions as part of T374065.

CCiufo-WMF reassigned this task from • Catrope to aude.Mon, Sep 9, 6:09 PM
CCiufo-WMF moved this task from Sprint 5 to Estimated on the Charts board.
CCiufo-WMF edited projects, added Charts; removed Charts (Sprint 5).
CCiufo-WMF raised the priority of this task from Medium to High.Mon, Sep 9, 6:30 PM
CCiufo-WMF moved this task from Estimated to Sprint 6 on the Charts board.
CCiufo-WMF edited projects, added Charts (Sprint 6); removed Charts.
Jdlrobson moved this task from Incoming to Ready for Dev on the Charts (Sprint 6) board.Mon, Sep 9, 6:45 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits