@posthog/core 1.40.2 → 1.41.1

package/src/surveys/index.ts

@@ -16,3 +16,5 @@ export {
   getLanguageFromStoredPersonProperties,
   normalizeLanguageCode,
 } from './translations'
+export { canSurveyActivateRepeatedly, doesSurveyActivateByEvent } from './activation'
+export { getSurveyIterationKey, isSurveyKeyForSurvey, type SurveyWithIteration } from './keys'

package/src/surveys/keys.spec.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it } from '@jest/globals'
+import { getSurveyIterationKey, isSurveyKeyForSurvey } from './keys'
+
+describe('getSurveyIterationKey', () => {
+  const cases: [number | null | undefined, string][] = [
+    [2, 'survey-1_2'],
+    [1, 'survey-1_1'],
+    [0, 'survey-1'],
+    [null, 'survey-1'],
+    [undefined, 'survey-1'],
+  ]
+
+  it.each(cases)('current_iteration %p produces key %p', (currentIteration, expected) => {
+    expect(getSurveyIterationKey({ id: 'survey-1', current_iteration: currentIteration })).toBe(expected)
+  })
+})
+
+describe('isSurveyKeyForSurvey', () => {
+  it.each([
+    ['bare id', 'abc', 'abc', true],
+    ['first iteration', 'abc_1', 'abc', true],
+    ['later iteration', 'abc_12', 'abc', true],
+    ['different survey id', 'def_1', 'abc', false],
+    ['prefix collision with bare id', 'abcd', 'abc', false],
+    ['prefix collision with iteration key', 'abcd_1', 'abc', false],
+  ])('%s: key %p for survey %p returns %p', (_name, key, surveyId, expected) => {
+    expect(isSurveyKeyForSurvey(key, surveyId)).toBe(expected)
+  })
+})

package/src/surveys/keys.ts

@@ -0,0 +1,23 @@
+import { Survey } from '../types'
+
+export type SurveyWithIteration = Pick<Survey, 'id' | 'current_iteration'>
+
+/**
+ * True when a stored display-state key belongs to the given survey: its bare id
+ * or any iteration-qualified `id_n` key.
+ */
+export function isSurveyKeyForSurvey(key: string, surveyId: string): boolean {
+  return key === surveyId || key.startsWith(`${surveyId}_`)
+}
+
+/**
+ * Iteration-qualified survey identifier ('id' or 'id_iteration'), used to key
+ * per-survey display state (seen, in-progress, ...). Keying by iteration lets a
+ * repeating survey become visible again when a new iteration starts.
+ */
+export function getSurveyIterationKey(survey: SurveyWithIteration): string {
+  if (survey.current_iteration && survey.current_iteration > 0) {
+    return `${survey.id}_${survey.current_iteration}`
+  }
+  return survey.id
+}

package/src/types.ts

@@ -633,43 +633,49 @@ export type SurveyAppearance = {
   widgetColor?: string
 }
 
-export enum SurveyPosition {
-  TopLeft = 'top_left',
-  TopCenter = 'top_center',
-  TopRight = 'top_right',
-  MiddleLeft = 'middle_left',
-  MiddleCenter = 'middle_center',
-  MiddleRight = 'middle_right',
-  Left = 'left',
-  Right = 'right',
-  Center = 'center',
-}
+export const SurveyPosition = {
+  TopLeft: 'top_left',
+  TopCenter: 'top_center',
+  TopRight: 'top_right',
+  MiddleLeft: 'middle_left',
+  MiddleCenter: 'middle_center',
+  MiddleRight: 'middle_right',
+  Left: 'left',
+  Right: 'right',
+  Center: 'center',
+} as const
+export type SurveyPosition = (typeof SurveyPosition)[keyof typeof SurveyPosition]
 
-export enum SurveyWidgetType {
-  Button = 'button',
-  Tab = 'tab',
-  Selector = 'selector',
-}
+export const SurveyWidgetType = {
+  Button: 'button',
+  Tab: 'tab',
+  Selector: 'selector',
+} as const
+export type SurveyWidgetType = (typeof SurveyWidgetType)[keyof typeof SurveyWidgetType]
 
