Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add possibility to define Job parent to create live entities #304

Merged
merged 7 commits into from
Jun 13, 2021
Merged

feat: Add possibility to define Job parent to create live entities #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9036fda
feat: Add possibility to define Job parent to create live entities
Distractic May 27, 2021
935c891
fix: Use CoroutineScope to define parent
Distractic May 27, 2021
ad3091b
feat: Allows to set CoroutineScope for each method 'on'
Distractic May 27, 2021
9a068ae
feat: Set coroutineScope into constructor of Live entities
Distractic May 28, 2021
2534b6a
Reload Github workflow
Distractic May 28, 2021
0020147
fix: Use kord.coroutineContext to build default CoroutineScope for li…
Distractic Jun 4, 2021
63dac11
Merge branch 'live-entity-life-cycle' into feat/live_parent
Distractic Jun 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 66 additions & 38 deletions core/src/main/kotlin/live/LiveGuild.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,125 +18,153 @@ import dev.kord.core.event.role.RoleUpdateEvent
import dev.kord.core.event.user.PresenceUpdateEvent
import dev.kord.core.event.user.VoiceStateUpdateEvent
import dev.kord.core.live.exception.LiveCancellationException
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.*

@KordPreview
fun Guild.live(dispatcher: CoroutineDispatcher = Dispatchers.Default): LiveGuild =
LiveGuild(this, dispatcher)
fun Guild.live(
coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)
): LiveGuild = LiveGuild(this, coroutineScope)

@KordPreview
inline fun Guild.live(dispatcher: CoroutineDispatcher = Dispatchers.Default, block: LiveGuild.() -> Unit) =
this.live(dispatcher).apply(block)
inline fun Guild.live(
coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job),
block: LiveGuild.() -> Unit
) = this.live(coroutineScope).apply(block)

