Maakaf/friends-activity-backend

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

Aperta

#56 aperta il 30 ott 2025

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (1 assegnatario)TypeScript (17 fork)auto 404
hacktoberfest

Metriche repository

Star
 (9 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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 ?

Guida contributor

Direzione di ricerca
Esamina l'implementazione attuale di GithubService e l'uso di Octokit. Progetta un'astrazione (es. un'interfaccia) che incapsuli le funzionalità necessarie di Octokit. Refactoring di GithubService per dipendere da questa astrazione invece che da Octokit concreto. Quindi aggiorna la configurazione di dependency injection per fornire un'implementazione basata su Octokit e rivedi i test unitari per utilizzare mock per un migliore isolamento.
Tech stack
typescriptnodejs
Dominio
backendapi
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitTypeScriptDependency InjectionUnit Testing
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70