openedx/openedx-platform

Script to print xsslint violations is missing

Open

#35,965 opened on Dec 4, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (4,331 forks)auto 404
code healthhelp wanted

Repository metrics

Stars
 (8,150 stars)
PR merge metrics
 (PR metrics pending)

Description

This was discovered as an existing issue while working on https://github.com/openedx/edx-platform/pull/35159

When xsslint detects a violation beyond the forgiven thresholds, rather than printing anything helpful, it fails with:

python scripts/xsslint/xss_linter.py \
--rule-totals \
--config=scripts.xsslint_config \
--thresholds=scripts/xsslint_thresholds.json
xsslint
FAILURE: XSSLinter Failed.
Too many violations total (65).
The limit is 64.
Too many python-concat-html violations (1).
The python-concat-html limit is 0.
run the following command to hone in on the problem:
./scripts/xss-commit-linter.sh -h
make: *** [Makefile:176: xsslint] Error 1

The script it tells you to run, ./scripts/xss-commit-linter.sh -h, does not exist.

We should provide the dev some way of seeing violations. Or, maybe we just print the violations every single time, like eslint does.

Contributor guide

Research direction
Locate the xsslint script and modify it to print violations instead of just failing, or create the missing script `scripts/xss commit linter.sh` to display violations.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80