uber / uber/RIBs-iOS

Should LeakDetector's singleton instance be available to the library's consumers?

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
193
Forks
23
PR merge metrics
No merged PRs in 30d

Description

Currently LeakDetector exposes its singleton instance via public static let instance = LeakDetector() to the users of this library. Should it really be exposed as it doesn't seem to have any intended usage by the developers building applications with RIBs? Even more, should any of the methods, static or public, of the LeakDetector class be exposed to the library users?

Leak detection seems to be an internal mechanic of RIBs and besides exposing an override for debugging there doesn't seem to be any need in giving users access to it.

By hiding the internals and the public API of the LeakDetector we can make easier and safer future optimizations of it or internal API changes without introducing breaking changes to consumers of the library.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names LeakDetector but no file or test. Start by locating the class, its singleton declaration, and its public or static methods, then inspect any existing debugging override usage. Done means reaching a decision and updating the exposed API consistently without removing the intended debugging access.

Written by the indexing model from the issue text.

Assessment

Tech stack
ios, swift
Domain
devtools, mobile-dev
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.