feat(cli): cache telemetry consent status

sanity-io · Dec 11, 2023 · cd555ca · cd555ca
1 parent 7053829
commit cd555ca
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 6 deletions.
diff --git a/packages/@sanity/cli/src/actions/login/login.ts b/packages/@sanity/cli/src/actions/login/login.ts
@@ -9,6 +9,7 @@ import {getCliToken} from '../../util/clientWrapper'
 import {getUserConfig} from '../../util/getUserConfig'
 import {canLaunchBrowser} from '../../util/canLaunchBrowser'
 import type {CliApiClient, CliCommandArguments, CliCommandContext, CliPrompter} from '../../types'
+import {TELEMETRY_CONSENT_CONFIG_KEY} from '../../util/createTelemetryStore'
 import type {LoginProvider, ProvidersResponse, SamlLoginProvider} from './types'
 import {LoginTrace} from './login.telemetry'
 
@@ -122,6 +123,9 @@ export async function login(
     authType: 'normal',
   })
 
+  // Clear cached telemetry consent
+  getUserConfig().delete(TELEMETRY_CONSENT_CONFIG_KEY)
+
   // If we had a session previously, attempt to clear it
   if (hasExistingToken) {
     await apiClient({requireUser: true, requireProject: false})

diff --git a/packages/@sanity/cli/src/commands/logout/logoutCommand.ts b/packages/@sanity/cli/src/commands/logout/logoutCommand.ts
@@ -1,6 +1,7 @@
 import chalk from 'chalk'
 import type {CliCommandDefinition} from '../../types'
 import {getUserConfig} from '../../util/getUserConfig'
+import {TELEMETRY_CONSENT_CONFIG_KEY} from '../../util/createTelemetryStore'
 
 const helpText = `
 Examples
@@ -40,6 +41,9 @@ const logoutCommand: CliCommandDefinition = {
     cfg.delete('authType')
     cfg.delete('authToken')
 
+    // Clear cached telemetry consent
+    cfg.delete(TELEMETRY_CONSENT_CONFIG_KEY)
+
     output.print(chalk.green('Logged out'))
   },
 }

diff --git a/packages/@sanity/cli/src/commands/telemetry/telemetryStatusCommand.ts b/packages/@sanity/cli/src/commands/telemetry/telemetryStatusCommand.ts
@@ -1,5 +1,5 @@
 import type {CliCommandDefinition} from '../../types'
-import {resolveConsent} from '../../util/initTelemetry'
+import {resolveConsent} from '../../util/createTelemetryStore'
 
 const helpText = `
 Examples

diff --git a/packages/@sanity/cli/src/util/createExpiringConfig.ts b/packages/@sanity/cli/src/util/createExpiringConfig.ts
@@ -41,6 +41,7 @@ export function createExpiringConfig<Type>({
   onFetch = () => null,
   onCacheHit = () => null,
 }: ExpiringConfigOptions<Type>): ExpiringConfigApi<Type> {
+  let currentFetch: Promise<Type> | null = null
   return {
     async get() {
       const {value, updatedAt} = store.get(key) ?? {}
@@ -56,8 +57,14 @@ export function createExpiringConfig<Type>({
         onRevalidate()
       }
 
+      if (currentFetch) {
+        return currentFetch
+      }
       onFetch()
-      const nextValue = await fetchValue()
+
+      currentFetch = Promise.resolve(fetchValue())
+      const nextValue = await currentFetch
+      currentFetch = null
 
       store.set(key, {
         value: nextValue,

diff --git a/packages/@sanity/cli/src/util/createTelemetryStore.ts b/packages/@sanity/cli/src/util/createTelemetryStore.ts
@@ -2,9 +2,15 @@ import {createClient, SanityClient} from '@sanity/client'
 import {ConsentStatus, createBatchedStore, createSessionId, TelemetryEvent} from '@sanity/telemetry'
 import {debug as baseDebug} from '../debug'
 import {getCliToken} from './clientWrapper'
+import {getUserConfig} from './getUserConfig'
+import {createExpiringConfig} from './createExpiringConfig'
 
 const debug = baseDebug.extend('telemetry')
 
+const FIVE_MINUTES = 1000 * 60 * 5
+
+export const TELEMETRY_CONSENT_CONFIG_KEY = 'telemetryConsent'
+
 function isTrueish(value: string | undefined) {
   if (value === undefined) return false
   if (value.toLowerCase() === 'true') return true
@@ -96,15 +102,33 @@ export function resolveConsent({env}: Options): Promise<ConsentInformation> {
 
   const client = getCachedClient(token)
 
-  function fetchConsent(): Promise<{
-    status: ValidConsentStatus
-  }> {
+  function fetchConsent() {
+    const telemetryConsentConfig = createExpiringConfig<{
+      status: ValidConsentStatus
+    }>({
+      store: getUserConfig(),
+      key: TELEMETRY_CONSENT_CONFIG_KEY,
+      ttl: FIVE_MINUTES,
+      fetchValue: () => client.request({uri: '/users/me/consents/telemetry'}),
+      onRevalidate() {
+        debug('Revalidating cached telemetry consent status...')
+      },
+      onFetch() {
+        debug('Fetching telemetry consent status...')
+      },
+      onCacheHit() {
+        debug('Retrieved telemetry consent status from cache')
+      },
+    })
+
     if (env.MOCK_CONSENT) {
+      debug('Mocking telemetry consent status')
       return Promise.resolve({
         status: isTrueish(env.MOCK_CONSENT) ? 'granted' : parseConsent(env.MOCK_CONSENT),
       })
     }
-    return client.request({uri: '/users/me/consents/telemetry'})
+
+    return telemetryConsentConfig.get()
   }
 
   return fetchConsent()