Skip to content

Commit

Permalink
Merge pull request #38 from serverless-components/add-retry-remove-op…
Browse files Browse the repository at this point in the history 
…enapi

Add retry limits to lambda creation and remove openapi auto-generation
  • Loading branch information
@austencollins
austencollins authored Sep 18, 2020
2 parents b43d272 + 32b468c commit 9e2c26a
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 119 deletions.
17 changes: 0 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
- [x] **Custom Domain + SSL** - Auto-configure a custom domain w/ a free AWS ACM SSL certificate.
- [x] **Team Collaboration** - Collaborate with your teamates with shared state and outputs.
- [x] **Built-in Monitoring** - Monitor your express app right from the Serverless Dashboard.
- [x] **(NEW) Auto-Generate An OpenAPI Spec On Each Deployment** - A new OpenAPI spec is generated after each deployment.

<br/>

Expand Down Expand Up @@ -115,7 +114,6 @@ inputs:
- arn:aws:second:layer
domain: api.serverless.com # (optional) if the domain was registered via AWS Route53 on the account you are deploying to, it will automatically be set-up with your Express app's API Gateway, as well as a free AWS ACM SSL Cert.
region: us-east-2 # (optional) aws region to deploy to. default is us-east-1.
openApi: true # (optional) (experimental) Initialize the express app on each deployment, extract an OpenAPI V.3 specification, and add it to the outputs.
```
Once you've chosen your configuration, run `serverless deploy` again (or simply just `serverless`) to deploy your changes.
Expand Down Expand Up @@ -221,21 +219,6 @@ If things aren't working, revert your code to the old code, remove the `traffic`

If things are working, keep the new code, remove the `traffic` configuration option, and deploy.

### Auto-Generate An OpenAPI V3 Specification From Your Express.js App

Version 1.5.0 introduced experimental support for auto-generating an OpenAPI specification from your Express app upon every deployment, then adding them to the `outputs` of your app.

This works by attempting to run your application on each deployment and extracting the routes you've defined in your Express app.

Currently, this feature is disabled by default, since it's experimental. To enable it, add `openApi: true` to your `serverless.yml` and ensure you are using the latest version of the Express coponent (>= 1.1.0).

Given a lot of things can happen in your application upon starting it up, this does not work consistently. For example, your environment variables will NOT be available during this process, which could cause your app not to initialize.

If it runs into an error trying to start your application, it will try its best to pass through useful errors to you so you can address what's blocking it from working. You can see these by running `serverless deploy --debug`

Overall, an OpenAPI specification generated by default is very powerful. This means you don't have to maintain that manually since it auto-updates on every deployment. (That's what serverless is all about!)

We will be adding many interesting features built on this. Extracting your endpoints and putting them into a common format was merely the first step...

### How To Debug CORS Errors

Expand Down
7 changes: 1 addition & 6 deletions serverless.component.yml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: express
version: 1.6.0
version: 1.7.0
author: eahefnawy
org: serverlessinc
description: Deploys a serverless Express.js application onto AWS Lambda and AWS HTTP API.
Expand All @@ -13,7 +13,6 @@ actions:
deploy:
description: Deploy your Express.js application to AWS Lambda, AWS HTTP API and more.
inputs:

src:
type: src
description: The folder containing the source code of your Express.js application.
Expand Down Expand Up @@ -110,10 +109,6 @@ actions:
min: 0
max: 1

openApi:
type: boolean
description: Automatically generate an OpenAPI specification on every deployment.

# remove

remove:
Expand Down
3 changes: 0 additions & 3 deletions src/serverless.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@ class Express extends Component {
async deploy(inputs) {
const outputs = {};

// Defaults
inputs.openApi = inputs.openApi === true;

// Check credentials exist
if (Object.keys(this.credentials.aws).length === 0) {
const msg =
Expand Down
227 changes: 134 additions & 93 deletions src/utils.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ const getNakedDomain = (domain) => {
* @param ${instance} instance - the component instance
* @param ${object} config - the component config
*/
const packageExpress = async (instance, inputs, outputs) => {
const packageExpress = async (instance, inputs) => {
console.log('Packaging Express.js application...');

// unzip source zip file
Expand All @@ -106,10 +106,14 @@ const packageExpress = async (instance, inputs, outputs) => {
console.log('Installing Express + AWS Lambda handler...');
copySync(path.join(__dirname, '_express'), path.join(sourceDirectory, '_express'));

/**
* DEPRECATED: This runs untrusted code and should not be used until we can find a way to do this more securely.
*/
// Attempt to infer data from the application
if (inputs.openApi) {
await infer(instance, inputs, outputs, sourceDirectory);
}
// if (inputs.openApi) {
// console.log('Attempting to collect API routes and convert to OpenAPI format, since openAPI is set to 'true'')
// await infer(instance, inputs, outputs, sourceDirectory);
// }

// add sdk to the source directory, add original handler
console.log('Installing Serverless Framework SDK...');
Expand All @@ -133,101 +137,106 @@ const packageExpress = async (instance, inputs, outputs) => {
};

/*
* DEPRECATED: This runs untrusted code and should not be used until we can find a way to do this more securely.
*
* Infer data from the Application by attempting to intiatlize it during deployment and extracting data.
*
* @param ${object} instance - the component instance
* @param ${object} inputs - the component inputs
*/
const infer = async (instance, inputs, outputs, sourceDirectory) => {
// Initialize application
let app;
try {
app = require(path.join(sourceDirectory, './app.js'));
} catch (error) {
const msg = error.message;
error.message = `OpenAPI auto-generation failed due to the Express Component not being able to start your app. To fix this, you can turn this feature off by specifying "inputs.openApi: false" or fix the following issue: ${msg}`;
throw error;
}

try {
await generateOpenAPI(instance, inputs, outputs, app);
} catch (error) {
const msg = error.message;
error.message = `OpenAPI auto-generation failed due to the Express Component not being able to start your app. To fix this, you can turn this feature off by specifying "inputs.openApi: false" or fix the following issue: ${msg}`;
throw error;
}
};
// const infer = async (instance, inputs, outputs, sourceDirectory) => {
// // Initialize application
// let app;
// try {
// // Load app
// app = require(path.join(sourceDirectory, './app.js'));
// } catch (error) {
// const msg = error.message;
// error.message = `OpenAPI auto-generation failed due to the Express Component not being able to start your app. To fix this, you can turn this feature off by specifying 'inputs.openApi: false' or fix the following issue: ${msg}`;
// throw error;
// }

// try {
// await generateOpenAPI(instance, inputs, outputs, app);
// } catch (error) {
// const msg = error.message;
// error.message = `OpenAPI auto-generation failed due to the Express Component not being able to start your app. To fix this, you can turn this feature off by specifying 'inputs.openApi: false' or fix the following issue: ${msg}`;
// throw error;
// }
// };

/*
* DEPRECATED: This runs untrusted code and should not be used until we can find a way to do this more securely.
*
* Generate an OpenAPI specification from the Application
*
* @param ${object} instance - the component instance
* @param ${object} inputs - the component inputs
*/
const generateOpenAPI = async (instance, inputs, outputs, app) => {
// Open API Version 3.0.3, found here: https://swagger.io/specification/
// TODO: This is not complete, but the pieces that do exist are accurate.
const openApi = {
openapi: '3.0.3',
info: {
// title: null,
// description: null,
version: '0.0.1',
},
paths: {},
};

// Parts of the OpenAPI spec that we may use these at a later date.
// For now, they are unincorporated.
// const oaServersObject = {
// url: null,
// description: null,
// variables: {},
// };
// const oaComponentsObject = {
// schemas: {},
// responses: {},
// parameters: {},
// examples: {},
// requestBodies: {},
// headers: {},
// securitySchemes: {},
// links: {},
// callbacks: {},
// };
// const oaPathItem = {
// description: null,
// summary: null,
// operationId: null,
// responses: {},
// };

if (app && app._router && app._router.stack && app._router.stack.length) {
app._router.stack.forEach((route) => {
// This array holds all middleware layers, which include routes and more
// First check if this 'layer' is an express route type, otherwise skip
if (!route.route) return;

// Define key data
const ePath = route.route.path;

if (['*', '/*'].indexOf(ePath) > -1) {
return;
}

// Save path
openApi.paths[ePath] = openApi.paths[ePath] || {};

for (const method of Object.keys(route.route.methods)) {
// Save method
openApi.paths[ePath][method] = {};
}
});
}

// Save to outputs
outputs.api = openApi;
};
// const generateOpenAPI = async (instance, inputs, outputs, app) => {
// // Open API Version 3.0.3, found here: https://swagger.io/specification/
// // TODO: This is not complete, but the pieces that do exist are accurate.
// const openApi = {
// openapi: '3.0.3',
// info: {
// // title: null,
// // description: null,
// version: '0.0.1',
// },
// paths: {},
// };

// // Parts of the OpenAPI spec that we may use these at a later date.
// // For now, they are unincorporated.
// // const oaServersObject = {
// // url: null,
// // description: null,
// // variables: {},
// // };
// // const oaComponentsObject = {
// // schemas: {},
// // responses: {},
// // parameters: {},
// // examples: {},
// // requestBodies: {},
// // headers: {},
// // securitySchemes: {},
// // links: {},
// // callbacks: {},
// // };
// // const oaPathItem = {
// // description: null,
// // summary: null,
// // operationId: null,
// // responses: {},
// // };

// if (app && app._router && app._router.stack && app._router.stack.length) {
// app._router.stack.forEach((route) => {
// // This array holds all middleware layers, which include routes and more
// // First check if this 'layer' is an express route type, otherwise skip
// if (!route.route) return;

// // Define key data
// const ePath = route.route.path;

// if (['*', '/*'].indexOf(ePath) > -1) {
// return;
// }

// // Save path
// openApi.paths[ePath] = openApi.paths[ePath] || {};

// for (const method of Object.keys(route.route.methods)) {
// // Save method
// openApi.paths[ePath][method] = {};
// }
// });
// }

// // Save to outputs
// outputs.api = openApi;
// };

/*
* Fetches a lambda function by ARN
Expand Down Expand Up @@ -269,7 +278,10 @@ const getVpcConfig = (vpcConfig) => {
* @param ${object} inputs - the component inputs
* @param ${object} clients - the aws clients object
*/
const createLambda = async (instance, inputs, clients) => {
const createLambda = async (instance, inputs, clients, retries = 0) => {
// Track retries
retries++;

const vpcConfig = getVpcConfig(inputs.vpc);

const params = {
Expand Down Expand Up @@ -302,16 +314,45 @@ const createLambda = async (instance, inputs, clients) => {
instance.state.lambdaVersion = res.Version;
} catch (e) {
console.log(`Unable to create AWS Lambda due to: ${e.message}`);

// Handle known errors

if (e.message.includes('The role defined for the function cannot be assumed by Lambda')) {
// This error can happen upon first creation. So sleeping is an acceptable solution. This code will retry multiple times.
if (retries > 5) {
console.log(
'Attempted to retry Lambda creation 5 times, but the invalid role error persists. Aborting...'
);

// Throw different errors, depending on whether the user is using a custom role
if (instance.state.userRoleArn) {
throw new Error(
'Unable to create the AWS Lambda function which your Express.js app runs on. The reason is "the role defined for the function cannot be assumed by Lambda". This might be due to a missing or invalid "Trust Relationship" within the policy of the custom IAM Role you you are attempting to use. Try modifying that. If that doesn\'t work, this is an issue with AWS Lambda\'s APIs. We suggest trying to remove this instance by running "serverless remove" then redeploying to get around this.'
);
} else {
throw new Error(
'Unable to create the AWS Lambda function which your Express.js app runs on. The reason is "the role defined for the function cannot be assumed by Lambda". This is an issue with AWS Lambda\'s APIs. We suggest trying to remove this instance by running "serverless remove" then redeploying to get around this. This seems to be the only way users have gotten past this.'
);
}
}
}

if (
e.message.includes('The role defined for the function cannot be assumed by Lambda') ||
e.message.includes(
'Lambda was unable to configure access to your environment variables because the KMS key is invalid'
)
) {
// we need to wait around 2 seconds after the role is created before it can be assumed
await sleep(2000);
return createLambda(instance, inputs, clients);
// This error can happen upon first creation. So sleeping is an acceptable solution. This code will retry multiple times.
if (retries > 5) {
console.log(
'Attempted to retry Lambda creation 5 times, but the KMS error persists Aborting...'
);
throw new Error(
'Unable to create the AWS Lambda function which your Express.js app runs on. The reason is "Lambda was unable to configure access to your environment variables because the KMS key is invalid". This is a known issue with AWS Lambda\'s APIs, and there is nothing the Serverless Framework can do to help with it at this time. We suggest trying to remove this instance by running "serverless remove" then redeploying to attempt to get around this.'
);
}
}

throw e;
}
return null;
Expand Down Expand Up @@ -472,7 +513,7 @@ const findOrCreateCertificate = async (instance, clients) => {
);

console.log(
`Certificate for ${instance.state.nakedDomain} is in a "${certificate.Status}" status`
`Certificate for ${instance.state.nakedDomain} is in a '${certificate.Status}' status`
);

if (certificate.Status === 'PENDING_VALIDATION') {
Expand Down

0 comments on commit 9e2c26a

Please sign in to comment.