feat: to add cache-mode to adapter #1888

tdeekens · 2024-04-05T16:29:23Z

Summary

Relates to #1879

This introduces the behaviour of eager and lazy cache modes. At the same time it removes the subscribeToFlagChanges as we always subscribe. Lastly, the unsubscribeFromCachedFlags is almost like the lazy cache.

changeset-bot · 2024-04-05T16:29:26Z

🦋 Changeset detected

Latest commit: a27dd86

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 17 packages

Name	Type
@flopflip/cache	Major
@flopflip/graphql-adapter	Major
@flopflip/http-adapter	Major
@flopflip/launchdarkly-adapter	Major
@flopflip/react	Major
@flopflip/types	Major
@flopflip/adapter-utilities	Major
@flopflip/combine-adapters	Major
@flopflip/cypress-plugin	Major
@flopflip/localstorage-adapter	Major
@flopflip/localstorage-cache	Major
@flopflip/memory-adapter	Major
@flopflip/react-broadcast	Major
@flopflip/react-redux	Major
@flopflip/sessionstorage-cache	Major
@flopflip/splitio-adapter	Major
@flopflip/test-utils	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

codecov · 2024-04-07T18:41:19Z

Codecov Report

Attention: Patch coverage is 84.00000% with 16 lines in your changes are missing coverage. Please review.

Project coverage is 93.84%. Comparing base (df89f1e) to head (a27dd86).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1888      +/-   ##
==========================================
+ Coverage   93.26%   93.84%   +0.57%     
==========================================
  Files         109      109              
  Lines        1752     1754       +2     
  Branches      256      266      +10     
==========================================
+ Hits         1634     1646      +12     
+ Misses        118      108      -10

Files	Coverage Δ
...components/configure-adapter/configure-adapter.tsx	`92.80% <100.00%> (+0.05%)`	⬆️
...ckages/launchdarkly-adapter/src/adapter/adapter.ts	`95.42% <90.90%> (+0.07%)`	⬆️
packages/graphql-adapter/src/adapter/adapter.ts	`86.36% <81.81%> (-0.31%)`	⬇️
packages/http-adapter/src/adapter/adapter.ts	`85.82% <69.23%> (-1.04%)`	⬇️
packages/cache/src/cache/cache.ts	`86.79% <86.79%> (ø)`

tdeekens

Next up I'll have to plug the loading of flags from the cache into react-redux and react-broadcast before the initial "setState" so that there is no "flash of changing flags".

tdeekens · 2024-04-07T18:40:00Z

packages/cache/package.json

