smart-on-fhir/cumulus-etl

Refactor: do a pass to remove `noqa: S*` lines

Open

#186 opened on Mar 10, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (8 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (25 stars)
PR merge metrics
 (PR metrics pending)

Description

None of the current noqa: S* lines are security issues. But it's still a nicer story if there aren't any.

We have two kinds of security linter exemptions right now:

  • SQL injection (because there's no user input involved, it's just basic string formatting)
  • assert lines (because it's OK that they get ignored in optimized code, as they are just sanity checks for developers writing new tasks)

So both could be fixed easily enough (SQL maybe would use some version of bound variables and the asserts could be re-written or just dropped).

Not a high priority, but might be nice to do, to simplify the security story.

Contributor guide

Research direction
Inspect each noqa S* line in the codebase, identify whether it's a SQL injection or assert warning, and replace with safe practices such as using bound variables for SQL or removing unnecessary asserts.
Tech stack
pythonsql
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75