darkatra / v-rising-discord-bot Goto Github PK

It should be possible to configure the bot to only allow ips from public ip ranges. Ranges in reserved networks should be prohibited, e.g. 10.0.0.0/8, 127.0.0.0/8, 192.168.0.0/16, 172.16.0.0/12 and 169.254.0.0/16 (maybe even more).

Useful:

• InetAddress#isLoopbackAddress()
• InetAddress#isLinkLocalAddress()
• InetAddress#isSiteLocalAddress()

The issue
One of the biggest drawbacks of this bot is its memory consumption. With the recent upgrade to Spring Boot 3 we could try to build a native image using GraalVM.

Proposed solution
Configure the spring-boot-maven-plugin so that it builds a native image via GraalVM. This would result in near instant startup times and lower memory consumption for the bot. It would also eliminate the need for a JVM.

Notes
I've already attempted to build a native image when Spring Boot 3 was released and it didn't work out of the box. The main issue back then was that kotlin coroutines didn't play nicely with native image, see: oracle/graal#5606. Also, the database is using jackson for serialization, e.g. runtime hints are required, see: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/aot/hint/annotation/RegisterReflectionForBinding.html

The pre release version 2.2.0-next.6 does not work with databases that were created by previous versions. It currently does not fail to start but no longer recognizes any existing database entries. This behaviour is unintended and should be fixed.

Documents in the old collection should be deleted during the migration from 2.1.x (or earlier) to 2.2.x. Right now the migration only moves existing documents to the new collection but it does not delete the old data afterwards.

In some cases the bot seems to fail to create the nitrite database.

Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'database' defined in class path resource [de/darkatra/vrising/discord/DatabaseConfiguration.class]: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.dizitart.no2.Nitrite]: Factory method 'database' threw exception; nested exception is java.lang.NullPointerException: builder()
            .c?perties.databasePassword) must not be null

Discord Post: https://discord.com/channels/993243434695540837/993243434695540839/1082189504837865492
See also: nitrite/nitrite-java#801

Is your feature request related to a problem? Please describe.
If a server has a lot of players online and the ServerStatusMonitor is configured to display the player list using ASCII tables, then the embed field exceeds the maximum size of 1024 characters and the bot is unable to update the embed anymore.

Describe the solution you'd like
The default display mode distributes the player list across multiple embed fields by building batches of 20. This could be an option for the ASCII table mode as well but might look ugly because the table header is printed separately for each batch.

This is a huge blocked for this feature and could mean that i'm not releasing it in the final 2.2.x release.

Context

• #80

Describe the solution you'd like
/get-server-details should also print the most recent error messages so that it's possible to get information on why the bot is failing to update a status message without access to the bot's logs. It should not log the whole stacktrace though.

Patch 0.5.42553:

• Replaced “Days Played” with “Days Running” in the Server Details.
• “Days Played” previously displayed the number of in-game days since server start, “Days Running” will now instead display the number of real-time days since server start.

Running docker 1.6.0 in unRaid 6.9.2
Initial setup works great, then ceases to update overnight.
Removing the game server and adding it again resolves the issue.

java.util.concurrent.CompletionException: java.util.concurrent.RejectedExecutionException
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger$RequestContext.completion(SourceQueryMessenger.java:368) ~[agql-source-query-1.0.5.jar:1.0.5]
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger$RequestContext.access$1000(SourceQueryMessenger.java:279) ~[agql-source-query-1.0.5.jar:1.0.5]
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger.lambda$send$1(SourceQueryMessenger.java:240) ~[agql-source-query-1.0.5.jar:1.0.5]
at java.base/java.util.concurrent.CompletableFuture.uniHandle(Unknown Source) ~[na:na]
at java.base/java.util.concurrent.CompletableFuture.uniHandleStage(Unknown Source) ~[na:na]
at java.base/java.util.concurrent.CompletableFuture.handle(Unknown Source) ~[na:na]
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger.send(SourceQueryMessenger.java:240) ~[agql-source-query-1.0.5.jar:1.0.5]
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger.send(SourceQueryMessenger.java:62) ~[agql-source-query-1.0.5.jar:1.0.5]
at com.ibasco.agql.core.AbstractClient.send(AbstractClient.java:111) ~[agql-lib-core-1.0.5.jar:1.0.5]
at com.ibasco.agql.core.AbstractClient.send(AbstractClient.java:87) ~[agql-lib-core-1.0.5.jar:1.0.5]
at com.ibasco.agql.protocols.valve.source.query.SourceQueryClient.getPlayers(SourceQueryClient.java:228) ~[agql-source-query-1.0.5.jar:1.0.5]
at de.darkatra.vrising.discord.ServerQueryClient.getPlayerList(ServerQueryClient.kt:39) ~[classes/:1.6.0]
at de.darkatra.vrising.discord.ServerStatusMonitorService$launchServerStatusMonitor$1.invokeSuspend(ServerStatusMonitorService.kt:80) ~[classes/:1.6.0]
at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33) ~[kotlin-stdlib-1.6.21.jar:1.6.21-release-334(1.6.21)]
at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:106) ~[kotlinx-coroutines-core-jvm-1.6.3.jar:na]
at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:570) ~[kotlinx-coroutines-core-jvm-1.6.3.jar:na]
at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:749) ~[kotlinx-coroutines-core-jvm-1.6.3.jar:na]
at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:677) ~[kotlinx-coroutines-core-jvm-1.6.3.jar:na]
at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:664) ~[kotlinx-coroutines-core-jvm-1.6.3.jar:na]
Caused by: java.util.concurrent.RejectedExecutionException: null
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger$RequestContext.execute(SourceQueryMessenger.java:303) ~[agql-source-query-1.0.5.jar:1.0.5]
at com.ibasco.agql.protocols.valve.source.query.SourceQueryMessenger.send(SourceQueryMessenger.java:239) ~[agql-source-query-1.0.5.jar:1.0.5]
... 12 common frames omitted

