Merge branch 'master' into master

Author: jsimonweb

appengine/flexible/multiple_services/README.md

@@ -63,5 +63,5 @@ and enter `Y` when prompted.  Or to skip the check add `-q`.
 To deploy multiple services simultaneously just add the path to each `app.yaml`
 file as an argument to `gcloud app deploy `:
 ```Bash
-$ gcloud app deploy gateway/app.yaml static/app.yaml
+$ gcloud app deploy gateway-service/app.yaml static-service/app.yaml
 ```

appengine/flexible/websockets/README.md

@@ -0,0 +1,11 @@
+# Python websockets sample for Google App Engine Flexible Environment
+
+This sample demonstrates how to use websockets on [Google App Engine Flexible Environment](https://cloud.google.com/appengine).
+
+## Running locally
+
+Refer to the [top-level README](../README.md) for instructions on running and deploying.
+
+To run locally, you need to use gunicorn with the ``flask_socket`` worker:
+
+    $ gunicorn -b 127.0.0.1:8080 -k flask_sockets.worker main:app

appengine/flexible/websockets/app.yaml

@@ -0,0 +1,22 @@
+runtime: python
+env: flex
+
+# Use a special gunicorn worker class to support websockets.
+entrypoint: gunicorn -b :$PORT -k flask_sockets.worker main:app
+
+runtime_config:
+  python_version: 3
+
+# Use only a single instance, so that this local-memory-only chat app will work
+# consistently with multiple users. To work across multiple instances, an
+# extra-instance messaging system or data store would be needed.
+manual_scaling:
+  instances: 1
+
+
+# For applications which can take advantage of session affinity
+# (where the load balancer will attempt to route multiple connections from
+# the same user to the same App Engine instance), uncomment the folowing:
+
+# network:
+#   session_affinity: true

appengine/flexible/websockets/main.py

@@ -0,0 +1,53 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+from __future__ import print_function
+
+# [START gae_flex_websockets_app]
+from flask import Flask, render_template
+from flask_sockets import Sockets
+
+
+app = Flask(__name__)
+sockets = Sockets(app)
+
+
+@sockets.route('/chat')
+def chat_socket(ws):
+    while not ws.closed:
+        message = ws.receive()
+        if message is None:  # message is "None" if the client has closed.
+            continue
+        # Send the message to all clients connected to this webserver
+        # process. (To support multiple processes or instances, an
+        # extra-instance storage or messaging system would be required.)
+        clients = ws.handler.server.clients.values()
+        for client in clients:
+            client.ws.send(message)
+# [END gae_flex_websockets_app]
+
+
+@app.route('/')
+def index():
+    return render_template('index.html')
+
+
+if __name__ == '__main__':
+    print("""
+This can not be run directly because the Flask development server does not
+support web sockets. Instead, use gunicorn:
+
+gunicorn -b 127.0.0.1:8080 -k flask_sockets.worker main:app
+
+""")

appengine/flexible/websockets/main_test.py

@@ -0,0 +1,71 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+
+import socket
+import subprocess
+
+import pytest
+import requests
+from retrying import retry
+import websocket
+
+
+@pytest.fixture(scope='module')
+def server():
+    """Provides the address of a test HTTP/websocket server.
+    The test server is automatically created before
+    a test and destroyed at the end.
+    """
+    # Ask the OS to allocate a port.
+    sock = socket.socket()
+    sock.bind(('127.0.0.1', 0))
+    port = sock.getsockname()[1]
+
+    # Free the port and pass it to a subprocess.
+    sock.close()
+
+    bind_to = '127.0.0.1:{}'.format(port)
+    server = subprocess.Popen(
+        ['gunicorn', '-b', bind_to, '-k' 'flask_sockets.worker', 'main:app'])
+
+    # Wait until the server responds before proceeding.
+    @retry(wait_fixed=50, stop_max_delay=5000)
+    def check_server(url):
+        requests.get(url)
+
+    check_server('http://{}/'.format(bind_to))
+
+    yield bind_to
+
+    server.kill()
+
+
+def test_http(server):
+    result = requests.get('http://{}/'.format(server))
+    assert 'Python Websockets Chat' in result.text
+
+
+def test_websocket(server):
+    url = 'ws://{}/chat'.format(server)
+    ws_one = websocket.WebSocket()
+    ws_one.connect(url)
+
+    ws_two = websocket.WebSocket()
+    ws_two.connect(url)
+
+    message = 'Hello, World'
+    ws_one.send(message)
+
+    assert ws_one.recv() == message
+    assert ws_two.recv() == message

appengine/flexible/websockets/requirements.txt

@@ -0,0 +1,4 @@
+Flask==0.12.2
+Flask-Sockets==0.2.1
+gunicorn==19.7.1
+requests==2.14.2

appengine/flexible/websockets/templates/index.html

@@ -0,0 +1,96 @@
+{#
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+#}
+<!doctype html>
+<html>
+  <head>
+    <title>Google App Engine Flexible Environment - Python Websockets Chat</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  </head>
+  <body>
+
+    <!-- [START gae_flex_websockets_form] -->
+    <p>Chat demo</p>
+    <form id="chat-form">
+      <textarea id="chat-text" placeholder="Enter some text..."></textarea>
+      <button type="submit">Send</button>
+    </form>
+
+    <div>
+      <p>Messages:</p>
+      <ul id="chat-response"></ul>
+    </div>
+
+    <div>
+      <p>Status:</p>
+      <ul id="chat-status"></ul>
+    </div>
+    <!-- [END gae_flex_websockets_form] -->
+
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
+    <script>
+    // [START gae_flex_websockets_js]
+    $(function() {
+      /* If the main page is served via https, the WebSocket must be served via
+         "wss" (WebSocket Secure) */
+      var scheme = window.location.protocol == "https:" ? 'wss://' : 'ws://';
+      var webSocketUri =  scheme
+                          + window.location.hostname
+                          + (location.port ? ':'+location.port: '')
+                          + '/chat';
+
+      /* Get elements from the page */
+      var form = $('#chat-form');
+      var textarea = $('#chat-text');
+      var output = $('#chat-response');
+      var status = $('#chat-status');
+
+      /* Helper to keep an activity log on the page. */
+      function log(text){
+        status.append($('<li>').text(text))
+      }
+
+      /* Establish the WebSocket connection and register event handlers. */
+      var websocket = new WebSocket(webSocketUri);
+
+      websocket.onopen = function() {
+        log('Connected');
+      };
+
+      websocket.onclose = function() {
+        log('Closed');
+      };
+
+      websocket.onmessage = function(e) {
+        log('Message received');
+        output.append($('<li>').text(e.data));
+      };
+
+      websocket.onerror = function(e) {
+        log('Error (see console)');
+        console.log(e);
+      };
+
+      /* Handle form submission and send a message to the websocket. */
+      form.submit(function(e) {
+        e.preventDefault();
+        var data = textarea.val();
+        websocket.send(data);
+      });
+    });
+    // [END gae_flex_websockets_js]
+    </script>
+  </body>
+</html>