fmaclen / canutin-desktop Goto Github PK

warn(prisma-client) There are already 10 instances of Prisma Client actively running.

• Needed to instantiate new PrismaClient's in some cases because the queries appear to returned cached data.
• These additional Prisma clients were instantiated as uncachedPrisma.
• uncachedPrisma.$disconnect() is called after using them but it doesn't seem like that is removing them correctly.

• Add light version
• Switch dynamically

• When choosing a vault the path to the file is stored to the user's settings.
• After the app quits and it's started again it reads the vault path from the user's settings but the file may have changed name or been deleted.
• We should check if the file still exists at the previous path before the rest of code is executed with a path that points to no file.

Only a few of the methods in TrayMenu have unit tests, primarily due to difficulty mocking Electron's modules.

Specifically, we need tests for:

• constructor()
• toggleServer()
• openVault()
• updateTray()

It wouldn't be a bad idea to go over the existing tests as there is probably quite a bit of room for improvement.

Also worth noting that the mocks in this test suite is printing an error to the console but it's not failing the test:

node:internal/modules/cjs/loader:936
  throw err;
  ^

Error: Cannot find module '/path/to/fake/assets/fake-image.png'
    at Function.Module._resolveFilename (node:internal/modules/cjs/loader:933:15)
    at Function.Module._load (node:internal/modules/cjs/loader:778:27)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:77:12)
    at node:internal/main/run_main_module:17:47 {
  code: 'MODULE_NOT_FOUND',
  requireStack: []
}

It might be a good idea to break some of these tasks into separate issues and PRs.

At the moment the tests run using 1 worker, the main reason why we can't increase the number of workers is due to: #51

Aside from being blocked by that issue there is probably a way to improve the current GitHub Actions workflow to at least parallelize each of the browser jobs.

• Add Add data on the sidebar linking to a page where there would be a file chooser to select a CanutinFile.json to be imported.
• It should validate the file before committing the changes to the DB.

The status bar would display:

• Current settings
  • Currency
  • Language
• Notices
  • Success
  • Errors
  • Warnings
  • Progress of long processes REF #38

• If Account isClosed or Asset isSold don't show it in Balance sheet.
• Maybe show a list of closed and sold entities below.

Prevent the body from growing past width: 1200px;

• Remove config from /package.json
• Move config to /electron-builder.yml
  https://www.electron.build/configuration/configuration.html

• Show charts displaying aggregate balances over time for:
  • Net worth
  • Cash
  • Debt
  • Investments
  • Other assets
• Charts will be stacked on top of one another.

Use this config as a reference: https://github.com/Canutin/svelte-currency-input/blob/main/playwright.config.ts

• Add a progress animation to indicate the alert it's going to be dismissed automatically after a second or two.
• Perhaps it could render a green top border that grows as time goes by.

• The current bundle is ~100 MB
• The biggest offender is the fact that Electron ships with Chromium
• Since the app is meant to be run with the user's default browser we should explore ways to prevent shipping unnecessary dependencies
• Consider migrating from Electron to Tauri

• Icons look very low-res on hi-DPI screen resolutions in Windows.
• Other apps in Windows use color icons for apps that run in the tray bar, might be worth using the version with blue background than the monochromatic icons we use in macOS.

• It should detect columns and add drop-downs for each one
• The user can use the drop-downs to match each column with one of CanutinFile's types
• Nice-to-have: add a table below the import form with a few rows of data so the user can see it as a reference when mapping the columns

• Run every step outlined in the README through a single command
• Update .github/workflow's so they take advantage of such command
• Update README

Reference

1. Install Electron dependencies

% npm install

2. Install SvelteKit dependencies

% cd sveltekit && npm install

3. Generate Prisma's artifacts.

% cd sveltekit && npx prisma generate

4. Create and seed a vault which will be seeded with the minimum required data (account/asset types, categories, etc).

% cd sveltekit && npx prisma migrate dev

• Describe the shape of CanutinFiles
• List all xxx.json endpoints and what payloads they accept