2022-07-07 07:21:05.038 ERROR 1 --- [atcher-worker-4] d.d.v.d.ServerStatusMonitorService : Exception while fetching the status of bdf8b1eb-fd61-11ec-a5b9-8518966c8d10

Is your feature request related to a problem? Please describe.
There is currently no way to list all status monitors for v rising servers across multiple discord servers.

Describe the solution you'd like
It should be possible to use the /list-servers command in DMs to the bot user. This is probably something that only the administrator of the bot should have access to, so the idea is to implement an allowlist for that specific DM command (via discord userId).

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update all non-major dependencies (aquasecurity/trivy-action, graalvm/setup-graalvm, maven, com.github.tomakehurst:wiremock, org.mockito.kotlin:mockito-kotlin, commons-validator:commons-validator, com.ibasco.agql:agql-source-query, dev.kord:kord-core-jvm, org.jetbrains.kotlin:kotlin-maven-allopen, org.jetbrains.kotlin:kotlin-maven-plugin, org.springframework.boot:spring-boot-starter-parent)
• fix(deps): update dependency com.fasterxml.uuid:java-uuid-generator to v5
• fix(deps): update dependency org.dizitart:potassium-nitrite to v4
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

It seems like the bot has a memory leak in both the jar and native version. It seems to be related to the logic performed in ServerStatusMonitorService#updateServerStatusMonitor as the memory goes up every time a server status monitor is updated. This leak causes the bot to exit after a few hours/days. When running in docker, it restarts automatically if restart: unless-stopped is set in the docker-compose file.

Until this issue is fixed, every user of the bot should limit the amount of memory the bot can allocate to around 512MB and ensure that the bot is restarted if it crashes.

Describe the solution you'd like
With the introduction of the v-rising-discord-bot-companion it is now possible to fetch additional data from a v rising server. This would allow us to add leaderboards that show, for example, the top 10 players based on their kill/death/assist ratio or by the number of vbloods they killed.

Is your feature request related to a problem? Please describe.
Now that the bot also has an option to display the gear level, clan name and amount of killed vbloods, the simple line based visualization in the discord embed reaches its limits.

Describe the solution you'd like
The bot should introduce an option to enable ascii based tables per ServerStatusMonitor. E.g. something like this:

+-----------------+------+
| Column name     | ID   |
+-----------------+------+
| some data0      | 0    |
| some data1      | 1    |
| some data2      | 4    |
| some data3      | 9    |
| some data4      | 16   |
+-----------------+------+

With patch 0.5.42405, the player's gear level is no longer displayed in the Steam server list and thus can no longer be queried.

See: https://store.steampowered.com/news/app/1604030/view/3320856891245612392

There should be an option to enable a PvP Killfeed in discord, like:

July 27, 2023 7:01 PM: Bobby (84) killed Atra (50)

Needs: DarkAtra/v-rising-discord-bot-companion#10

The screenshot of the discord embed in the readme files is quite outdated. It should be updated to reflect what the current version of the bot looking like.

See:

• https://youtrack.jetbrains.com/issue/KT-60211/Kotlin-1.9.0-kotlin.annotation.AnnotationTarget-was-unintentionally-initialized-at-build-time-GraalVM-nativeTest
• oracle/graal#6957

See: ribasco/async-gamequery-lib#106

Is your feature request related to a problem? Please describe.
It should be possible to display the domain name instead of an ip address in the discord embed.

We're currently displaying the query port instead of the game port in the status message on discord.

The bot does not validate that server-hostname is a valid ip or domain name at the moment. This leads to the following exception when the bot attempts to query data from the server: java.nio.channels.UnresolvedAddressException: null

Desired Solution: validation for server-hostname should ensure that an ip address (ipv4 and ipv6) or a domain name is provided and fail otherwise.

See: https://discord.com/channels/993243434695540837/993243434695540839/1082228757802274826

Describe the solution you'd like
It should be possible to display some information about a given server in the Bot's Status Message on Discord.

The native builds are currently failing on Github for some reason. I suspect a change in GraalVM. Local builds with "older" GraalVM versions work just fine.

Feature Request
It should be possible to send notifications in a discord channel whenever a player connects or disconnects from a server.

Preferred Solution
This could be implemented by remembering the previous server player response and creating a diff with the current one. Players that are no longer in the list disconnected. Players that weren't in the previous list but are in the current one joined recently.

It should be possible to enable player activity tracking on a per server basis using the /update-server command. It's probably also a good idea to ask for a different channel to post these logs to. This could be done by passing a discord channel-id to the /update-server command.

Known Limitations
This approach does not track player activity in real time and is limited by the bot.update-delay. By default server information is only fetched every 30 seconds. If a player connects and disconnects within these 30 seconds, no activity would be logged. This is acceptable.

v2.2.0-next.7 added support for displaying the clan and the number of slain vbloods per player. However, at the moment it is not possible to control which information should be displayed in the embed.

Example (which requires the v-rising-discord-bot-companion):

Feature Request

Make it possible to define which data should be displayed in the embed. E.g. if i only want to display the gear level of a player but not the clan name, that should be possible.

Solution

Introduce properties similar to display-server-description to control if gear-level, clan and slain-vbloods should be visible.