From 4cb5d8ca7a6674c3dfbb7c2092e8e002f6a63c73 Mon Sep 17 00:00:00 2001
From: Michael Rittmeister <michael@rittmeister.in>
Date: Sat, 22 Jul 2023 11:50:26 +0200
Subject: [PATCH] Update Sponsorblock plugin - Update plugin name - Add support
 for YouTubeChapter events

---
 .idea/jarRepositories.xml                     |  5 ++
 build.gradle.kts                              |  3 +-
 .../lavakord/audio/internal/NodeImpl.kt       |  8 ++-
 .../audio/internal/WebsocketPlayer.kt         |  2 +-
 .../me/schlaubi/lavakord/example/Lavakord.kt  |  2 +-
 .../src/commonMain/kotlin/Plugin.kt           |  6 +-
 .../kotlin/model/DurationSerializer.kt        | 21 ++++++
 .../src/commonMain/kotlin/model/Events.kt     | 68 +++++++++++++++----
 8 files changed, 93 insertions(+), 22 deletions(-)
 create mode 100644 plugins/sponsorblock/src/commonMain/kotlin/model/DurationSerializer.kt

diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml
index 6cc0644b..dac78eef 100644
--- a/.idea/jarRepositories.xml
+++ b/.idea/jarRepositories.xml
@@ -71,5 +71,10 @@
       <option name="name" value="maven3" />
       <option name="url" value="https://maven.arbjerg.dev/snapshots" />
     </remote-repository>
+    <remote-repository>
+      <option name="id" value="maven3" />
+      <option name="name" value="maven3" />
+      <option name="url" value="https://maven.topi.wtf/snapshots" />
+    </remote-repository>
   </component>
 </project>
\ No newline at end of file
diff --git a/build.gradle.kts b/build.gradle.kts
index 76323666..ff06737d 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -8,13 +8,14 @@ plugins {
 }
 
 group = "dev.schlaubi.lavakord"
-version = "5.0.3"
+version = "5.1.0"
 
 allprojects {
     repositories {
         mavenCentral()
         maven("https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven")
         maven("https://oss.sonatype.org/content/repositories/snapshots")
+        maven("https://maven.topi.wtf/snapshots")
     }
 }
 
diff --git a/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/NodeImpl.kt b/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/NodeImpl.kt
index 5104d662..0afdf572 100644
--- a/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/NodeImpl.kt
+++ b/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/NodeImpl.kt
@@ -26,6 +26,7 @@ import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.SharedFlow
 import kotlinx.coroutines.flow.asSharedFlow
 import kotlinx.coroutines.launch
+import kotlinx.serialization.SerializationException
 import kotlinx.serialization.json.JsonElement
 import kotlinx.serialization.json.decodeFromJsonElement
 import kotlinx.serialization.json.jsonObject
@@ -164,7 +165,12 @@ internal class NodeImpl(
             eventPublisher.tryEmit(event)
             return
         }