-export enum SurveyType {
-  Popover = 'popover',
-  API = 'api',
-  Widget = 'widget',
-  ExternalSurvey = 'external_survey',
-}
+export const SurveyType = {
+  Popover: 'popover',
+  API: 'api',
+  Widget: 'widget',
+  ExternalSurvey: 'external_survey',
+} as const
+export type SurveyType = (typeof SurveyType)[keyof typeof SurveyType]
 
 export type SurveyQuestion = BasicSurveyQuestion | LinkSurveyQuestion | RatingSurveyQuestion | MultipleSurveyQuestion
 
-export enum SurveyQuestionDescriptionContentType {
-  Html = 'html',
-  Text = 'text',
-}
+export const SurveyQuestionDescriptionContentType = {
+  Html: 'html',
+  Text: 'text',
+} as const
+export type SurveyQuestionDescriptionContentType =
+  (typeof SurveyQuestionDescriptionContentType)[keyof typeof SurveyQuestionDescriptionContentType]
 
 // Survey validation types
-export enum SurveyValidationType {
-  MinLength = 'min_length',
-  MaxLength = 'max_length',
-}
+export const SurveyValidationType = {
+  MinLength: 'min_length',
+  MaxLength: 'max_length',
+} as const
+export type SurveyValidationType = (typeof SurveyValidationType)[keyof typeof SurveyValidationType]
 
 export interface SurveyValidationRule {
   type: SurveyValidationType
@@ -710,16 +716,16 @@ type SurveyQuestionBase = {
 }
 
 export type BasicSurveyQuestion = SurveyQuestionBase & {
-  type: SurveyQuestionType.Open
+  type: typeof SurveyQuestionType.Open
 }
 
 export type LinkSurveyQuestion = SurveyQuestionBase & {
-  type: SurveyQuestionType.Link
+  type: typeof SurveyQuestionType.Link
   link?: string | null
 }
 
 export type RatingSurveyQuestion = SurveyQuestionBase & {
-  type: SurveyQuestionType.Rating
+  type: typeof SurveyQuestionType.Rating
   display: SurveyRatingDisplay
   scale: 2 | 3 | 5 | 7 | 10
   lowerBoundLabel: string
@@ -727,49 +733,52 @@ export type RatingSurveyQuestion = SurveyQuestionBase & {
   skipSubmitButton?: boolean
 }
 
-export enum SurveyRatingDisplay {
-  Number = 'number',
-  Emoji = 'emoji',
-}
+export const SurveyRatingDisplay = {
+  Number: 'number',
+  Emoji: 'emoji',
+} as const
+export type SurveyRatingDisplay = (typeof SurveyRatingDisplay)[keyof typeof SurveyRatingDisplay]
 
 export type MultipleSurveyQuestion = SurveyQuestionBase & {
-  type: SurveyQuestionType.SingleChoice | SurveyQuestionType.MultipleChoice
+  type: typeof SurveyQuestionType.SingleChoice | typeof SurveyQuestionType.MultipleChoice
   choices: string[]
   hasOpenChoice?: boolean
   shuffleOptions?: boolean
   skipSubmitButton?: boolean
 }
 
-export enum SurveyQuestionType {
-  Open = 'open',
-  MultipleChoice = 'multiple_choice',
-  SingleChoice = 'single_choice',
-  Rating = 'rating',
-  Link = 'link',
-}
+export const SurveyQuestionType = {
+  Open: 'open',
+  MultipleChoice: 'multiple_choice',
+  SingleChoice: 'single_choice',
+  Rating: 'rating',
+  Link: 'link',
+} as const
+export type SurveyQuestionType = (typeof SurveyQuestionType)[keyof typeof SurveyQuestionType]
 
-export enum SurveyQuestionBranchingType {
-  NextQuestion = 'next_question',
-  End = 'end',
-  ResponseBased = 'response_based',
-  SpecificQuestion = 'specific_question',
-}
+export const SurveyQuestionBranchingType = {
+  NextQuestion: 'next_question',
+  End: 'end',
+  ResponseBased: 'response_based',
+  SpecificQuestion: 'specific_question',
+} as const
+export type SurveyQuestionBranchingType = (typeof SurveyQuestionBranchingType)[keyof typeof SurveyQuestionBranchingType]
 
 export type NextQuestionBranching = {
-  type: SurveyQuestionBranchingType.NextQuestion
+  type: typeof SurveyQuestionBranchingType.NextQuestion
 }
 
 export type EndBranching = {
-  type: SurveyQuestionBranchingType.End
+  type: typeof SurveyQuestionBranchingType.End
 }
 
 export type ResponseBasedBranching = {
-  type: SurveyQuestionBranchingType.ResponseBased
+  type: typeof SurveyQuestionBranchingType.ResponseBased
   responseValues: Record<string, any>
 }
 
 export type SpecificQuestionBranching = {
-  type: SurveyQuestionBranchingType.SpecificQuestion
+  type: typeof SurveyQuestionBranchingType.SpecificQuestion
   index: number
 }
 
@@ -783,20 +792,22 @@ export type SurveyResponses = Record<string, SurveyResponseValue>
 
 export type SurveyCallback = (surveys: Survey[]) => void
 
-export enum SurveyMatchType {
-  Regex = 'regex',
-  NotRegex = 'not_regex',
-  Exact = 'exact',
-  IsNot = 'is_not',
-  Icontains = 'icontains',
-  NotIcontains = 'not_icontains',
-}
+export const SurveyMatchType = {
+  Regex: 'regex',
+  NotRegex: 'not_regex',
+  Exact: 'exact',
+  IsNot: 'is_not',
+  Icontains: 'icontains',
+  NotIcontains: 'not_icontains',
+} as const
+export type SurveyMatchType = (typeof SurveyMatchType)[keyof typeof SurveyMatchType]
 
-export enum SurveySchedule {
-  Once = 'once',
-  Recurring = 'recurring',
-  Always = 'always',
-}
+export const SurveySchedule = {
+  Once: 'once',
+  Recurring: 'recurring',
+  Always: 'always',
+} as const
+export type SurveySchedule = (typeof SurveySchedule)[keyof typeof SurveySchedule]
 
 export type SurveyElement = {
   text?: string
@@ -853,9 +864,9 @@ export type Survey = {
   }
   start_date?: string
   end_date?: string
-  current_iteration?: number
-  current_iteration_start_date?: string
-  schedule?: SurveySchedule
+  current_iteration?: number | null
+  current_iteration_start_date?: string | null
+  schedule?: SurveySchedule | null
 }
 
 export type SurveyActionType = {
@@ -865,11 +876,12 @@ export type SurveyActionType = {
 }
 
 /** Sync with plugin-server/src/types.ts */
-export enum ActionStepStringMatching {
-  Contains = 'contains',
-  Exact = 'exact',
-  Regex = 'regex',
-}
+export const ActionStepStringMatching = {
+  Contains: 'contains',
+  Exact: 'exact',
+  Regex: 'regex',
+} as const
+export type ActionStepStringMatching = (typeof ActionStepStringMatching)[keyof typeof ActionStepStringMatching]
 
 export type ActionStepType = {
   event?: string

package/src/utils/bucketed-rate-limiter.spec.ts

@@ -1,8 +1,45 @@
 import { Logger } from '@/types'
-import { BucketedRateLimiter } from './bucketed-rate-limiter'
+import {
+  BucketedRateLimiter,
+  DEFAULT_EXCEPTION_RATE_LIMITER_BUCKET_SIZE,
+  DEFAULT_EXCEPTION_RATE_LIMITER_REFILL_RATE,
+  resolveExceptionRateLimiterConfig,
+} from './bucketed-rate-limiter'
 
 jest.useFakeTimers()
 
+describe('resolveExceptionRateLimiterConfig', () => {
+  it('falls back to the shared defaults when nothing is configured', () => {
+    expect(resolveExceptionRateLimiterConfig()).toEqual({
+      refillRate: DEFAULT_EXCEPTION_RATE_LIMITER_REFILL_RATE,
+      bucketSize: DEFAULT_EXCEPTION_RATE_LIMITER_BUCKET_SIZE,
+    })
+  })
+
+  it('prefers the first-class options', () => {
+    expect(
+      resolveExceptionRateLimiterConfig({ exceptionRateLimiterRefillRate: 2, exceptionRateLimiterBucketSize: 20 })
+    ).toEqual({ refillRate: 2, bucketSize: 20 })
+  })
+
+  it('honours the deprecated double-underscore options as a fallback', () => {
+    expect(
+      resolveExceptionRateLimiterConfig({ __exceptionRateLimiterRefillRate: 3, __exceptionRateLimiterBucketSize: 30 })
+    ).toEqual({ refillRate: 3, bucketSize: 30 })
+  })
+
+  it('lets the first-class options win over the deprecated ones', () => {
+    expect(
+      resolveExceptionRateLimiterConfig({
+        exceptionRateLimiterRefillRate: 5,
+        __exceptionRateLimiterRefillRate: 3,
+        exceptionRateLimiterBucketSize: 50,
+        __exceptionRateLimiterBucketSize: 30,
+      })
+    ).toEqual({ refillRate: 5, bucketSize: 50 })
+  })
+})
+
 describe('BucketedRateLimiter', () => {
   let rateLimiter: BucketedRateLimiter<string>
 

package/src/utils/bucketed-rate-limiter.ts

@@ -1,9 +1,38 @@
+import type { ExceptionRateLimiterConfig } from '@posthog/types'
 import { Logger } from '../types'
 import { clampToRange } from './number-utils'
 
 type Bucket = { tokens: number; lastAccess: number }
 const ONE_DAY_IN_MS = 86400000
 
+export const DEFAULT_EXCEPTION_RATE_LIMITER_REFILL_RATE = 1
+export const DEFAULT_EXCEPTION_RATE_LIMITER_BUCKET_SIZE = 10
+
+/**
+ * Resolves the error tracking rate limiter's `refillRate` and `bucketSize` from SDK config,
+ * applying the shared defaults. The deprecated double-underscore options are honoured as a
+ * fallback so existing browser SDK configs keep working after the rename.
+ */
+export function resolveExceptionRateLimiterConfig(
+  config: ExceptionRateLimiterConfig & {
+    /** @deprecated use exceptionRateLimiterRefillRate */
+    __exceptionRateLimiterRefillRate?: number
+    /** @deprecated use exceptionRateLimiterBucketSize */
+    __exceptionRateLimiterBucketSize?: number
+  } = {}
+): { refillRate: number; bucketSize: number } {
+  return {
+    refillRate:
+      config.exceptionRateLimiterRefillRate ??
+      config.__exceptionRateLimiterRefillRate ??
+      DEFAULT_EXCEPTION_RATE_LIMITER_REFILL_RATE,
+    bucketSize:
+      config.exceptionRateLimiterBucketSize ??
+      config.__exceptionRateLimiterBucketSize ??
+      DEFAULT_EXCEPTION_RATE_LIMITER_BUCKET_SIZE,
+  }
+}
+
 export class BucketedRateLimiter<T extends string | number> {
   private _bucketSize: number
   private _refillRate: number

package/src/utils/type-utils.ts

@@ -6,7 +6,6 @@ import {
 } from '../types'
 import { includes } from './string-utils'
 
-// eslint-disable-next-line posthog-js/no-direct-array-check
 const nativeIsArray = Array.isArray
 const ObjProto = Object.prototype
 export const hasOwnProperty = ObjProto.hasOwnProperty
@@ -22,7 +21,6 @@ export const isArray =
 // fails on only one very rare and deliberate custom object:
 // let bomb = { toString : undefined, valueOf: function(o) { return "function BOMBA!"; }};
 export const isFunction = (x: unknown): x is (...args: any[]) => any => {
-  // eslint-disable-next-line posthog-js/no-direct-function-check
   return typeof x === 'function'
 }
 
@@ -53,9 +51,7 @@ export const isString = (x: unknown): x is string => {
 }
 
 export const isEmptyString = (x: unknown): boolean => isString(x) && x.trim().length === 0
-
 export const isNull = (x: unknown): x is null => {
-  // eslint-disable-next-line posthog-js/no-direct-null-check
   return x === null
 }
 
@@ -66,7 +62,6 @@ export const isNull = (x: unknown): x is null => {
 export const isNullish = (x: unknown): x is null | undefined => isUndefined(x) || isNull(x)
 
 export const isNumber = (x: unknown): x is number => {
-  // eslint-disable-next-line posthog-js/no-direct-number-check
   // x !== x is true only for NaN (ES5-compatible NaN check)
   return toString.call(x) == '[object Number]' && x === x
 }
@@ -76,7 +71,6 @@ export const isPositiveNumber = (value: unknown): value is number => {
 }
 
 export const isBoolean = (x: unknown): x is boolean => {
-  // eslint-disable-next-line posthog-js/no-direct-boolean-check
   return toString.call(x) === '[object Boolean]'
 }