Skip to content
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.

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

Aws cloudfront event schema #8250

Merged
merged 13 commits into from Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
97 changes: 92 additions & 5 deletions lib/plugins/aws/package/compile/events/cloudFront/index.js
Expand Up @@ -27,9 +27,100 @@ class AwsCompileCloudFrontEvents {
'before:remove:remove': this.logRemoveReminder.bind(this),
};

// TODO: Complete schema, see https://github.com/serverless/serverless/issues/8025
const originObjectSchema = {
type: 'object',
properties: {
ConnectionAttempts: { type: 'integer', miminum: 1, maximum: 3 },
ConnectionTimeout: { type: 'integer', miminum: 1, maximum: 10 },
CustomOriginConfig: {
type: 'object',
properties: {
HTTPPort: { type: 'integer', miminum: 0, maximum: 65535 },
HTTPSPort: { type: 'integer', miminum: 0, maximum: 65535 },
OriginKeepaliveTimeout: { type: 'integer', miminum: 1, maximum: 60 },
OriginProtocolPolicy: {
enum: ['http-only', 'match-viewer', 'https-only'],
},
OriginReadTimeout: { type: 'integer', miminum: 1, maximum: 60 },
OriginSSLProtocols: {
type: 'array',
items: { enum: ['SSLv3', 'TLSv1', 'TLSv1.1', 'TLSv1.2'] },
},
},
additionalProperties: false,
required: ['OriginProtocolPolicy'],
},
DomainName: { type: 'string' },
OriginCustomHeaders: {
type: 'array',
items: {
type: 'object',
properties: {
HeaderName: { type: 'string' },
HeaderValue: { type: 'string' },
},
additionalProperties: false,
required: ['HeaderName', 'HeaderValue'],
},
},
OriginPath: { type: 'string' },
S3OriginConfig: {
type: 'object',
properties: {
OriginAccessIdentity: {
type: 'string',
pattern: '^origin-access-identity/cloudfront/.+',
},
},
additionalProperties: false,
},
},
additionalProperties: false,
required: ['DomainName', 'Id'],
oneOf: [{ required: ['CustomOriginConfig'] }, { required: ['S3OriginConfig'] }],
};

const behaviorObjectSchema = {
type: 'object',
properties: {
AllowedMethods: {
oneOf: [
{ enum: ['GET', 'HEAD'] },
{ enum: ['GET', 'HEAD', 'OPTIONS'] },
{ enum: ['GET', 'HEAD', 'OPTIONS', 'PUT', 'PATCH', 'POST', 'DELETE'] },
],
},
CachedMethods: {
oneOf: [{ enum: ['GET', 'HEAD'] }, { enum: ['GET', 'HEAD', 'OPTIONS'] }],
},
CachePolicyId: { type: 'string' },
Compress: { type: 'boolean' },
FieldLevelEncryptionId: { type: 'string' },
OriginRequestPolicyId: { type: 'string' },
SmoothStreaming: { type: 'boolean' },
TrustedSigners: { type: 'array', items: { type: 'string' } },
ViewerProtocolPolicy: {
enum: ['allow-all', 'redirect-to-https', 'https-only'],
},
},
additionalProperties: false,
};

this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'cloudFront', {
type: 'object',
properties: {
behavior: behaviorObjectSchema,
eventType: {
enum: ['viewer-request', 'origin-request', 'origin-response', 'viewer-response'],
},
isDefaultOrigin: { type: 'boolean' },
includeBody: { type: 'boolean' },
origin: {
oneOf: [{ type: 'string', format: 'uri' }, originObjectSchema],
},
pathPattern: { type: 'string', pattern: '^([A-Za-z0-9_.*$/~"\'@:+-]|&)+$' },
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add additionalProperties: false

additionalProperties: false,
});
}

Expand Down Expand Up @@ -156,10 +247,6 @@ class AwsCompileCloudFrontEvents {
if (functionObj.events) {
functionObj.events.forEach(event => {
if (event.cloudFront) {
if (!_.isObject(event.cloudFront)) {
throw new Error('cloudFront event has to be an object');
}

const lambdaFunctionLogicalId = Object.keys(Resources).find(
key =>
Resources[key].Type === 'AWS::Lambda::Function' &&
Expand Down
26 changes: 0 additions & 26 deletions lib/plugins/aws/package/compile/events/cloudFront/index.test.js
Expand Up @@ -351,32 +351,6 @@ describe('AwsCompileCloudFrontEvents', () => {
});

describe('#compileCloudFrontEvents()', () => {
it('should throw an error if cloudFront event type is not an object', () => {
awsCompileCloudFrontEvents.serverless.service.functions = {
first: {
events: [
{
cloudFront: 42,
},
],
},
};

expect(() => awsCompileCloudFrontEvents.compileCloudFrontEvents()).to.throw(Error);

awsCompileCloudFrontEvents.serverless.service.functions = {
first: {
events: [
{
cloudFront: 'some',
},
],
},
};

expect(() => awsCompileCloudFrontEvents.compileCloudFrontEvents()).to.throw(Error);
});

it('should throw an error if the region is not us-east-1', () => {
options.region = 'eu-central-1';
awsCompileCloudFrontEvents.serverless.service.functions = {
Expand Down