feat: Create store to manage Portals (#5020)

Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com>
Co-authored-by: Pranav Raj S <pranav@chatwoot.com>
This commit is contained in:
Nithin David Thomas
2022-07-27 12:24:43 +05:30
committed by GitHub
parent 1594d49a70
commit bfca4852c8
9 changed files with 559 additions and 0 deletions

View File

@@ -0,0 +1,126 @@
import axios from 'axios';
import { actions } from '../actions';
import { types } from '../mutations';
import { apiResponse } from './fixtures';
const commit = jest.fn();
global.axios = axios;
jest.mock('axios');
describe('#actions', () => {
describe('#index', () => {
it('sends correct actions if API is success', async () => {
axios.get.mockResolvedValue({ data: apiResponse });
await actions.index({ commit });
expect(commit.mock.calls).toEqual([
[types.SET_UI_FLAG, { isFetching: true }],
[types.ADD_MANY_PORTALS_ENTRY, apiResponse],
[types.ADD_MANY_PORTALS_IDS, [1, 2]],
[types.SET_UI_FLAG, { isFetching: false }],
]);
});
it('sends correct actions if API is error', async () => {
axios.get.mockRejectedValue({ message: 'Incorrect header' });
await expect(actions.index({ commit })).rejects.toThrow(Error);
expect(commit.mock.calls).toEqual([
[types.SET_UI_FLAG, { isFetching: true }],
[types.SET_UI_FLAG, { isFetching: false }],
]);
});
});
describe('#create', () => {
it('sends correct actions if API is success', async () => {
axios.post.mockResolvedValue({ data: apiResponse[1] });
await actions.create(
{ commit },
{
color: 'red',
custom_domain: 'domain_for_help',
header_text: 'Domain Header',
}
);
expect(commit.mock.calls).toEqual([
[types.SET_UI_FLAG, { isCreating: true }],
[types.ADD_PORTAL_ENTRY, apiResponse[1]],
[types.ADD_PORTAL_ID, 2],
[types.SET_UI_FLAG, { isCreating: false }],
]);
});
it('sends correct actions if API is error', async () => {
axios.post.mockRejectedValue({ message: 'Incorrect header' });
await expect(actions.create({ commit }, {})).rejects.toThrow(Error);
expect(commit.mock.calls).toEqual([
[types.SET_UI_FLAG, { isCreating: true }],
[types.SET_UI_FLAG, { isCreating: false }],
]);
});
});
describe('#update', () => {
it('sends correct actions if API is success', async () => {
axios.patch.mockResolvedValue({ data: apiResponse[1] });
await actions.update({ commit }, apiResponse[1]);
expect(commit.mock.calls).toEqual([
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isUpdating: true }, portalId: 2 },
],
[types.UPDATE_PORTAL_ENTRY, apiResponse[1]],
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isUpdating: false }, portalId: 2 },
],
]);
});
it('sends correct actions if API is error', async () => {
axios.patch.mockRejectedValue({ message: 'Incorrect header' });
await expect(actions.update({ commit }, apiResponse[1])).rejects.toThrow(
Error
);
expect(commit.mock.calls).toEqual([
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isUpdating: true }, portalId: 2 },
],
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isUpdating: false }, portalId: 2 },
],
]);
});
});
describe('#delete', () => {
it('sends correct actions if API is success', async () => {
axios.delete.mockResolvedValue({});
await actions.delete({ commit }, 2);
expect(commit.mock.calls).toEqual([
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isDeleting: true }, portalId: 2 },
],
[types.REMOVE_PORTAL_ENTRY, 2],
[types.REMOVE_PORTAL_ID, 2],
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isDeleting: false }, portalId: 2 },
],
]);
});
it('sends correct actions if API is error', async () => {
axios.delete.mockRejectedValue({ message: 'Incorrect header' });
await expect(actions.delete({ commit }, 2)).rejects.toThrow(Error);
expect(commit.mock.calls).toEqual([
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isDeleting: true }, portalId: 2 },
],
[
types.SET_HELP_PORTAL_UI_FLAG,
{ uiFlags: { isDeleting: false }, portalId: 2 },
],
]);
});
});
});

View File

