Used nightly is undocumented

[badboy]

tide requires nightly, but this is nowhere documented.
Additionally it's not documented which nightly works.
The one defined for Travis is old and as shown by Travis, tide doesn't compile anymore.

Please do:

1. Document that it depends on nightly (and why).
2. Document which nightly works, e.g. in a rust-toolchain file.
3. Use that nightly on CI.

[badboy]

Oh, additionally it might be necessary to either have a Cargo.lock committed or version-pin dependencies. I can't get Tide compiled with yesterday's or today's nightly because dependencies fail to build.

[fairingrey]

I agree, it should be documented!

By the way, the latest nightly that works with tide currently is nightly-2019-04-07, because of rust-lang/futures-rs#1518. The fix to it was merged just hours ago and futures 0.3.0-alpha.14 is now available with the fix.

However, the http-service dependency still relies on 0.3.0-alpha.13, so it can't be used until that's also updated, I believe... There's a breaking change here:

 cargo build
   Compiling arrayvec v0.4.10
   Compiling either v1.5.2
   Compiling byteorder v1.3.1
   Compiling proc-macro-nested v0.1.3
   Compiling cfg-if v0.1.7
   Compiling lazy_static v1.3.0
   Compiling stable_deref_trait v1.1.1
   Compiling siphasher v0.2.3
   Compiling nodrop v0.1.13
   Compiling scopeguard v0.3.3
   Compiling cc v1.0.35
   Compiling smallvec v0.6.9
   Compiling serde v1.0.90
   Compiling memoffset v0.2.1
   Compiling lazycell v1.2.1
   Compiling num-traits v0.2.6
   Compiling slab v0.4.2
   Compiling fnv v1.0.6
   Compiling futures v0.1.26
   Compiling pin-utils v0.1.0-alpha.4
   Compiling memchr v2.2.0
   Compiling num-integer v0.1.39
   Compiling itoa v0.4.3
   Compiling httparse v1.3.3
   Compiling ryu v0.2.7
   Compiling slog v2.4.1
   Compiling string v0.1.3
   Compiling rustc-demangle v0.1.14
   Compiling try-lock v0.2.2
   Compiling safemem v0.2.0
   Compiling traitobject v0.1.0
   Compiling remove_dir_all v0.5.1
   Compiling quick-error v1.2.2
   Compiling take_mut v0.2.2
   Compiling safemem v0.3.0
   Compiling data-encoding v2.1.2
   Compiling percent-encoding v1.0.1
   Compiling route-recognizer v0.1.12
   Compiling proc-macro2 v0.4.27
   Compiling libc v0.2.51
   Compiling semver v0.9.0
   Compiling rand_chacha v0.1.1
   Compiling rand_pcg v0.1.2
   Compiling rand v0.6.5
   Compiling backtrace v0.3.15
   Compiling unicase v1.4.2
   Compiling syn v0.15.31
   Compiling rand_core v0.3.1
   Compiling rand_jitter v0.1.3
   Compiling futures-core-preview v0.3.0-alpha.14
   Compiling log v0.4.6
   Compiling owning_ref v0.4.0
   Compiling crossbeam-utils v0.6.5
   Compiling tokio-trace-core v0.1.0
   Compiling thread_local v0.3.6
   Compiling backtrace-sys v0.1.28
   Compiling unsafe-any v0.4.2
   Compiling tokio-sync v0.1.4
   Compiling rustc_version v0.2.3
   Compiling rand_isaac v0.1.1
   Compiling rand_hc v0.1.0
   Compiling rand_xorshift v0.1.1
   Compiling futures-channel-preview v0.3.0-alpha.14
   Compiling lock_api v0.1.5
   Compiling log v0.3.9
   Compiling want v0.0.6
   Compiling crossbeam-queue v0.1.2
   Compiling tokio-executor v0.1.7
   Compiling typemap v0.3.3
   Compiling parking_lot_core v0.4.0
   Compiling rand_os v0.1.3
   Compiling iovec v0.1.2
   Compiling net2 v0.2.33
   Compiling num_cpus v1.10.0
   Compiling rand v0.4.6
   Compiling dirs v1.0.5
   Compiling time v0.1.42
   Compiling isatty v0.1.9
   Compiling quote v0.6.12
   Compiling crossbeam-epoch v0.7.1
   Compiling futures-sink-preview v0.3.0-alpha.14
   Compiling mime v0.2.6
   Compiling tokio-current-thread v0.1.6
   Compiling tokio-timer v0.2.10
   Compiling twoway v0.1.8
   Compiling buf_redux v0.8.1
   Compiling slog-async v2.3.0
   Compiling futures-io-preview v0.3.0-alpha.14
   Compiling bytes v0.4.12
   Compiling futures-cpupool v0.1.8
   Compiling mio v0.6.16
   Compiling term v0.5.2
   Compiling phf_shared v0.7.24
   Compiling cookie v0.11.0
   Compiling tempdir v0.3.7
   Compiling crossbeam-deque v0.7.1
   Compiling chrono v0.4.6
   Compiling tokio-io v0.1.12
   Compiling http v0.1.17
   Compiling phf v0.7.24
   Compiling phf_generator v0.7.24
   Compiling tokio-threadpool v0.1.13
   Compiling error-chain v0.12.0
   Compiling slog-term v2.4.0
   Compiling phf_codegen v0.7.24
   Compiling parking_lot v0.7.1
   Compiling mime_guess v1.8.6
   Compiling tokio-reactor v0.1.9
   Compiling proc-macro-hack v0.5.4
   Compiling serde_derive v1.0.90
   Compiling multipart v0.15.4
   Compiling tokio v0.1.18
   Compiling tokio-tcp v0.1.3
   Compiling futures-select-macro-preview v0.3.0-alpha.14
   Compiling futures-util-preview v0.3.0-alpha.14
   Compiling futures-executor-preview v0.3.0-alpha.14
   Compiling futures-preview v0.3.0-alpha.14
   Compiling http-service v0.1.4
