Merge branch 'master' into release/0.1.14

Author: tublitzed

.gitignore

@@ -25,8 +25,6 @@ pypy/
 ./src/
 .tox/
 .eggs/
-autopush_rs/target
-autopush_rs/_native*
 target
 *.rs.bk
 .#*

Makefile

@@ -4,6 +4,14 @@
 
 SYNC_DATABASE_URL = 'mysql://sample_user:sample_password@localhost/syncstorage_rs'
 
+# This key can live anywhere on your machine. Adjust path as needed.
+PATH_TO_SYNC_SPANNER_KEYS = `pwd`/service-account.json
+
+# TODO: replace with rust grpc alternative when ready
+# Assumes you've cloned the server-syncstorage repo locally into a peer dir.
+# https://github.com/mozilla-services/server-syncstorage
+PATH_TO_GRPC_CERT = ../server-syncstorage/local/lib/python2.7/site-packages/grpc/_cython/_credentials/roots.pem
+
 clippy:
 	# Matches what's run in circleci
 	cargo clippy --all --all-targets -- -D warnings
@@ -20,5 +28,8 @@ docker_stop:
 run:
 	RUST_LOG=debug RUST_BACKTRACE=full cargo run -- --config config/local.toml
 
+run_spanner:
+	GOOGLE_APPLICATION_CREDENTIALS=$(PATH_TO_SYNC_SPANNER_KEYS) GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=$(PATH_TO_GRPC_CERT) make run
+
 test:
 	cd db-tests && SYNC_DATABASE_URL=$(SYNC_DATABASE_URL) RUST_TEST_THREADS=1 cargo test

README.md

@@ -71,8 +71,8 @@ select the correct project.
 - Select "_Create Key_" from the pop-up menu.
 - Select "JSON" from the Dialog Box.
 
-A proper Key file will be downloaded to your local directory. It's important to safeguard that key file. For this example, we're going to name the file
-`sync-spanner.json` and store it in a subdirectory called `./keys`
+A proper key file will be downloaded to your local directory. It's important to safeguard that key file. For this example, we're going to name the file
+`service-account.json`.
 
 The proper key file is in JSON format. An example file is provided below, with private information replaced by "`...`"
 
@@ -91,15 +91,15 @@ The proper key file is in JSON format. An example file is provided below, with p
 }
 ```
 
-You can then specify the path to the key file using the environment variable `GOOGLE_APPLICATION_CREDENTIALS` when running the application.
-
-e.g.
+Note, that unlike MySQL, there is no automatic migrations facility. Currently Spanner schema must be hand edited and modified.
 
-```bash
-RUST_LOG=warn GOOGLE_APPLICATION_CREDENTIALS=`pwd`/keys/sync-spanner.json` cargo run -- --config sync.ini
-```
+To point to a GCP hosted Spanner instance from your local machine, follow these steps:
 
-Note, that unlike MySQL, there is no automatic migrations facility. Currently Spanner schema must be hand edited and modified.
+1. Download the key file as shown above.
+2. Open `local.toml` and replace `database_url` with a link to your spanner instance.
+3. Open the Makefile and ensure you've correctly set you `PATH_TO_GRPC_CERT`.
+4. `make run_spanner`.
+5. Visit `http://localhost:8000/__heartbeat__` to make sure the server is running.
 
 ### Running via Docker
 This currently requires access to the [mozilla-rust-sdk](https://github.com/mozilla-services/mozilla-rust-sdk) repo. If you don't have it, this will be made public soon; we'll update the README here when that happens.

config/local.example.toml

@@ -1,4 +1,11 @@
+# Example MySQL DSN:
 database_url = "mysql://sample_user:sample_password@localhost/syncstorage_rs"
+
+# Example Spanner DSN:
+# database_url="spanner://projects/SAMPLE_GCP_PROJECT/instances/SAMPLE_SPANNER_INSTANCE/databases/SAMPLE_SPANNER_DB"
+
+"limits.max_total_records"=1666 # See issues #298/#333
 master_secret = "INSERT_SECRET_KEY_HERE"
+
 # removing this line will default to moz_json formatted logs (which is preferred for production envs)
 human_logs = 1 

docs/config.md

@@ -24,7 +24,7 @@ $ cargo run -- --config sync.ini
 Options can be mixed between environment and configuration.
 
 ## Options
-The following configuration options are avaialble.
+The following configuration options are available.
 
 | Option | Default value |Description |
 | --- | --- | --- |