Skip to content

introduce serverless v2 schema validation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

introduce serverless v2 schema validation #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de1a565
introduce serverless v2 schema validation
Jul 20, 2021
83859f8
introduce serverless v2 schema validation
Jul 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ provider:
name: aws

custom:
logRetentionInDays: 30 # used to set a global value for all functions
serverless-plugin-log-retention:
logRetentionInDays: 30 # used to set a global value for all functions

functions:
function1:
Expand Down
28 changes: 26 additions & 2 deletions add-log-retention.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

const nco = require('nco');
const semver = require('semver');
const PLUGIN_NAME = 'serverless-plugin-log-retention';

//values from http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html
const validRetentionInDays = [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653];
Expand All @@ -15,6 +16,29 @@ class AwsAddLogRetention {
this.serverless = serverless;
this.options = options;
this.provider = this.serverless.getProvider('aws');

// Add schema based validation of service config
const propertyDefinitions = {
properties: {
logRetentionInDays: { type: 'number' }
}
};
if(this.serverless.configSchemaHandler.defineFunctionProperties) {
this.serverless.configSchemaHandler.defineFunctionProperties('aws', propertyDefinitions);
}

if(this.serverless.configSchemaHandler.defineCustomProperties) {
this.serverless.configSchemaHandler.defineCustomProperties({
type: 'object',
properties: {
[PLUGIN_NAME] : {
type: 'object',
...propertyDefinitions
}
}
});
}

this.hooks = {
'package:createDeploymentArtifacts': this.beforeDeploy.bind(this),
};
Expand Down Expand Up @@ -58,8 +82,8 @@ class AwsAddLogRetention {

beforeDeploy() {
const service = this.serverless.service;
const globalLogRetentionInDays = service.custom && service.custom.logRetentionInDays
? this.sanitizeRetentionValue(service.custom.logRetentionInDays)
const globalLogRetentionInDays = service.custom && service.custom[PLUGIN_NAME] && service.custom[PLUGIN_NAME].logRetentionInDays
? this.sanitizeRetentionValue(service.custom[PLUGIN_NAME].logRetentionInDays)
: null;
this.addLogRetentionForFunctions(globalLogRetentionInDays);
}
Expand Down