Json Parsing Optimizations #1267

schnapster · 2020-04-18T17:56:16Z

Pull Request Etiquette

I have checked the PRs for upcoming features/bug fixes.
I have read the contributing guidelines.

Changes

Internal code
Library interface (affecting end-user code)
Documentation
Other: _____

Description

I finally had some time to deep dive into some performance optimizations. The wins are not huge here, but still around a solid 5 % on a bot that has most intents turned off. I can imagine that number to look better the more events are received, as well as bot that have high REST requests (I did not do any).

This PR has 3 areas of improvement:
A. Uses the binary representation of websocket text messages
B. Avoid intermediate string representation of JSON payloads received on the websocket
C. Avoid intermediate string representation of JSON request bodies for rest actions

These are based on the official recommendations from Jackson, see https://github.com/FasterXML/jackson-docs/wiki/Presentation:-Jackson-Performance#basics-things-you-should-do-anyway

Test Environment

100 shards fully loaded
Enabled intents: GUILD_MESSAGES, DIRECT_MESSAGES, GUILD_MESSAGE_REACTIONS, GUILD_EMOJIS, GUILD_MEMBERS, GUILD_VOICE_STATES
No commands being executed

Unfortunately the measurements are not as clean as they could be, as I was in parallel working on performance improvements of my metrics. Nevertheless, I have a direct comparison of the most important changes (change B) of this PR to vanilla JDA v4.1.1_133:

Vanilla 4.1.1_133:

Including change A and change B:

schnapster · 2020-04-18T18:02:25Z

As mentioned, I was working on some improvements in my own code as well. In the end, I'm very happy with the result, but it is not that comparable to the other two measurements as I fixed a lot of JSON unrelated stuff as well.

Changes A, B and C + some other optimizations in my own code

MinnDevelopment

I'm a bit concerned about encoding. Do these methods properly use UTF-8 encoding regardless of runtime properties?

MinnDevelopment · 2020-04-19T13:12:31Z

src/main/java/net/dv8tion/jda/api/utils/data/DataArray.java

