search

Appelpitje / MOHSH-Disord-Rich-Presence

Shows details about Medal Of Honor Spearhead which server and map you are playing in Discord Rich Presence
1 stars 0 forks source link

Sweep: improve performance issue #1

Closed Appelpitje closed 1 year ago

Appelpitje commented 1 year ago

Sweep: when running the application we notice a periodic hickup and makes the game lag, improve the code so we dont have the performance issue

sweep-ai[bot] commented 1 year ago

Here's the PR! https://github.com/Appelpitje/MOHSH-Disord-Rich-Presence/pull/3.

⚡ Sweep Free Trial: I used GPT-4 to create this ticket. You have 5 GPT-4 tickets left. For more GPT-4 tickets, visit our payment portal.To get Sweep to recreate this ticket, leave a comment prefixed with "sweep:" or edit the issue.

Step 1: 🔍 Code Search

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description. https://github.com/Appelpitje/MOHSH-Disord-Rich-Presence/blob/49a3c173fa9b44ce2ead356906384ba0d4302894/mohaaRichPresence.py#L1-L91 https://github.com/Appelpitje/MOHSH-Disord-Rich-Presence/blob/49a3c173fa9b44ce2ead356906384ba0d4302894/README.md#L1-L10

Step 2: 🧐 Snippet Analysis

From looking through the relevant snippets, I decided to make the following modifications:

File Path Proposed Changes
mohaaRichPresence.py - Modify the discordRP() function to reduce the frequency of the readMOHAA(), getServerDetails(), and RPC.update() calls. Instead of calling these functions every 15 seconds, we can call them every minute or so. This can be done by changing the time.sleep(15) call to time.sleep(60) or a suitable value.
- Add error handling for the win32gui calls in the readMOHAA() function. This can help to avoid performance issues caused by unhandled exceptions.
- Add error handling for the socket calls in the getServerDetails() function. This can help to avoid performance issues caused by unhandled exceptions.

Step 3: 📝 Planning

I have created a plan for writing the pull request. I am now working my plan and coding the required changes to address this issue. Here is the planned pull request:

Improve performance issue sweep/improve-performance-issue

Description

This PR aims to improve the performance issue reported in issue #1. The performance issue is caused by the frequent interactions with the game's console window and the game server. To address this, the following changes have been made:

  • Reduced the frequency of the readMOHAA() function calls in the discordRP() function from every 15 seconds to every minute.
  • Reduced the frequency of the getServerDetails() function calls in the discordRP() function from every 15 seconds to every minute.
  • Reduced the frequency of the RPC.update() calls in the discordRP() function from every 15 seconds to every minute.
  • Added error handling for the win32gui calls in the readMOHAA() function to avoid performance issues caused by unhandled exceptions.
  • Added error handling for the socket calls in the getServerDetails() function to avoid performance issues caused by unhandled exceptions.

These changes will help reduce the resource-intensive operations and improve the overall performance of the application.

Summary of Changes

  • Modified the discordRP() function to reduce the frequency of readMOHAA(), getServerDetails(), and RPC.update() calls.
  • Added error handling for win32gui calls in the readMOHAA() function.
  • Added error handling for socket calls in the getServerDetails() function.

Step 4: ⌨️ Coding

File Instructions Progress
mohaaRichPresence.py - Modify the discordRP() function to reduce the frequency of the readMOHAA(), getServerDetails(), and RPC.update() calls. Instead of calling these functions every 15 seconds, we can call them every minute or so. This can be done by changing the time.sleep(15) call to time.sleep(60) or a suitable value.
- Add error handling for the win32gui calls in the readMOHAA() function. This can help to avoid performance issues caused by unhandled exceptions.
- Add error handling for the socket calls in the getServerDetails() function. This can help to avoid performance issues caused by unhandled exceptions.		 ✅ Done with commit c3e09c9 I have finished coding the issue. I am now reviewing it for completeness.

Step 5: 🔁 Code Review

Here are the my self-reviews of my changes at sweep/improve-performance-issue.

Here is the 1st review

No changes required. The code changes made in the pull request are well implemented. The addition of try-except blocks for error handling is a good practice. Also, the change in sleep time from 15 seconds to 60 seconds is noted and does not introduce any errors. Good job!

I finished incorporating these changes.

To recreate the pull request, leave a comment prefixed with "sweep:" or edit the issue. Join Our Discord