-        when (val event = lavakord.json.decodeFromJsonElement<Message>(eventRaw)) {
+        val event = try {
+            lavakord.json.decodeFromJsonElement<Message>(eventRaw)
+        } catch (e: SerializationException) {
+            LOG.warn(e) {"Could not parse event"}
+        }
+        when (event) {
             is Message.PlayerUpdateEvent -> (lavakord.getLink(event.guildId).player as WebsocketPlayer).provideState(
                 event.state
             )
diff --git a/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/WebsocketPlayer.kt b/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/WebsocketPlayer.kt
index 18a8289a..52c481e4 100644
--- a/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/WebsocketPlayer.kt
+++ b/core/src/commonMain/kotlin/dev/schlaubi/lavakord/audio/internal/WebsocketPlayer.kt
@@ -86,7 +86,7 @@ internal class WebsocketPlayer(internal val node: NodeImpl, internal val guildId
         )
     }
 
-    private suspend fun handleNewTrack(event: TrackStartEvent) {
+    private fun handleNewTrack(event: TrackStartEvent) {
         updateTime = Clock.System.now()
         val track = event.track
         lastPosition = 0.milliseconds
diff --git a/example/src/main/kotlin/me/schlaubi/lavakord/example/Lavakord.kt b/example/src/main/kotlin/me/schlaubi/lavakord/example/Lavakord.kt
index 3bf62924..8246cdce 100644
--- a/example/src/main/kotlin/me/schlaubi/lavakord/example/Lavakord.kt
+++ b/example/src/main/kotlin/me/schlaubi/lavakord/example/Lavakord.kt
@@ -32,7 +32,7 @@ suspend fun main() {
         }
     }
 
-    lavalink.addNode("wss://3bc979254994.ngrok.app", "youshallnotpass")
+    lavalink.addNode("ws://localhost:2333", "youshallnotpass")
 
     kord.on<MessageCreateEvent> {
         val args = message.content.split(" ")
diff --git a/plugins/sponsorblock/src/commonMain/kotlin/Plugin.kt b/plugins/sponsorblock/src/commonMain/kotlin/Plugin.kt
index c66767ef..34de0065 100644
--- a/plugins/sponsorblock/src/commonMain/kotlin/Plugin.kt
+++ b/plugins/sponsorblock/src/commonMain/kotlin/Plugin.kt
@@ -18,12 +18,12 @@ import dev.schlaubi.lavakord.plugins.sponsorblock.model.Event as SponsorblockRes
  */
 public object Sponsorblock : Plugin {
     override val name: String
-        // Topi messed up :rolling_eyes:
-        get() = "lavasrc-plugin"
+        get() = "sponsorblock-plugin"
     override val version: String
         get() = "3.0.0-beta.1"
 
-    override val eventTypes: List<String> = listOf("SegmentsLoaded", "SegmentSkipped")
+    override val eventTypes: List<String> =
+        listOf("SegmentsLoaded", "SegmentSkipped", "ChaptersLoaded", "ChapterStarted")
 
     override fun JsonElement.decodeToEvent(): Event =
         Json.decodeFromJsonElement<SponsorblockRestEvent>(this)
diff --git a/plugins/sponsorblock/src/commonMain/kotlin/model/DurationSerializer.kt b/plugins/sponsorblock/src/commonMain/kotlin/model/DurationSerializer.kt
new file mode 100644
index 00000000..83963fc1
--- /dev/null
+++ b/plugins/sponsorblock/src/commonMain/kotlin/model/DurationSerializer.kt
@@ -0,0 +1,21 @@
+package dev.schlaubi.lavakord.plugins.sponsorblock.model
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import kotlin.time.Duration
+import kotlin.time.DurationUnit
+import kotlin.time.toDuration
+
+internal object DurationSerializer : KSerializer<Duration> {
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor(
+        "com.github.topi314.sponsorblock.plugin.protocol.serialization.DurationonAsMilliseconds", PrimitiveKind.LONG
+    )
+
+    override fun deserialize(decoder: Decoder): Duration = decoder.decodeLong().toDuration(DurationUnit.MILLISECONDS)
+
+    override fun serialize(encoder: Encoder, value: Duration): Unit = encoder.encodeLong(value.inWholeMilliseconds)
+}
diff --git a/plugins/sponsorblock/src/commonMain/kotlin/model/Events.kt b/plugins/sponsorblock/src/commonMain/kotlin/model/Events.kt
index ed52f468..77250f2c 100644
--- a/plugins/sponsorblock/src/commonMain/kotlin/model/Events.kt
+++ b/plugins/sponsorblock/src/commonMain/kotlin/model/Events.kt
@@ -5,8 +5,6 @@ import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.JsonClassDiscriminator
 import kotlin.time.Duration
-import kotlin.time.DurationUnit
-import kotlin.time.toDuration
 import dev.schlaubi.lavakord.plugins.sponsorblock.model.Event as LavakordEvent
 
 @JsonClassDiscriminator("type")
@@ -30,30 +28,53 @@ internal sealed interface Event : SponsorblockEvent {
         override val guildId: ULong,
         override val segment: SponsorblockSegment
     ) : LavakordEvent, SegmentSkippedEvent
+
+    @SerialName("ChaptersLoaded")
+    @Serializable
+    data class ChaptersLoaded(
+        override val op: String,
+        override val guildId: ULong,
+        override val chapters: List<YouTubeChapter>
+    ) : LavakordEvent, ChaptersLoadedEvent
+
+    @SerialName("ChapterStarted")
+    @Serializable
+    data class ChapterStarted(
+        override val op: String,
+        override val guildId: ULong,
+        override val chapter: YouTubeChapter
+    ) : LavakordEvent, ChapterStartedEvent
 }
 
 /**
  * Representation of a Sponsorblock segment.
  *
  * @property category the [Category] of this segment
- * @property startMs the milliseconds of the position where the segment started
- * @property endMs the milliseconds of the position where the segment ended
  * @property start the [position][Duration] where the segment started
  * @property end the [position][Duration] where the segment ended
  */
 @Serializable
 public data class SponsorblockSegment(
     val category: Category,
-    @SerialName("start")
-    val startMs: Int,
-    @SerialName("end")
-    val endMs: Int
-) {
-    public val start: Duration
-        get() = startMs.toDuration(DurationUnit.MILLISECONDS)
-    public val end: Duration
-        get() = endMs.toDuration(DurationUnit.MILLISECONDS)
-}
+    val start: @Serializable(with = DurationSerializer::class) Duration,
+    val end: @Serializable(with = DurationSerializer::class) Duration
+)
+
+/**
+ * Representation of a YouTube chapter.
+ *
+ * @property name the name of the chapter
+ * @property start the [position][Duration] where the chapter started
+ * @property end the [position][Duration] where the chapter ended
+ * @property duration the [Duration] of the chapter
+ */
+@Serializable
+public data class YouTubeChapter(
+    val name: String,
+    val start: @Serializable(with = DurationSerializer::class) Duration,
+    val end: @Serializable(with = DurationSerializer::class) Duration,
+    val duration: @Serializable(with = DurationSerializer::class) Duration
+)
 
 /**
  * Super class for all sponsor block events.
@@ -75,6 +96,23 @@ public interface SegmentsLoadedEvent : SponsorblockEvent {
  * @property segment the [segment][SponsorblockSegment] which was skipped
  */
 public interface SegmentSkippedEvent : SponsorblockEvent {
-
     public val segment: SponsorblockSegment
 }
+
+/**
+ * Event fired when the segments for a track were loaded.
+ *
+ * @property chapters the [chapters][YouTubeChapter] for this track.
+ */
+public interface ChaptersLoadedEvent : SponsorblockEvent {
+    public val chapters: List<YouTubeChapter>
+}
+
+/**
+ * Event fired when a chapter began.
+ *
+ * @property chapter the [chapter][YouTubeChapter] which started.
+ */
+public interface ChapterStartedEvent : SponsorblockEvent {
+    public val chapter: YouTubeChapter
+}