feat: Add swr cache

[bdougie]

What type of PR is this? (check all applicable)

• 🍕 Feature
• 🐛 Bug Fix
• 📝 Documentation Update
• 🎨 Style
• 🧑‍💻 Code Refactor
• 🔥 Performance Improvements
• ✅ Test
• 🤖 Build
• 🔁 CI
• 📦 Chore (Release)
• ⏩ Revert

Description

Fetching content from the API could be cached and this PR applies that patter to all hooks

Details

• useRepositoriesList
• useRepositoryCommits
• useRepositoriyPRs
• useContributorData
• useContributorListuseNav

Related Tickets & Documents

fix #308

Mobile & Desktop Screenshots/Recordings

Added tests?

• 👍 yes
• 🙅 no, because they aren't needed
• 🙋 no, because I need help

Added to documentation?

• 📜 README.md
• 📓 docs.opensauced.pizza
• 🍕 dev.to/opensauced
• 📕 storybook
• 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

[netlify]

✅ Deploy Preview for oss-insights ready!

Name	Link
🔨 Latest commit	fe3f4e7
🔍 Latest deploy log	https://app.netlify.com/sites/oss-insights/deploys/6334c72b3ba3ad00080034d0
😎 Deploy Preview	https://deploy-preview-437--oss-insights.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[netlify]

✅ Deploy Preview for design-insights ready!

Name	Link
🔨 Latest commit	fe3f4e7
🔍 Latest deploy log	https://app.netlify.com/sites/design-insights/deploys/6334c72bca52e30009551bbf
😎 Deploy Preview	https://deploy-preview-437--design-insights.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[bdougie]

After some test yesterday, it seems like the caching works with this change. SWR works best with Next.js and no extra configuration should be needed. Marked this for review so we can test the caching on a production URL

[0-vortex]

After some test yesterday, it seems like the caching works with this change. SWR works best with Next.js and not extra configuration should be needed. Marked this for review so we can test the caching on a production URL

Glad it works out of the box, actually looked at why this is after your last stream and it is preconfigured for nextjs rendering - for this PR there is the question of whether we can use refreshInterval globally or we need to provide some custom value to 1-2 hooks. I don't think any of the other options are really needed for us.

We are not really mutating anything right now anyway! 🍕

[bdougie]

for this PR there is the question of whether we can use refreshInterval globally or if we need to provide some custom value to 1-2 hooks. I don't think any of the other options are really needed for us.

Curious about this too. If we have the ETL updating data on a cron for X amount of time, it might be worth following slightly longer than that interval would be.

[0-vortex]

for this PR there is the question of whether we can use refreshInterval globally or if we need to provide some custom value to 1-2 hooks. I don't think any of the other options are really needed for us.

Curious about this too. If we have the ETL updating data on a cron for X amount of time, it might be worth following slightly longer than that interval would be.

Was thinking of "days" to be honest, etl is minutes right now 😅

[bdougie]

So after some testing on the deploy preview vs production url. I have come to the conclusion that this is all working as expected and this PR is possibly not adding nay value.

deploy preview

production insights.opensauced.pizza

My assumption is the addition of the localstorage is not a performance win unless we are tapping the cache directly, but what I am seeing around is that is not recommended.

So my question is:

Should we go with this and replace localStorage in the event we add a state management tool in the future or stick with the defaults, and close this PR and issue for now?

[0-vortex]

So after some testing on the deploy preview vs production url. I have come to the conclusion that this is all working as expected and this PR is possibly not adding nay value.

deploy preview

production insights.opensauced.pizza

My assumption is the addition of the localstorage is not a performance win unless we are tapping the cache directly, but what I am seeing around is that is not recommended.

So my question is:

Should we go with this and replace localStorage in the event we add a state management tool in the future or stick with the defaults, and close this PR and issue for now?

Partially correct, the default cache is a memory buffer that is pretty big on our turbo charged machines. The local storage would indeed add value in the long term as we would cache stuff for low end machines as well and for a longer period of time.

I would say that even without that, this PR would be a win by simply enforcing good cache and revalidate timeouts to force swr to do the updates instead of us making an extra wrapper to write to the localstorage (no gains, just code)

🍕 🍕 🍕

[brandonroberts]

I think we will end up having a combination, where we have some centralized shared state that gets synced to local storage similar to what we have now.

I think the PR helps either way also

[bdougie]

ok, based on that. going to merge and move forward.

[github-actions]

🎉 This PR is included in version 1.8.0-beta.5 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