[CHORE] refactor telemetry code

remove unneeded telemetry::Sink
rename IDs file to Registry (easy to understand)

Author: nots1dd

CMakeLists.txt

@@ -213,10 +213,9 @@ set(INLIMBO_CORE_SOURCES
     src/taglib/source/MP3.cc
     src/taglib/source/FLAC.cc
     src/mpris/Service.cc
-    src/telemetry/Sink.cc
     src/telemetry/Analysis.cc
     src/telemetry/Store.cc
-    src/telemetry/IDs.cc
+    src/telemetry/Registry.cc
     src/query/SongMap.cc
     src/query/sort/Engine.cc
     src/query/sort/Stats.cc

include/inlimbo/telemetry/Context.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "IDs.hpp"
+#include "Registry.hpp"
 #include "Store.hpp"
 
 namespace telemetry

include/inlimbo/telemetry/Event.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "IDs.hpp"
+#include "Registry.hpp"
 #include <cereal/types/vector.hpp>
 
 namespace telemetry

include/inlimbo/telemetry/IDs.hpp include/inlimbo/telemetry/Registry.hppinclude/inlimbo/telemetry/IDs.hpp renamed to include/inlimbo/telemetry/Registry.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "IDs.hpp"
+#include "Registry.hpp"
 
 namespace telemetry
 {

include/inlimbo/telemetry/Sink.hpp

@@ -11,6 +11,13 @@
 namespace telemetry
 {
 
+/// a generic map that corresponds to T -> key && Stats -> value
+///
+/// ex: StatsMap<SongID> -> for each song id we have a corresponding stat struct
+/// describing about the song (like no of plays, total playtime, last played, etc.)
+template <typename T>
+using StatsMap = ankerl::unordered_dense::map<T, Stats>;
+
 class Store
 {
 public:
@@ -27,10 +34,10 @@ class Store
   [[nodiscard]] auto album(AlbumID id) const -> const Stats*;
   [[nodiscard]] auto genre(GenreID id) const -> const Stats*;
 
-  [[nodiscard]] auto songs() const -> const ankerl::unordered_dense::map<SongID, Stats>&;
-  [[nodiscard]] auto artists() const -> const ankerl::unordered_dense::map<ArtistID, Stats>&;
-  [[nodiscard]] auto albums() const -> const ankerl::unordered_dense::map<AlbumID, Stats>&;
-  [[nodiscard]] auto genres() const -> const ankerl::unordered_dense::map<GenreID, Stats>&;
+  [[nodiscard]] auto songs() const -> const StatsMap<SongID>&;
+  [[nodiscard]] auto artists() const -> const StatsMap<ArtistID>&;
+  [[nodiscard]] auto albums() const -> const StatsMap<AlbumID>&;
+  [[nodiscard]] auto genres() const -> const StatsMap<GenreID>&;
 
   // Disk API
   [[nodiscard]] auto save(const std::string& path) const -> bool;
@@ -45,10 +52,10 @@ class Store
   std::vector<Event> events;
   double             minPlaySec = 30.0;
 
-  ankerl::unordered_dense::map<SongID, Stats>   songStats;
-  ankerl::unordered_dense::map<ArtistID, Stats> artistStats;
-  ankerl::unordered_dense::map<AlbumID, Stats>  albumStats;
-  ankerl::unordered_dense::map<GenreID, Stats>  genreStats;
+  StatsMap<SongID>   songStats;
+  StatsMap<ArtistID> artistStats;
+  StatsMap<AlbumID>  albumStats;
+  StatsMap<GenreID>  genreStats;
 
   static auto find(const auto& map, auto id) -> const Stats*;
 

include/inlimbo/telemetry/Stats.hpp

@@ -8,6 +8,15 @@
 namespace utils::string
 {
 
+/// a generic class that is meant to contain a ID, STRING relation
+///
+/// ex: id1 --- "hi", id2 --- "hello", etc.
+///
+/// class ensures that the relation is completely retrievable via
+/// 2 relation maps (id -> str) and (str -> id) for lookups.
+///
+/// there could be more memory efficient way to store this, but
+/// this works for now.
 template <typename ID>
 class StringTable
 {

include/inlimbo/telemetry/Store.hpp

@@ -1,4 +1,4 @@
-#include "telemetry/IDs.hpp"
+#include "telemetry/Registry.hpp"
 #include <cereal/archives/binary.hpp>
 #include <cereal/types/vector.hpp>
 #include <fstream>