├── CONTRIB.md
├── Dockerfile
├── LICENSE
├── README.md
├── app.js
├── app.yaml
├── package.json
└── public
└── index.html
/CONTRIB.md:
--------------------------------------------------------------------------------
1 | # How to become a contributor and submit your own code
2 |
3 | ## Contributor License Agreements
4 |
5 | We'd love to accept your sample apps and patches! Before we can take them, we
6 | have to jump a couple of legal hurdles.
7 |
8 | Please fill out either the individual or corporate Contributor License Agreement
9 | (CLA).
10 |
11 | * If you are an individual writing original source code and you're sure you
12 | own the intellectual property, then you'll need to sign an [individual CLA]
13 | (https://developers.google.com/open-source/cla/individual).
14 | * If you work for a company that wants to allow you to contribute your work,
15 | then you'll need to sign a [corporate CLA]
16 | (https://developers.google.com/open-source/cla/corporate).
17 |
18 | Follow either of the two links above to access the appropriate CLA and
19 | instructions for how to sign and return it. Once we receive it, we'll be able to
20 | accept your pull requests.
21 |
22 | ## Contributing A Patch
23 |
24 | 1. Submit an issue describing your proposed change to the repo in question.
25 | 1. The repo owner will respond to your issue promptly.
26 | 1. If your proposed change is accepted, and you haven't already done so, sign a
27 | Contributor License Agreement (see details above).
28 | 1. Fork the desired repo, develop and test your code changes.
29 | 1. Ensure that your code adheres to the existing style in the sample to which
30 | you are contributing. Refer to the
31 | [Google Cloud Platform Samples Style Guide]
32 | (https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
33 | recommended coding standards for this organization.
34 | 1. Ensure that your code has an appropriate set of unit tests which all pass.
35 | 1. Submit a pull request.
36 |
37 | ## Contributing A New Sample App
38 |
39 | 1. Submit an issue to the GoogleCloudPlatform/Template repo describing your
40 | proposed sample app.
41 | 1. The Template repo owner will respond to your enhancement issue promptly.
42 | Instructional value is the top priority when evaluating new app proposals for
43 | this collection of repos.
44 | 1. If your proposal is accepted, and you haven't already done so, sign a
45 | Contributor License Agreement (see details above).
46 | 1. Create your own repo for your app following this naming convention:
47 | * {product}-{app-name}-{language}
48 | * products: appengine, compute, storage, bigquery, prediction, cloudsql
49 | * example: appengine-guestbook-python
50 | * For multi-product apps, concatenate the primary products, like this:
51 | compute-appengine-demo-suite-python.
52 | * For multi-language apps, concatenate the primary languages like this:
53 | appengine-sockets-python-java-go.
54 |
55 | 1. Clone the README.md, CONTRIB.md and LICENSE files from the
56 | GoogleCloudPlatform/Template repo.
57 | 1. Ensure that your code adheres to the existing style in the sample to which
58 | you are contributing. Refer to the
59 | [Google Cloud Platform Samples Style Guide]
60 | (https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the
61 | recommended coding standards for this organization.
62 | 1. Ensure that your code has an appropriate set of unit tests which all pass.
63 | 1. Submit a request to fork your repo in GoogleCloudPlatform organizationt via
64 | your proposal issue.
65 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM google/nodejs-runtime
2 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2013 Google Inc.
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Example App: Running Websocket on AppEngine
2 |
3 | This project implements a simple websocket with Node.js using the AppEngine resources;
4 |
5 |
6 | ## Project setup, installation, and configuration
7 |
8 | Create a virtual environment, and get the gcloud components. You will use the Managed VMs
9 |
10 | Then, clone this project on your machine.
11 |
12 | ```
13 |
14 | $ cd /path/to/this/project/appengine-websocket-nodejs
15 | $ npm install
16 | $ node app.js
17 |
18 | ```
19 |
20 |
21 | ## Deploying
22 |
23 | ### How to deploy
24 |
25 | ```
26 |
27 | $ gcloud preview app deploy . --force
28 |
29 | ```
30 |
31 | ### How to setup the deployment environment
32 | On your account at the Google Cloud Platform you need access the Menu:
33 | Google App Engine -> Instances - Change the option Managed to User.
34 | Next you need set the IP to static.
35 |
36 | Your app is able to run =D
37 |
38 |
39 | ## Contributing changes
40 |
41 | * See [CONTRIB.md](CONTRIB.md)
42 |
43 |
44 | ## Licensing
45 |
46 | * See [LICENSE](LICENSE)
47 |
--------------------------------------------------------------------------------
/app.js:
--------------------------------------------------------------------------------
1 | var WebSocketServer = require('ws').Server;
2 | var appengine = require('appengine');
3 | var http = require('http');
4 | var express = require('express');
5 | var app = express();
6 |
7 | var server = http.createServer(app);
8 | app.use(express.static(__dirname + '/public'));
9 | app.use(appengine.middleware.base);
10 |
11 | app.get('/_ah/health', function(req, res) {
12 | res.set('Content-Type', 'text/plain');
13 | res.status(200).send('ok');
14 | });
15 |
16 | app.get('/_ah/start', function(req, res) {
17 | res.set('Content-Type', 'text/plain');
18 | res.status(200).send('ok');
19 | });
20 |
21 | /*app.get('/_ah/stop', function(req, res) {
22 | res.set('Content-Type', 'text/plain');
23 | res.status(200).send('ok');
24 | process.exit();
25 | });*/
26 |
27 | server.listen(8080, '0.0.0.0');
28 |
29 | var wss = new WebSocketServer({host: '0.0.0.0', port: 3000});
30 | wss.on('connection', function(ws){
31 | console.log('socket connected');
32 |
33 | ws.on('message', function incoming(data){
34 | console.log('message received: '+data);
35 | ws.send('you say: '+data);
36 | });
37 |
38 | ws.on('error', function error(err){
39 | console.log('socket closed by error: '+err);
40 | ws.terminate();
41 | });
42 | });
43 |
44 | wss.on('error', function(err){
45 | console.log('server closed by error: '+err);
46 | server.close();
47 | });
48 |
--------------------------------------------------------------------------------
/app.yaml:
--------------------------------------------------------------------------------
1 | version: mark21
2 | runtime: custom
3 | vm: true
4 | api_version: 1
5 |
6 | manual_scaling:
7 | instances: 1
8 |
9 | network:
10 | forwarded_ports: ["3000"]
11 |
12 | handlers:
13 |
14 | - url: /(.*\.(html|css|js))
15 | static_files: public/\1
16 | upload: public/(.*\.(html|css|js))
17 |
18 | - url: /
19 | static_files: public/index.html
20 | upload: public/index.html
21 |
22 | - url: /.*
23 | script: server.js
24 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "dummy_socket",
3 | "version": "0.0.0",
4 | "description": "really simple test of websocket",
5 | "main": "app.js",
6 | "scripts": {
7 | "test": "echo \"Error: no test specified\" && exit 1"
8 | },
9 | "author": "Marcos Bérgamo",
10 | "license": "ISC",
11 | "dependencies": {
12 | "express": "^4.10.4",
13 | "ws": "^0.5.0",
14 | "appengine": "git://github.com/GoogleCloudPlatform/appengine-nodejs.git"
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/public/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
12 |
13 |
14 |