refactor: cleanup and move API - Githubissues

caas-team / sparrow

A monitoring tool to gather infrastructure network information

Apache License 2.0

6 stars 4 forks source link

refactor: cleanup and move API #95

Closed lvlcn-t closed 7 months ago

lvlcn-t commented 8 months ago

Motivation

To finish the refactoring started in #91, where the checks' handler methods were removed from the interface.

Closes #92

Changes

I've refactored the API to a dedicated component in another package behind an interface. We partly discussed this here.
I've refactored the Sparrow struct into a composition structure in order to improve code organization and clarity. This includes setting apart different responsibilities into checkCoordinator and errorHandler types.
I've removed functionalities and sections of code that were no longer needed.

(I also adjusted the docs of one dns metric that has changed)

Tests done

I've moved/refactored the unit tests for the API
I've added some more unit tests
[x] Unit tests suceeded.
[x] E2E tests succeeded.

TODO

[x] I've assigned this PR to myself
[x] I've labeled this PR correctly