feat: improve type checking of the default variant identifier using `…

…NoInfer` utility type
mateuszkulpa · Mar 24, 2024 · 27e2e19 · 27e2e19
1 parent 56e1d3c
commit 27e2e19
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 12 deletions.
diff --git a/src/runtime/components/ABTest.vue b/src/runtime/components/ABTest.vue
@@ -1,22 +1,22 @@
-<script setup lang="ts" generic="TVariantValue extends JSONValue">
+<script setup lang="ts" generic="TVariantKey extends string, TVariantValue extends JSONValue">
 import { useABTest } from '../composables/useABTest'
 import type { JSONValue, Variant } from '../types'
 import { useSlots } from '#imports'
 
 const props = withDefaults(
   defineProps<{
     id: string
-    variants: Variant<TVariantValue>[]
+    variants: Variant<TVariantKey, TVariantValue>[]
     enabled?: boolean
-    default?: string
+    default?: NoInfer<TVariantKey>
   }>(),
   {
     enabled: undefined,
     default: undefined,
   }
 )
 
-const { result } = useABTest<TVariantValue>({
+const { result } = useABTest({
   id: props.id,
   variants: props.variants,
   enabled: props.enabled,

diff --git a/src/runtime/composables/useABTest.ts b/src/runtime/composables/useABTest.ts
@@ -4,8 +4,8 @@ import { resolveABTestVariant } from '../core/variants'
 
 const STORAGE_KEY_PREFIX = 'ab-test'
 
-export function useABTest<TVariantValue extends JSONValue>(
-  abTest: ABTest<TVariantValue>
+export function useABTest<TVariantKey extends string, TVariantValue extends JSONValue>(
+  abTest: ABTest<TVariantKey, TVariantValue>
 ): ABTestResult<TVariantValue> {
   const storageId = `${STORAGE_KEY_PREFIX}:${abTest.id}`
 

diff --git a/src/runtime/core/variants.ts b/src/runtime/core/variants.ts
@@ -1,7 +1,7 @@
 import type { ABTest, ABTestResult, JSONValue } from '~/src/runtime/types'
 
 export function resolveABTestVariant<TVariantValue extends JSONValue>(
-  abTest: ABTest<TVariantValue>
+  abTest: ABTest<string, TVariantValue>
 ): ABTestResult<TVariantValue> {
   if (abTest.variants.every(variant => variant.weight === undefined)) {
     return {

diff --git a/src/runtime/types/index.ts b/src/runtime/types/index.ts
@@ -14,8 +14,8 @@ export interface JSONObject {
 }
 export type JSONArray = JSONValue[]
 
-export interface Variant<TVariantValue extends JSONValue> {
-  id: string
+export interface Variant<TVariantKey extends string, TVariantValue extends JSONValue> {
+  id: TVariantKey
   value: TVariantValue
   weight?: number
 }
@@ -39,9 +39,12 @@ export type ABTestResult<TVariantValue extends JSONValue> =
   | ABTestResultEnabled<TVariantValue>
   | ABTestResultDisabled<TVariantValue>
 
-export interface ABTest<TVariantValue extends JSONValue = JSONValue> {
+export interface ABTest<
+  TVariantKey extends string = string,
+  TVariantValue extends JSONValue = JSONValue,
+> {
   id: string
-  variants: Variant<TVariantValue>[]
+  variants: Variant<TVariantKey, TVariantValue>[]
   /**
    * Indicates whether the A/B test is enabled or not.
    * By default, the test is considered to be enabled.
@@ -53,5 +56,5 @@ export interface ABTest<TVariantValue extends JSONValue = JSONValue> {
    * The id of the default variant to use when the test is not enabled (`enabled` is `false`).
    * This property is required when `enabled` is `false` to specify which variant should be considered the default.
    */
-  default?: string
+  default?: NoInfer<TVariantKey>
 }
diff --git a/test/variants.test.ts b/test/variants.test.ts
@@ -58,4 +58,19 @@ describe('useABTest', () => {
 
     expect(result).toEqual({ enabled: false, result: undefined })
   })
+
+  test("doesn't return default value when default is wrong identifier", () => {
+    const result = useABTest({
+      id: 'test-id',
+      variants: [
+        { id: 'a', value: 'a' },
+        { id: 'b', value: 'b' },
+      ],
+      enabled: false,
+      // @ts-expect-error
+      default: 'c',
+    })
+
+    expect(result).toEqual({ enabled: false, result: undefined })
+  })
 })