Job data model change #66

kategreenUSDS · 2024-10-02T00:25:40Z

About this pull request

Ticket: FFS-1775

Main goal: Move job, expense, and payment data model and methods to reflect a more relational state as discussed in redux documentation.

New data model structure

This will be the structure for payments and expenses as well. payments and expenses will have an index back to their associated job to allow for streamlined data storage and relational behavior.

export interface JobItem {
    description: string
    business: string
    taxesFiled: boolean
}

interface JobState {
    byId: {
        [id: string]: JobItem
    },
    allIds: Array<string>
}

What's in here

Data-model specific

Add user slice
Create payment slice
Move expense slice under job
Add all the methods for expense and payment (edit, delete, both of which aren't yet in the app, but will need to be)

Side effects

Split out the expense/add form into its own page like job/add+IncomeFormJob and payment/add+IncomeFormPayment
Move expenses pages under job in the routing/file structure to pass the correct params
Add explicit UUID id structure, which makes the routing look a little icky but is the standard for ids these days
Commented out some stuff in the statement/ section to get passing tests and created FFS-1818 for that work
Added a temporary flow choice to create "add expenses to a job" experience (I have some questions on how this will go in to the flow and work, but that's for later on)
Created test fixture generators, first pass on this notion

* s/income/job * s/payments/payment * import payment details from the right file

…hange

YvetteWhiteUSDS

fyi-- prereviewed per Kate's request. No comments; lgtm.

…hange

kategreenUSDS · 2024-10-04T19:02:54Z

app/[locale]/job/[idx]/expense/FormExpense.tsx

This file is net new and is the Form for adding and editing expenses. This is a side effect of the expenses work here

kategreenUSDS · 2024-10-04T19:03:23Z

app/[locale]/job/[idx]/expense/add/page.test.tsx

@@ -16,7 +16,7 @@ describe('Add Income To Ledger Page', async () => {
        }))
        mockRouter.push('/job/expense/add')
        store = makeStore()
-        render (<Provider store={store}><Page /></Provider>)
+        render (<Provider store={store}><Page params={{idx: '0'}} /></Provider>)


this adds the job param. that's what idx is here

kategreenUSDS · 2024-10-04T19:05:17Z

app/[locale]/job/[idx]/expense/add/page.test.tsx

@@ -59,7 +59,7 @@ describe('Add Income To Ledger Page', async () => {

        await waitFor(() => {
            expect(mockRouter).toMatchObject({
-                asPath: "/job/expense/list"
+                asPath: "/job/list"


this is the flow change choice i made to keep it moving

kategreenUSDS · 2024-10-04T19:06:16Z

app/[locale]/job/[idx]/expense/add/page.tsx

this looks new, but it's actually moving the expense directory under the job/[idx] dir and then ripping out the <Form> to separate concerns

Thanks for separating concerns.

kategreenUSDS · 2024-10-04T19:06:46Z

app/[locale]/job/[idx]/expense/list/page.test.tsx

this is also a file move that looks net new but it's not

kategreenUSDS · 2024-10-04T19:18:09Z

lib/features/job/expenses/expenses.test.ts

this file was moved to the one below it in this list

kategreenUSDS · 2024-10-04T19:19:31Z

lib/features/job/expenses/expensesSlice.ts

all of [jobSlice, expensesSlice, and paymentSlice] and their tests should look very similar. they are all using the same ideas and should be refactored to reuse logic eventually (i will make a ticket for it)

kategreenUSDS · 2024-10-04T19:20:48Z

lib/features/user/userSlice.ts

this is stub page until we know what data we'll want to add

kategreenUSDS · 2024-10-04T19:20:58Z

lib/features/user/userSlice.test.ts

stub (see next file)

kategreenUSDS · 2024-10-04T19:21:26Z

lib/store.ts

+ */
+
+export const createUuid = () => uuidv4()


i'm not 100% sure this is the right place for this method, but here it will live until i find a better spot

YvetteWhiteUSDS

I appreciate the step by step comments-- super helpful.

YvetteWhiteUSDS · 2024-10-05T01:45:39Z

app/[locale]/job/[idx]/expense/FormExpense.tsx

+            control={control}
+            rules={{ required: {value:true, message: t('add_expense_date_required')} }}
+            render={({ field }) => (
+                <>


This empty <> is making my brain glitch. What does <></> do? Div?

i'm pretty sure it's going to render the root element

YvetteWhiteUSDS · 2024-10-05T01:50:09Z

app/[locale]/job/[idx]/expense/add/page.tsx

Thanks for separating concerns.

kategreenUSDS added 10 commits September 25, 2024 11:29

Making a payment slice file

985dc5a

a whole bunch of find and replace to:

d0604c1

* s/income/job * s/payments/payment * import payment details from the right file

Add user reducer to use later on

77e837d

Merge branch 'main' into k8/FFS-1487/expenses-under-jobs-data-model-c…

f30c1de

…hange

Adjustments for new data shape

dfe1236

add uuid

670d64c

add new structure for jobs

f371575

adding edit functionality and fixing tests

507ed53

fix job list to reflect new structure

3bb6e75

lint fixes

734396c

YvetteWhiteUSDS reviewed Oct 2, 2024

View reviewed changes

kategreenUSDS added 17 commits October 2, 2024 14:22

Merge branch 'main' into k8/FFS-1487/expenses-under-jobs-data-model-c…

0e193ba

…hange

Add job test changes + total payments by job

9b3e571

adding methods for adding up payments on jobs

d0dca53

progress commit

9fc3e2c

removed cleanup needs because the test items don't require idempotency

a6efb00

Fix up the last of the jobs tests

d127a9c

Payment list item fix

9d218e9

Typo fix

aa27a53

reducer updates for expenses

6f6d643

Moving expenses under the id

998ef0b

Switch flow a bit to handle expenses<->job relation

71737ab

Standardize methods

3d2b236

fixing tests, commenting out some work that i've moved to other tickets

f62aadc

lint fixes

c11490c

adding skipped tests, jobs slice style

9faffde

Add state generator methods

94af571

All teh tests

591fe1b

kategreenUSDS changed the title ~~[DRAFT] Job data model change~~ Job data model change Oct 4, 2024

kategreenUSDS commented Oct 4, 2024

View reviewed changes

YvetteWhiteUSDS approved these changes Oct 5, 2024

View reviewed changes

kategreenUSDS merged commit 915bacf into main Oct 7, 2024
3 checks passed

kategreenUSDS deleted the k8/FFS-1487/expenses-under-jobs-data-model-change branch October 7, 2024 15:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Job data model change #66

Job data model change #66

kategreenUSDS commented Oct 2, 2024 •

edited

Loading

YvetteWhiteUSDS left a comment

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

YvetteWhiteUSDS Oct 5, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

kategreenUSDS Oct 4, 2024

YvetteWhiteUSDS left a comment

YvetteWhiteUSDS Oct 5, 2024

kategreenUSDS Oct 7, 2024

YvetteWhiteUSDS Oct 5, 2024

Job data model change #66

Job data model change #66

Conversation

kategreenUSDS commented Oct 2, 2024 • edited Loading

About this pull request

New data model structure

What's in here

Data-model specific

Side effects

YvetteWhiteUSDS left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YvetteWhiteUSDS left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kategreenUSDS commented Oct 2, 2024 •

edited

Loading