error[E0053]: method `poll_next` has an incompatible type for trait
  --> /home/allen/.cargo/registry/src/github.com-1ecc6299db9ec823/http-service-0.1.4/src/lib.rs:65:5
   |
65 |     fn poll_next(mut self: Pin<&mut Self>, waker: &Waker) -> Poll<Option<Self::Item>> {
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ types differ in mutability
   |
   = note: expected type `fn(std::pin::Pin<&mut Body>, &mut std::task::Context<'_>) -> core::task::poll::Poll<std::option::Option<std::result::Result<bytes::bytes::Bytes, std::io::Error>>>`
              found type `fn(std::pin::Pin<&mut Body>, &std::task::Waker) -> core::task::poll::Poll<std::option::Option<std::result::Result<bytes::bytes::Bytes, std::io::Error>>>`

error: aborting due to previous error

For more information about this error, try `rustc --explain E0053`.
error: Could not compile `http-service`.
warning: build failed, waiting for other jobs to finish...
error: build failed

EDIT: should work now!

[DCjanus]

Not related to the lock file, more is the change of the standard library.
As library, tide should not lock dependencies, Patch version update should not interrupt user.

[badboy]

@fairingrey cool, thanks!
@DCjanus Normally I would agree, but this being all unstable and nightly APIs there's a higher chance on breaking.

[secretfader]

We mention that Tide requires the async_await feature flag in the README. As someone familiar with the Rust ecosystem, this is obvious enough. Still, I could see where newcomers might be tripped up.

I'm conflicted over whether we need a notice that Tide requires nightly (and a fairly recent one, too). If this question were posed a few months ago, I'd suggest notifying potential users. However, according to my understanding, we're only a few months away, maximum, from having a stable implementation of Futures in the standard library.

Tide isn't ready for prime-time just yet. If newcomers want to use the framework, that's great; we can educate as needed, but I wouldn't recommend it for beginners. As of now, I favor waiting out the release of std::future and updating the README when we have news of stability.