feat(event-bridge): schedule, whenAny, rename, when without scope, docs #161

thantos · 2022-05-27T03:41:22Z

Closes #142, closes #89, closes #140, closes #147

interface MyEventDetails {
   name: string;
}
interface MyEvent extends Event<MyEventDetails, 'myDetailType', 'mySource'>{}
interface LambdaEvent extends Event<{}, string, 'lambda'>{}

const bus = new EventBus<LambdaEvent  | MyEvent>(stack, 'bus');

const allEvents = bus.all();
// transform and then send to lambda
allEvents.map(event => event.id).pipe(new Function(stack, 'func', async (id) => console.log(id)));

const lambdaEvents = bus
   // when the source is lambda
   .when(event => event.source === "lambda")
   // bus to bus
   .pipe(new EventBus());

const logGroup = new aws_logs.LogGroup(this, 'MyLogGroup', {
  logGroupName: 'MyLogGroup',
});

// use the pipe callback escape hatch to pipe to a cloudwatch log group (which functionless doesn't natively support, yet)
bus.when(event => event.source === "lambda")
   .map(event => `log me ${event.id}`)
   .pipe((targetInput) => new targets.CloudWatchLogGroup(logGroup))

const sender = new Function(stack, 'sender', async () => {
   // new pattern to send events from lambda, sfn to an event bus
   bus.putEvents({ source: "mySource", "detail-type": "myDetailType", detail: { name: "SAM" } });
})

BREAKING_CHANGE: Event bus integration from Function and StepFunction has been updated to use the pattern bus.putEvent(event). Previously events were sent by invoking the bus bus(event).
BREAKING_CHANGE: Type names have been changed: EventtBusRule ->Rule, EventBusTransform -> EventTransform, EventBusRuleInput -> Event

netlify · 2022-05-27T03:41:27Z

✅ Deploy Preview for effortless-malabi-1c3e77 ready!

Name	Link
🔨 Latest commit	`ff9a3ba`
🔍 Latest deploy log	https://app.netlify.com/sites/effortless-malabi-1c3e77/deploys/6298ad7a0a902d0008a8bfca
😎 Deploy Preview	https://deploy-preview-161--effortless-malabi-1c3e77.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

src/event-bridge/event-bus.ts

sam-goodwin · 2022-05-30T08:25:47Z

src/event-bridge/event-bus.ts

+   *  .pipe(func);
+   * ```
+   */
+  all(): EventBusPredicateRuleBase<E>;


Are we going to rename EventBusPredicateRuleBase also? PredicateRuleBase?

sam-goodwin · 2022-05-30T08:26:40Z

src/event-bridge/event-bus.ts

+  }
+
+  /**
+   * @inheritdoc


Is this necessary?

Guess not, I didn't think it would pull the docs in on its own, I guess it does.

sam-goodwin · 2022-05-30T08:28:04Z

src/event-bridge/event-bus.ts

+   * ```ts
+   * const bus = EventBus.default(scope);
+   * // every hour
+   * const everyHour = bus.schedule(scope, 'cron', aws_events.Schedule.rate(Duration.hours(1)));


This looks wrong. schedule is static

Had the docs backwards between the two implementations. Fixed

sam-goodwin · 2022-05-30T08:30:40Z

src/event-bridge/event-bus.ts

+   *
+   * ```ts
+   * // every hour
+   * const everyHour = EventBus.schedule(scope, 'cron', aws_events.Schedule.rate(Duration.hours(1)));


I wonder if we could have a simpler interface on top?

Schedule.every(1, "minute").pipe(f)

Later? This would just be a helper? plus there are the other forms, cron and expression.

https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html#eb-rate-expressions

Sure, no problem with that. Open an issue to track.

test-app/src/people-events.ts

sam-goodwin · 2022-05-30T08:33:44Z

website/docs/concepts/event-bridge/event-bus.md

-  "OnSignUp",
-  (event) => event["detail-type"] === "SignUp"
-);
+const defaultBus = EventBus.default();


Why does it require a function call instead of just being static?

Err, there is a parameter for the scope that I missed. will fix.

sam-goodwin · 2022-05-30T08:34:44Z

website/docs/concepts/event-bridge/event-bus.md


-Functionless lets you write logic in Typescript on the type safe event.
+Event Bus integrates with other AWS Resources via functionless.


What does this mean?

via Functionless

Just the authoring integration support.

Updated

Functionless supports putEvents integrations with other AWS Resources.

I don't understand what that means? Do you mean something like:

The putEvents Integration is supported in Lambda Functions (link), Step Functions (link), Appsync Resolvers (link) and API Gateway Integrations (link)

Overall advice is to be more explicit and thorough with documentation.

sam-goodwin · 2022-05-30T08:35:18Z

website/docs/concepts/event-bridge/event-bus.md

 ```

