piral-search 1.3.3-beta.6190 → 1.3.3-beta.6204

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-search",
-  "version": "1.3.3-beta.6190",
+  "version": "1.3.3-beta.6204",
   "description": "Plugin for centralizing search in Piral.",
   "keywords": [
     "piral",
@@ -62,8 +62,8 @@
   },
   "devDependencies": {
     "@types/react": "^18.0.0",
-    "piral-core": "1.3.3-beta.6190",
+    "piral-core": "1.3.3-beta.6204",
     "react": "^18.0.0"
   },
-  "gitHead": "dc3358f0e08b06acea2056b612f268334a8c49c8"
+  "gitHead": "8a1fa7b847b0e146a5bdb8e0497c436fffe4fd4d"
 }

package/src/actions.test.ts

@@ -1,8 +1,37 @@
+/**
+ * @vitest-environment jsdom
+ */
 import create from 'zustand';
-import { createListener } from 'piral-base';
-import { createActions } from 'piral-core';
+import { describe, it, expect, vitest } from 'vitest';
 import { createActions as createSearchActions } from './actions';
 
+function createListener() {
+  return {
+    on: vitest.fn(),
+    off: vitest.fn(),
+    emit: vitest.fn(),
+  };
+}
+
+function createActions(state, listener) {
+  const obj = {
+    ...listener,
+    state: state.getState(),
+    defineActions(actions) {
+      Object.entries(actions).forEach(([name, cb]) => {
+        obj[name] = (cb as any).bind(obj, obj);
+      });
+    },
+    readState(select) {
+      return select(state.getState());
+    },
+    dispatch(change) {
+      state.setState(change(state.getState()));
+    },
+  };
+  return obj;
+}
+
 const state = {
   search: {
     input: 'abc',
@@ -25,7 +54,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.appendSearchResults(['a', 'b'], false);
     expect(state.getState()).toEqual({
@@ -51,7 +80,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.appendSearchResults(['a'], true);
     expect(state.getState()).toEqual({
@@ -77,7 +106,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.prependSearchResults(['a', 'b'], false);
     expect(state.getState()).toEqual({
@@ -103,7 +132,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.prependSearchResults(['a'], true);
     expect(state.getState()).toEqual({
@@ -129,7 +158,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.resetSearchResults('yo', true);
     expect(state.getState()).toEqual({
@@ -155,7 +184,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.resetSearchResults('yo y', false);
     expect(state.getState()).toEqual({
@@ -181,7 +210,7 @@ describe('Search Action Module', () => {
         },
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.setSearchInput('test input');
     expect(state.getState()).toEqual({
@@ -199,7 +228,7 @@ describe('Search Action Module', () => {
   it('immediately resets with loading false if some value is given but no provider found', () => {
     state.search.input = 'foo';
     const globalState: any = create(() => state);
-    const ctx = createActions(globalState, createListener({}));
+    const ctx = createActions(globalState, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     expect(globalState.getState().search.results.loading).toBe(false);
@@ -215,7 +244,7 @@ describe('Search Action Module', () => {
       cancel() {},
     };
     const globalState: any = create(() => state);
-    const ctx = createActions(globalState, createListener({}));
+    const ctx = createActions(globalState, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     expect(globalState.getState().search.results.loading).toBe(true);
@@ -224,7 +253,7 @@ describe('Search Action Module', () => {
   it('immediately resets with loading false if no value is given implicitly', () => {
     state.search.input = '';
     const globalState: any = create(() => state);
-    const ctx = createActions(globalState, createListener({}));
+    const ctx = createActions(globalState, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     expect(globalState.getState().search.results.loading).toBe(false);
@@ -232,7 +261,7 @@ describe('Search Action Module', () => {
 
   it('immediately resets with loading false if no value is given explicitly', () => {
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     const dispose = ctx.triggerSearch('');
     dispose();
@@ -241,7 +270,7 @@ describe('Search Action Module', () => {
 
   it('immediately resets with loading false if no value is given explicitly though immediate', () => {
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     const dispose = ctx.triggerSearch('', true);
     dispose();
@@ -258,23 +287,23 @@ describe('Search Action Module', () => {
       cancel() {},
     };
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch('foo');
     expect(gs.getState().search.results.loading).toBe(true);
   });
 
   it('walks over all search providers', () => {
-    const search = jest.fn(() => Promise.resolve([]));
-    const clear = jest.fn();
-    const cancel = jest.fn();
+    const search = vitest.fn(() => Promise.resolve([]));
+    const clear = vitest.fn();
+    const cancel = vitest.fn();
     state.search.input = 'test';
     state.registry.searchProviders = {
       foo: { search, clear, cancel },
       bar: { search, clear, cancel },
     };
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     expect(search).toHaveBeenCalledTimes(2);
@@ -292,14 +321,14 @@ describe('Search Action Module', () => {
       },
     };
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     await (state.registry.searchProviders as any).foo.search().catch((m) => m);
   });
 
   it('stops existing search', async () => {
-    const cancel = jest.fn();
+    const cancel = vitest.fn();
     state.search.input = 'test';
     state.registry.searchProviders = {
       foo: {
@@ -311,7 +340,7 @@ describe('Search Action Module', () => {
       },
     };
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     await (state.registry.searchProviders as any).foo.search().catch((m) => m);
@@ -319,7 +348,7 @@ describe('Search Action Module', () => {
   });
 
   it('cancels existing search', async () => {
-    const cancel = jest.fn();
+    const cancel = vitest.fn();
     state.search.input = 'test';
     state.registry.searchProviders = {
       foo: {
@@ -331,7 +360,7 @@ describe('Search Action Module', () => {
       },
     };
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     const dispose = ctx.triggerSearch();
     dispose();
@@ -340,7 +369,7 @@ describe('Search Action Module', () => {
   });
 
   it('catches any emitted exceptions', async () => {
-    console.warn = jest.fn();
+    console.warn = vitest.fn();
     state.search.input = 'test';
     state.registry.searchProviders = {
       foo: {
@@ -352,7 +381,7 @@ describe('Search Action Module', () => {
       },
     };
     const gs: any = create(() => state);
-    const ctx = createActions(gs, createListener({}));
+    const ctx = createActions(gs, createListener());
     ctx.defineActions(createSearchActions());
     ctx.triggerSearch();
     await (state.registry.searchProviders as any).foo.search().catch((m) => m);
@@ -367,7 +396,7 @@ describe('Search Action Module', () => {
         searchProviders: {},
       },
     }));
-    const ctx = createActions(state, createListener({}));
+    const ctx = createActions(state, createListener());
     ctx.defineActions(createSearchActions());
     ctx.registerSearchProvider('foo', 10 as any);
     expect(state.getState()).toEqual({

package/src/create.test.ts

@@ -1,4 +1,8 @@
+/**
+ * @vitest-environment jsdom
+ */
 import create from 'zustand';
+import { describe, it, expect, vitest } from 'vitest';
 import { createSearchApi } from './create';
 
 function createMockContainer() {
@@ -10,9 +14,9 @@ function createMockContainer() {
   }));
   return {
     context: {
-      on: jest.fn(),
-      off: jest.fn(),
-      emit: jest.fn(),
+      on: vitest.fn(),
+      off: vitest.fn(),
+      emit: vitest.fn(),
       defineActions() {},
       state,
       readState(cb) {
@@ -41,8 +45,8 @@ const moduleMetadata = {
 describe('Create Search API Extensions', () => {
   it('createCoreApi can register and unregister a search provider', () => {
     const container = createMockContainer();
-    container.context.registerSearchProvider = jest.fn();
-    container.context.unregisterSearchProvider = jest.fn();
+    container.context.registerSearchProvider = vitest.fn();
+    container.context.unregisterSearchProvider = vitest.fn();
     const api = (createSearchApi()(container.context) as any)(container.api, moduleMetadata);
     api.registerSearchProvider('my-sp', () => Promise.resolve([]));
     expect(container.context.registerSearchProvider).toHaveBeenCalledTimes(1);
@@ -56,10 +60,10 @@ describe('Create Search API Extensions', () => {
 
   it('createCoreApi registration of a search provider wraps it', () => {
     const container = createMockContainer();
-    container.context.registerSearchProvider = jest.fn();
-    container.context.unregisterSearchProvider = jest.fn();
+    container.context.registerSearchProvider = vitest.fn();
+    container.context.unregisterSearchProvider = vitest.fn();
     const api = (createSearchApi()(container.context) as any)(container.api, moduleMetadata);
-    const search = jest.fn();
+    const search = vitest.fn();
     api.registerSearchProvider('my-sp', search);
     container.context.registerSearchProvider.mock.calls[0][1].search('foo');
     expect(search).toHaveBeenCalledWith('foo', container.api);

package/src/useDebounce.test.ts

@@ -1,12 +1,16 @@
+/**
+ * @vitest-environment jsdom
+ */
 import * as React from 'react';
+import { describe, it, expect, vitest } from 'vitest';
 import { useDebounce } from './useDebounce';
 
-jest.mock('react');
+vitest.mock('react');
 
 describe('Debounce Hook Module', () => {
   it('just returns initial value if nothing has been changed', () => {
-    const usedEffect = jest.fn();
-    const usedState = jest.fn((value) => [value]);
+    const usedEffect = vitest.fn();
+    const usedState = vitest.fn((value) => [value]);
     (React as any).useState = usedState;
     (React as any).useEffect = usedEffect;
     const result = useDebounce('foo');
@@ -16,9 +20,9 @@ describe('Debounce Hook Module', () => {
   });
 
   it('invokes useEffect immediately, but does not set value immediately', () => {
-    const usedEffect = jest.fn((fn) => fn());
-    const setValue = jest.fn();
-    const usedState = jest.fn((value) => [value, setValue]);
+    const usedEffect = vitest.fn((fn) => fn());
+    const setValue = vitest.fn();
+    const usedState = vitest.fn((value) => [value, setValue]);
     (React as any).useState = usedState;
     (React as any).useEffect = usedEffect;
     useDebounce('foo');
@@ -26,42 +30,42 @@ describe('Debounce Hook Module', () => {
   });
 
   it('invokes useEffect immediately, but sets value immediately if 0', () => {
-    jest.useFakeTimers();
-    const usedEffect = jest.fn((fn) => fn());
-    const setValue = jest.fn();
-    const usedState = jest.fn((value) => [value, setValue]);
+    vitest.useFakeTimers();
+    const usedEffect = vitest.fn((fn) => fn());
+    const setValue = vitest.fn();
+    const usedState = vitest.fn((value) => [value, setValue]);
     (React as any).useState = usedState;
     (React as any).useEffect = usedEffect;
     useDebounce('foo', 0);
-    jest.advanceTimersByTime(0);
+    vitest.advanceTimersByTime(0);
     expect(setValue).toHaveBeenCalled();
   });
 
   it('invokes useEffect immediately, but sets value after wait time', () => {
-    jest.useFakeTimers();
-    const usedEffect = jest.fn((fn) => fn());
-    const setValue = jest.fn();
-    const usedState = jest.fn((value) => [value, setValue]);
+    vitest.useFakeTimers();
+    const usedEffect = vitest.fn((fn) => fn());
+    const setValue = vitest.fn();
+    const usedState = vitest.fn((value) => [value, setValue]);
     (React as any).useState = usedState;
     (React as any).useEffect = usedEffect;
     expect(setValue).not.toHaveBeenCalled();
     useDebounce('foo', 300);
-    jest.advanceTimersByTime(300);
+    vitest.advanceTimersByTime(300);
     expect(setValue).toHaveBeenCalled();
   });
 
   it('invokes useEffect immediately and resets timer if needed', () => {
-    jest.useFakeTimers();
-    const usedEffect = jest.fn((fn) => fn());
-    const setValue = jest.fn();
-    const usedState = jest.fn((value) => [value, setValue]);
+    vitest.useFakeTimers();
+    const usedEffect = vitest.fn((fn) => fn());
+    const setValue = vitest.fn();
+    const usedState = vitest.fn((value) => [value, setValue]);
     (React as any).useState = usedState;
     (React as any).useEffect = usedEffect;
     expect(setValue).not.toHaveBeenCalled();
     useDebounce('foo', 300);
-    jest.advanceTimersByTime(250);
+    vitest.advanceTimersByTime(250);
     usedEffect.mock.results[0].value();
-    jest.advanceTimersByTime(50);
+    vitest.advanceTimersByTime(50);
     expect(setValue).not.toHaveBeenCalled();
   });
 });

package/src/useSearch.test.ts

@@ -1,4 +1,8 @@
+/**
+ * @vitest-environment jsdom
+ */
 import * as React from 'react';
+import { describe, it, expect, vitest } from 'vitest';
 
 const state = {
   search: {
@@ -10,63 +14,85 @@ const state = {
 };
 
 const availableActions = {
-  setSearchInput: jest.fn(),
-  triggerSearch: jest.fn(),
+  setSearchInput: vitest.fn(),
+  triggerSearch: vitest.fn(),
 };
 
-const useGlobalState = jest.fn((select: any) => select(state));
-const useActions = jest.fn(() => availableActions);
-const useDebounce = jest.fn((value) => value);
+const useGlobalState = vitest.fn((select: any) => select(state));
+const useActions = vitest.fn(() => availableActions);
+const useDebounce = vitest.fn((value) => value);
 
-jest.mock('piral-core', () => ({
-  ...jest.requireActual('piral-core'),
+vitest.mock('piral-core', async () => ({
+  ...((await vitest.importActual('piral-core')) as any),
   useGlobalState,
   useActions,
 }));
 
-jest.mock('./useDebounce.ts', () => ({
+vitest.mock('./useDebounce.ts', () => ({
   useDebounce,
 }));
 
+vitest.mock('react');
+
+const testOptions = {
+  timeout: 30000,
+};
+
 describe('Search Hook Module', () => {
-  it('just returns current input value', () => {
-    const { useSearch } = require('./useSearch');
-    const usedEffect = jest.fn();
-    (React as any).useEffect = usedEffect;
-    (React as any).useRef = (current) => ({ current });
-    const [value] = useSearch();
-    expect(value).toBe('abc');
-  });
+  it(
+    'just returns current input value',
+    async () => {
+      const { useSearch } = await import('./useSearch');
+      const usedEffect = vitest.fn();
+      (React as any).useEffect = usedEffect;
+      (React as any).useRef = (current) => ({ current });
+      const [value] = useSearch();
+      expect(value).toBe('abc');
+    },
+    testOptions,
+  );
 
-  it('sets the value using the action', () => {
-    const { useSearch } = require('./useSearch');
-    const usedEffect = jest.fn();
-    (React as any).useEffect = usedEffect;
-    (React as any).useRef = (current) => ({ current });
-    (React as any).useState = (initial) => [initial, jest.fn()];
-    const [_, setValue] = useSearch();
-    setValue('foo');
-    expect(availableActions.setSearchInput).toHaveBeenCalledWith('foo');
-  });
+  it(
+    'sets the value using the action',
+    async () => {
+      const { useSearch } = await import('./useSearch');
+      const usedEffect = vitest.fn();
+      (React as any).useEffect = usedEffect;
+      (React as any).useRef = (current) => ({ current });
+      (React as any).useState = (initial) => [initial, vitest.fn()];
+      const [_, setValue] = useSearch();
+      setValue('foo');
+      expect(availableActions.setSearchInput).toHaveBeenCalledWith('foo');
+    },
+    testOptions,
+  );
 
-  it('triggers the search without immediate mode', () => {
-    const { useSearch } = require('./useSearch');
-    const usedEffect = jest.fn((fn) => fn());
-    (React as any).useEffect = usedEffect;
-    (React as any).useRef = (current) => ({ current });
-    (React as any).useState = (initial) => [initial, jest.fn()];
-    useSearch();
-    expect(availableActions.triggerSearch).toHaveBeenCalledWith('abc', false);
-  });
+  it(
+    'triggers the search without immediate mode',
+    async () => {
+      const { useSearch } = await import('./useSearch');
+      const usedEffect = vitest.fn((fn) => fn());
+      (React as any).useEffect = usedEffect;
+      (React as any).useRef = (current) => ({ current });
+      (React as any).useState = (initial) => [initial, vitest.fn()];
+      useSearch();
+      expect(availableActions.triggerSearch).toHaveBeenCalledWith('abc', false);
+    },
+    testOptions,
+  );
 
-  it('cancels the current search', () => {
-    const { useSearch } = require('./useSearch');
-    const usedEffect = jest.fn((fn) => fn());
-    const cancel = jest.fn();
-    (React as any).useEffect = usedEffect;
-    (React as any).useRef = (_) => ({ current: cancel });
-    (React as any).useState = (initial) => [initial, jest.fn()];
-    useSearch();
-    expect(cancel).toHaveBeenCalledTimes(1);
-  });
+  it(
+    'cancels the current search',
+    async () => {
+      const { useSearch } = await import('./useSearch');
+      const usedEffect = vitest.fn((fn) => fn());
+      const cancel = vitest.fn();
+      (React as any).useEffect = usedEffect;
+      (React as any).useRef = (_) => ({ current: cancel });
+      (React as any).useState = (initial) => [initial, vitest.fn()];
+      useSearch();
+      expect(cancel).toHaveBeenCalledTimes(1);
+    },
+    testOptions,
+  );
 });