add service worker file and manually register service worker

lucasxsong commented 3 months ago

Proposed changes

Hopes to address 404 OAuth Error.

Updates the service worker file with a cleanupOutdatedCaches() function that should do as it is named. I've also updated the precacheAndRoute() function to account for a bug that was happening with the parameter previously passed in.

The PR also updates the VitePWA strategy from registerSW to injectManifest. This strategy makes the registration of the service worker more configurable and less dynamic. You can read more about the different strategies here. The change in strategy should fix an issue where the Sentry import was being injected into the previous, auto-generated service worker file.

I've tested on my local in development and production environments and the fixes seem to have taken care of a few of the bugs that I was seeing before. I can't say for certain it will fix the staging 404 error, but I think there is a fairly good chance it will take care of at least one of the bugs we are seeing right now. Feel free to take a look and review. Thanks!

Types of changes

What types of changes does this pull request introduce?

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Refactoring (non-breaking change that does not add functionality but makes code cleaner or more efficient)
[ ] Documentation Update
[ ] Tests (new or updated tests)
[ ] Style (changes to code styling)
[ ] CI (continuous integration changes)
[ ] Repository Maintenance
[ ] Other (please describe below)

Checklist

[x] I have read the guidelines for contributing.
[x] The changes in this PR are as small as they can be. They represent one and only one fix or enhancement.
[x] Linting checks pass with my changes.
[x] Any existing unit tests pass with my changes.
[x] Any existing end-to-end tests pass with my changes.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] If this PR fixes an existing issue, I have added a unit or end-to-end test that will detect if this issue reoccurs.
[x] I have added JSDoc comments as appropriate.
[x] I have added the necessary documentation to the roar-docs repository.
[x] I have shared this PR on the roar-pr-reviews channel (if I have access)
[x] I have linked relevant issues (if any)

Justification of missing checklist items

Further comments

github-actions[bot] commented 3 months ago

Visit the preview URL for this PR (updated for commit 9a9eb1b):

https://roar-staging--pr694-fix-service-worker-b997apqj.web.app

_{(expires Wed, 03 Jul 2024 21:11:31 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 2631e9c58fd0104ecbfddd72a62245ddac467460}

cypress[bot] commented 3 months ago

Passing run #3057 ↗︎

0

26

0

Details:

Tests for PR 694 "add service worker file and manually register service worker" ...
Project: roar-dashboard-e2e	Commit: `9a9eb1ba10`
Status: Passed	Duration: 03:37 💡
Started: Jun 26, 2024 9:09 PM	Ended: Jun 26, 2024 9:13 PM

yeatmanlab / roar-dashboard