feat! (stores): ✨ Async Stores #129

whizzzkid · 2023-07-10T23:51:31Z

In this PR:

Introduced Async Stores.
These are needed for the ipfs-companion's async localstorage api, chrome.storage.local.get ...
Since this now supports async stores, the property initDone is now public.
Fixed types being exported in the public dist, i.e. dist refers to types from ../types/index.d.ts but it's not actually shipped. Added a typings folder and moved the shared types to .ts file, which fixes this (tsc does not touch .d.ts files)
Introducing this as a breaking change as this might break existing refs.

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

whizzzkid

self-review.

whizzzkid · 2023-07-12T09:45:08Z

.gitignore

@@ -22,7 +22,6 @@ dist/
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-typings/


🤷🏽 Is this an issue 🤔

whizzzkid · 2023-07-12T09:46:05Z

src/BrowserStorageProvider.ts


-export class BrowserStorageProvider implements StorageProvider {
+export class BrowserStorageProvider implements StorageProviderInterface {


this makes it simpler to understand what the interface looks like, otherwise the type changes when we add methods to StorageProvider

whizzzkid · 2023-07-12T09:47:30Z

src/MetricsProvider.ts

@@ -20,8 +20,9 @@ export interface MetricsProviderConstructorOptions<T> {
  metricsService: T
  queue_size?: number
  session_update?: number
+  storage?: 'none' | 'localStorage' | 'sessionStorage' | 'cookie'


https://github.com/Countly/countly-sdk-web/blob/master/lib/countly.js#L280

whizzzkid · 2023-07-12T09:47:45Z

src/MetricsProvider.ts

-  private readonly storageProvider: StorageProvider | null
-  private readonly initDone: boolean = false
+  private readonly storageProvider: StorageProviderInterface | null
+  public initDone: boolean = false


this now needs to be checked.

whizzzkid · 2023-07-12T09:47:58Z

src/MetricsProvider.ts

@@ -58,9 +59,13 @@ export default class MetricsProvider<T extends CountlyWebSdk | CountlyNodeSdk> {
      this.setupAutoTrack()
    }

-    const existingConsent = this.getConsentStore()
+    void this.initExistingConsent()


because this call is now async.

whizzzkid · 2023-07-12T09:50:39Z

tsconfig.json

just auto-fixed 😵‍💫

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

SgtPooki · 2023-07-12T21:58:42Z

src/MetricsProvider.ts

-  private readonly storageProvider: StorageProvider | null
-  private readonly initDone: boolean = false
+  private readonly storageProvider: StorageProviderInterface | null
+  public initDone: boolean = false


we should probably add _initDone and make initDone a function that returns a promise.

I'm fine with us handling this later.

SgtPooki · 2023-07-12T22:03:28Z

test/node/NodeMetricsProvider.spec.ts

+      while (!telemetry.initDone) {
+        await new Promise(resolve => setTimeout(resolve, 10))
+      }


not a big fan of needing a while loop, but im okay with it for now.

Can we add a followup action item for exposing a promise that folks can await to determine when init is done?

SgtPooki · 2023-07-12T22:15:20Z

src/MetricsProvider.ts

-  private readonly storageProvider: StorageProvider | null
-  private readonly initDone: boolean = false
+  private readonly storageProvider: StorageProviderInterface | null
+  public initDone: boolean = false


Suggested change

public initDone: boolean = false

public initDone: Promise<boolean> = false

SgtPooki · 2023-07-12T22:15:36Z

src/MetricsProvider.ts

@@ -58,9 +62,13 @@ export default class MetricsProvider<T extends CountlyWebSdk | CountlyNodeSdk> {
      this.setupAutoTrack()
    }

-    const existingConsent = this.getConsentStore()
+    void this.initExistingConsent()


Suggested change

void this.initExistingConsent()

this.initDone = this.initExistingConsent()

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

github-actions · 2023-07-13T06:10:10Z

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

whizzzkid added 8 commits July 10, 2023 17:50

feat: ✨ Async Stores

c2da4af

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: 🔧 Updating TsConfig

cfc5317

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: ♻️ Refactoring Shared Types

ba28d8a

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: ✏️ Adding shared types to root.

a3d9a77

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: 🗑️ gitignore

7e04ed6

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: exposing initDone to be public

22d6750

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: Fixed Tests

f15c110

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix:

b2086f0

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

whizzzkid commented Jul 12, 2023

View reviewed changes

whizzzkid requested a review from SgtPooki July 12, 2023 09:51

whizzzkid marked this pull request as ready for review July 12, 2023 09:51

whizzzkid mentioned this pull request Jul 12, 2023

feat(metrics): ✨ Adding patched analytics. ipfs/ipfs-companion#1232

Merged

whizzzkid added 2 commits July 12, 2023 15:54

fix: async not needed here.

7f2261b

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: added todo

f30a3eb

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

SgtPooki approved these changes Jul 12, 2023

View reviewed changes

SgtPooki reviewed Jul 12, 2023

View reviewed changes

whizzzkid and others added 4 commits July 12, 2023 16:34

fix: Changed API

eb5c188

Signed-off-by: Nishant Arora <1895906+whizzzkid@users.noreply.github.com>

fix: ensureCall ordering

968eb85

test: fix User has no consent stored

dc52e2f

test: fix User removes consent

3b1cccd

whizzzkid mentioned this pull request Jul 12, 2023

[Enhancement] More info in failing tests. #130

Open

whizzzkid merged commit 4abe722 into main Jul 12, 2023
15 checks passed

github-actions bot added the released label Jul 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat! (stores): ✨ Async Stores #129

feat! (stores): ✨ Async Stores #129

whizzzkid commented Jul 10, 2023 •

edited

whizzzkid left a comment

whizzzkid Jul 12, 2023

whizzzkid Jul 12, 2023

whizzzkid Jul 12, 2023

whizzzkid Jul 12, 2023

whizzzkid Jul 12, 2023

whizzzkid Jul 12, 2023

SgtPooki Jul 12, 2023

SgtPooki Jul 12, 2023

SgtPooki Jul 12, 2023

SgtPooki Jul 12, 2023

SgtPooki Jul 12, 2023

github-actions bot commented Jul 13, 2023


		export class BrowserStorageProvider implements StorageProvider {
		export class BrowserStorageProvider implements StorageProviderInterface {

	public initDone: boolean = false
	public initDone: Promise<boolean> = false

	void this.initExistingConsent()
	this.initDone = this.initExistingConsent()

feat! (stores): ✨ Async Stores #129

feat! (stores): ✨ Async Stores #129

Conversation

whizzzkid commented Jul 10, 2023 • edited

whizzzkid left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 13, 2023

whizzzkid commented Jul 10, 2023 •

edited