Maakaf/friends-activity-backend

refactor - github service - inject octokit and use abstraction level to remove coupling

Open

#56 opened on Oct 30, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)TypeScript (17 forks)auto 404
hacktoberfest

Repository metrics

Stars
 (9 stars)
PR merge metrics
 (PR metrics pending)

Description

while trying to write the more "interesting" utests for GithubService, i came to realize that it would be a lot easier to mock and test if octokit (and Logger for that matter) would be injected.

So i would like to refactor the service such that it expects an abstraction and use octokit to implement it. this would:

  1. enable easier mocking in utests.
  2. remove strong couling we have today between octokit and github service.

@UrielOfir @barlavi1 @Lidor57 - any thoughts about this ?

Contributor guide

Research direction
Review the current GithubService implementation and its use of Octokit. Design an abstraction (e.g., an interface) that wraps Octokit's required functionality. Refactor GithubService to depend on this abstraction instead of concrete Octokit. Then update the dependency injection configuration to provide an Octokit based implementation, and revise unit tests to use mocks for better isolation.
Tech stack
typescriptnodejs
Domain
backendapi
Issue type
Refactor
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.
Mostly clear
Prerequisites
GitTypeScriptDependency InjectionUnit Testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70