@@ -0,0 +1,75 @@
export default {
portals: {
byId: {
1: {
id: 1,
color: 'red',
custom_domain: 'domain_for_help',
header_text: 'Domain Header',
homepage_link: 'help-center',
name: 'help name',
page_title: 'page title',
slug: 'domain',
archived: false,
config: {
allowed_locales: ['en'],
},
},
2: {
id: 2,
color: 'green',
custom_domain: 'campaign_for_help',
header_text: 'Campaign Header',
homepage_link: 'help-center',
name: 'help name',
page_title: 'campaign title',
slug: 'campaign',
archived: false,
config: {
allowed_locales: ['en'],
},
},
},
allIds: [1, 2],
uiFlags: {
byId: {
1: { isFetching: false, isUpdating: true, isDeleting: false },
},
},
},
uiFlags: {
allFetched: false,
isFetching: true,
},
};
export const apiResponse = [
{
id: 1,
color: 'red',
custom_domain: 'domain_for_help',
header_text: 'Domain Header',
homepage_link: 'help-center',
name: 'help name',
page_title: 'page title',
slug: 'domain',
archived: false,
config: {
allowed_locales: ['en'],
},
},
{
id: 2,
color: 'green',
custom_domain: 'campaign_for_help',
header_text: 'Campaign Header',
homepage_link: 'help-center',
name: 'help name',
page_title: 'campaign title',
slug: 'campaign',
archived: false,
config: {
allowed_locales: ['en'],
},
},
];

View File

@@ -0,0 +1,45 @@
import { getters } from '../getters';
import portal from './fixtures';
describe('#getters', () => {
it('getUIFlagsIn', () => {
const state = portal;
expect(getters.uiFlagsIn(state)(1)).toEqual({
isFetching: false,
isUpdating: true,
isDeleting: false,
});
});
it('isFetchingPortals', () => {
const state = portal;
expect(getters.isFetchingPortals(state)).toEqual(true);
});
it('portalById', () => {
const state = portal;
expect(getters.portalById(state)(1)).toEqual({
id: 1,
color: 'red',
custom_domain: 'domain_for_help',
header_text: 'Domain Header',
homepage_link: 'help-center',
name: 'help name',
page_title: 'page title',
slug: 'domain',
archived: false,
config: {
allowed_locales: ['en'],
},
});
});
it('allPortals', () => {
const state = portal;
expect(getters.allPortals(state, getters).length).toEqual(2);
});
it('count', () => {
const state = portal;
expect(getters.count(state)).toEqual(2);
});
});

View File

@@ -0,0 +1,95 @@
import { mutations, types } from '../mutations';
import portal from './fixtures';
describe('#mutations', () => {
let state = {};
beforeEach(() => {
state = { ...portal };
});
describe('#SET_UI_FLAG', () => {
it('It returns default flags if empty object passed', () => {
mutations[types.SET_UI_FLAG](state, {});
expect(state.uiFlags).toEqual({
allFetched: false,
isFetching: true,
});
});
it('It updates keys when passed as parameters', () => {
mutations[types.SET_UI_FLAG](state, { isFetching: false });
expect(state.uiFlags).toEqual({
allFetched: false,
isFetching: false,
});
});
});
describe('[types.ADD_PORTAL_ENTRY]', () => {
it('does not add empty objects to state', () => {
mutations[types.ADD_PORTAL_ENTRY](state, {});
expect(state).toEqual(portal);
});
it('does adds helpcenter object to state', () => {
mutations[types.ADD_PORTAL_ENTRY](state, { id: 3 });
expect(state.portals.byId[3]).toEqual({ id: 3 });
});
});
describe('[types.ADD_PORTAL_ID]', () => {
it('adds helpcenter id to state', () => {
mutations[types.ADD_PORTAL_ID](state, 12);
expect(state.portals.allIds).toEqual([1, 2, 12]);
});
});
describe('[types.UPDATE_PORTAL_ENTRY]', () => {
it('does not updates if empty object is passed', () => {
mutations[types.UPDATE_PORTAL_ENTRY](state, {});
expect(state).toEqual(portal);
});
it('does not updates if object id is not present ', () => {
mutations[types.UPDATE_PORTAL_ENTRY](state, { id: 5 });
expect(state).toEqual(portal);
});
it(' updates if object with id already present in the state', () => {
mutations[types.UPDATE_PORTAL_ENTRY](state, {
id: 2,
name: 'Updated name',
});
expect(state.portals.byId[2].name).toEqual('Updated name');
});
});
describe('[types.REMOVE_PORTAL_ENTRY]', () => {
it('does not remove object entry if no id is passed', () => {
mutations[types.REMOVE_PORTAL_ENTRY](state, undefined);
expect(state).toEqual({ ...portal });
});
it('removes object entry with to conversation if outgoing', () => {
mutations[types.REMOVE_PORTAL_ENTRY](state, 2);
expect(state.portals.byId[2]).toEqual(undefined);
});
});
describe('[types.REMOVE_PORTAL_ID]', () => {
it('removes id from state', () => {
mutations[types.REMOVE_PORTAL_ID](state, 2);
expect(state.portals.allIds).toEqual([1, 12]);
});
});
describe('[types.SET_HELP_PORTAL_UI_FLAG]', () => {
it('sets correct flag in state', () => {
mutations[types.SET_HELP_PORTAL_UI_FLAG](state, {
portalId: 1,
uiFlags: { isFetching: true },
});
expect(state.portals.uiFlags.byId[1]).toEqual({
isFetching: true,
isUpdating: true,
isDeleting: false,
});
});
});
});