The Transactions page has an active API endpoint which can be interacted from outside the app with a GET request.
Should add a <Section /> (perhaps below the transactions table) with instructions on how to use it.

Example from Import page:

• For example: [section] - Canutin, [accountName] - Account - Canutin

• If a vault path is not stored in the app's settings a prompt will open when the app is opened.
• The prompt should have 3 options:
  • Create new vault
    • Should open a save dialog window.
    • Once the user sets the path we create a copy of a blank vault at that location.
    • The server starts with that vault set.
  • Open existing vault
    • Maps to the existing behavior that triggers openVault()
  • Dismiss
    • Closes the prompt and keeps the app running in the background in an idle state.

For example:

• Searching/filtering transactions
• Importing data

Blocked by #39

• When the production app is running side-by-side with the development app there is no way to visually differentiate them.
• Changing the icon for the development environment should make it obvious which one is which.

The current implementation sets a timeout delay but ideally we should check if the server is indeed running before it opens the url in the user's browser.

Might be a good idea to also update the way toggleServer() sets the this.isServerRunning prop.

Perhaps we could try tcp-port-used to check if the port is used.

• Add the routes /accounts and /assets
• This view will show a table with all of the accounts/assets (including those isClosed and isSold respectively)

https://playwright.dev/docs/test-snapshots

Tests to capture:

• The big picture
• Balance sheet
• Transactions
• Developer tools
• Vault error

https://www.electron.build/auto-update

Blocked by #29

If we can't read the app version in SvelteKit from it's package.json we could could use Electrons app.getVersion() and pass it as an environment variable, for example: ELECTRON_APP_VERSION.

balanceSheet.test.ts.

// Check that the balanceGroups have the correct amounts after importing data
await importCanutinFile(baseURL!, 'minimum-data');
await page.reload();
expect(await page.locator('.card', { hasText: 'Cash' }).textContent()).toMatch('$0');
expect(await page.locator('.card', { hasText: 'Debt' }).textContent()).toMatch('$0');
expect(await page.locator('.card', { hasText: 'Investments' }).textContent()).toMatch('$0');
expect(await page.locator('.card', { hasText: 'Other assets' }).textContent()).toMatch('$7,571');

We should replace importCanutinFile() with databaseSeed() and add more detailed assertions (maybe in a separate test).

• I think we can enable allowToChangeInstallationDirectory.
• Sounds like this feature is only available for Windows isntallers.

• Archive canutin/desktop-legacy
• Update README's
• Update Canutin.com so the links point to this repository

https://www.electron.build/code-signing

• Fields such as assetBalanceStatement.value, accountBalanceStatement.cost, accountBalanceStatement.value, transaction.amount should be formatted as currency.
• Number fields that don't need to be expressed as currencies should have monospace font-family (i.e. assetBalanceStatement.quantity)

Positive values should be in --color-greenPrimary

Negative values in --color-redPrimary

Zero should be the same shade of grey as the placeholder

sveltejs/kit#5774

• In the Account edit form, when an account has auto-calculated set to true the Balance field should reflect the correct value.

• Check if the existing DB needs migration
• Apply migrations if needed
• Seed it if the DB is new

REF #28

https://github.com/Canutin/svelte-currency-input

• Display a list of actions a user can take to ingest data into the app.
• Buttons to show:
  • Sync with Plaid (maybe)
  • Import from CanutinFile
  • Import from CSV (not yet implemented)
  • Add account
  • Add asset
  • Add transaction

At least will need to settle this error:

Rename your server hook file from src/hooks.ts to src/hooks.server.ts (because there's also client hooks now). See the PR for more information: https://github.com/sveltejs/kit/pull/6586

sveltejs/kit#6586

REF https://kit.svelte.dev/docs/layouts#error-pages

• 404
• 500
  • Check that if there is an issue with the vault (i.e no seeded data) it shows a descriptive error so it's easier to troubleshoot.

The test UI is rendered correctly when there are transactions present varies depending on the day in which the test is run, need to make the transaction results more deterministic to avoid this issue.