sourcegraph/sourcegraph-public-snapshot

insights: refactor capture group methods for readability and performance

Open

#33,148 opened on Mar 28, 2022

View on GitHubContributor guide
 (11 comments) (0 reactions) (0 assignees)Go (1,374 forks)auto 404
backendcode-insightsgood first issue

Repository metrics

Stars
 (10,290 stars)
PR merge metrics
 (PR metrics pending)

Description

When a capture group insight is created, we tally up matches per capture group using MatchValues and Counts methods on ComputeMatchContext. We then group them in the method GroupByCaptureMatch.

The current logic uses many nested for loops. The aim of this ticket is to look into simplifying this logic. What we want at the end is a map of unique capture group values to their count.

Contributor guide

Research direction
Inspect the MatchValues, Counts, and GroupByCaptureMatch methods in the sourcegraph codebase. Identify nested loops and explore alternatives like using a map to aggregate counts directly, or using streams to reduce complexity.
Tech stack
go
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60