sourcegraph/sourcegraph-public-snapshot

insights: Extend/change add/remove gql mutation in a way to handle list of insights per one mutation

Open

#32,194 opened on Mar 4, 2022

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

Repository metrics

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

Description

Related GH thread https://github.com/sourcegraph/sourcegraph/issues/23065#issuecomment-1057858501

Background

In the nutshell, at the moment addInsightViewToDashboard and removeInsightViewFromDashboard mutations take only one insight id. But it would be better from the performance point of view for the frontend to have mutations that could take a list of insights for adding or removing them to/from the dashboard.

A good use case for such mutations might be our "Add or remove insights" modal view. At the moment we are sending a package (bulk) GQL mutation request for each added/removed insight there. With a new mutation, we could just run one mutation for adding and one for removing.

Contributor guide

Research direction
Examine the current mutations `addInsightViewToDashboard` and `removeInsightViewFromDashboard` in the GraphQL schema and resolver. Understand how they handle single insight IDs. Then design a new mutation that accepts a list of insight IDs for bulk add/remove, ensuring proper validation, error handling, and database transactions.
Tech stack
go
Domain
backend
Issue type
Feature
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
GitGoGraphQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70