Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-12-27 02:23:28 +08:00
Code Issues Projects Releases Packages Wiki Activity

Add Roadmap doc

Browse source
This commit is contained in:
Ben Gotow 2017-08-10 15:19:21 -07:00
parent 4726cc249a
commit d87a602c8b
2 changed files with 101 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -23,31 +23,9 @@ High level Goals:
- Bring back mail rules.
Technical Breakdown of Changes:
Roadmap and Progress:
---
- Activity window and client-sync package removed.
- MailsyncBridge, a new singleton in the main window, manages C++ sync workers.
- DatabaseStore no longer provides an interface to write to the database from JavaScript and the following have moved to C++:
+ Database setup and migration
+ Search indexing of threads/contacts
+ Delta processing
+ Task processing
- Heavy node modules removed:
+ Bluebird
+ Q
+ request
+ etc...
- Package manager has been completely rewritten to be more performant and load packages in two phases.
- Delta serialization / deserialization performance has been dramatically improved by removing the JSON reviver.
- FileDownloadStore / FileUploadStore have been merged into AttachmentStore
Future Features:
----
- Receipts
- Templates with per-template performance tracking
- Groups
- Files
See [ROADMAP.md](https://github.com/Foundry376/Merani/blob/master/ROADMAP.md)
----------------

99
ROADMAP.md Normal file
View file

@ -0,0 +1,99 @@
## Roadmap to Initial Release:
Target Ship Date: Late September
#### C++ MailSync
*Goal: Reduce bugginess and battery impact, enable new controls over what mail data is synced, and dramatically improve performance by moving mailsync to a new C++ codebase based on MailCore2.*
- [x] Build a lightweight C++ command-line application that syncs mail using `MailCore2` and `libcurl` and writes to the same sqlite3 database schema used by Nylas Mail.
- [x] Remove the client-sync package and the Activity window and implement `MailsyncProcess`/`MailsyncBridge` wrappers around new C++ codebase. Broadcast database events from the C++ app into the JavaScript app so the UI updates as data changes.
- [x] Remove thread and contact search indexing, perform indexing as data is retrieved from IMAP in C++.
- [x] Remove migration support from JavaScript. Run the C++ app at launch with `--migrate` to run migrations before the main window is displayed.
- [x] Make the DatabaseStore in the JavaScript application read-only. All changes to all models flow through C++ worker for that account.
- [x] Rewrite the task queue to dispatch tasks to C++ and watch for table changes rather than executing tasks in JavaScript.
- [x] Rewrite all mail triage tasks (flag changes, folder changes, label changes) in C++ and update JS code to dispatch tasks to the C++ codebase.
- [x] Rewrite sync progress reporting to use new metrics attached to Folder models
- [x] Refactor the way the JavaScript front-end references "Labels" and "Folders" to reflect the fact that Gmail has both labels and folders, not just labels and "special labels with weird behavior."
- [x] Refactor the `FileUploadStore` and `FileDownloadStore` into a single `AttachmentStore`. Remove all uploading / downloading from JavaScript.
- [x] Rewrite the onboarding flow to spawn a C++ worker to check IMAP/SMTP credentials.
- [x] Rewrite the SendDraftTask in C++
- [x] Basic implementation
- [ ] Ensure errors are presented in JavaScript and re-open the message window
- [ ] Ensure "multisend" works and metadata is transferred to the new message
- [ ] Ensure the message is saved to the Sent Folder
- [x] Store IMAP/SMTP credentials and the cloud API token in the keychain securely.
- [ ] Ensure C++ worker crashes are reported through Sentry or Backtrace
- [ ] Restart C++ workers if they crash and alert the user to repeated errors.
- [ ] Add support for Gmail authentication flow and XOAUTH2 [ until this is done, you need to use an "App Password" ]
- [ ] Add more robust retry / failure handling logic to C++ code.
- [ ] Decide what license to use for the C++ codebase / whether to open-source it or provide binaries.
- [ ] Link the C++ codebase into Merani as a submodule, make Travis and AppVeyor CI build the C++ codebase.
#### C++ MailSync Testing:
- [x] Test with a Gmail account
- [x] Test with a FastMail account
- [ ] Test with a Yahoo account
- [ ] Test with an iCloud account
- [ ] Test with a AOL account
- [ ] Test with an insecure IMAP/SMTP account
- [ ] Test that "multisend" works for open/link tracking
- [ ] Test that sending errors are shown in JavaScript
#### Cloud Services
*Goal: Provide equivalent infrastructure that will allow snooze, send later, to continue working, autoupdating of the app, etc.*
- [x] Re-implement Identity services (billing.nylas.com)
+ [x] Implement basic sign in / create your account pages and token-based auth
+ [ ] Implement autoupdate and download endpoints for Mac, Win, Linux
+ [ ] Implement billing dashboard for paid version
- [x] Re-implement Accounts services ("Edgehill" API):
+ [x] Implement storage of key-value metadata for threads, messages and contacts.
+ [x] Implement delta stream that sends metadata changes to the app (eg: when an email is opened.)
+ [x] Implement delta stream handling in the C++ codebase
#### Deployment
- [x] Create a new AWS account for Merani project
- [x] Register Merani domain(s)
- [ ] Setup Sentry for JavaScript error reporting
- [x] Obtain Mac Developer Certificate for Merani
- [ ] Obtain Windows Verisign Certificate for Merani
- [ ] Deploy new identity API to id.getmerani.com
- [ ] Deploy new accounts API to accounts.getmerani.com
- [ ] Deploy cloud workers to a secured AWS VPC
*Blocked: Waiting for Nylas to open-source the rest of the code.*
#### General
- [ ] Create a new logo / icon for Merani
- [x] Bump Electron to 1.7.6
- [x] Bump React to 15.x
- [x] Remove "heavy" Node modules no longer needed in 2017 and contribute to slow launch time:
*Bluebird, Q, node-request, etc.*
- [x] Re-implement package manager to support two-phase loading. Get the window onscreen faster and wait to load non-essential plugins.
- [x] Stop transpiling async/await which are now supported by Electron
- [~] Rewrite all CoffeeScript in modern JavaScript. See [this spreadsheet](https://docs.google.com/spreadsheets/d/1DsZhrNEzCTBlsrPo82UkUxSgqj_fkGRcgTQ-lurnq7c) for progress.
- [ ] Figure out why the composer contenteditable selection freaks out sometimes (related to upgrading Electron + Chromium?) Composer is not shippable ATM.
- [ ] QA the entire application
-----
## Roadmap Past 1.0
- [ ] Bring back Mail Rules!
- [ ] Update documentation for creating plugins and themes
- [ ] Create help site using existing content from support.nylas.com.
*Verify they are OK with this?*
- [ ] Implement plugin / theme browser like the Chrome Web Store.
+ Decide whether to restore support for plugins that need native modules.
- [ ] Localize the app into other languages
- [ ] Improve Linux support (find a maintainer interested in focusing on Linux?)
- [ ] Overhaul the rich text composer:
+ It's currently pretty slow and degrades the overall experience. Initially we wanted to support editing reply text / inline replies, and this has come at a high cost. Investigate using Draft.JS instead of our custom composer.
- [ ] Add options for controlling the size of the message cache
+ Only sync the last "X" months of mail headers
+ Only sync the last "X" months of mail bodies / attachments
+ Omit certain folders
- [ ] Create new plugins:
+ Receipts
+ Templates with per-template performance tracking
+ Groups
+ Files