Mailspring/docs/build-instructions/windows.md
Ben Gotow 1e8fd46342 fix(drafts): Various improvements and fixes to drafts, draft state management
Summary:
This diff contains a few major changes:

1. Scribe is no longer used for the text editor. It's just a plain contenteditable region. The toolbar items (bold, italic, underline) still work. Scribe was causing React inconcistency issues in the following scenario:
   - View thread with draft, edit draft
   - Move to another thread
   - Move back to thread with draft
   - Move to another thread. Notice that one or more messages from thread with draft are still there.

There may be a way to fix this, but I tried for hours and there are Github Issues open on it's repository asking for React compatibility, so it may be fixed soon. For now contenteditable is working great.

2. Action.saveDraft() is no longer debounced in the DraftStore. Instead, firing that action causes the save to happen immediately, and the DraftStoreProxy has a new "DraftChangeSet" class which is responsbile for batching saves as the user interacts with the ComposerView. There are a couple big wins here:

   - In the future, we may want to be able to call Action.saveDraft() in other situations and it should behave like a normal action. We may also want to expose the DraftStoreProxy as an easy way of backing interactive draft UI.

   - Previously, when you added a contact to To/CC/BCC, this happened:

     <input> -> Action.saveDraft -> (delay!!) -> Database -> DraftStore -> DraftStoreProxy -> View Updates

Increasing the delay to something reasonable like 200msec meant there was 200msec of lag before you saw the new view state.

To fix this, I created a new class called DraftChangeSet which is responsible for accumulating changes as they're made and firing Action.saveDraft. "Adding" a change to the change set also causes the Draft provided by the DraftStoreProxy to change immediately (the changes are a temporary layer on top of the database object). This means no delay while changes are being applied. There's a better explanation in the source!

This diff includes a few minor fixes as well:

1. Draft.state is gone—use Message.object = draft instead
2. String model attributes should never be null
3. Pre-send checks that can cancel draft send
4. Put the entire curl history and task queue into feedback reports
5. Cache localIds for extra speed
6. Move us up to latest React

Test Plan: No new tests - once we lock down this new design I'll write tests for the DraftChangeSet

Reviewers: evan

Reviewed By: evan

Differential Revision: https://review.inboxapp.com/D1125
2015-02-03 16:24:31 -08:00

4.1 KiB

Windows

Requirements

On Windows 7

On Windows 8

Instructions

# Use the `Git Shell` app which was installed by GitHub for Windows. Also Make
# sure you have logged into the GitHub for Windows GUI App.
cd C:\
git clone https://github.com/inboxapp/edgehill/
cd edgehill
script/build # Creates application in the `Program Files` directory

Why do I have to use GitHub for Windows?

You don't. You can use your existing Git! GitHub for Windows's Git Shell is just easier to set up.

If you prefer using your existing Git installation, make sure git's cmd directory is in your PATH env variable (e.g. C:\Program Files (x86)\Git\cmd) before you open your powershell or command window. Note that you may have to open your command window as administrator. For powershell that doesn't seem to always be the case, though.

If none of this works, do install Github for Windows and use its Git shell. Makes life easier.

Troubleshooting

Common Errors

  • node is not recognized

    • If you just installed node you need to restart your computer before node is available on your Path.
  • script/build outputs only the Node and Python versions before returning

    • Try moving the repository to C:\atom. Most likely, the path is too long. See issue #2200.
  • error MSB4025: The project file could not be loaded. Invalid character in the given encoding.

  • script/build stops at installing runas with 'Failed at the runas@0.5.4 install script.'

    See the next item.

  • error MSB8020: The build tools for Visual Studio 2010 (Platform Toolset = 'v100') cannot be found.

    • If you're building atom with Visual Studio 2013 try executing the following command in your Git shell and then re-run script/build:

      $env:GYP_MSVS_VERSION=2013
      
  • Other node-gyp errors on first build attempt, even though the right node and python versions are installed.

    • Do try the build command one more time, as experience shows it often works on second try in many of these cases.

Windows build error reports in atom/atom

  • If all fails, use this search to get a list of reports about build errors on Windows, and see if yours has already been reported.

  • If it hasn't, please open a new issue with your Windows version 32/64bit and a print/screenshot of your build output, incl. the node and python versions.