Add a Covering Index for Hot Query Columns
Include all columns the query reads in the index so the database answers from the index without touching the table.
Task
Apply CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); to reduce a measured bottleneck that shows up in the performance budget or Lighthouse audit.
When to use this
Lighthouse reports the page fails the performance budget because of CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total);, scoring 72 on mobile.
Prerequisites
- A Lighthouse or WebPageTest baseline measurement
- Access to the build configuration
Steps
1. Configure CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); in the project configuration file with the recommended defaults.
CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total);
Expected output: The configuration is accepted and CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); runs without errors on the first invocation.
2. Run the check locally to verify CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); produces the expected result before pushing.
pnpm test
Expected output: Local run matches CI behavior; no surprises after push.
3. Add the gate to the CI pipeline so CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); blocks merge on failure.
- name: Run add index covering query
run: pnpm test
Expected output: Pull requests with failing CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); are blocked from merging.
Troubleshooting
Problem
The check passes locally but fails in CI
Solution
Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.
Problem
Configuration is rejected with a schema error
Solution
Check the tool version matches the config schema; older versions may not support newer fields.
Limitations
- The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
- Configuration drift is possible if someone edits settings outside version control.
Measure before optimizing
Start by measuring the problem. Include all columns the query reads in the index so the database answers from the index without touching the table. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); against the current codebase and inspect the output before wiring it into CI.
CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total);Verify the improvement
Once the gate is in place, make failures actionable. A failing CREATE INDEX idx_covering ON orders (user_id) INCLUDE (status, total); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.