Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue-2158/Refactored redux store utility functions #2482

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

issue-2158/Refactored redux store utility functions #2482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
090575f
issue-2158/Refactored redux store utility functions for Areas, AreaAs…
KraftKatten Jan 19, 2025
5481100
issue-2158/Add internal utility methods to storeUtils
KraftKatten Jan 19, 2025
80e6bcb
Fixed method call from areas store
KraftKatten Jan 19, 2025
ecc79a2
Refactor storeUtils, add tests
KraftKatten Feb 1, 2025
e2546ce
Merge branch 'main' into issue-2158/store-utility-method
KraftKatten Feb 1, 2025
fa95cb8
Clear jest mocks and timers
KraftKatten Feb 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 14 additions & 52 deletions src/features/areaAssignments/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import { createSlice, PayloadAction } from '@reduxjs/toolkit';

import {
findOrAddItem,
remoteItemCreatedWithData,
remoteItemLoad,
remoteItemLoaded,
remoteItemUpdated,
remoteItemDeleted,
RemoteItem,
remoteItem,
remoteList,
Expand Down Expand Up @@ -56,53 +60,22 @@ const areaAssignmentSlice = createSlice({
action: PayloadAction<ZetkinAreaAssignment>
) => {
const areaAssignment = action.payload;
const item = remoteItem(areaAssignment.id, {
data: areaAssignment,
loaded: new Date().toISOString(),
});

state.areaAssignmentList.items.push(item);
remoteItemCreatedWithData(state.areaAssignmentList, areaAssignment);
},
areaAssignmentDeleted: (state, action: PayloadAction<number>) => {
const areaAssId = action.payload;
const areaAssignmentItem = state.areaAssignmentList.items.find(
(item) => item.id === areaAssId
);

if (areaAssignmentItem) {
areaAssignmentItem.deleted = true;
}
remoteItemDeleted(state.areaAssignmentList, areaAssId);
},
areaAssignmentLoad: (state, action: PayloadAction<string>) => {
const areaAssId = action.payload;
const item = state.areaAssignmentList.items.find(
(item) => item.id == areaAssId
);

if (item) {
item.isLoading = true;
} else {
state.areaAssignmentList.items = state.areaAssignmentList.items.concat([
remoteItem(areaAssId, { isLoading: true }),
]);
}
remoteItemLoad(state.areaAssignmentList, areaAssId);
},
areaAssignmentLoaded: (
state,
action: PayloadAction<ZetkinAreaAssignment>
) => {
const areaAssignment = action.payload;
const item = state.areaAssignmentList.items.find(
(item) => item.id == areaAssignment.id
);

if (!item) {
throw new Error('Finished loading item that never started loading');
}

item.data = areaAssignment;
item.isLoading = false;
item.loaded = new Date().toISOString();
remoteItemLoaded(state.areaAssignmentList, areaAssignment);
},
areaAssignmentSessionCreated: (
state,
Expand Down Expand Up @@ -153,11 +126,8 @@ const areaAssignmentSlice = createSlice({
state,
action: PayloadAction<ZetkinAreaAssignment>
) => {
const assignment = action.payload;
const item = findOrAddItem(state.areaAssignmentList, assignment.id);

item.data = assignment;
item.loaded = new Date().toISOString();
const updatedArea = action.payload;
remoteItemUpdated(state.areaAssignmentList, updatedArea);
},
areaAssignmentsLoad: (state) => {
state.areaAssignmentList.isLoading = true;
Expand Down Expand Up @@ -219,19 +189,11 @@ const areaAssignmentSlice = createSlice({
},
locationCreated: (state, action: PayloadAction<ZetkinLocation>) => {
const location = action.payload;
const item = remoteItem(location.id, {
data: location,
loaded: new Date().toISOString(),
});

state.locationList.items.push(item);
remoteItemCreatedWithData(state.locationList, location);
},
locationUpdated: (state, action: PayloadAction<ZetkinLocation>) => {
const location = action.payload;
const item = findOrAddItem(state.locationList, location.id);

item.data = location;
item.loaded = new Date().toISOString();
const updatedLocation = action.payload;
remoteItemUpdated(state.locationList, updatedLocation);
},
locationsInvalidated: (state) => {
state.locationList.isStale = true;
Expand Down
48 changes: 12 additions & 36 deletions src/features/areas/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import { createSlice, PayloadAction } from '@reduxjs/toolkit';

import {
findOrAddItem,
remoteItem,
remoteItemCreatedWithData,
remoteItemDeleted,
remoteItemLoad,
remoteItemLoaded,
remoteItemUpdated,
remoteList,
RemoteList,
} from 'utils/storeUtils';
Expand All @@ -25,49 +28,23 @@ const areasSlice = createSlice({
reducers: {
areaCreated: (state, action: PayloadAction<ZetkinArea>) => {
const area = action.payload;
const item = remoteItem(area.id, {
data: area,
loaded: new Date().toISOString(),
});

state.areaList.items.push(item);
remoteItemCreatedWithData(state.areaList, area);
},
areaDeleted: (state, action: PayloadAction<string>) => {
const deletedId = action.payload;
state.areaList.items = state.areaList.items.filter(
(item) => item.id != deletedId
);
remoteItemDeleted(state.areaList, deletedId);
},
areaLoad: (state, action: PayloadAction<string>) => {
const areaId = action.payload;
const item = state.areaList.items.find((item) => item.id == areaId);

if (item) {
item.isLoading = true;
} else {
state.areaList.items = state.areaList.items.concat([
remoteItem(areaId, { isLoading: true }),
]);
}
remoteItemLoad(state.areaList, areaId);
},
areaLoaded: (state, action: PayloadAction<ZetkinArea>) => {
const area = action.payload;
const item = state.areaList.items.find((item) => item.id == area.id);

if (!item) {
throw new Error('Finished loading item that never started loading');
}

item.data = area;
item.isLoading = false;
item.loaded = new Date().toISOString();
remoteItemLoaded(state.areaList, area);
},
areaUpdated: (state, action: PayloadAction<ZetkinArea>) => {
const area = action.payload;
const item = findOrAddItem(state.areaList, area.id);

item.data = area;
item.loaded = new Date().toISOString();
remoteItemUpdated(state.areaList, area);
},
areasLoad: (state) => {
state.areaList.isLoading = true;
Expand All @@ -82,9 +59,8 @@ const areasSlice = createSlice({
tagAssigned: (state, action: PayloadAction<[string, ZetkinTag]>) => {
const [areaId, tag] = action.payload;
state.tagsByAreaId[areaId] ||= remoteList();
const tagItem = findOrAddItem(state.tagsByAreaId[areaId], tag.id);
tagItem.data = tag;
tagItem.loaded = new Date().toISOString();

remoteItemUpdated(state.tagsByAreaId[areaId], tag);

const areaItem = state.areaList.items.find((item) => item.id == areaId);
if (areaItem?.data) {
Expand Down
55 changes: 20 additions & 35 deletions src/features/joinForms/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
import { createSlice, PayloadAction } from '@reduxjs/toolkit';

import { findOrAddItem, remoteList, RemoteList } from 'utils/storeUtils';
import {
remoteItemCreatedWithData,
remoteItemLoad,
remoteItemLoaded,
remoteItemDeleted,
remoteItemUpdate,
remoteItemUpdated,
remoteList,
RemoteList,
} from 'utils/storeUtils';
import { ZetkinJoinForm, ZetkinJoinSubmission } from './types';

export interface JoinFormsStoreSlice {
Expand All @@ -19,33 +28,23 @@ const joinFormsSlice = createSlice({
reducers: {
joinFormCreated: (state, action: PayloadAction<ZetkinJoinForm>) => {
const form = action.payload;
const item = findOrAddItem(state.formList, form.id);
item.loaded = new Date().toISOString();
item.data = form;
remoteItemCreatedWithData(state.formList, form);
},
joinFormLoad: (state, action: PayloadAction<number>) => {
const formId = action.payload;
const item = findOrAddItem(state.formList, formId);
item.isLoading = true;
remoteItemLoad(state.formList, formId);
},
joinFormLoaded: (state, action: PayloadAction<ZetkinJoinForm>) => {
const form = action.payload;
const item = findOrAddItem(state.formList, form.id);
item.isLoading = false;
item.loaded = new Date().toISOString();
item.data = form;
remoteItemLoaded(state.formList, form);
},
joinFormUpdate: (state, action: PayloadAction<[number, string[]]>) => {
const [formId, mutating] = action.payload;
const item = findOrAddItem(state.formList, formId);
item.mutating = mutating;
remoteItemUpdate(state.formList, formId, mutating);
},
joinFormUpdated: (state, action: PayloadAction<ZetkinJoinForm>) => {
const form = action.payload;
const item = findOrAddItem(state.formList, form.id);
item.data = form;
item.mutating = [];
item.loaded = new Date().toISOString();
remoteItemUpdated(state.formList, form);
},
joinFormsLoad: (state) => {
state.formList.isLoading = true;
Expand All @@ -56,37 +55,23 @@ const joinFormsSlice = createSlice({
},
submissionDeleted: (state, action: PayloadAction<number>) => {
const submissionId = action.payload;
const item = state.submissionList.items.find(
(item) => item.id == submissionId
);

if (item) {
item.deleted = true;
}
remoteItemDeleted(state.submissionList, submissionId);
},
submissionLoad: (state, action: PayloadAction<number>) => {
const submissionId = action.payload;
const item = findOrAddItem(state.submissionList, submissionId);
item.isLoading = true;
remoteItemLoad(state.submissionList, submissionId);
},
submissionLoaded: (state, action: PayloadAction<ZetkinJoinSubmission>) => {
const submission = action.payload;
const item = findOrAddItem(state.submissionList, submission.id);
item.isLoading = false;
item.data = submission;
item.loaded = new Date().toISOString();
remoteItemLoaded(state.submissionList, submission);
},
submissionUpdate: (state, action: PayloadAction<[number, string[]]>) => {
const [submissionId, mutating] = action.payload;
const item = findOrAddItem(state.submissionList, submissionId);
item.mutating = mutating;
remoteItemUpdate(state.submissionList, submissionId, mutating);
},
submissionUpdated: (state, action: PayloadAction<ZetkinJoinSubmission>) => {
const submission = action.payload;
const item = findOrAddItem(state.submissionList, submission.id);
item.mutating = [];
item.data = submission;
item.loaded = new Date().toISOString();
remoteItemUpdated(state.submissionList, submission);
},
submissionsLoad: (state) => {
state.submissionList.isLoading = true;
Expand Down
Loading
Loading