aws cloudwatchEvent event schema by thewizarodofoz · Pull Request #8230 · serverless/serverless

thewizarodofoz · 2020-09-14T11:53:13Z

Closes: #8026

codecov-commenter · 2020-09-14T11:55:09Z

Codecov Report

Merging #8230 into master will decrease coverage by 0.06%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #8230      +/-   ##
==========================================
- Coverage   88.16%   88.09%   -0.07%     
==========================================
  Files         248      248              
  Lines        9430     9376      -54     
==========================================
- Hits         8314     8260      -54     
  Misses       1116     1116

Impacted Files	Coverage Δ
...ws/package/compile/events/cloudWatchEvent/index.js	`100.00% <100.00%> (ø)`
...plugins/aws/package/compile/events/stream/index.js	`98.00% <0.00%> (-0.60%)`	⬇️
lib/utils/getServerlessConfigFile.js	`94.11% <0.00%> (ø)`
lib/plugins/aws/provider/awsProvider.js	`93.11% <0.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4af57a5...5b1f3ad. Read the comment docs.

medikoo

Thank you @thewizarodofoz

It looks good! Please see my remarks, also let's remove corresponding inline validation

medikoo · 2020-09-14T13:15:27Z

      type: 'object',
+      properties: {
+        event: { type: 'object' },
+        input: { type: 'string', maxLength: 8192 },


In implementation we support also object type

medikoo · 2020-09-14T13:18:54Z

+          type: 'object',
+          properties: {
+            inputPathsMap: { type: 'object' },
+            inputTemplates: { type: 'string', maxLength: 8192 },


It should be inputTemplate.

Also we're relying on same configuration in case of eventBridge event. It'll be nice to have both schemas matching.

See:

serverless/lib/plugins/aws/package/compile/events/eventBridge/index.js

Lines 17 to 64 in 6961b62

this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'eventBridge', {

type: 'object',

properties: {

eventBus: { type: 'string', minLength: 1 },

schedule: { pattern: '^(?:cron|rate)\$.+\$$' },

pattern: {

type: 'object',

properties: {

'version': {},

'id': {},

'detail-type': {},

'source': {},

'account': {},

'time': {},

'region': {},

'resources': {},

'detail': {},

},

additionalProperties: false,

},

input: { type: 'object' },

inputPath: { type: 'string', minLength: 1, maxLength: 256 },

inputTransformer: {

type: 'object',

properties: {

inputPathsMap: {

type: 'object',

additionalProperties: { type: 'string', minLength: 1 },

},

inputTemplate: { type: 'string', minLength: 1, maxLength: 8192 },

},

required: ['inputTemplate'],

additionalProperties: false,

},

},

allOf: [

{ anyOf: [{ required: ['pattern'] }, { required: ['schedule'] }] },

{

oneOf: [

{ required: [] },

{ required: ['input'] },

{ required: ['inputPath'] },

{ required: ['inputTransformer'] },

],

},

],

});

}

medikoo · 2020-09-14T13:20:53Z

+          additionalProperties: false,
+        },
+        description: { type: 'string', maxLength: 512 },
+        name: { type: 'string', pattern: '[a-zA-Z0-9-_.]+', maxLength: 64 },


Let's also define minLength

medikoo

Thank you @thewizarodofoz it looks great! I have just one concern, please see my comment

medikoo · 2020-09-15T09:53:06Z

+        { required: ['input'] },
+        { required: ['inputPath'] },
+        { required: ['inputTransformer'] },


I think we should also add required: [], as technically we do not require any of this options

medikoo

Thank you @thewizarodofoz !

aws cloudwatch event schema

e0c80c5

medikoo suggested changes Sep 14, 2020

View reviewed changes

medikoo added cat/aws-event-cloudwatch cat/config-schema enhancement labels Sep 14, 2020

medikoo assigned thewizarodofoz Sep 14, 2020

ozwi added 3 commits September 15, 2020 10:46

extend schema

e425e1c

remove schema validation tests

3eb322b

prettify

9fcb264

thewizarodofoz requested a review from medikoo September 15, 2020 07:53

thewizarodofoz changed the title ~~aws cloudwatch event schema~~ aws cloudwatchEvent event schema Sep 15, 2020

add minLength to name

4c53b77

medikoo suggested changes Sep 15, 2020

View reviewed changes

allow event without any input

5b1f3ad

thewizarodofoz requested a review from medikoo September 15, 2020 12:08

medikoo approved these changes Sep 15, 2020

View reviewed changes

medikoo merged commit 3730fd4 into serverless:master Sep 15, 2020

thewizarodofoz deleted the aws-cloudwatchevent-event-schema branch September 15, 2020 14:58

medikoo mentioned this pull request Oct 9, 2020

Config Schema: Revert invalid "oneOf" based validation #8376

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

aws cloudwatchEvent event schema#8230

aws cloudwatchEvent event schema#8230
medikoo merged 6 commits into
serverless:masterfrom
thewizarodofoz:aws-cloudwatchevent-event-schema

thewizarodofoz commented Sep 14, 2020

Uh oh!

codecov-commenter commented Sep 14, 2020 •

edited

Loading

Uh oh!

medikoo left a comment

Uh oh!

medikoo Sep 14, 2020

Uh oh!

medikoo Sep 14, 2020

Uh oh!

medikoo Sep 14, 2020

Uh oh!

medikoo left a comment

Uh oh!

medikoo Sep 15, 2020

Uh oh!

medikoo left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'eventBridge', {
	type: 'object',
	properties: {
	eventBus: { type: 'string', minLength: 1 },
	schedule: { pattern: '^(?:cron\|rate)\\(.+\\)$' },
	pattern: {
	type: 'object',
	properties: {
	'version': {},
	'id': {},
	'detail-type': {},
	'source': {},
	'account': {},
	'time': {},
	'region': {},
	'resources': {},
	'detail': {},
	},
	additionalProperties: false,
	},
	input: { type: 'object' },
	inputPath: { type: 'string', minLength: 1, maxLength: 256 },
	inputTransformer: {
	type: 'object',
	properties: {
	inputPathsMap: {
	type: 'object',
	additionalProperties: { type: 'string', minLength: 1 },
	},
	inputTemplate: { type: 'string', minLength: 1, maxLength: 8192 },
	},
	required: ['inputTemplate'],
	additionalProperties: false,
	},
	},
	allOf: [
	{ anyOf: [{ required: ['pattern'] }, { required: ['schedule'] }] },
	{
	oneOf: [
	{ required: [] },
	{ required: ['input'] },
	{ required: ['inputPath'] },
	{ required: ['inputTransformer'] },
	],
	},
	],
	});
	}

Uh oh!

Conversation

thewizarodofoz commented Sep 14, 2020

Uh oh!

codecov-commenter commented Sep 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

medikoo Sep 14, 2020

Choose a reason for hiding this comment

Uh oh!

medikoo Sep 14, 2020

Choose a reason for hiding this comment

Uh oh!

medikoo Sep 14, 2020

Choose a reason for hiding this comment

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

medikoo Sep 15, 2020

Choose a reason for hiding this comment

Uh oh!

medikoo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov-commenter commented Sep 14, 2020 •

edited

Loading