Move redis adapter to separate npm library #87

mannyv123 · 2024-01-31T02:58:05Z

Description

This change removes the redis 4 adapter from @epic-web/cachified and links to a separate npm library I set up:
cachified-redis-adapter

Why

This helps avoid issues when updating the adapter and causing breaking change releases for the entire @epic-web/cachified package.

Details

cachified-redis-adapter basically takes the code that was in @epic-web/cachified for the redis adapter and moves it into a separate library
this PR then updates @epic-web/cachified to remove the redis adapter code and update the readme.md file to link to cachified-redis-adapter

Note: I wasn't too sure how to update the extractExamples.js file. I can see that since the readme.md file is update it has removed the redis adapter example from generating. Any suggestions here would be appreciated!

@tearingItUp786

Move redis adapter to separate npm library

Xiphe · 2024-01-31T09:38:28Z

Hi @mannyv123 thanks for taking care of this.

For context: The extractExamples.js + readme.test.ts ensure that the example code in the readme is correct & working.
For the redis adapter examples the setup was too complex to actually run the examples so we just make sure there are not type-issues in there.

As you removed the redis example, we no longer need to validate that one -> can remove it from the test as you did.

Xiphe

Code-wise: LGTM

But we need to decide if we want to release this as a breaking change or not.

A) When we want to actually remove the adapter:
Add BREAKING CHANGE to one of the commit messages (or to the squash merge message) in order to issue a new major version. See semantic-release#commit-message-format for details.
B) When we don't want to create a new major version just yet:
Keep the adapter in and @deprecate. The docs can stay updated to point towards the new package.

Leaving this decision to you @kentcdodds

kentcdodds · 2024-01-31T16:00:37Z

Thanks for this @mannyv123!

I would prefer that we also remove the Redis 3 adapter as part of the breaking change. I don't think it's necessary for anyone to create a library for that because it's so little code people can just copy it themselves.

I think we can keep the lru-cache adapter though. That one is quite simple, unlikely to change, and makes this package useful out of the box.

So if you also remove the Redis 3 adapter code then I'm good to go with a major version bump as a part of this PR.

Thanks!

BREAKING CHANGE: remove redis adapter to external package

mannyv123 · 2024-01-31T22:46:38Z

Thanks everyone for the feedback! I've made the following changes:

removed redis3 adapter code and related tests
removed redis-mock, @types/redis-mock, redis4 packages

I also added BREAKING CHANGE to the commit message, hopefully formatted it correctly🤞

Thanks again!

kentcdodds

Actually, the more I think about it, the more I think I would prefer to delete all adapters. And I think the README could be cleaned up as well. Do you have time and interest in doing that please @mannyv123?

tearingItUp786 · 2024-01-31T23:56:06Z

Hey hey! I'll probably be helping @mannyv123 with this 😄

So the plan for the work going forward:

remove adapters.ts
Update the README
Update the extractExamples.js or do we want to remove this?

kentcdodds · 2024-02-01T02:03:17Z

I think we can remove that. Thanks @tearingItUp786!

Xiphe · 2024-02-01T07:35:42Z

Voting to keep extractExamples.js but as the creator of it I'm certainly biased :)

I've created that one because I tend to forget keeping (readme) examples up to date and wanted to have a safeguard.
Let me know when you want my help with it.

kentcdodds · 2024-02-01T15:31:36Z

I think it's a cool idea, but with removing all the adapters and moving the docs for them into their respective packages combined with the level of complexity there, I don't think it makes sense to keep it around.

Xiphe · 2024-02-01T17:28:33Z

The adapters were actually the examples that have not been tested :)
But I'm completely fine with removing it 👍

mannyv123 · 2024-02-03T23:37:37Z

Hi all!

I've made the changes as discussed:

removed adapters and tests
removed extractExamples.js and related tests
updated the README

@kentcdodds you mentioned during the last office hours that it would be good to update the usage example in the README with the lru adapter code and that we might be able to reduce the amount of code as well. I updated the example with the lru adapter but wasn't too sure how to make it simpler. Would you be able to provide some feedback/guidance on how to update this? Thank you!

kentcdodds

This is looking good to me. Definitely simplifies things for us development-wise and reduces the chance that we'll need breaking changes in the future.

