Skip to content

Commit 7944fc0

Browse files
committed
refactor: rename to @vendia/serverless-express and remove Amazon-related notices
1 parent d1a42ef commit 7944fc0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+18396
-5409
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,9 @@ Please ensure all pull requests are made against the `develop` branch.
44

55
*Description of changes:*
66

7-
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
7+
# Checklist
8+
9+
[ ] Tests have been added and are passing
10+
[ ] Documentation has been updated
11+
12+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

.travis.yml

Lines changed: 0 additions & 46 deletions
This file was deleted.

CODE_OF_CONDUCT.md

Lines changed: 133 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,133 @@
1-
## Code of Conduct
2-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4-
[email protected] with any additional questions or comments.
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Please read through this document before submitting any issues or pull requests
88

99
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1010

11-
When filing an issue, please check [existing open](https://github.com/awslabs/aws-serverless-express/issues), or [recently closed](https://github.com/awslabs/aws-serverless-express/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
11+
When filing an issue, please check [existing open](https://github.com/vendia/serverless-express/issues), or [recently closed](https://github.com/vendia/serverless-express/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
1212

1313
* A reproducible test case or series of steps
1414
* The version of our code being used
@@ -40,14 +40,14 @@ Looking at the existing issues is a great way to find something to contribute on
4040

4141
## Code of Conduct
4242

43-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact [email protected] with any additional questions or comments.
43+
Please refer to our [Code of Conduct](CODE_OF_CONDUCT.md)
4444

4545
## Security issue notifications
4646

47-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
47+
If you discover a potential security issue in this project we ask that you notify us directly - [email protected]. Please do **not** create a public github issue.
4848

4949
## Licensing
5050

51-
See the [LICENSE](https://github.com/awslabs/aws-serverless-express/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
51+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
5252

5353
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

NOTICE.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
# AWS Serverless Express
1+
# Serverless Express
22

3-
[![Join the chat at https://gitter.im/awslabs/aws-serverless-express](https://badges.gitter.im/awslabs/aws-serverless-express.svg)](https://gitter.im/awslabs/aws-serverless-express?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4-
[![Build Status](https://travis-ci.org/awslabs/aws-serverless-express.svg?branch=master)](https://travis-ci.org/awslabs/aws-serverless-express) [![npm](https://img.shields.io/npm/v/aws-serverless-express.svg)]() [![npm](https://img.shields.io/npm/dm/aws-serverless-express.svg)]() [![dependencies Status](https://david-dm.org/awslabs/aws-serverless-express/status.svg)](https://david-dm.org/awslabs/aws-serverless-express) [![devDependencies Status](https://david-dm.org/awslabs/aws-serverless-express/dev-status.svg)](https://david-dm.org/awslabs/aws-serverless-express?type=dev)
3+
[![npm](https://img.shields.io/npm/v/@vendia/serverless-express.svg)]() [![npm](https://img.shields.io/npm/dm/@vendia/serverless-express.svg)]() [![dependencies Status](https://david-dm.org/vendia/serverless-express/status.svg)](https://david-dm.org/vendia/serverless-express) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
54

65
Run REST APIs and other web applications using your existing [Node.js](https://nodejs.org/) application framework (Express, Koa, Hapi, Sails, etc.), on top of [AWS Lambda](https://aws.amazon.com/lambda/) and [Amazon API Gateway](https://aws.amazon.com/api-gateway/).
76

87
```bash
9-
npm install aws-serverless-express
8+
npm install @vendia/serverless-express
109
```
1110

1211
## Quick Start/Example
1312

14-
Want to get up and running quickly? [Check out our basic starter example](examples/basic-starter) which includes:
13+
Want to get up and running quickly? [Check out our basic starter example](examples/basic-starter) that includes:
1514

1615
- Lambda function
1716
- Express application
@@ -26,7 +25,7 @@ The only AWS Lambda specific code you need to write is a simple handler like bel
2625

2726
```js
2827
// lambda.js
29-
const { configure } = require('aws-serverless-express')
28+
const { configure } = require('@vendia/serverless-express')
3029
const app = require('./app')
3130
const servererlessExpress = configure({ app })
3231
exports.handler = servererlessExpress.handler
@@ -76,7 +75,7 @@ Provide additional [Winston logger](https://www.npmjs.com/package/winston) confi
7675

7776
### resolutionMode (default: `'PROMISE'`)
7877

79-
Lambda supports three methods to end the execution and return a result: context, callback, and promise. By default, aws-serverless-express uses promise resolution, but you can specify 'CONTEXT' or 'CALLBACK' if you need to change this. If you specify 'CALLBACK', then `context.callbackWaitsForEmptyEventLoop = false` is also set for you.
78+
Lambda supports three methods to end the execution and return a result: context, callback, and promise. By default, serverless-express uses promise resolution, but you can specify 'CONTEXT' or 'CALLBACK' if you need to change this. If you specify 'CALLBACK', then `context.callbackWaitsForEmptyEventLoop = false` is also set for you.
8079

8180
```js
8281
configure({
@@ -85,15 +84,15 @@ configure({
8584
})
8685
```
8786

88-
### respondWithErrors (default: `false`)
87+
### respondWithErrors (default: `process.env.NODE_ENV === 'development'`)
8988

90-
Set this to true to have `aws-serverless-express` include the error stack trace in the event of an unhandled exception. This is especially useful during development.
89+
Set this to true to have serverless-express include the error stack trace in the event of an unhandled exception. This is especially useful during development. By default, this is enabled when `NODE_ENV === 'development'` so that the stack trace isn't returned in production.
9190

9291
## Advanced API
9392

9493
### eventFns
9594

96-
aws-serverless-express natively supports API Gateway, ALB, and Lambda@Edge. If you want to use Express with other AWS Services which can invoke a Lambda Function you can provide your own custom request/response mappings via `eventFns`. See the [custom-mapper-dynamodb example](examples/custom-mapper-dynamodb).
95+
serverless-express natively supports API Gateway, ALB, and Lambda@Edge. If you want to use Express with other AWS Services which can invoke a Lambda Function you can provide your own custom request/response mappings via `eventFns`. See the [custom-mapper-dynamodb example](examples/custom-mapper-dynamodb).
9796

9897
```js
9998
function requestMapper ({ event }) {
@@ -149,27 +148,27 @@ Provide a `logger` object with `debug` and `error` methods to override the defau
149148
This package exposes a function to easily get the `event` and `context` objects Lambda receives from the event source.
150149

151150
```js
152-
const { getCurrentLambdaInvoke } = require('aws-serverless-express')
151+
const { getCurrentLambdaInvoke } = require('@vendia/serverless-express')
153152
app.get('/', (req, res) => {
154-
const currentLambdaInvoke = getCurrentLambdaInvoke()
153+
const { event, context } = getCurrentLambdaInvoke()
155154
156-
res.json(currentLambdaInvoke.event)
155+
res.json(event)
157156
})
158157
```
159158

160159
## 4.0.0 Goals
161160

162161
1. ✅ Improved API - Simpler for end user to use and configure; extensible without breaking backwards compatibility or hurting API
163-
2. ✅ Node.js 8+ only - can upgrade dependencies to latest (Jest); can use latest syntax in source and tests; can use server.listening; future-proof for Node.js 10
162+
2. ✅ Node.js 12+ only - can upgrade dependencies to latest (Jest); can use latest syntax in source and tests; can use server.listening; future-proof for Node.js 10
164163
3. ✅ Promise resolution mode by default
165-
4. ✅ Additional event sources - currently only supports API Gateway Proxy; should also support Lambda@Edge (https://github.com/awslabs/aws-serverless-express/issues/152) and ALB; have had a customer request for DynamoDB; should make it easy to provide your own IO mapping function.
164+
4. ✅ Additional event sources - currently only supports API Gateway Proxy; should also support Lambda@Edge (https://github.com/vendia/serverless-express/issues/152) and ALB; have had a customer request for DynamoDB; should make it easy to provide your own IO mapping function.
166165
1. Added ALB; requires example refactor.
167166
2. Need to add Lambda@Edge and example
168167
3. Need to add example of doing custom resolver (DynamoDB)
169168
5. ✅ Multiple header values - can get rid of set-cookie hack
170169
6. ✅ Configure logging - default winston and allow customers to provide their own; include option to respond to 500s with the stack trace instead of empty string currently
171170
7. ✅Improved documentation
172-
8. ✅ Option to strip base path for custom domains (https://github.com/awslabs/aws-serverless-express/issues/86).
171+
8. ✅ Option to strip base path for custom domains (https://github.com/vendia/serverless-express/issues/86).
173172
9. ✅ Update example to include optional parameter for setting up custom domain
174173

175174
## Is AWS serverless right for my app?
@@ -197,4 +196,15 @@ app.get('/', (req, res) => {
197196

198197
## Loadtesting
199198

200-
`npx loadtest --rps 100 -k -n 1500 -c 50 https://xxxx.execute-api.us-east-1.amazonaws.com/prod/users`
199+
`npx loadtest --rps 100 -k -n 1500 -c 50 https://xxxx.execute-api.us-east-1.amazonaws.com/prod/users`
200+
201+
# AWS Serverless Express has moved
202+
203+
On 11/30, the AWS Serverless Express library moved from AWS to [Vendia](https://github.com/vendia/serverless-express) and will be rebranded to `@vendia/serverless-express`. Similarly, the [`aws-serverless-express` NPM package](https://www.npmjs.com/package/aws-serverless-express) will be deprecated in favor of [@vendia/serverless-express](https://www.npmjs.com/package/@vendia/serverless-express).
204+
205+
[Brett](https://github.com/brettstack), the original creator of the Serverless Express library, will continue maintaining the repository and give it the attention and care it deserves. At the same time, we will be looking for additional contributors to participate in the development and stewardship of the Serverless Express library. AWS and the [SAM team](https://github.com/aws/aws-sam-cli) will remain involved in an administrative role alongside Vendia, Brett, and the new maintainers that will join the project.
206+
207+
We believe this is the best course of action to ensure that customers using this library get the best possible support in the future. To learn more about this move or become a maintainer of the new Serverless Express library, reach out to us through a GitHub issue on this repository.
208+
209+
Best,
210+
The AWS Serverless team, Brett & the Vendia team

SCOPE.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
############################################################################
22
## SCOPE.txt - version 1.0 ##
3-
## Created by Brett Andrews - andrbret@amazon.com ##
3+
## Created by Brett Andrews - brett.j.andrews@gmail.com ##
44
## ---------------------------------------------------------------------- ##
55
## Version history: ##
66
## ---------------------------------------------------------------------- ##
@@ -16,9 +16,9 @@ directory which allows developers to quickly deploy a running application using
1616

1717
This repository should contain:
1818

19-
- The aws-serverless-express library.
20-
- Documentation on using aws-serverless-express
21-
- Examples of using the aws-serverless-express library.
19+
- The @vendia/serverless-express library.
20+
- Documentation on using @vendia/serverless-express
21+
- Examples of using the @vendia/serverless-express library.
2222

2323
This repository does not contain:
2424

0 commit comments

Comments
 (0)