+        }
+        catch (IOException e)
+        {
+            throw new IllegalStateException(e);


I'd use UncheckedIOException instead even if it can't be thrown.

Just copied the toString() method from right below, no big thoughts went into this. I don't understand the structure and failure handling of JDA good enough to make an educated decision anyways, feel free to edit at will.

MinnDevelopment · 2020-04-19T13:13:39Z

src/main/java/net/dv8tion/jda/api/utils/data/DataObject.java

+        }
+        catch (IOException e)
+        {
+            throw new ParsingException(e);


Why did you use a different exception here?

Just copied the toString() method from right below, no big thoughts went into this. I don't understand the structure and failure handling of JDA good enough to make an educated decision anyways, feel free to edit at will.

schnapster · 2020-04-19T13:58:14Z

I'm a bit concerned about encoding. Do these methods properly use UTF-8 encoding regardless of runtime properties?

Should be fine, Jackson appears to be doing some autodetection with UTF-8 being the default. See issues like FasterXML/jackson-core#222

MinnDevelopment

Could you also do these changes for the AudioWebSocket?

schnapster · 2020-04-20T17:29:43Z

Done.

* Fix description for RestAction#flatMap * Remove invalid NSFW info * Fix bug in buffer allocation for ZlibDecompressor * Don't insert null into override cache * Keep a strong reference to user from members Fake members will use fake users that are not cached * Add functionality to set/get state of embed suppression (discord-jda#1117) * Add functionality to set/get state of embed suppression * Provide Enum for MessageFlags * Improve handling of events for unavailable guilds (discord-jda#1184) * Improve handling of events for unavailable guilds * Add UnavailableGuildLeaveEvent * Update docs for Guild#isAvailable * Improve ratelimit bucket handling (discord-jda#1103) * Let ChannelUpdateHandler add overrides to cache This is a bug since the override shouldn't be in the interface if the member is not actually in the cache. With the current implementation we have a cache inconsistency that could NPE. * Change handling of GuildDeleteHandler to avoid deadlock There really is no point in holding a write-lock here * Bump version * Add South Korea Region * Add getPermissionHolder method to PermissionOverride (discord-jda#1183) * Make ignored events for unavailable guilds a debug log * Add ErrorHandler utility class (discord-jda#1200) * Add ErrorHandler utility class * Improve logging of 429 warnings * Add clearReactions(String) (discord-jda#1192) * Add clearReactions(String) * Add MessageReactionRemoveEmoteEvent * Fix some outdated documentation * Log and rethrow errors in BotRateLimiter workers * Properly encode reaction emoji for clearReactionsById(...) * Updated all copyright headers for 2020 (discord-jda#1198) * Add (Guild) Invite Events (discord-jda#1196) Adds GuildInviteCreateEvent and GuildInviteDeleteEvent * Allow queued requests to finish * Support gateway intents and configurable member caching (discord-jda#1190) * First pass on member cache policy * Add INVALID_INTENTS to close code enum * Deprecate AccountType.CLIENT * Add Guild#unloadMembers * Update README with better examples * Improve handling of channel overrides * Add documentation for intents and member cache policy * Remove references to guild subscriptions * Add GuildMemberRemoveEvent * Improve retrieveMemberById and retrieveUserById * Changes to the builders, we use factory methods now :) * Disable presence cache by default * Add JDA#getGatewayIntents * Fix NPE for GUILD_UPDATE handling * Fix GuildChannel#createCopy for uncached members (discord-jda#1229) * Deprecate GuildUpdateBannerEvent#getNewBannerIdUrl (discord-jda#1217) * Allow to open private channel with user id (discord-jda#1224) * Change defaults for requester to be non-daemon and have a shorter timeout (discord-jda#1215) * Added Server Insights permission (discord-jda#1221) * Add RestAction#timeout and RestAction#deadline (discord-jda#1220) * Fix NPE in PermissionOverrideAction constructor * Fix another NPE in success handler * Documentation updates (discord-jda#1222) * Swapped manage server and manage channel in Invite#isExpanded docs (discord-jda#1210) * Document another possible null return case of Message#getMember (discord-jda#1204) * Fix EmbedBuilder constructor javadocs (discord-jda#1214) * Update example for jda-nas * Add more details to modifyMemberRoles docs * Fix typo * Added getGuildChannelById methods to ShardManager (discord-jda#1234) * Add better configuration methods to the builders (discord-jda#1240) * Update README * Add enableCache and disableCache * Add enableIntents and disableIntents * Update docs for events to mention required intents when necessary. * Deprecate the old setters for cache flags * Include voice server endpoint in connection failure logs * Initialize SelfUser for all shards before logging them in * Fix bug with new channel overrides having incorrect permissions * Add the close code to the disconnect warn * Adding a check in reaction methods before calling getTextChannel() (discord-jda#1216) * Add JDA#cancelRequests (discord-jda#1223) * Fix boost time not being handled in guild create * Add GuildVoiceStreamEvent * Fix IllegalStateException in Requester Closes discord-jda#1254 * Change reconnect code to 4900 to avoid confusion (discord-jda#1250) * Change reconnect code to 4900 to avoid confusion * And update the disconnect handling to better log things * Make resume reconnect log on debug * Log server error on error level * Add catch in gateway worker * Add Guild#getMaxFileSize and Guild.BoostTier#getMaxFileSize (discord-jda#1244) Fixes discord-jda#1243 * Add fallback operators onErrorMap and onErrorFlatMap to RestAction (discord-jda#1219) * Fix incorrect file size check * Documentation updates (discord-jda#1241) * Add note about presence update and member intents * Fix typo in readme * Add MessageChannel#retrieveReactionUsersById and update reaction related docs (discord-jda#1236) * Add requirements section to member/user events * Json Parsing Optimizations (discord-jda#1267) * Remove initial reconnect delay for resumes * Add prune overload to disable wait parameter * Add Guild#retrieveMetaData (discord-jda#1171) * Lazy load member limits for guilds * Improve implementation of update handler * Add Guild#retrieveMetaData * Add check for heartbeats in WebSocketClient (discord-jda#1282) * Add retrieveMembersByPrefix (discord-jda#1276) * Add retrieveMemberByPrefix * Add event pool configuration * Fix javadoc errors * Rename chunkSyncQueue -> chunkQueue * Create file if it doesn't exist in downloadToFile * Add members to cache from retrieveMember methods * Improve handling of join times for members * Add Message.JUMP_URL_PATTERN * Replace disconnect handling to recover from strange thread states (discord-jda#1295) * Shutdown the WebSocket connection after everything else * Use executor to shutdown in DefaultShardManager * Add methods to bulk retrieve members (discord-jda#1292) * Add methods to bulk retrieve members * Add documentation * Add missing annotations to Task interface * Use random number as nonce * Improvements to handling of Error (discord-jda#1285) * Remove usage of AssertionError * Improve handling of Errors * Change domain to discord.com (discord-jda#1288) * Fix NPE in ChannelManager#sync * Add User#getFlags (discord-jda#1271) * Add Emote#isAvailable() method Co-authored-by: Florian Spieß <business@minnced.club> Co-authored-by: Michael Ritter <ritter.michael92@gmail.com> Co-authored-by: horyu1234 <horyu1234@naver.com> Co-authored-by: DMan <DManstrator@users.noreply.github.com> Co-authored-by: Austin Keener <keeneraustin@yahoo.com> Co-authored-by: averen <31487840+averen@users.noreply.github.com> Co-authored-by: Mathéo CIMBARO <25774021+DiscowZombie@users.noreply.github.com> Co-authored-by: Artuto <artutogamer@gmail.com> Co-authored-by: Nik <nik@monsterlyrics.co> Co-authored-by: Sebo Molnár <git@mlnr.dev> Co-authored-by: gpluscb <20143778+gpluscb@users.noreply.github.com> Co-authored-by: Napster <napster@npstr.space>

schnapster added 3 commits April 18, 2020 15:54

Enable direct text messages

b71d6bf

Avoid intermediate string parsing of json payloads

65c9281

Avoid intermediate string parsing of json request bodies

99d9a35

MinnDevelopment added size: small type: enhancement labels Apr 18, 2020

MinnDevelopment added this to the v4.2.0 milestone Apr 18, 2020

MinnDevelopment self-requested a review April 18, 2020 18:12

MinnDevelopment reviewed Apr 19, 2020

View reviewed changes

MinnDevelopment added 2 commits April 19, 2020 16:10

Update DataObject.java

8e2ac5b

Update DataArray.java

f103c63

MinnDevelopment reviewed Apr 20, 2020

View reviewed changes

Enable direct text messages in audio web socket

159af48

Move enabling direct messages out of synchronization

e2bab3f

MinnDevelopment self-requested a review April 21, 2020 11:29

MinnDevelopment approved these changes Apr 25, 2020

View reviewed changes

MinnDevelopment merged commit b38ff20 into discord-jda:development Apr 25, 2020

schnapster deleted the json-parsing-optimization branch April 25, 2020 18:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Json Parsing Optimizations #1267

Json Parsing Optimizations #1267

schnapster commented Apr 18, 2020 •

edited

Loading

schnapster commented Apr 18, 2020 •

edited

Loading

MinnDevelopment left a comment

MinnDevelopment Apr 19, 2020

schnapster Apr 19, 2020

MinnDevelopment Apr 19, 2020

schnapster Apr 19, 2020

schnapster commented Apr 19, 2020

MinnDevelopment left a comment

schnapster commented Apr 20, 2020

Json Parsing Optimizations #1267

Json Parsing Optimizations #1267

Conversation

schnapster commented Apr 18, 2020 • edited Loading

Pull Request Etiquette

Changes

Description

Test Environment

schnapster commented Apr 18, 2020 • edited Loading

MinnDevelopment left a comment

Choose a reason for hiding this comment

MinnDevelopment Apr 19, 2020

Choose a reason for hiding this comment

schnapster Apr 19, 2020

Choose a reason for hiding this comment

MinnDevelopment Apr 19, 2020

Choose a reason for hiding this comment

schnapster Apr 19, 2020

Choose a reason for hiding this comment

schnapster commented Apr 19, 2020

MinnDevelopment left a comment

Choose a reason for hiding this comment

schnapster commented Apr 20, 2020

schnapster commented Apr 18, 2020 •

edited

Loading

schnapster commented Apr 18, 2020 •

edited

Loading