Skip to content

Commit 305a2ac

Browse files
swalkowskiswalkowski
committed
Initial commit of Functions Framework for Node.js.
0 parents  commit 305a2ac

23 files changed

+6361
-0
lines changed

‎CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Contributor License Agreement
7+
8+
Contributions to this project must be accompanied by a Contributor License
9+
Agreement. You (or your employer) retain the copyright to your contribution;
10+
this simply gives us permission to use and redistribute your contributions as
11+
part of the project. Head over to <https://cla.developers.google.com/> to see
12+
your current agreements on file or to sign a new one.
13+
14+
You generally only need to submit a CLA once, so if you've already submitted one
15+
(even if it was for a different project), you probably don't need to do it
16+
again.
17+
18+
## Code reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult
22+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23+
information on using pull requests.
24+
25+
## Community Guidelines
26+
27+
This project follows [Google's Open Source Community
28+
Guidelines](https://opensource.google.com/conduct/).

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+164
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# Functions Framework for Node.js
2+
3+
An open source FaaS (Function as a service) framework for writing portable
4+
Node.js functions -- brought to you by the Google Cloud Functions team.
5+
6+
The Functions Framework lets you write lightweight functions that run in many
7+
different environments, including:
8+
9+
* [Google Cloud Functions](https://cloud.google.com/functions/)
10+
* Your local development machine
11+
* [Knative](https://github.com/knative/)-based environments
12+
13+
The framework allows you to go from:
14+
15+
```js
16+
exports.helloWorld = (req, res) => {
17+
res.send('Hello, World');
18+
};
19+
```
20+
21+
To:
22+
23+
```sh
24+
curl http://my-url
25+
# Output: Hello, World
26+
```
27+
28+
All without needing to worry about writing an HTTP server or complicated request
29+
handling logic.
30+
31+
# Features
32+
33+
* Spin up a local development server for quick testing
34+
* Invoke a function in response to a request
35+
* Automatically unmarshal events conforming to the
36+
[CloudEvents](https://cloudevents.io/) spec
37+
* Portable between serverless platforms
38+
39+
# Installation
40+
41+
Add the Functions Framework to your `package.json` file using `npm`.
42+
43+
```sh
44+
npm install @google-cloud/functions-framework
45+
```
46+
47+
# Quickstart: Hello, World on your local machine
48+
49+
Create an `index.js` file with the following contents:
50+
51+
```js
52+
exports.helloWorld = (req, res) => {
53+
res.send('Hello, World');
54+
};
55+
```
56+
57+
To run a function locally, first create a `package.json` file using `npm init`:
58+
59+
```sh
60+
npm init
61+
```
62+
63+
Now install the Functions Framework:
64+
65+
```sh
66+
npm install @google-cloud/functions-framework
67+
```
68+
69+
Add a `start` script to `package.json`, with configuration passed via
70+
command-line arguments:
71+
72+
```js
73+
...
74+
"scripts": {
75+
"start": "functions-framework --function-target=helloWorld"
76+
}
77+
...
78+
```
79+
80+
Use `npm start` to start the built-in local development server:
81+
82+
```sh
83+
npm start
84+
...
85+
Serving function...
86+
Function: helloWorld
87+
URL: http://localhost:8080/
88+
```
89+
90+
Send requests to this function using `curl` from another terminal window:
91+
92+
```sh
93+
curl localhost:8080
94+
# Output: Hello, World
95+
```
96+
97+
# Run your function on serverless platforms
98+
99+
## Google Cloud Functions
100+
101+
The
102+
[Node.js 10 runtime on Google Cloud Functions](https://cloud.google.com/functions/docs/concepts/nodejs-10-runtime)
103+
is based on the Functions Framework. On Cloud Functions, the Functions Framework
104+
is completely optional: if you don't add it to your `package.json`, it will be
105+
installed automatically.
106+
107+
After you've written your function, you can simply deploy it from your local
108+
machine using the `gcloud` command-line tool.
109+
[Check out the Cloud Functions quickstart](https://cloud.google.com/functions/docs/quickstart).
110+
111+
## Container environments based on Knative
112+
113+
The Functions Framework is designed to be compatible with Knative environments.
114+
Just build and deploy your container to a Knative environment.
115+
116+
# Configure the Functions Framework
117+
118+
You can configure the Functions Framework using command-line flags or
119+
environment variables. If you specify both, the environment variable will be
120+
ignored.
121+
122+
Command-line flag | Environment variable | Description
123+
------------------------- | ------------------------- | -----------
124+
`port` | `PORT` | The port on which the Functions Framework listens for requests. Default: `8080`
125+
`function-target` | `FUNCTION_TARGET` | The name of the exported function to be invoked in response to requests. Default: `function`
126+
`function-signature-type` | `FUNCTION_SIGNATURE_TYPE` | The signature used when writing your function. Controls unmarshalling rules and determines which arguments are used to invoke your function. Default: `http`; accepted values: `http` or `event`
127+
128+
You can set command-line flags in your `package.json` via the `start` script.
129+
For example:
130+
131+
```js
132+
...
133+
"scripts": {
134+
"start": "functions-framework --function-target=helloWorld"
135+
}
136+
...
137+
```
138+
139+
# Enable CloudEvents handling for use with the event function signature
140+
141+
The Functions Framework can unmarshall incoming
142+
[CloudEvents](http://cloudevents.io) payloads to `data` and `context` objects.
143+
These will be passed as arguments to your function when it receives a request.
144+
Note that your function must use the event-style function signature:
145+
146+
```js
147+
exports.helloEvents = (data, context) => {
148+
console.log(data);
149+
console.log(context);
150+
};
151+
```
152+
153+
To enable automatic unmarshalling, set the function signature type to `event`
154+
using a command-line flag or an environment variable. By default, the HTTP
155+
signature will be used and automatic event unmarshalling will be disabled.
156+
157+
For more details on this signature type, check out the Google Cloud Functions
158+
documentation on
159+
[background functions](https://cloud.google.com/functions/docs/writing/background#cloud_pubsub_example).
160+
161+
# Contributing
162+
163+
Contributions to this library are welcome and encouraged. See
164+
[CONTRIBUTING](CONTRIBUTING.md) for more information on how to get started.

‎converter/.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
unsafe-perm=true

0 commit comments

Comments
 (0)