-What about our young cat lovers? We want to forward those events to our sister team's event bus for processing.
+:::caution
+Caveat: Events passed to the bus in a step function must be one or more literal objects and may not use the spread (`...`) syntax.


Should we explain why and perhaps link to an issue?

website/docs/concepts/event-bridge/event-bus.md

brendo-m · 2022-05-30T15:31:12Z

website/docs/concepts/event-bridge/index.md

-## Default Event Bus
+## Declare an Event Type
+
+Functionless supports well typed events, lets add our event schema to Typescript.


let's define

I think this section needs more of an introduction on what Event Types are, rather than just jumping into defining one.

brendo-m · 2022-05-30T15:31:21Z

website/docs/concepts/event-bridge/index.md

+  > {}
+```
+
+## Create an Rule


Find replace needs to support grammar updates.

website/docs/concepts/event-bridge/index.md

brendo-m · 2022-05-30T15:40:15Z

website/docs/concepts/event-bridge/index.md

+
+## Put Events from other sources
+
+Event Bridge Put Events API is one of the methods for putting new events on an event bus. We support some first party integrations between services and event bus.


Functionless supports integrations between some AWS services and Event Bridge using the PutEvents API

brendo-m · 2022-05-30T15:50:47Z

website/docs/concepts/event-bridge/rule.md

+  "myScheduledRule2",
+  aws_events.Schedule.duration(Duration.hour(1))
+);
+// or


or in regular CDK:

brendo-m · 2022-05-30T15:51:19Z

website/docs/concepts/event-bridge/rule.md

+const bus = new EventBus(stack, 'bus');
+const allEvents = bus.all('allBusEvents');
+// or
+const allEventWhen = bus.when(()) => true);


one too many )

brendo-m · 2022-05-30T15:52:40Z

website/docs/concepts/event-bridge/event-sources.md

+const successEvents = sfn.onSucceeded(stack, 'successEvent')
+  .map(...) // optionally, transform
+  .pipe(...); // and send somewhere;


this is amazing

yeah, its exciting.

brendo-m · 2022-05-30T15:53:26Z

website/docs/concepts/event-bridge/event-sources.md

+  .pipe(...);
+```
+
+Event sources (and all rules) can also be refined:


this is redundant, there's a page dedicated to it

brendo-m · 2022-05-30T15:54:43Z

website/docs/concepts/step-function/event-sources.md

