Split to a Grafana Service

KeesCBakker commented 3 months ago

Partially fixes #177 in which we do a refactor to:

┌────────────────────────────┐   ┌────────────────────────┐    ┌────────────────────────┐ 
│ BOT                        │   │ ADAPTER                │    │ CUSTOM RESPONDER       │ 
│                            │   │                        │    │                        │ 
│ handles request from Hubot ├───► respond to a specific  ├────► influence the way the  │ 
│ responsible for response   │   │ chat platform          │    │ response is written    │ 
│ formatting                 │   │                        │    │                        │ 
└──────────────┬─────────────┘   └────────────────────────┘    └────────────────────────┘ 
               │                                                                          
┌──────────────▼─────────────┐                                                            
│ SERVICE                    │                                                            
│                            │                                                            
│ business rules for         │                                                            
│ querying of dashboards     │                                                            
└──────────────┬─────────────┘                                                            
               │                                                                          
┌──────────────▼─────────────┐                                                            
│  CLIENT                    │                                                            
│                            │                                                            
│  interaction with the      │                                                            
│  Grafana API over HTTP     │                                                            
└────────────────────────────┘

So in this PR we are doing the following:

Combining Adapter, GrafanaService and the GrafanaClient into a Bot class. This makes it a bit easier to interact with the package and not having to build your own class. I could not get the new Bot class to handle all the Hubot requests.
Improved failing test speeds. Tests should be finished withing 100ms. This was 2000ms, causing failing tests to run way too long for refactoring. Also: --forbid-only --forbid-pending when doing a commit or push, so we fail when we try to commit a mocka.only.
Improved test coverage by adding tests for pausing and unpausing all alerts.
The GrafanaService has all the business rules. One could use them without the bot (to collect multiple dashboards before sending them on).
Added some types to types.d.ts so JSDoc understands what we're doing.
With set setResponder it is easier for users to influence the way the dashboard is formatted (so we don't need to use middleware like https://keestalkstech.com/2023/08/improving-responsiveness-of-hubot-grafana/#putting-it-all-together anymore.

KeesCBakker commented 3 months ago

Interesting coverage. We might need to add some extra tests.

KeesCBakker commented 3 months ago

"It's not easy being green!" 😁

KeesCBakker commented 3 months ago

Will test it on a live Hubot today. Have a great new feature I want to add to our bot, so at the end of the day we'll know.

KeesCBakker commented 3 months ago

Did some testing and some further refactoring. All my tests with a live Hubot were also OK.

@stephenyeargin, we can merge if you don't see anything crazy.

stephenyeargin commented 3 months ago

Looks good to me, I'll let you do the honors. I see you're sneaking it a bit of TypeScript. 😉

KeesCBakker commented 3 months ago

Looks good to me, I'll let you do the honors. I see you're sneaking it a bit of TypeScript. 😉

Hahaha. Yeah the d.ts files work great together with JS Docs.

stephenyeargin / hubot-grafana

Split to a Grafana Service #180