feat: mutation for item publish

Author: louisewang1

src/api/index.ts

@@ -14,3 +14,4 @@ export * from './itemLike';
 export * from './itemValidation';
 export * from './action';
 export * from './invitation';
+export * from './itemPublish';

src/api/itemPublish.ts

@@ -0,0 +1,17 @@
+import { QueryClientConfig, UUID } from '../types';
+import configureAxios, { verifyAuthentication } from './axios';
+import { buildItemPublishRoute } from './routes';
+
+const axios = configureAxios();
+
+/* eslint-disable import/prefer-default-export */
+export const publishItem = async (
+  id: UUID,
+  notification: boolean,
+  { API_HOST }: QueryClientConfig,
+) =>
+  verifyAuthentication(() =>
+    axios
+      .get(`${API_HOST}/${buildItemPublishRoute(id, notification)}`)
+      .then(({ data }) => data),
+    );

src/api/routes.ts

@@ -277,6 +277,9 @@ export const buildPostInvitationsRoute = (itemId: UUID) =>
 export const buildResendInvitationRoute = (args: { itemId: UUID; id: UUID }) =>
   `${ITEMS_ROUTE}/${args.itemId}/${INVITATIONS_ROUTE}/${args.id}/send`;
 
+export const buildItemPublishRoute = (itemId: UUID, notification: boolean) =>
+  `${ITEMS_ROUTE}/${itemId}/publish${qs.stringify(notification)}`;
+
 export const API_ROUTES = {
   APPS_ROUTE,
   ITEMS_ROUTE,

src/config/keys.ts

@@ -233,4 +233,5 @@ export const MUTATION_KEYS = {
   PATCH_INVITATION: 'patchInvitation',
   DELETE_INVITATION: 'deleteInvitation',
   RESEND_INVITATION: 'resendInvitation',
+  PUBLISH_ITEM: 'publishItem',
 };

src/mutations/index.ts

@@ -14,6 +14,7 @@ import itemValidationMutations from './itemValidation';
 import actionMutations from './action';
 import invitationMutations from './invitation';
 import authenticationMutations from './authentication';
+import itemPublishMutations from './itemPublish';
 
 const configureMutations = (
   queryClient: QueryClient,
@@ -33,6 +34,7 @@ const configureMutations = (
   actionMutations(queryClient, queryConfig);
   invitationMutations(queryClient, queryConfig);
   authenticationMutations(queryClient, queryConfig);
+  itemPublishMutations(queryClient, queryConfig);
 };
 
 export default configureMutations;

src/mutations/itemPublish.test.ts

@@ -0,0 +1,101 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import nock from 'nock';
+import Cookies from 'js-cookie';
+import { act } from 'react-test-renderer';
+import { StatusCodes } from 'http-status-codes';
+import { mockMutation, setUpTest, waitForMutation } from '../../test/utils';
+import { REQUEST_METHODS } from '../api/utils';
+import { buildItemTagsKey, MUTATION_KEYS } from '../config/keys';
+import {
+  buildItemPublishRoute,
+} from '../api/routes';
+import { publishItemRoutine } from '../routines';
+import { ITEMS, ITEM_TAGS, UNAUTHORIZED_RESPONSE } from '../../test/constants';
+
+const mockedNotifier = jest.fn();
+const { wrapper, queryClient, useMutation } = setUpTest({
+  notifier: mockedNotifier,
+});
+
+jest.spyOn(Cookies, 'get').mockReturnValue({ session: 'somesession' });
+
+describe('Publish Item', () => {
+  afterEach(() => {
+    queryClient.clear();
+    nock.cleanAll();
+  });
+
+  describe(MUTATION_KEYS.PUBLISH_ITEM, () => {
+    const item = ITEMS[0];
+    const itemId = item.id;
+    const notification = true;
+    const route = `/${buildItemPublishRoute(itemId, notification)}`;
+    const mutation = () => useMutation(MUTATION_KEYS.PUBLISH_ITEM);
+    const itemTagKey = buildItemTagsKey(itemId);
+
+    it('Publish Item', async () => {
+      queryClient.setQueryData(itemTagKey, ITEM_TAGS);
+
+      const endpoints = [
+        {
+          response: { item },
+          method: REQUEST_METHODS.GET,
+          route,
+        },
+      ];
+
+      const mockedMutation = await mockMutation({
+        endpoints,
+        mutation,
+        wrapper,
+      });
+
+      await act(async () => {
+        await mockedMutation.mutate({
+          id: itemId,
+          notification,
+        });
+        await waitForMutation();
+      });
+
+      expect(queryClient.getQueryState(itemTagKey)?.isInvalidated).toBeTruthy();
+      expect(mockedNotifier).toHaveBeenCalledWith({
+        type: publishItemRoutine.SUCCESS,
+      });
+    });
+
+    it('Unauthorized to publish item', async () => {
+      queryClient.setQueryData(itemTagKey, ITEM_TAGS);
+
+      const endpoints = [
+        {
+          response: UNAUTHORIZED_RESPONSE,
+          statusCode: StatusCodes.UNAUTHORIZED,
+          method: REQUEST_METHODS.GET,
+          route,
+        },
+      ];
+
+      const mockedMutation = await mockMutation({
+        endpoints,
+        mutation,
+        wrapper,
+      });
+
+      await act(async () => {
+        await mockedMutation.mutate({
+          id: itemId,
+          notification,
+        });
+        await waitForMutation();
+      });
+
+     // expect(queryClient.getQueryState(itemTagKey)?.isInvalidated).toBeTruthy();
+      expect(mockedNotifier).toHaveBeenCalledWith(
+        expect.objectContaining({
+          type: publishItemRoutine.FAILURE,
+        }),
+      );
+    });
+  });
+});

src/mutations/itemPublish.ts

@@ -0,0 +1,25 @@
+import { QueryClient } from 'react-query';
+import * as Api from '../api';
+import { MUTATION_KEYS, buildItemTagsKey } from '../config/keys';
+import { publishItemRoutine } from '../routines';
+import { QueryClientConfig } from '../types';
+
+export default (queryClient: QueryClient, queryConfig: QueryClientConfig) => {
+  const { notifier } = queryConfig;
+
+  /**
+   * @param notification {boolean} send out email notification
+   */
+  queryClient.setMutationDefaults(MUTATION_KEYS.PUBLISH_ITEM, {
+    mutationFn: ({ id, notification }) => Api.publishItem(id, notification, queryConfig ),
+    onSuccess: () => {
+      notifier?.({ type: publishItemRoutine.SUCCESS });
+    },
+    onError: (error) => {
+      notifier?.({ type: publishItemRoutine.FAILURE, payload: { error } });
+    },
+    onSettled: (_data, _error, { id }) => {
+      queryClient.invalidateQueries(buildItemTagsKey(id));
+    },
+  });
+};

src/routines/index.ts

@@ -12,3 +12,4 @@ export * from './itemValidation';
 export * from './action';
 export * from './invitation';
 export * from './authentication';
+export * from './itemPublish';

src/routines/itemPublish.ts

@@ -0,0 +1,4 @@
+import createRoutine from './utils';
+
+/* eslint-disable import/prefer-default-export */
+export const publishItemRoutine = createRoutine('PUBLISH_ITEM');