Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

Reference Documents

Scope

  • This sprint will primarily be concerned with wrapping up custom revenue and custom expenses

    • Expenses readonly / edit / delete & Sale API + saga update – DESIGNS EXIST; tickets needed

    • Revenue needs readonly / edit (non-crop type) / delete (= update to new modal) designs David Trapp – but we have a newly refactored edit view to work off of

  • We also want to prepare for these new requirements + user stories which remain in Finances 2.0 and will the the focus of our next sprint.

    • Generate income statement: “As a farmer I want to be able to generate an income statement so that I can understand if my farm has been profitable over a set timeframe”. Should include revenues, expenses, and gross profit (Priority: Highest)

    • Finances dashboard: “As a farmer I want to be able to understand my financial position at a glance when landing on the finances page so that I can quickly understand the financial footing of my operation” (Priority Medium)

Remaining revenue and expense flow tasks

Epic Link: LF-3597 - Getting issue details... STATUS

 

tasks

 notes

1

Update the “edit individual expense” flow

LF-3627 - Getting issue details... STATUS

Readonly view is disabled inputs

2

Update the “edit individual revenue” flow

LF-3628 - Getting issue details... STATUS

Readonly view is disabled inputs

Number Input bugs (3):

3

The onChange handler (as far as I can tell) on AddExpense is buggy in Portuguese. This is the situation in which David Trapp was not able to enter a comma and the decimal cleared the whole input. This is specific to that Input and not the others.

Fix AddExpense value Input for Portuguese LF-3643 - Getting issue details... STATUS

Please test in Spanish and other comma-based decimal languages as well

4

Validation messages are not displaying when valueAsNumber is set to true (image from the new GeneralRevenue)

Relatedly the minimum validation for the current AddSale total field is flakey (sometimes the error message displays onBlur and sometimes doesn’t)

Fix validation messages for currency inputs LF-3644 - Getting issue details... STATUS (Crop Sale, General Sale, Add Expense, and their read-only + edit views)

As below, the behaviour of the Unit (e.g. the Harvest Quantity of Edit Expense) is correct

5

The handling of decimals in Add Sale and Edit Expense is mediocre. The behaviour of the Harvest Quantity component is ideal: decimals should become commas (when appropriate in that language) and rounding to two decimals should occur onBlur

Update finance currency Inputs to share the internationalization behaviour of Harvest Quantity (a <Unit /> component)

LF-3641 - Getting issue details... STATUS

Getting ideal behaviour may or may not involve refactoring from an Input to a Unit

Technical Notes

