Skip to content

Add structures to support hot restarting #232

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

Jump to bottom
Draft
wants to merge 31 commits into
base: 3.X
Choose a base branch
from
Draft

Add structures to support hot restarting #232

wants to merge 31 commits into from

Conversation

freya022
Copy link
Owner

@freya022 freya022 commented May 31, 2025 •
edited
Loading

Depends on freya022/BotCommands-Restarter#1

Deprecations

  • Deprecated BotCommands#create(<configuration block>)
    • Added an overload accepting the arguments of the main method
  • Deprecated JDAConfiguration.DevTools
    • Replaced with shutdownTimeout in BConfig, which applies to the entire framework's shutdown

New Features

  • Added BContext#shutdown
  • Added BContext#shutdownNow
  • Added BContext#awaitShutdown
  • Added SHUTTING_DOWN and SHUTDOWN in BContext.Status
  • Added BConfig#enableShutdownHook
  • Added BConfig#shutdownTimeout
  • Added BConfig#args
    • Not directly configurable, passed in the entry point or retrieved from Spring
  • Added BRestartConfig
  • Added BShutdownEvent
  • Added ApplicationStartListener
    • Will most likely be only used by the restarter module

Changes

  • Made internal coroutine dispatchers use daemon threads
    • So the JVM can exit if the bot is shut down (assuming the user does not create more non-daemon threads)
  • Moved RequiresDefaultInjection to the API
  • Added isDaemon to namedDefaultScope, defaults to false (compatible)

To do

  • Don't activate outside of development environments
  • Fix trying to access JDA from a closed Spring ApplicationContext on shutdown
  • Have the JDA cache not have a bajillion gotchas
  • Docs
  • Fix resource leaks, if any (threads, classes referencing old restart class loaders)
  • Fix all TODOs

freya022 added 19 commits May 24, 2025 15:39
@freya022
Add configs
194ddab
@freya022
Start adding hot reloading
2b6b2ee
@freya022
Listen to file changes using the NIO WatchService
3f57cff
@freya022
Move path walkers to a util file
56c7a69
@freya022
Start adding restart listeners, refactor
c7eb5d3
@freya022
Rename SpringJDARestartListener to SpringJDAShutdownHandler
3a6f956
@freya022
Moved restarter to module, daemon internal coroutine dispatchers
f379efd
@freya022
notes
78236ad
@freya022
Move RequiresDefaultInjection to API
1df8f4c
@freya022
Update names
1b4c49b
@freya022
Move main args to BConfig through entry point, leave feature enabled
3d87a88 
As it requires adding a dependency
@freya022
Use service-loaded configurer to override ClassGraph's class loader
8c276e7
@freya022
Set restarter dependency's scope to test
63669b5
@freya022
Remove restart test files
1c0d5a6
@freya022
Remove try/catch in test file
c93b35d 
So it doesn't catch the (expected) restart exception
@freya022
Remove BConfig#beforeStart
27e8163
@freya022
tests: Add back stacktrace-decoroutinator
ff7d92d 
Maybe it works with the restarter, who knows
@freya022
Add notes
7f287c0
@freya022
Fix name of JDAConfiguration.shutdownTimeout replacement property
9761cfe
@freya022 freya022 added this to the v3.0 milestone May 31, 2025
@freya022 freya022 added type: feature V3 Targets BotCommands 3.x.x type: experimental Might not make it into a release labels May 31, 2025
freya022 added 7 commits May 31, 2025 19:49
@freya022
Disable local Restarter build
80c4a99 
So Jitpack can build it
@freya022
Add BRestartConfig#cacheKey
ca747b5
@freya022
Add BContext#restartConfig
0ba3344
@freya022
Shutdown the bot immediately after receiving a ContextClosedEvent
d2013d3
@freya022
Remove ClassGraphConfigurer
81271d3 
Will instead make a PR to ClassGraph,
overriding class loaders isn't enough
@freya022
Don't set a shutdown hook when using Spring
c123c8c 
As it has its own hook already
@freya022
Shutdown executors after all shards are shut down
41b8109 
Fixes awaiting termination always waiting until the deadline
freya022 added 5 commits June 5, 2025 23:15
@freya022
Replace Duration.INFINITE by ZERO when awaiting JDA termination
a567d3e
@freya022
Check for any JDA status beyond CONNECTING_TO_WEBSOCKET
7b23461 
This is required for the JDA restart cache module,
as it will fire the READY status directly
@freya022
Use an impossible deadline when the timeout is negative or infinite
b3133de
@freya022
Don't use shutdown() in shutdownNow()
ba842f2 
Calling scheduleShutdownSignal more than once is not great
@freya022
Run BotOwnersImpl#onInjectedJDA async
9366ee3 
So it doesn't block the main thread unnecessarily,
getting the owners will block until the value is set anyway
@freya022 freya022 mentioned this pull request Jun 6, 2025
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
type: experimental Might not make it into a release type: feature V3 Targets BotCommands 3.x.x
Projects
None yet
Milestone
v3.0
Development

Successfully merging this pull request may close these issues.
1 participant
@freya022