@astral/mobx-query 1.19.0 → 1.19.1

package/README.md

@@ -46,7 +46,7 @@
     - [Кастомная установка ключей кэширования](#кастомная-установка-ключей-кэширования)
   - [Фоновая загрузка данных QuerySet и InfiniteQuerySet](#фоновая-загрузка-данных-queryset-и-infinitequeryset)
   - [Изменение кэша QuerySet и InfiniteQuerySet](#изменение-кэша-queryset-и-infinitequeryset)
-  - [Тестирование QuerySet и InfiniteQuerySet](#тестирование-queryset-и-infinitequeryset)
+  - [Тестирование](#тестирование)
 - [Core](#core)
 
 ## Installation
@@ -935,7 +935,9 @@ docsFetcher.queries.document.createWithConfig({
   }
 ```
 
-## Тестирование Fetcher на сонове QuerySet и InfiniteQuerySet.
+## Тестирование
+
+### Реализация `mockFetcher` (один раз в проекте)
 
 Для мокинга QuerySet и InfiniteQuerySet необходимо использовать mock следующего вида:
 ```ts
@@ -948,92 +950,73 @@ type Fetcher = {
 const mockFetcher = <TFetcher extends Fetcher>(config: DeepPartial<TFetcher>) => config as TFetcher;
 ```
 
-**Не используйте 'vitest-mock-extended' для мокинга Fetcher.**
-Причина: `vitest-mock-extended` оборачивает объект в Proxy, что нарушает работу Mobx.
+**Не используйте `vitest-mock-extended` для мокинга Fetcher.**
+Причина: `vitest-mock-extended` нарушает работу Mobx.
 
-### Тестирование с включенным ```enabledAutoFetch```
+### 1 тест - 1 mobx-query instance
 
-```MobxQuery``` инициализируется с параметром: ```enabledAutoFetch```:
 ```ts
-const createMobxQuery = () => new MobxQuery({
-  enabledAutoFetch: true,
-});
+const setup = () => {
+  const mobxQuery = createMobxQuery();
+
+  const booksFetcherMock = mockFetcher<BooksFetcher>({
+    queries: {
+      list: mobxQuery.createQuerySet(...),
+    },
+  });
+}
 ```
 
-```booksFetcher.ts```
+### Mock Query, Mutation
+
+Для определения queries, mutations использовать соответствующие методы mobxQuery:
 ```ts
-export const booksFetcher = {
+const booksFetcherMock = mockFetcher<BooksFetcher>({
   queries: {
-    bookList: mobxQuery.createQuerySet((params: BooksDTO.BookListInput) => ({
-      execute: () => booksEndpoint.getBookList(params),
+    bookList: mobxQuery.createQuerySet((filters) => ({
+      execute: async () => fakeBookList,
     })),
   },
-};
-
-export type BooksFetcher = typeof booksFetcher;
-```
-
-```BooksListStore``` - использует `BooksFetcher` для получения данных:
-```ts
-class BooksListStore {
-  public sort?: SortData;
-
-  constructor(private readonly _booksFetcher: BooksFetcher) {
-    makeAutoObservable(this);
-  }
-
-  private get listQuery() {
-    return this._booksFetcher.queries.bookList.create(this.sort);
+  mutations: {
+    createBook: mobxQuery.createMutation(async (book) => undefined),
   }
+});
+```
 
-  public get list(): ListItem[] {
-    const data = this.listQuery.data || [];
+### Mock InfiniteQuery
 
-    return data.map(({ id, name, price }) => ({
-      id,
-      name,
-      price: formatPriceToView(price),
-    }));
+Для определения `InfiniteQueries` использовать `createInfiniteQuerySet`:
+```ts
+const booksFetcherMock = mockFetcher<BooksFetcher>({
+  infiniteQueries: {
+    bookList: mobxQuery.createInfiniteQuerySet(
+      (filters) => ({
+        execute: ({ offset, count }) => fakeBookList,
+      }),
+    ),
   }
-}
+});
 ```
 
-Тест ```BooksListStore```:
+### Ожидание|триггер запроса данных при `enabledAutoFetch` (дефолтное поведение)
 
 ```ts
 import { when } from 'mobx';
-import { mockCacheGroups } from '@astral/mobx-query-vitest-mock';
-
-describe('BooksListStore', () => {
-  it('Список книг форматируется для отображения', async () => {
-    // Для каждого теста необходимо инициализировать свой instance MobxQuery,
-    // в противном случае каждый тест будет модифицировать кэш
-    const mobxQuery = createMobxQuery();
-
-    const fakeBookList = makeFakeBookList(2, { price: 1000 });
-    const fakeBookListItem = fakeBookList.data[0];
-
-   const booksFetcherMock = mockFetcher<BooksFetcher>({
-      queries: {
-        bookList: () => mobxQuery.createQuerySet(() => ({
-          execute: async () => fakeBookList,
-        })),
-      },
-    });
 
-    const sut = new BooksListStore(booksFetcherMock);
+const booksFetcherMock = mockFetcher<BooksFetcher>({
+  queries: {
+    bookList: mobxQuery.createQuerySet((filters) => ({
+      execute: async () => fakeBookList,
+    })),
+  },
+});
 
-    // Ждем автоматической загрузки данных
-    // Загрузка данных начнется автоматически при обращении к sut.list за счет параметра enabledAutoFetch
-    await when(() => Boolean(sut.list?.length));
+const sut = new Store(booksFetcherMock);
 
-    expect(sut.list[0]).toEqual({
-      id: fakeBookListItem.id,
-      name: fakeBookListItem.name,
-      price: '1 000 руб.',
-    });
-  });
-});
+// Обращаемся к data из query -> триггер запроса данных -> ожидаем когда загрузятся данные
+await when(() => Boolean(sut.data));
+
+expect(sut.status.isSuccess).toBe(true);
 ```
 
 ## Core

package/package.json

@@ -10,7 +10,7 @@
   "peerDependencies": {
     "mobx": "^6.0.0"
   },
-  "version": "1.19.0",
+  "version": "1.19.1",
   "author": "Astral.Soft",
   "license": "MIT",
   "repository": {