Generate income statement

  • I suggest we use the package ExcelJS (https://github.com/exceljs/exceljs) to generate our xlxs document. It is a popular packages with close to 1 million weekly downloads (npm), has a readable API and the generated spreadsheet is fully styleable

    • The most popular alternative, SheetJS, has recently moved off of GitHub, has security vulnerabilities, and requires a pro account to style. We had actually previously imported SheetJS into our codebase, but it was not used and removed this year in a package cleanup PR

  • ExcelJS is a large package, 1.1MB minified and 259.1kB minified and gzipped according to Bundlephobia

  • As a point of comparison, a single sheet xlsx file as we generate in certification export is 8-9kB. This suggests we should be creating the xlsx file on the server and sending via API to the frontend. However there are some other considerations we can keep in mind.

    • We don’t yet know the specifications of the file we will be generating (e.g. I believe they will be more highly styled than the certification documents) and they may end up larger

    • The client can cache the library code, making the difference in data sent to the client less noticeable as more documents are exported

    • This might be worth testing on different devices in terms of responsiveness

  • Folder structure: I suggest generating the Excel document in a function in packages/api/util that can be used by the controller or, if we decide to restructure, the frontend

  • We don’t yet have the exact specification for this document (data content or visuals), but we can set up the framework (saga → controller → document generation → download) now with some data available on the current finance homepage

    • There is a mockup of the filtering page (the page that selects which data will be exported) which I would like to get confirmed before we start work on it

Dashboard Views

  • Although this rework is visually substantial, most of the data is already present within three existing components, accessed via Finances, Actual Revenue, and Other Expenses

    • Note as revenue types is a new concept in Finances 2.0 we do not have organization by type in Actual Revenue. Other Expenses already contains this breakdown by type

  • Date filtering already works correctly via the <DateRangeSelector /> “component” which controls the date_range within the financesReducer slice of the store

  • Here and elsewhere you might notice that the container + pure component architecture is not always followed. It is preferred but not required for the dashboard tickets.

  • Please continue to use the old Redux architecture as it is functional

  • We are still waiting designs to be confirmed as final, so there is some risk of the visuals changing (noted below)

    • Note on the Figma Mockup: we are using the second panel of “Finances homescreen” as our current guide for the main homepage dashboard, with the addition of the date filtering from the third panel

Epic Links:

  • LF-3624 - Getting issue details... STATUS

  • LF-3625 - Getting issue details... STATUS

 

tasks

 notes

1

Preliminary Dashboard Task

Convert the following class-based components into functional components:

  • <Finances /> container

  • <OtherExpenses /> container

  • <DateRangeSelector /> component

    LF-3615 - Getting issue details... STATUS

2

Create reusable summary tile component

LF-3616 - Getting issue details... STATUS

Low risk (consistent throughout design document)

3

Create/update existing transactions list <Table /> component to new style

LF-3617 - Getting issue details... STATUS

Slight risk design might change, particularly the top and bottom table frame

4

Create swipeable summary icon tiles component. Please use the existing icon tile component as your guide / base.

LF-3618 - Getting issue details... STATUS

Medium risk –

consistent throughout design document

BUT Duncan doesn’t like it and Loïc may not either

5

Update <Finances /> container and components. All data is available.

LF-3619 - Getting issue details... STATUS

Blocked by 1

Requires at least one of 2, 3, or 4 - ticket owner should feel free to subtask and apply whichever component(s) are available

6

Update <OtherExpensens /> container and components. All data is available in current container.

Please base visuals on homepage / Revenue below. This needs updating.

LF-3620 - Getting issue details... STATUS

Blocked by 1

Requires at least one of 2, 3, or 4 - ticket owner should feel free to subtask and apply whichever component(s) are available

Please do not implement “Last 30 days” filtering before checking in with product (it doesn’t appear on the homescreen tiles)

7

Update <ActualRevenue /> container and components. A new breakdown by Revenue Type is necessary for the summary icon tiles. All other data is available in current container.

LF-3621 - Getting issue details... STATUS

Requires at least one of 2, 3, or 4 - ticket owner should feel free to subtask and apply whichever component(s) are available

Please do not implement “Last 30 days” filtering before checking in with product (it doesn’t appear on the homescreen tiles)

8

Build container and component to filter export report data. Add three-dots menu to Finances homescreen to trigger export.

LF-3622 - Getting issue details... STATUS

BLOCKED BY PRODUCT – Older design; I would prefer to get this confirmed before working.

PDF export is not part of scope so that radio button should not exist

9

Export structure / POC

Build saga, API route, controller, and utility function to generate and return an xlsx file

LF-3623 - Getting issue details... STATUS

See technical notes above. Only send and write to file three values (revenue, expenses, balance) and trigger download automatically as in current uploaded document functionality.

10

Date Inputs in the <DateRangeSelector /> component are weird – they don’t input manually properly and the validation does not match stylistically to the rest of the app

Update the Date inputs used in <DateRangeSelector />

LF-3637 - Getting issue details... STATUS

They probably can to be migrated to <Input type={'date'} />

 

 

 

 


 

Questions & Answers

For product team

  • What’s the relationship between the old Labour view and the new Labour expense tile? Is there a migration covering this? For now is the old Labour summary view removed?

    Related comment: LF-3553 - Getting issue details... STATUS
    ticket to add type “Labour”: LF-3564 - Getting issue details... STATUS

  • Is estimated revenue removed? Where should it go now?? David Trapp

  • Are tooltips on the current finance page being carried over? Not in designs David Trapp

  • Does document export need to be recorded somewhere (e.g. in the database)?

  • No labels