Just one thing on the example in the README and then I'll be ready to merge this.

kentcdodds · 2024-02-04T05:19:57Z

README.md

+/* defines options for the set method for lru cache */
+interface LRUishCache extends Omit<Cache, 'set'> {
+  set(
+    key: string,
+    value: CacheEntry<unknown>,
+    options?: { ttl?: number; start?: number },
+  ): void;
+}
+
+/* creates a wrapper for the lru cache so that it can easily work with cachified and ensures the lru cache cleans up outdated values itself*/
+function lruCacheAdapter(lruCache: LRUishCache): Cache {
+  return {
+    set(key, value) {
+      const ttl = totalTtl(value?.metadata);
+      return lruCache.set(key, value, {
+        ttl: ttl === Infinity ? undefined : ttl,
+        start: value?.metadata?.createdTime,
+      });
+    },
+    get(key) {
+      return lruCache.get(key);
+    },
+    delete(key) {
+      return lruCache.delete(key);
+    },
+  };
+}
+
+const lru = lruCacheAdapter(lruInstance);


Remove this stuff and just set lru to the cache instance itself. So something like:

const lru: Cache = { set() {}, get() {}, delete() {}, }

Of course you'll want to fill that in with working code and make sure the types are happy too. I think you'll want to use the Cache generic maybe.

Xiphe

Agree with Kents feedback. Rest: LGTM!

mannyv123 · 2024-02-06T21:56:16Z

Thank you for the feedback!

I've updated the usage example now. Please let me know if this is in line with what you were thinking or if any changes are needed.

Thanks again!

Xiphe · 2024-02-07T08:48:54Z

README.md

+  delete(key) {
+    return lruInstance.delete(key);
+  },
+};


This implementation has no benefit over

const cache = new LRUCache<string, CacheEntry>({ max: 1000 }) cachified({ cache, /* ... */ });

One of the main reasons for an adapter is to set the TTL on the cached item in a way that the cache will clean it up itself without involving cachified.

Proposing to either not create an on the fly adapter (example above) or do the following:

/* lru cache is not part of this package but a simple non-persistent cache */ const lruInstance = new LRUCache<string, CacheEntry>({ max: 1000 }); const cache: Cache = { set(key, value) { const ttl = totalTtl(value?.metadata); return lruCache.set(key, value, { ttl: ttl === Infinity ? undefined : ttl, start: value?.metadata?.createdTime, }); }, get(key) { return lruInstance.get(key); }, delete(key) { return lruInstance.delete(key); }, };

Would vote for the latter option. In real apps this is quite critical in order to not bloat your cache db.

Yep, I agree. Let's update the example to the one which sets the ttl 👍

Ahh that makes sense! Thank you for the help!

I've updated it now to the above example.

mannyv123 · 2024-02-07T20:07:46Z

Hi all,

I resolved the merge conflicts that were in the package.json file.

Also, I made an update to the tsconfig.json file as when tsc was run, it was no longer creating the dist/src folder structure. It seems this was caused when I removed the readme.test.ts file. Please let me know if my change here was incorrect and I can update.

Thanks!

Xiphe

LGTM 🐋

Good catch with the src folder. The other option would have been to remove the src/ in the "type" paths in package.json but I'm fine with either 👍

github-actions · 2024-02-09T19:44:56Z

🎉 This PR is included in version 5.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

caiocmpaes · 2024-02-10T00:49:53Z

Hi, everyone! 👋

I just updated the package to 5.1.1 and then seems like we need a bump on the peer dependency of cachified-redis-adapter.

tearingItUp786 · 2024-02-10T04:23:22Z

Hi, everyone! 👋

I just updated the package to 5.1.1 and then seems like we need a bump on the peer dependency of cachified-redis-adapter.

@caiocmpaes opened up a PR for my bud :)
mannyv123/cachified-redis-adapter#7

mannyv123 · 2024-02-10T05:53:13Z

@caiocmpaes @tearingItUp786 PR is now merged! :)
Thank you!

mannyv123 and others added 3 commits January 30, 2024 16:26

remove redis4 code and tests; update readme

599f0dc

remove redis test

b5166fd

Merge pull request #1 from mannyv123/develop

67b3687

Move redis adapter to separate npm library