@@ -0,0 +1,52 @@
+# Event Sources
+
+AWS Step Functions sends [Event Bus events](https://docs.aws.amazon.com/step-functions/latest/dg/cw-events.html) for each machine execution. Functionless provides easy access to them through Event Bus [Event Sources](../event-bridge/event-sources).


maybe you can link to this page from the event bridge event-sources page

I do, there is a table at the bottom.

sam-goodwin · 2022-05-30T21:38:54Z

We should standardize feature names.

feat(event-bridge)

thantos · 2022-05-30T22:03:28Z

We should standardize feature names.
feat(event-bridge)

To match the labels.

website/docs/concepts/event-bridge/index.md

website/docs/concepts/event-bridge/integrations.md

website/docs/concepts/event-bridge/rule.md

website/docs/concepts/event-bridge/transform.md

sam-goodwin · 2022-06-01T09:38:50Z

website/docs/concepts/event-bridge/transform.md

+
+[Event Bus Input Transforms](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) transform events matched by [Rules](./rule).
+
+Functionless allows typescript to be used when defining an input transform.


Something like this?

Functionless translates a purely functional closure into the Event Bus Input Transform JSON format. THis enables you to implement transforms using syntax such as literals and spread expressions.

This may be too complex and technical. Simpler way of saying it?

Save that complexity for the syntax page?

Are we being too redundant by repeatedly explaining how Functionless supports translating TypeScript into XYZ language? Or is it helpful to be redundant on that point?

I also worry that transforms the closure may be too complicated for average readers. Should we granularly explain what this means with examples?

closure -> code.

Overall, I think its good to callout which features are being aided by compilation.

Gradually explaining, my attempt at that was

sam-goodwin · 2022-06-01T09:41:26Z

website/docs/concepts/event-bridge/transform.md

+  // matches all events.
+  eventPattern: { source: [{ prefix: "" }] },


perhaps include:

// equivalent to .map(event => event.id)

Is it really though? Why is eventPattern this?

{ source: [{ prefix: "" }] }

Ha... that is how you match all events... source is a required string and prefix: "" matches any present string.

https://stackoverflow.com/questions/62406933/aws-eventbridge-pattern-to-capture-all-events

Add a comment explaining that since this is documentation and it wasn't obvious why/how that happened.

sam-goodwin · 2022-06-01T11:16:17Z

website/docs/concepts/event-bridge/index.md

@@ -18,8 +18,6 @@ bus
  .pipe(onSignupStepFunction);
 ```

-To jump right into building, see the [`EventBus`](./event-bus.md) documentation.


Why was this removed

I removed it because the index page now has a full example and the even bus page is just details about the event bus type.

Ok, probably fine. I had it there with the idea that as people read the docs, I wanted to help the jump to the technical resources since the index explained high level overview of the Event Bridge service.

website/docs/concepts/event-bridge/index.md

sam-goodwin

Approving, but left some comments. Address the ones you think are relevant and then go ahead and merge.

thantos added 2 commits May 26, 2022 17:48

chore: update rule name

e99cca9

feat(EventBus): schedule, whenAny, rename, when without scope

22e4057

thantos changed the title ~~Event bus v2 2~~ feat(EventBus): schedule, whenAny, rename, when without scope May 27, 2022

thantos changed the title ~~feat(EventBus): schedule, whenAny, rename, when without scope~~ feat(EventBus): schedule, whenAny, rename, when without scope, docs May 27, 2022

brendo-m reviewed May 27, 2022

View reviewed changes

src/event-bridge/event-bus.ts Outdated Show resolved Hide resolved

thantos added 5 commits May 28, 2022 18:04

chore: update repo reference

242f086

Merge branch 'main' into event_bus_v2_2

49a0eb1

fix: change whenAny to all

240d94e

feat: event bridge docs

0b9bd85

Merge branch 'main' into event_bus_v2_2

811d000

sam-goodwin requested changes May 30, 2022

View reviewed changes

brendo-m reviewed May 30, 2022

View reviewed changes

Merge branch 'main' into event_bus_v2_2

81a6edc

thantos changed the title ~~feat(EventBus): schedule, whenAny, rename, when without scope, docs~~ feat(event-bridge): schedule, whenAny, rename, when without scope, docs May 30, 2022

thantos added the event-bridge label May 30, 2022

thantos added 4 commits May 30, 2022 17:03

fix: feedback

062ba3e

feat: breaking change: update bus invocation to putEvents method

50f0c3d

feat: rename EventBusEvent interface to Event

0e187f5

feat: more docs

2e73a83

thantos requested review from brendo-m and sam-goodwin May 31, 2022 12:48

thantos marked this pull request as ready for review May 31, 2022 12:49

feat: pipe escape hatch and escape hatch docs

bd92146

brendo-m reviewed May 31, 2022

View reviewed changes

website/docs/concepts/event-bridge/index.md Outdated Show resolved Hide resolved

brendo-m approved these changes May 31, 2022

View reviewed changes

fix: sussman is bad at spelling

b40fe5e

sam-goodwin requested changes May 31, 2022

View reviewed changes

website/docs/concepts/event-bridge/integrations.md Outdated Show resolved Hide resolved

fix: add missing ids to when statements

be9f3fa

sam-goodwin requested changes Jun 1, 2022

View reviewed changes

thantos mentioned this pull request Jun 1, 2022

feat(lambda,event-bridge): lambda event sources #179

Merged

2 tasks

fix: feedback

415b37b

sam-goodwin approved these changes Jun 1, 2022

View reviewed changes

thantos mentioned this pull request Jun 2, 2022

Event Bridge: Improve Schedule API #188

Open

fix: feedback

ff9a3ba

thantos merged commit 82c72d3 into main Jun 2, 2022


		Functionless lets you write logic in Typescript on the type safe event.
		Event Bus integrates with other AWS Resources via functionless.


		## Put Events from other sources

		Event Bridge Put Events API is one of the methods for putting new events on an event bus. We support some first party integrations between services and event bus.

		@@ -0,0 +1,52 @@
		# Event Sources

		AWS Step Functions sends [Event Bus events](https://docs.aws.amazon.com/step-functions/latest/dg/cw-events.html) for each machine execution. Functionless provides easy access to them through Event Bus [Event Sources](../event-bridge/event-sources).


		[Event Bus Input Transforms](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) transform events matched by [Rules](./rule).

		Functionless allows typescript to be used when defining an input transform.

		// matches all events.
		eventPattern: { source: [{ prefix: "" }] },

feat(event-bridge): schedule, whenAny, rename, when without scope, docs #161

feat(event-bridge): schedule, whenAny, rename, when without scope, docs #161

Conversation

thantos commented May 27, 2022 • edited

netlify bot commented May 27, 2022 • edited

✅ Deploy Preview for effortless-malabi-1c3e77 ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-goodwin commented May 30, 2022

thantos commented May 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-goodwin left a comment

Choose a reason for hiding this comment

thantos commented May 27, 2022 •

edited

netlify bot commented May 27, 2022 •

edited