@@ -0,0 +1,36 @@
+{


This makes a lot of things easier. No adapter knows about a direct type (local or session storage) of cache. A facade takes care of delegating and lazily importing concrete caches.

tdeekens · 2024-04-07T18:40:12Z

packages/cache/src/cache/cache.ts

+const FLAGS_CACHE_KEY = 'flags';
+const FLAGS_REFERENCE_CACHE_KEY = 'flags-reference';
+
+function getCachePrefix(adapterIdentifiers: TAdapterIdentifiers) {


This allows for making it generic.

tdeekens · 2024-04-07T18:40:20Z

packages/cache/src/cache/cache.ts


      if (haveFlagsBeenWritten) {
        referenceCache.set(
-          FLAGS_REFERENCE_KEY,
-          [flagsCachePrefix, FLAGS_KEY].join('/')
+          FLAGS_REFERENCE_CACHE_KEY,


Just renaming it.

tdeekens · 2024-04-07T18:40:54Z

packages/cache/src/cache/cache.ts

    },
  };
 }

-function getCachedFlags(cacheIdentifier: TCacheIdentifiers): TFlags {
+function getCachedFlags(


This will later be used in react-redux and react-broadcast.

tdeekens · 2024-04-07T18:41:10Z

packages/graphql-adapter/src/adapter/adapter.ts

@@ -75,38 +73,6 @@ class GraphQlAdapter implements TGraphQlAdapterInterface {
  readonly #getIsFlagLocked = (flagName: TFlagName) =>
    this.#adapterState.lockedFlags.has(flagName);

-  readonly #getCache = async (cacheIdentifier: TCacheIdentifiers) => {


This for each adapter moved to the cache package.

tdeekens · 2024-04-07T18:41:50Z

packages/graphql-adapter/src/adapter/adapter.ts


            cache.set(nextFlags);
          }

          this.#adapterState.flags = nextFlags;
+
+          if (adapterArgs.cacheMode === 'lazy') {


In lazy mode we just write to the cache. No flushing of updates. The next configuration or reconfiguration (can be a reload) will flush this state "into React".

tdeekens · 2024-04-09T21:16:04Z

packages/cache/src/cache/cache.ts

+    return {};
+  }
+
+  if (adapter.effectIds) {


This allows us to load default flags from various adapters when combined.

tdeekens commented Apr 7, 2024

View reviewed changes

tdeekens mentioned this pull request Apr 7, 2024

A cachePolicy to guide behaviour of how cached flags are restored #1879

Closed

tdeekens added 14 commits April 9, 2024 22:48

feat: to add cache-mode to adapter

8e15ee4

feat: add new cache module abstracting over specific caches

c4bccf6

refactor: to make cache require adapter identifier

5902e55

refactor: to write into cache module

5daa778

refactor: shamefully cast the type

83840a8

refactor: shamefully cast the type

15c94eb

refactor: one cache module to rule them all

babff05

feat: add cache mode to http and graphql adapter

6ed3fdb

test: adjust test case for cache mode

3c3d434

refactor: gimme some constants

93a965b

refactor: to not flush flags when reconfiguring

e0e72e6

refactor: to always flush on reconfigure

87cd85b

fix: to not flush initial remote fetching

8e70f11

refactor: to use sync import to get flags

8783764

tdeekens force-pushed the cache-mode branch from d7fe8fc to 8783764 Compare April 9, 2024 21:09

tdeekens commented Apr 9, 2024

View reviewed changes

tdeekens and others added 3 commits April 10, 2024 21:45

test: add initial set of tests

e3ec2c4

test: add test case for cached flag restoring

0a4b344

Create chilled-phones-greet.md

a27dd86

tdeekens marked this pull request as ready for review April 11, 2024 07:40

tdeekens merged commit 72f308b into main Apr 11, 2024
8 checks passed

tdeekens mentioned this pull request Apr 11, 2024

ci(changesets): version packages #1893

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: to add cache-mode to adapter #1888

feat: to add cache-mode to adapter #1888

tdeekens commented Apr 5, 2024

changeset-bot bot commented Apr 5, 2024 •

edited

Loading

codecov bot commented Apr 7, 2024 •

edited

Loading

tdeekens left a comment

tdeekens Apr 7, 2024

tdeekens Apr 7, 2024

tdeekens Apr 7, 2024

tdeekens Apr 7, 2024

tdeekens Apr 7, 2024

tdeekens Apr 7, 2024

tdeekens Apr 9, 2024

feat: to add cache-mode to adapter #1888

feat: to add cache-mode to adapter #1888

Conversation

tdeekens commented Apr 5, 2024

Summary

changeset-bot bot commented Apr 5, 2024 • edited Loading

🦋 Changeset detected

codecov bot commented Apr 7, 2024 • edited Loading

Codecov Report

tdeekens left a comment

Choose a reason for hiding this comment

tdeekens Apr 7, 2024

Choose a reason for hiding this comment

tdeekens Apr 7, 2024

Choose a reason for hiding this comment

tdeekens Apr 7, 2024

Choose a reason for hiding this comment

tdeekens Apr 7, 2024

Choose a reason for hiding this comment

tdeekens Apr 7, 2024

Choose a reason for hiding this comment

tdeekens Apr 7, 2024

Choose a reason for hiding this comment

tdeekens Apr 9, 2024

Choose a reason for hiding this comment

changeset-bot bot commented Apr 5, 2024 •

edited

Loading

codecov bot commented Apr 7, 2024 •

edited

Loading