Xiphe self-requested a review January 31, 2024 09:38

Xiphe reviewed Jan 31, 2024

View reviewed changes

refactor: removed redis3 adapter code and from readme

073bae2

BREAKING CHANGE: remove redis adapter to external package

mannyv123 requested a review from Xiphe January 31, 2024 22:46

kentcdodds requested changes Jan 31, 2024

View reviewed changes

remove all adapters and related tests; remove readme example tests

ecf28db

kentcdodds reviewed Feb 4, 2024

View reviewed changes

mannyv123 mentioned this pull request Feb 5, 2024

Update readme usage example mannyv123/cachified#2

Merged

Xiphe approved these changes Feb 5, 2024

View reviewed changes

Update readme usage example (#2)

a0c1536

mannyv123 requested a review from kentcdodds February 6, 2024 21:56

Xiphe reviewed Feb 7, 2024

View reviewed changes

mannyv123 added 2 commits February 7, 2024 10:01

update readme usage example with ttl

c012567

resolve merge conflicts; update tsconfig for dist/src structure

a9a3745

mannyv123 requested a review from Xiphe February 7, 2024 20:07

Xiphe approved these changes Feb 8, 2024

View reviewed changes

kentcdodds changed the base branch from main to next February 9, 2024 19:22

kentcdodds merged commit 45afb15 into epicweb-dev:next Feb 9, 2024
5 checks passed

github-actions bot added the released label Feb 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move redis adapter to separate npm library #87

Move redis adapter to separate npm library #87

mannyv123 commented Jan 31, 2024

Xiphe commented Jan 31, 2024

Xiphe left a comment •

edited

Loading

kentcdodds commented Jan 31, 2024

mannyv123 commented Jan 31, 2024

kentcdodds left a comment

tearingItUp786 commented Jan 31, 2024

kentcdodds commented Feb 1, 2024

Xiphe commented Feb 1, 2024

kentcdodds commented Feb 1, 2024

Xiphe commented Feb 1, 2024

mannyv123 commented Feb 3, 2024

kentcdodds left a comment

kentcdodds Feb 4, 2024

Xiphe left a comment

mannyv123 commented Feb 6, 2024

Xiphe Feb 7, 2024

Xiphe Feb 7, 2024

kentcdodds Feb 7, 2024

mannyv123 Feb 7, 2024

mannyv123 commented Feb 7, 2024

Xiphe left a comment

github-actions bot commented Feb 9, 2024

caiocmpaes commented Feb 10, 2024

tearingItUp786 commented Feb 10, 2024 •

edited

Loading

mannyv123 commented Feb 10, 2024

Move redis adapter to separate npm library #87

Move redis adapter to separate npm library #87

Conversation

mannyv123 commented Jan 31, 2024

Description

Why

Details

Xiphe commented Jan 31, 2024

Xiphe left a comment • edited Loading

Choose a reason for hiding this comment

kentcdodds commented Jan 31, 2024

mannyv123 commented Jan 31, 2024

kentcdodds left a comment

Choose a reason for hiding this comment

tearingItUp786 commented Jan 31, 2024

kentcdodds commented Feb 1, 2024

Xiphe commented Feb 1, 2024

kentcdodds commented Feb 1, 2024

Xiphe commented Feb 1, 2024

mannyv123 commented Feb 3, 2024

kentcdodds left a comment

Choose a reason for hiding this comment

kentcdodds Feb 4, 2024

Choose a reason for hiding this comment

Xiphe left a comment

Choose a reason for hiding this comment

mannyv123 commented Feb 6, 2024

Xiphe Feb 7, 2024

Choose a reason for hiding this comment

Xiphe Feb 7, 2024

Choose a reason for hiding this comment

kentcdodds Feb 7, 2024

Choose a reason for hiding this comment

mannyv123 Feb 7, 2024

Choose a reason for hiding this comment

mannyv123 commented Feb 7, 2024

Xiphe left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 9, 2024

caiocmpaes commented Feb 10, 2024

tearingItUp786 commented Feb 10, 2024 • edited Loading

mannyv123 commented Feb 10, 2024

Xiphe left a comment •

edited

Loading

tearingItUp786 commented Feb 10, 2024 •

edited

Loading