ipfs/kubo

Audit CoreAPI for cases where the context should be canceled internally

Open

#7,200 opened on Apr 23, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
P3exp/intermediatehelp wantedkind/bug

Description

Version information:

v0.5.0-rc3

Description:

There are several places in the CoreAPI (e.g., Ls) where we're assuming the context will be canceled when the caller is done. If that doesn't happen, we won't cleanup some resources.

Luckily, we are canceling these contexts. However, we shouldn't require that.

Contributor guide

Tech stack
go
Domain
backendapiperformance
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Go's context packageUnderstanding of IPFS CoreAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Audit CoreAPI functions like Ls to find places where resources are cleaned up only when the caller cancels the context. These functions should cancel their own contexts internally to ensure cleanup. Check existing comments and the codebase for patterns. No linked PRs, but the issue is clear about the goal.