appengine: updating dependency paths and adding documentation

.travis.yml

@@ -16,10 +16,9 @@ install:
 
   # Google App Engine dependencies
   - cd ..
-  - wget https://storage.googleapis.com/appengine-sdks/featured/go_appengine_sdk_linux_amd64-1.9.23.zip
-  - unzip -q go_appengine_sdk_linux_amd64-1.9.23.zip
+  - wget https://storage.googleapis.com/appengine-sdks/featured/go_appengine_sdk_linux_amd64-1.9.40.zip
+  - unzip -q go_appengine_sdk_linux_amd64-1.9.40.zip
   - export PATH=$PATH:$PWD/go_appengine/
-  - $PWD/go_appengine/goapp get github.com/stretchr/testify/require github.com/pborman/uuid golang.org/x/net/context # FIXME
   - cd cayley
 
 script:

appengine/.gitignore

@@ -0,0 +1,4 @@
+/appengine
+/docs
+/static
+/templates

appengine/README.md

@@ -0,0 +1,59 @@
+# About appengine
+
+This directory contains a appengine deployable cayley graph instance.
+
+# Running/testing traditional appengine locally
+
+Install the latest appengine sdk, and ensure that your local version of go
+matches the same version obtained from `goapp`.
+
+Note: if you use a more recent version of Go locally, `goapp` get might
+accidentally copy the wrong files from the local `$GOPATH`.
+
+```sh
+$ cd $GOPATH/src/github.com/cayleygraph/cayley/appengine
+
+# check go version
+$ go version
+
+# check goapp version
+$ goapp version
+
+# install dependencies
+$ goapp get
+
+# ensure that goapp can build
+$ goapp build
+
+# test locally
+$ goapp serve
+```
+
+# Running/testing flexible appengine locally
+
+The latest appengine flexible environment can be tested instead of the
+traditional environment by doing the following:
+
+```sh
+# calls ./sync-assets.sh
+$ go generate
+
+$ goapp serve app.flexible.yaml
+```
+
+# Deploying to traditional appengine environment
+```sh
+$ goapp deploy -version 1 -application <MY_PROJECT_ID>
+```
+
+# Deploying to flexible appengine environment
+```sh
+# install aedeploy if not installed
+$ go get -u google.golang.org/appengine/cmd/aedeploy
+
+# calls ./sync-assets.sh
+$ go generate
+
+# deploy
+$ aedeploy gcloud app deploy app.flexible.yaml
+```

appengine/app.flexible.yaml

@@ -0,0 +1,2 @@
+runtime: go
+vm: true

appengine/app.yaml

@@ -1,7 +1,5 @@
-application: cayley-test
-version: 1
 runtime: go
-api_version: go1.6.3
+api_version: go1
 
 handlers:
 - url: /.*

appengine/appengine.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// +build appengine
+// +build appengine appenginevm
 
 package main
 

appengine/main.go

@@ -0,0 +1,10 @@
+// +build appenginevm
+package main
+
+//go:generate ./sync-assets.sh
+
+import "google.golang.org/appengine"
+
+func main() {
+	appengine.Main()
+}

appengine/sync-assets.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+SRC="$( cd -P "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+rsync -avP --delete $GOPATH/src/github.com/cayleygraph/cayley/{static,docs,templates} $SRC/

graph/gaedatastore/iterator.go

@@ -12,18 +12,17 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// +build appengine
-
 package gaedatastore
 
 import (
 	"fmt"
+
 	"github.com/cayleygraph/cayley/graph"
 	"github.com/cayleygraph/cayley/graph/iterator"
 	"github.com/cayleygraph/cayley/quad"
 
-	"appengine/datastore"
 	"github.com/cayleygraph/cayley/clog"
+	"google.golang.org/appengine/datastore"
 )
 
 type Iterator struct {

graph/gaedatastore/quadstore.go

@@ -12,8 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// +build appengine
-
 package gaedatastore
 
 import (
@@ -24,8 +22,9 @@ import (
 
 	"github.com/cayleygraph/cayley/clog"
 
-	"appengine"
-	"appengine/datastore"
+	"golang.org/x/net/context"
+	"google.golang.org/appengine"
+	"google.golang.org/appengine/datastore"
 
 	"github.com/cayleygraph/cayley/graph"
 	"github.com/cayleygraph/cayley/graph/iterator"
@@ -44,7 +43,7 @@ var (
 )
 
 type QuadStore struct {
-	context appengine.Context
+	context context.Context
 }
 
 type MetadataEntry struct {
@@ -156,7 +155,7 @@ func (qs *QuadStore) checkValid(k *datastore.Key) (bool, error) {
 	return true, nil
 }
 
-func getContext(opts graph.Options) (appengine.Context, error) {
+func getContext(opts graph.Options) (context.Context, error) {
 	req := opts["HTTPRequest"].(*http.Request)
 	if req == nil {
 		err := errors.New("HTTP Request needed")
@@ -270,7 +269,7 @@ func (qs *QuadStore) updateNodes(in []graph.Delta) (int64, error) {
 	for i := 0; i < len(nodeDeltas); i += 5 {
 		j := int(math.Min(float64(len(nodeDeltas)-i), 5))
 		foundNodes := make([]NodeEntry, j)
-		err := datastore.RunInTransaction(qs.context, func(c appengine.Context) error {
+		err := datastore.RunInTransaction(qs.context, func(c context.Context) error {
 			err := datastore.GetMulti(c, keys[i:i+j], foundNodes)
 			// Sift through for errors
 			if me, ok := err.(appengine.MultiError); ok {
@@ -308,7 +307,7 @@ func (qs *QuadStore) updateQuads(in []graph.Delta) (int64, error) {
 	for i := 0; i < len(in); i += 5 {
 		// Find the closest batch of 5
 		j := int(math.Min(float64(len(in)-i), 5))
-		err := datastore.RunInTransaction(qs.context, func(c appengine.Context) error {
+		err := datastore.RunInTransaction(qs.context, func(c context.Context) error {
 			foundQuads := make([]QuadEntry, j)
 			// We don't process errors from GetMulti as they don't mean anything,
 			// we've handled existing quad conflicts above and we overwrite everything again anyways
@@ -343,7 +342,7 @@ func (qs *QuadStore) updateQuads(in []graph.Delta) (int64, error) {
 func (qs *QuadStore) updateMetadata(quadsAdded int64, nodesAdded int64) error {
 	key := qs.createKeyForMetadata()
 	foundMetadata := new(MetadataEntry)
-	err := datastore.RunInTransaction(qs.context, func(c appengine.Context) error {
+	err := datastore.RunInTransaction(qs.context, func(c context.Context) error {
 		err := datastore.Get(c, key, foundMetadata)
 		if err != nil && err != datastore.ErrNoSuchEntity {
 			clog.Errorf("Error: %v", err)

graph/gaedatastore/quadstore_test.go

@@ -10,7 +10,6 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-// +build appengine
 
 package gaedatastore
 
@@ -24,7 +23,7 @@ import (
 	"github.com/cayleygraph/cayley/writer"
 	"github.com/stretchr/testify/require"
 
-	"appengine/aetest"
+	"google.golang.org/appengine/aetest"
 )
 
 // This is a simple test graph.