generated from ipfs/ipfs-repository-template
-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: use localStorage to cache consent in browsers #64
Merged
Merged
Changes from 3 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
a82c0f6
feat: save consent in localStorage for browsers
SgtPooki 0524e74
Merge branch 'main' into feat/useStorageForBrowsers
SgtPooki d8d6326
chore: fix linter
SgtPooki 2cd942e
Update src/MetricsProvider.ts
SgtPooki 20920d6
Update src/MetricsProvider.ts
SgtPooki d14d52a
chore: fix lint
SgtPooki 1e68898
fix: use globalThis instead of window
SgtPooki cc19b56
feat: create StorageProvider class
SgtPooki 0263567
chore: enable testing
SgtPooki 84ee0e2
fix: types and construction
SgtPooki 8334d47
chore: add StorageProvider class
SgtPooki 3e9c2a7
fix: build artifacts dont use this
SgtPooki 57636b2
feat: add tests
SgtPooki f01a86b
fix: code cleanup and issues with serviceConfig
SgtPooki 77a95c5
fix: tests cleanup
SgtPooki af2b67d
chore: remove unused test scripts
SgtPooki ef9d4cc
fix: remove dist/test from npm package
SgtPooki File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
import type { StorageProvider } from './types/index.js' | ||
|
||
export const BrowserStorageProvider: StorageProvider = { | ||
SgtPooki marked this conversation as resolved.
Show resolved
Hide resolved
SgtPooki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
setStore: (consentArray) => { | ||
try { | ||
const jsonString = JSON.stringify(consentArray) | ||
window.localStorage.setItem('@ipfs-shipyard/ignite-metrics:consent', jsonString) | ||
SgtPooki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} catch (err) { | ||
// eslint-disable-next-line no-console | ||
console.error(err) | ||
} | ||
}, | ||
getStore: () => { | ||
try { | ||
const jsonString = window.localStorage.getItem('@ipfs-shipyard/ignite-metrics:consent') | ||
if (jsonString != null) { | ||
return JSON.parse(jsonString) | ||
} | ||
} catch (err) { | ||
// eslint-disable-next-line no-console | ||
console.error(err) | ||
} | ||
/** | ||
* Return minimal consent if there is nothing in the store. | ||
*/ | ||
return ['minimal'] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ import { COUNTLY_SETUP_DEFAULTS } from './config.js' | |
|
||
import type { metricFeatures, CountlyWebSdk } from 'countly-sdk-web' | ||
import type { CountlyNodeSdk } from 'countly-sdk-nodejs' | ||
import type { consentTypes, consentTypesExceptAll } from './types/index.js' | ||
import type { consentTypes, consentTypesExceptAll, StorageProvider } from './types/index.js' | ||
|
||
export interface MetricsProviderConstructorOptions<T> { | ||
appKey: string | ||
|
@@ -13,9 +13,10 @@ export interface MetricsProviderConstructorOptions<T> { | |
session_update?: number | ||
url?: string | ||
metricsService: T | ||
storageProvider?: StorageProvider | null | ||
} | ||
|
||
export default class MetricsProvider<T extends CountlyWebSdk & CountlyNodeSdk> { | ||
export default class MetricsProvider<T extends CountlyWebSdk | CountlyNodeSdk> { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. either or, not both. |
||
private readonly groupedFeatures: Record<consentTypes, metricFeatures[]> = this.mapAllEvents({ | ||
minimal: ['sessions', 'views', 'events'], | ||
performance: ['crashes', 'apm'], | ||
|
@@ -27,14 +28,16 @@ export default class MetricsProvider<T extends CountlyWebSdk & CountlyNodeSdk> { | |
private sessionStarted: boolean = false | ||
private readonly _consentGranted: Set<consentTypes> = new Set() | ||
private readonly metricsService: T | ||
private readonly storageProvider: StorageProvider | null | ||
|
||
constructor (config: MetricsProviderConstructorOptions<T>) { | ||
const serviceConfig = { | ||
...COUNTLY_SETUP_DEFAULTS, | ||
...config | ||
} | ||
const { appKey, autoTrack, metricsService, url } = serviceConfig | ||
const { appKey, autoTrack, metricsService, url, storageProvider } = serviceConfig | ||
this.metricsService = metricsService | ||
this.storageProvider = storageProvider ?? null | ||
this.metricsService.init({ | ||
app_key: appKey, | ||
url, | ||
|
@@ -47,6 +50,8 @@ export default class MetricsProvider<T extends CountlyWebSdk & CountlyNodeSdk> { | |
if (autoTrack) { | ||
this.setupAutoTrack() | ||
} | ||
|
||
this.getConsentStore().forEach(this.addConsent.bind(this)) | ||
SgtPooki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
mapAllEvents (eventMap: Record<consentTypesExceptAll, metricFeatures[]>): Record<consentTypes, metricFeatures[]> { | ||
|
@@ -77,6 +82,7 @@ export default class MetricsProvider<T extends CountlyWebSdk & CountlyNodeSdk> { | |
} | ||
consent.forEach(c => this._consentGranted.add(c)) | ||
this.metricsService.add_consent(consent) | ||
this.setConsentStore() | ||
} | ||
|
||
removeConsent (consent: consentTypes | consentTypes[]): void { | ||
|
@@ -85,6 +91,20 @@ export default class MetricsProvider<T extends CountlyWebSdk & CountlyNodeSdk> { | |
} | ||
consent.forEach(c => this._consentGranted.delete(c)) | ||
this.metricsService.remove_consent(consent, true) | ||
this.setConsentStore() | ||
} | ||
|
||
private setConsentStore (): void { | ||
if (this.storageProvider != null) { | ||
this.storageProvider.setStore(Array.from(this._consentGranted)) | ||
} | ||
SgtPooki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
private getConsentStore (): consentTypes[] { | ||
if (this.storageProvider != null) { | ||
return this.storageProvider.getStore() | ||
} | ||
return [] | ||
SgtPooki marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
checkConsent (consent: consentTypes | metricFeatures): boolean { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,8 @@ | ||
|
||
export type consentTypesExceptAll = 'minimal' | 'performance' | 'ux' | 'feedback' | 'location' | ||
export type consentTypes = 'all' | consentTypesExceptAll | ||
|
||
export interface StorageProvider { | ||
setStore: (values: consentTypes[]) => void | ||
getStore: () => consentTypes[] | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are only providing storage provider for non-node because that's the only one we currently need.