colinfwren / atomic-todo Goto Github PK

Set up a CI pipeline that will build and publish Docker images of the back-end and front-end apps so these can be pulled down as part of the Docker Compose

#6 will update the GraphQL schema to remove the lists array from the TodoBoardResult as those TodoList objects will be returned as part TodoBoard now.

The front-end code that fetches the TodoBoard and renders the TodoLists will need to be updated to reflect this schema change.

In order to make testing easier create a small container that when run will create the schema and test data for the app in the configured Appwrite instance.

Set up CI pipeline to run the front-end tests:

• Unit tests

If the tests fail this should prevent PRs from being merged or main branch being deployed.

In order for a board to associated with a user the user needs to be able to log into their account

In order to make it easier for self-hosters to run the app under their setup the front-end app needs to be able to be configured via Environment Variables. The folliwing parts of the front-end should be configurable:

• Back-end URL
• PostHog URL or if not defined then analytics is disabled
• Sentry/GlitchTup URL or if not defined then observability is disabled

Following discovery of how to best model the data in the app (https://medium.com/@colinwren/atomic-todo-discovery-modelling-dates-e5d062b6f4dc) I'm removing the hierarchy of TodoLists instead TodoList will become a dynamically generated collection of Todos within a period of time.

The following changes need to be made:

• Remove parentList from TodoList
• Remove childLists from TodoList
• Rename level to granularity
• Add endDate field to TodoList
• Change days on TodoBoard to be an array of TodoList
• Change weeks on TodoBoard to be an array of TodoList
• Change months on TodoBoard to be an array of TodoList
• Remove lists from TodoBoardResult as these will be rendered as part of the TodoBoard object directly now
• Rename startDate on TodoBoard to activePeriodStartDate to better reflect the fact this date relates to the active period shown

In order to get a good idea on the testing add allure to the back-end and front-end test reporters. Have the CI pipeline that runs the test create an artifact of the allure XML output so this can be imported into the Allure reporter service

Right now there's no authentication or user model. In order for Atomic Todo to be used as a service there needs to be a means for boards and todos to be linked to an account

Set up CI pipeline to run the back-end tests:

• Unit tests

If the tests fail this should prevent PRs from being merged or main branch being deployed.

Following discovery into how to best model the data for the app (https://medium.com/@colinwren/atomic-todo-discovery-modelling-dates-e5d062b6f4dc) the schema in Appwrite needs to be refactored:

• TodoList is no longer needed as these will be dynamically modelled as part of the query to get the TodoBoard
• TodoBoard no longer needs to define the TodoLists displayed in it as these will now be dynamic

Using Playwright create a set of end to end tests to check the following user flows:

• Signing up
• Logging in
• Changing email for account
• Changing password for account
• Completing Onboarding
• Creating TodoBoard
• Deleting TodoBoard
• Renaming TodoBoard
• Creating Todo
• Renaming Todo
• Deleting Todo
• Moving Todo from day granularity TodoList to week granularity TodoList
• Progressing Todoboard active period forward a month
• Regressing TodoBoard active period back a month

In order to link a board to an account a user needs to be able to create an account in the system.

With the changes to the schema (#5 and #6) the approach to moving a Todo between TodoLists should be made far simpler so the horrible blob of logic that was traversing the heirachy of lists should be refactored to use that new approach.

When implementing #17 there was an issue where the tests which run locally in the Europe/London timezone were failing when run in CI due to that being UTC.

The code shouldn't really care about timezones because it's not using time like that so should look to find a way to fix this issue properly

Add small suite of tests to spin up Appwrite, populate it with data and perform the following user flows via the API:

• Creating TodoBoard
• Creating Todo
• Deleting Todo
• Renaming Todo
• Completing Todo
• Moving Todo from day granularity list to week granularity list
• Progressing TodoBoard forward a month
• Regressing TodoBoard back a month

Will likely need to add some means of tracking position of the todo in the different granularities so maybe adding positionInMonth, positionInWeek, positionInDay could do this?

Need to take into consideration also that when moving between lists would like to sort that too.

Should be able to use the value of over from the handleDragEnd callback to get the list dates so can do a filter on the items in the list and update the position value accordingly

In order to make it easier for self-hosters to configure the setup for their needs the following parts of the back-end app need to be configurable via Environment Variables:

• Appwrite URL
• PostHog URL (or if not set this disables analytics)
• Sentry/GlitchTip URL (or if not set this disables observability)

Create a docker-compose.yml file for running the app locally.

It should deploy

• Appwrite
• Back-end app
  • With means to provide URL for Appwrite
  • With means to provide URL for Posthog or turn off Analytics
  • With means to provide URL for Sentry / GlitchTip or turn off Observability
• Front-end app
  • With means to provide URL for Back-end
  • With means to provide URL for Posthog or turn off Analytics
  • With means to provide URL for Sentry/GlitchTip or turn off Observability

And have option to deploy

• Posthog
• GlitchTip