@potok-web-framework/core 0.1.0

package/tests/signals.test.ts

@@ -0,0 +1,403 @@
+import { test, expect, mock } from 'bun:test'
+import {
+  batch,
+  createDisposer,
+  createEffect,
+  createSignal,
+  deepTrack,
+  untrack,
+} from '@/signals'
+
+test('сигнал сохраняет значение и вызывает эффекты при изменении', () => {
+  const signal = createSignal({ count: 1 })
+
+  // Проверка начального значения
+  expect(signal.count).toBe(1)
+
+  const spyFn = mock(() => {
+    signal.count
+  })
+
+  // Создаём эффект, подписанный на signal.count
+  createEffect(spyFn)
+
+  // Эффект вызывается при инициализации
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Изменение значения вызывает эффект
+  signal.count = 2
+  expect(signal.count).toBe(2)
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Установка нового значения снова вызывает эффект
+  signal.count = 3
+  expect(signal.count).toBe(3)
+  expect(spyFn).toHaveBeenCalledTimes(3)
+})
+
+test('эффект вызывается даже при установке сигнала в то же значение', () => {
+  const signal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    signal.count
+  })
+
+  createEffect(spyFn)
+
+  // Эффект должен вызваться при инициализации
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Установка нового значения вызывает эффект
+  signal.count = 2
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Установка снова того же значения вызывает эффект
+  signal.count = 2
+  expect(spyFn).toHaveBeenCalledTimes(3)
+})
+
+test('эффект реагирует на изменения всех сигналов, на которые он подписан', () => {
+  const firstSignal = createSignal({ count: 1 })
+  const secondSignal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    firstSignal.count
+    secondSignal.count
+  })
+
+  createEffect(spyFn)
+
+  // Эффект вызывается сразу при инициализации
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Изменение первого сигнала
+  firstSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Изменение второго сигнала
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(3)
+})
+
+test('все эффекты, подписанные на один сигнал, вызываются при изменении', () => {
+  const signal = createSignal({ count: 1 })
+
+  const firstSpyFn = mock(() => {
+    signal.count
+  })
+
+  const secondSpyFn = mock(() => {
+    signal.count
+  })
+
+  // Создаём два эффекта, подписанных на signal.count
+  createEffect(firstSpyFn)
+  createEffect(secondSpyFn)
+
+  // Оба эффекта вызываются один раз при создании
+  expect(firstSpyFn).toHaveBeenCalledTimes(1)
+  expect(secondSpyFn).toHaveBeenCalledTimes(1)
+
+  // Изменение сигнала вызывает оба эффекта
+  signal.count++
+
+  expect(signal.count).toBe(2)
+  expect(firstSpyFn).toHaveBeenCalledTimes(2)
+  expect(secondSpyFn).toHaveBeenCalledTimes(2)
+})
+
+test('вызывает эффект при изменении значения сигнала по ключу', () => {
+  const signal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    signal.count // Чтение для подписки
+  })
+
+  createEffect(spyFn)
+
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  signal.count++ // Изменение значения
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  signal.count = signal.count // Установка того же значения — всё равно должно вызвать, т.к. мы не проверяем на "одинаковость"
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  signal.count = 100 // Новое значение
+  expect(spyFn).toHaveBeenCalledTimes(4)
+})
+
+test('условная подписка: эффект не вызывается, если сигнал не читался', () => {
+  const firstSignal = createSignal({ count: 1 })
+  const secondSignal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    // Подписка на secondSignal происходит только при выполнении условия
+    if (firstSignal.count < 2) {
+      secondSignal.count
+    }
+  })
+
+  createEffect(spyFn)
+
+  // Первый вызов эффекта
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // secondSignal.count был прочитан (т.к. условие выполнилось), значит подписка есть
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Меняем firstSignal так, чтобы условие не выполнялось => secondSignal больше не читается
+  firstSignal.count = 2
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  // Изменение secondSignal — эффекта не будет, т.к. подписка снята
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  // Возвращаем условие обратно: подписка снова появится
+  firstSignal.count = 1
+  expect(spyFn).toHaveBeenCalledTimes(4)
+
+  // Подписка на secondSignal снова активна
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(5)
+})
+
+test('условная подписка: флаг игнорирования версионирования сохраняет подписку вне зависимости от чтения', () => {
+  const firstSignal = createSignal({ count: 1 })
+  const secondSignal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    // При `firstSignal.count < 2` читаем secondSignal
+    if (firstSignal.count < 2) {
+      secondSignal.count
+    }
+  })
+
+  // Второй аргумент `true` — включаем режим игнорирования версионирования
+  createEffect(spyFn, true)
+
+  // Изначальный запуск
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Подписка активна — изменение secondSignal вызывает эффект
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Условие теперь не выполняется — secondSignal НЕ читается
+  firstSignal.count = 2
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  // Несмотря на то, что secondSignal не был прочитан, эффект всё равно вызывается
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(4)
+
+  // Возвращаем обратно выполнение условия
+  firstSignal.count = 1
+  expect(spyFn).toHaveBeenCalledTimes(5)
+
+  // Подписка всё ещё живая
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(6)
+})
+
+test('эффект вызывается один раз при батчинге нескольких обновлений', () => {
+  const firstSignal = createSignal({ count: 1 })
+  const secondSignal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    firstSignal.count
+    secondSignal.count
+  })
+
+  createEffect(spyFn)
+
+  // Изначально вызывается один раз
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Обновление firstSignal вызывает эффект
+  firstSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Обновление secondSignal вызывает эффект
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  // Два последовательных обновления вызывают эффект дважды
+  firstSignal.count++
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(5)
+
+  // Обновления внутри batch вызывают эффект только один раз
+  batch(() => {
+    firstSignal.count++
+    secondSignal.count++
+  })
+  expect(spyFn).toHaveBeenCalledTimes(6)
+})
+
+test('untrack исключает сигналы из подписки внутри эффекта', () => {
+  const firstSignal = createSignal({ count: 1 })
+  const secondSignal = createSignal({ count: 1 })
+
+  const spyFn = mock(() => {
+    // Читаем firstSignal.count — устанавливаем реактивную подписку на firstSignal
+    firstSignal.count
+
+    // Читаем secondSignal.count внутри untrack — исключаем secondSignal из подписки эффекта
+    return untrack(() => secondSignal.count)
+  })
+
+  createEffect(spyFn)
+
+  // Эффект вызывается один раз при создании — начальная инициализация
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Обновляем firstSignal — т.к. есть подписка, эффект должен вызваться заново
+  firstSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Обновляем secondSignal — эффект НЕ вызывается, потому что secondSignal был прочитан в untrack
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Ещё раз обновляем firstSignal — эффект вызывается
+  firstSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  // Проверяем значение, возвращённое первым вызовом эффекта — secondSignal.count равен 1
+  expect(spyFn.mock.results[0]?.value).toBe(1)
+
+  // Проверяем значение, возвращённое вторым вызовом эффекта — secondSignal.count всё ещё 1,
+  // т.к. мы не подписаны на его изменения
+  expect(spyFn.mock.results[1]?.value).toBe(1)
+
+  // Проверяем значение, возвращённое третьим вызовом эффекта — secondSignal.count равно 2,
+  // т.к. в последнем вызове эффект прочитал значение после обновления firstSignal
+  expect(spyFn.mock.results[2]?.value).toBe(2)
+})
+
+test('deepTrack: реактивность на глубину отслеживания и разные уровни вложенности', () => {
+  const firstSignal = createSignal({
+    object: {
+      nestedObject: {
+        count: 1,
+      },
+    },
+  })
+  const secondSignal = createSignal({
+    object: {
+      nestedObject: {
+        count: 1,
+      },
+    },
+    count: 1,
+  })
+  const thirdSignal = createSignal({
+    object: {
+      nestedObject: {
+        count: 1,
+      },
+    },
+  })
+
+  const spyFn = mock(() => {
+    // Подписка на верхний уровень объекта firstSignal (без глубокой подписки)
+    firstSignal.object
+
+    // Подписка с глубиной 1 — отслеживает изменения только первого уровня в secondSignal
+    deepTrack(secondSignal, 1)
+
+    // Подписка с глубиной по умолчанию (глубокая) — отслеживает изменения на всех уровнях thirdSignal
+    deepTrack(thirdSignal)
+  })
+
+  createEffect(spyFn)
+
+  // Изначальный вызов эффекта
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Изменение вложенного поля первого сигнала не вызывает эффект (глубина подписки 0)
+  firstSignal.object.nestedObject.count++
+  expect(spyFn).toHaveBeenCalledTimes(1)
+
+  // Изменение самого объекта первого сигнала (ссылка) вызывает эффект
+  firstSignal.object = {
+    nestedObject: {
+      count: 2,
+    },
+  }
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Изменение вложенного поля в secondSignal не вызывает эффект (глубина подписки 1)
+  secondSignal.object.nestedObject.count++
+  expect(spyFn).toHaveBeenCalledTimes(2)
+
+  // Изменение поля второго уровня secondSignal (count) вызывает эффект
+  secondSignal.count++
+  expect(spyFn).toHaveBeenCalledTimes(3)
+
+  // Изменение ссылки на объект верхнего уровня secondSignal вызывает эффект
+  secondSignal.object = {
+    nestedObject: {
+      count: 1,
+    },
+  }
+  expect(spyFn).toHaveBeenCalledTimes(4)
+
+  // Изменение вложенного объекта внутри secondSignal.object не вызывает эффект (глубина 1)
+  secondSignal.object.nestedObject = {
+    count: 1,
+  }
+  expect(spyFn).toHaveBeenCalledTimes(4)
+
+  // Изменение вложенного свойства thirdSignal вызывает эффект (глубина подписки глубокая)
+  thirdSignal.object.nestedObject.count++
+  expect(spyFn).toHaveBeenCalledTimes(5)
+
+  // Изменение ссылки на объект верхнего уровня thirdSignal вызывает эффект
+  thirdSignal.object = {
+    nestedObject: {
+      count: 1,
+    },
+  }
+  expect(spyFn).toHaveBeenCalledTimes(6)
+})
+
+test('createDisposer: удаляет все эффекты, созданные внутри области действия', () => {
+  const signal = createSignal({
+    count: 1,
+  })
+
+  const firstSpyFn = mock(() => {
+    signal.count
+  })
+
+  const secondSpyFn = mock(() => {
+    signal.count
+  })
+
+  // Создаём disposer, который регистрирует два эффекта
+  const disposer = createDisposer(() => {
+    createEffect(firstSpyFn)
+    createEffect(secondSpyFn)
+  })
+
+  // Эффекты сразу выполняются один раз при создании
+  expect(firstSpyFn).toHaveBeenCalledTimes(1)
+  expect(secondSpyFn).toHaveBeenCalledTimes(1)
+
+  // Изменение сигнала вызывает оба эффекта повторно
+  signal.count++
+  expect(firstSpyFn).toHaveBeenCalledTimes(2)
+  expect(secondSpyFn).toHaveBeenCalledTimes(2)
+
+  // Отключаем все эффекты, созданные внутри disposer'а
+  disposer.dispose()
+
+  // Изменение сигнала больше не вызывает эффекты
+  signal.count++
+  expect(firstSpyFn).toHaveBeenCalledTimes(2)
+  expect(secondSpyFn).toHaveBeenCalledTimes(2)
+})

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": false,
+    "emitDeclarationOnly": true,
+    "jsx": "preserve",
+    "strict": true,
+    "types": ["bun-types"],
+    "outDir": "dist",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "target": "ESNext",
+    "module": "ESNext"
+  },
+  "include": ["./src/**/*"]
+}

package/vite.config.ts

@@ -0,0 +1,21 @@
+import { defineConfig } from 'vite'
+import dtsPlugin from 'vite-plugin-dts'
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: {
+        index: 'src/exports/index.ts',
+        server: 'src/exports/server.ts',
+        client: 'src/exports/client.ts',
+        'jsx-runtime': 'src/exports/jsx-runtime.ts',
+        hmr: 'src/exports/hmr.ts',
+      },
+      formats: ['es'],
+    },
+    rolldownOptions: {
+      external: ['path', /node:.*/],
+    },
+  },
+  plugins: [dtsPlugin()],
+})