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 5 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
115 changes: 110 additions & 5 deletions lib/plugins/aws/package/compile/events/cloudFront/index.js
Expand Up @@ -27,9 +27,118 @@ 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' },
HTTPSPort: { type: 'integer' },
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 maybe set min 0 and max 65535

OriginKeepaliveTimeout: { type: 'integer', miminum: 1, maximum: 60 },
OriginProtocolPolicy: {
type: 'string',
Copy link
Contributor

Choose a reason for hiding this comment

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

With enum, type is ineffective

enum: ['http-only', 'match-viewer', 'https-only'],
},
OriginReadTimeout: { type: 'integer', miminum: 1, maximum: 60 },
OriginSSLProtocols: {
type: 'array',
items: { type: 'string', enum: ['SSLv3', 'TLSv1', 'TLSv1.1', 'TLSv1.2'] },
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here

Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't seem to be addressed (we can remove type: 'string')

},
},
additionalProperties: false,
required: ['OriginProtocolPolicy'],
},
DomainName: { type: 'string' },
Id: { type: 'string' },
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should not include Id, as we unconditionally generate it:

Id: naming.getCloudFrontOriginId(originObj),

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: [
{ type: 'array', items: [{ const: 'GET' }, { const: 'HEAD' }] },
{ type: 'array', items: [{ const: 'GET' }, { const: 'HEAD' }, { const: 'OPTIONS' }] },
{
type: 'array',
items: [
{ const: 'GET' },
{ const: 'HEAD' },
{ const: 'OPTIONS' },
{ const: 'PUT' },
{ const: 'PATCH' },
{ const: 'POST' },
{ const: 'DELETE' },
],
},
Copy link
Contributor

Choose a reason for hiding this comment

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

If understand we allow three exact collections. If it's the case then above doesn't meet that, as AllowedMethods: ["GET"] will pass.

I believe we can achieve needed validation through { enum: [["GET", "HEAD"], [... ], [...]] }

],
},
CachedMethods: {
oneOf: [
{ type: 'array', items: [{ const: 'GET' }, { const: 'HEAD' }] },
{ type: 'array', items: [{ const: 'GET' }, { const: 'HEAD' }, { const: 'OPTIONS' }] },
],
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here

},
CachePolicyId: { type: 'string' },
Compress: { type: 'boolean' },
FieldLevelEncryptionId: { type: 'string' },
OriginRequestPolicyId: { type: 'string' },
SmoothStreaming: { type: 'boolean' },
TrustedSigners: { type: 'array', items: { type: 'string' } },
ViewerProtocolPolicy: {
type: 'string',
Copy link
Contributor

Choose a reason for hiding this comment

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

No need for type

enum: ['allow-all', 'redirect-to-https', 'https-only'],
},
},
additionalProperties: false,
};

this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'cloudFront', {
type: 'object',
properties: {
eventType: {
type: 'string',
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 remove type here

enum: ['viewer-request', 'origin-request', 'origin-response', 'viewer-response'],
},
pathPattern: { type: 'string', pattern: '^([A-Za-z0-9_.*$/~"\'@:+-]|&)+$' },
origin: {
oneOf: [{ type: 'string', format: 'uri' }, originObjectSchema],
},
isDefaultOrigin: { type: 'boolean' },
includeBody: { type: 'boolean' },
behavior: behaviorObjectSchema,
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 ensure alphabetical order (when there's larger count of properties, it's then easier to find one)

},
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 +265,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