@KordPreview
fun LiveGuild.onEmojisUpdate(block: suspend (EmojisUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onEmojisUpdate(scope: CoroutineScope = this, block: suspend (EmojisUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onIntegrationsUpdate(block: suspend (IntegrationsUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onIntegrationsUpdate(scope: CoroutineScope = this, block: suspend (IntegrationsUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onBanAdd(block: suspend (BanAddEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onBanAdd(scope: CoroutineScope = this, block: suspend (BanAddEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onBanRemove(block: suspend (BanRemoveEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onBanRemove(scope: CoroutineScope = this, block: suspend (BanRemoveEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onPresenceUpdate(block: suspend (PresenceUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onPresenceUpdate(scope: CoroutineScope = this, block: suspend (PresenceUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onVoiceServerUpdate(block: suspend (VoiceServerUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onVoiceServerUpdate(scope: CoroutineScope = this, block: suspend (VoiceServerUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onVoiceStateUpdate(block: suspend (VoiceStateUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onVoiceStateUpdate(scope: CoroutineScope = this, block: suspend (VoiceStateUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onWebhookUpdate(block: suspend (WebhookUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onWebhookUpdate(scope: CoroutineScope = this, block: suspend (WebhookUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onRoleCreate(block: suspend (RoleCreateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onRoleCreate(scope: CoroutineScope = this, block: suspend (RoleCreateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onRoleUpdate(block: suspend (RoleUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onRoleUpdate(scope: CoroutineScope = this, block: suspend (RoleUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onRoleDelete(block: suspend (RoleDeleteEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onRoleDelete(scope: CoroutineScope = this, block: suspend (RoleDeleteEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onMemberJoin(block: suspend (MemberJoinEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onMemberJoin(scope: CoroutineScope = this, block: suspend (MemberJoinEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onMemberUpdate(block: suspend (MemberUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onMemberUpdate(scope: CoroutineScope = this, block: suspend (MemberUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onMemberLeave(block: suspend (MemberLeaveEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onMemberLeave(scope: CoroutineScope = this, block: suspend (MemberLeaveEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onReactionAdd(block: suspend (ReactionAddEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onReactionAdd(scope: CoroutineScope = this, block: suspend (ReactionAddEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
inline fun LiveGuild.onReactionAdd(
reaction: ReactionEmoji,
crossinline block: suspend (ReactionAddEvent) -> Unit
) = on<ReactionAddEvent> {
scope: CoroutineScope = this, crossinline block: suspend (ReactionAddEvent) -> Unit
) = on<ReactionAddEvent>(scope) {
if (it.emoji == reaction) {
block(it)
}
}

@KordPreview
fun LiveGuild.onReactionRemove(block: suspend (ReactionRemoveEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onReactionRemove(scope: CoroutineScope = this, block: suspend (ReactionRemoveEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
inline fun LiveGuild.onReactionRemove(
reaction: ReactionEmoji,
crossinline block: suspend (ReactionRemoveEvent) -> Unit
) = on<ReactionRemoveEvent> {
scope: CoroutineScope = this, crossinline block: suspend (ReactionRemoveEvent) -> Unit
) = on<ReactionRemoveEvent>(scope) {
if (it.emoji == reaction) {
block(it)
}
}

@KordPreview
fun LiveGuild.onReactionRemoveAll(block: suspend (ReactionRemoveAllEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onReactionRemoveAll(scope: CoroutineScope = this, block: suspend (ReactionRemoveAllEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onMessageCreate(block: suspend (MessageCreateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onMessageCreate(scope: CoroutineScope = this, block: suspend (MessageCreateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onMessageUpdate(block: suspend (MessageUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onMessageUpdate(scope: CoroutineScope = this, block: suspend (MessageUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onMessageDelete(block: suspend (MessageDeleteEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onMessageDelete(scope: CoroutineScope = this, block: suspend (MessageDeleteEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onChannelCreate(block: suspend (ChannelCreateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onChannelCreate(scope: CoroutineScope = this, block: suspend (ChannelCreateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onChannelUpdate(block: suspend (ChannelUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onChannelUpdate(scope: CoroutineScope = this, block: suspend (ChannelUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onChannelDelete(block: suspend (ChannelDeleteEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onChannelDelete(scope: CoroutineScope = this, block: suspend (ChannelDeleteEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onGuildCreate(block: suspend (GuildCreateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onGuildCreate(scope: CoroutineScope = this, block: suspend (GuildCreateEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveGuild.onGuildUpdate(block: suspend (GuildUpdateEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onGuildUpdate(scope: CoroutineScope = this, block: suspend (GuildUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@Deprecated(
"The block is not called when the entity is deleted because the live entity is shut down",
ReplaceWith("coroutineContext.job.invokeOnCompletion(block)", "kotlinx.coroutines.job"),
DeprecationLevel.ERROR
)
@KordPreview
fun LiveGuild.onGuildDelete(block: suspend (GuildDeleteEvent) -> Unit) = on(consumer = block)
fun LiveGuild.onGuildDelete(scope: CoroutineScope = this, block: suspend (GuildDeleteEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
class LiveGuild(
guild: Guild,
dispatcher: CoroutineDispatcher = Dispatchers.Default
) : AbstractLiveKordEntity(guild.kord, dispatcher), KordEntity {
coroutineScope: CoroutineScope = guild.kord + SupervisorJob(guild.kord.coroutineContext.job)
) : AbstractLiveKordEntity(guild.kord, coroutineScope), KordEntity {

override val id: Snowflake
get() = guild.id
Expand Down
11 changes: 6 additions & 5 deletions core/src/main/kotlin/live/LiveKordEntity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ interface LiveKordEntity : KordEntity, CoroutineScope {
}

@KordPreview
abstract class AbstractLiveKordEntity(final override val kord: Kord, dispatcher: CoroutineDispatcher) : LiveKordEntity {

override val coroutineContext: CoroutineContext = dispatcher + SupervisorJob(kord.coroutineContext.job)
abstract class AbstractLiveKordEntity(
override val kord: Kord,
coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)
) : LiveKordEntity, CoroutineScope by coroutineScope {

@Suppress("EXPERIMENTAL_API_USAGE")
final override val events: SharedFlow<Event> =
Expand All @@ -45,7 +46,7 @@ abstract class AbstractLiveKordEntity(final override val kord: Kord, dispatcher:
* or [Kord] by default and will not propagate any exceptions.
*/
@KordPreview
inline fun <reified T : Event> LiveKordEntity.on(noinline consumer: suspend (T) -> Unit) =
inline fun <reified T : Event> LiveKordEntity.on(scope: CoroutineScope = this, noinline consumer: suspend (T) -> Unit) =
events.buffer(Channel.UNLIMITED).filterIsInstance<T>().onEach {
runCatching { consumer(it) }.onFailure { kordLogger.catching(it) }
}.catch { kordLogger.catching(it) }.launchIn(this)
}.catch { kordLogger.catching(it) }.launchIn(scope)
38 changes: 23 additions & 15 deletions core/src/main/kotlin/live/LiveMember.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,60 +11,68 @@ import dev.kord.core.event.guild.MemberLeaveEvent
import dev.kord.core.event.guild.MemberUpdateEvent
import dev.kord.core.live.channel.LiveGuildChannel
import dev.kord.core.live.exception.LiveCancellationException
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.*

@KordPreview
fun Member.live(dispatcher: CoroutineDispatcher = Dispatchers.Default) = LiveMember(this, dispatcher)
fun Member.live(
coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)
) = LiveMember(this, coroutineScope)

@KordPreview
inline fun Member.live(dispatcher: CoroutineDispatcher = Dispatchers.Default, block: LiveMember.() -> Unit) =
this.live(dispatcher).apply(block)
inline fun Member.live(
coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job),
block: LiveMember.() -> Unit
) = this.live(coroutineScope).apply(block)

@Deprecated(
"The block is not called when the entity is deleted because the live entity is shut down",
ReplaceWith("coroutineContext.job.invokeOnCompletion(block)", "kotlinx.coroutines.job"),
DeprecationLevel.ERROR
)
@KordPreview
fun LiveMember.onLeave(block: suspend (MemberLeaveEvent) -> Unit) = on(consumer = block)
fun LiveMember.onLeave(scope: CoroutineScope = this, block: suspend (MemberLeaveEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
fun LiveMember.onUpdate(block: suspend (MemberUpdateEvent) -> Unit) = on(consumer = block)
fun LiveMember.onUpdate(scope: CoroutineScope = this, block: suspend (MemberUpdateEvent) -> Unit) =
on(scope = scope, consumer = block)

@Deprecated(
"The block is not called when the entity is deleted because the live entity is shut down",
ReplaceWith("coroutineContext.job.invokeOnCompletion(block)", "kotlinx.coroutines.job"),
DeprecationLevel.ERROR
)
@KordPreview
fun LiveMember.onBanAdd(block: suspend (BanAddEvent) -> Unit) = on(consumer = block)
fun LiveMember.onBanAdd(scope: CoroutineScope = this, block: suspend (BanAddEvent) -> Unit) =
on(scope = scope, consumer = block)

@Deprecated(
"The block is not called when the live entity is shut down",
ReplaceWith("coroutineContext.job.invokeOnCompletion(block)", "kotlinx.coroutines.job"),
DeprecationLevel.ERROR
)
@KordPreview
inline fun LiveGuildChannel.onShutdown(crossinline block: suspend (Event) -> Unit) = on<Event> {
if (it is MemberLeaveEvent || it is BanAddEvent || it is GuildDeleteEvent) {
block(it)
inline fun LiveGuildChannel.onShutdown(scope: CoroutineScope = this, crossinline block: suspend (Event) -> Unit) =
on<Event>(scope) {
if (it is MemberLeaveEvent || it is BanAddEvent || it is GuildDeleteEvent) {
block(it)
}
}
}

@Deprecated(
"The block is not called when the entity is deleted because the live entity is shut down",
ReplaceWith("coroutineContext.job.invokeOnCompletion(block)", "kotlinx.coroutines.job"),
DeprecationLevel.ERROR
)
@KordPreview
fun LiveGuildChannel.onGuildDelete(block: suspend (GuildDeleteEvent) -> Unit) = on(consumer = block)
fun LiveGuildChannel.onGuildDelete(scope: CoroutineScope = this, block: suspend (GuildDeleteEvent) -> Unit) =
on(scope = scope, consumer = block)

@KordPreview
class LiveMember(
member: Member,
dispatcher: CoroutineDispatcher = Dispatchers.Default
) : AbstractLiveKordEntity(member.kord, dispatcher), KordEntity {
coroutineScope: CoroutineScope = member.kord + SupervisorJob(member.kord.coroutineContext.job)
) : AbstractLiveKordEntity(member.kord, coroutineScope), KordEntity {

override val id: Snowflake
get() = member.id
Expand Down
Loading