Sweep: Refactor script.js for better visibility control of login/register buttons

Here's the PR! https://github.com/SomethingGeneric/bookmark-sync/pull/30.

⚡ Sweep Free Trial: I used GPT-3.5 to create this ticket. You have 3 GPT-4 tickets left for the month and 0 for the day. For more GPT-4 tickets, visit our payment portal. To retrigger Sweep, 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/SomethingGeneric/bookmark-sync/blob/22c15a96278f8ab89b295f2cda6fef0b522691aa/extension/script.js#L1-L145 https://github.com/SomethingGeneric/bookmark-sync/blob/22c15a96278f8ab89b295f2cda6fef0b522691aa/LICENSE#L1-L20 https://github.com/SomethingGeneric/bookmark-sync/blob/22c15a96278f8ab89b295f2cda6fef0b522691aa/TODO.md#L1-L3 https://github.com/SomethingGeneric/bookmark-sync/blob/22c15a96278f8ab89b295f2cda6fef0b522691aa/README.md#L1-L1 https://github.com/SomethingGeneric/bookmark-sync/blob/22c15a96278f8ab89b295f2cda6fef0b522691aa/docker-compose.yml#L1-L6

Step 2: 🧐 Snippet Analysis

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

File Path Proposed Changes

extension/script.js Modify extension/script.js with contents:
• Create a function named checkSessionStatus that checks if a session exists. This function should return a boolean value indicating whether a session exists or not. Use the existing code in the checkSessionStatus function as a starting point, but modify it to return a boolean value instead of resolving a promise.
• Create a function named updateButtonVisibility that takes a boolean argument sessionExists. This function should call hideElement for the "signinbutton" and "registerbutton" if sessionExists is true, and showElement for these buttons if sessionExists is false.
• Replace the existing calls to hideElement and showElement for the "signinbutton" and "registerbutton" with calls to updateButtonVisibility. Pass the result of checkSessionStatus as an argument to updateButtonVisibility.
• In the DOMContentLoaded event listener, replace the existing call to updateButtonVisibility with a call to checkSessionStatus, and use the result to call updateButtonVisibility.

File Path	Proposed Changes
`extension/script.js`	Modify extension/script.js with contents: • Create a function named `checkSessionStatus` that checks if a session exists. This function should return a boolean value indicating whether a session exists or not. Use the existing code in the `checkSessionStatus` function as a starting point, but modify it to return a boolean value instead of resolving a promise. • Create a function named `updateButtonVisibility` that takes a boolean argument `sessionExists`. This function should call `hideElement` for the "signinbutton" and "registerbutton" if `sessionExists` is true, and `showElement` for these buttons if `sessionExists` is false. • Replace the existing calls to `hideElement` and `showElement` for the "signinbutton" and "registerbutton" with calls to `updateButtonVisibility`. Pass the result of `checkSessionStatus` as an argument to `updateButtonVisibility`. • In the `DOMContentLoaded` event listener, replace the existing call to `updateButtonVisibility` with a call to `checkSessionStatus`, and use the result to call `updateButtonVisibility`.

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:

Refactor script.js for better visibility control of login/register buttons sweep/refactor-visibility-control

Description

This PR refactors the script.js file to improve the visibility control of the login/register buttons. It introduces two new functions, checkSessionStatus and updateButtonVisibility, and modifies the existing code to utilize these functions.

Summary of Changes

Created a new function checkSessionStatus that checks if a session exists and returns a boolean value.

Created a new function updateButtonVisibility that updates the visibility of the login/register buttons based on the session status.

Replaced the existing calls to hideElement and showElement for the "signinbutton" and "registerbutton" with calls to updateButtonVisibility.

Modified the DOMContentLoaded event listener to call checkSessionStatus and use the result to call updateButtonVisibility.

Step 4: ⌨️ Coding

File	Instructions	Progress	Error logs
`extension/script.js`	Modify extension/script.js with contents: • Create a function named `checkSessionStatus` that checks if a session exists. This function should return a boolean value indicating whether a session exists or not. Use the existing code in the `checkSessionStatus` function as a starting point, but modify it to return a boolean value instead of resolving a promise. • Create a function named `updateButtonVisibility` that takes a boolean argument `sessionExists`. This function should call `hideElement` for the "signinbutton" and "registerbutton" if `sessionExists` is true, and `showElement` for these buttons if `sessionExists` is false. • Replace the existing calls to `hideElement` and `showElement` for the "signinbutton" and "registerbutton" with calls to `updateButtonVisibility`. Pass the result of `checkSessionStatus` as an argument to `updateButtonVisibility`. • In the `DOMContentLoaded` event listener, replace the existing call to `updateButtonVisibility` with a call to `checkSessionStatus`, and use the result to call `updateButtonVisibility`.	✅ Commit `b858937`	No errors.	I have finished coding the issue. I am now reviewing it for completeness.

Step 5: 🔁 Code Review

Here are my self-reviews of my changes at sweep/refactor-visibility-control_1.

Here is the 1st review

Thanks for your contribution. Here are a few changes that need to be made:

Please ensure that the function names hideElement and showElement have been updated in the rest of the codebase. This is in reference to the changes made on lines 63-66 in extension/script.js.

Please ensure that the browser.storage.local.get function exists and is imported correctly. This is in reference to the changes made on lines 70-75 in extension/script.js.

Please ensure that the checkSessionStatus function returns a promise. This is in reference to the changes made on lines 90-94 in extension/script.js.

Once these changes are made, we should be good to go. Keep up the good work!

I finished incorporating these changes.

🎉 Latest improvements to Sweep:

Use Sweep Map to break large issues into smaller sub-issues, perfect for large tasks like "Sweep (map): migrate from React class components to function components"
Getting Sweep to format before committing! Check out Sweep Sandbox Configs to set it up.
We released a demo of our chunker, where you can find the corresponding blog and code.

💡 To recreate the pull request edit the issue title or description. ^{Join Our Discord}

SomethingGeneric / bookmark-sync