Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions examples/loyalty-payments/.gitignore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
lib
node_modules
cdk.out
.eventual
*.tsbuildinfo
71 changes: 71 additions & 0 deletions examples/loyalty-payments/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
# Welcome to your Eventual Project

## Project Structure
The following folder structure will be generated.
```bash
├──infra # an AWS CDK application that deploys the repo's infrastructure
├──packages
├──service # the NPM package containing the my-service business logic
```

### `infra`

This is where you control what infrastructure is deployed with your Service, for example adding DynamoDB Tables, SQS Queues, or other stateful Resources.

### `packages/service`

This is where you add business logic such as APIs, Event handlers, Workflows and Tasks.

## Deployed Infrastructure

After deploying to AWS, you'll have a single stack named `loyalty-payments` containing your Service. Take a look at the structure using the Resources view in CloudFormation. Here, you can find a list of all the Lambda Functions and other Resources that come with a Service.

See the [Service documentation](https://docs.eventual.ai/reference/service) for more information.

## Scripts

The root `package.json` contains some scripts for your convenience.

### Build

The `build` script compiles all TypeScript (`.ts`) files in each package's `src/` directory and emits the compiled output in the corresponding `lib/` folder.

```
pnpm build
```

### Test

The `test` script runs `jest` in all sub-packages. Check out the packages/service package for example tests.

```
pnpm test
```

### Watch

The `watch` script run the typescript compiler in the background and re-compiles `.ts` files whenever they are changed.
```
pnpm watch
```

### Synth

The `synth` script synthesizes the CDK application in the `infra/` package.
```
pnpm synth
```

### Deploy

The `deploy` script synthesizes and deploys the CDK application in the `infra/` package to AWS.
```
pnpm run deploy
```

### Hotswap

The `hotswap` script synthesizes and deploys the CDK application in the `infra/` package to AWS using `cdk deploy --hotswap` which can bypass a slow CloudFormation deployment in cases where only the business logic in a Lambda Function has changed.
```
pnpm run deploy
```
5 changes: 5 additions & 0 deletions examples/loyalty-payments/eventual.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
{
"projectType": "aws-cdk",
"synth": "pnpm synth",
"deploy": "pnpm run deploy --require-approval never"
}
3 changes: 3 additions & 0 deletions examples/loyalty-payments/infra/cdk.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"app": "ts-node ./src/app.ts"
}
26 changes: 26 additions & 0 deletions examples/loyalty-payments/infra/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
{
"name": "infra",
"version": "0.0.0",
"scripts": {
"synth": "cdk synth",
"deploy": "cdk deploy",
"test": "echo no-op"
},
"dependencies": {
"@aws-cdk/aws-apigatewayv2-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-authorizers-alpha": "^2.50.0-alpha.0",
"@aws-cdk/aws-apigatewayv2-integrations-alpha": "^2.50.0-alpha.0",
"@eventual/aws-cdk": "^0.39.8",
"aws-cdk-lib": "^2.50.0",
"aws-cdk": "^2.50.0",
"constructs": "^10",
"esbuild": "^0.16.14",
"@loyalty-payments/service": "workspace:^"
},
"devDependencies": {
"@types/node": "^18",
"aws-cdk": "^2.50.0",
"ts-node": "^10.9.1",
"typescript": "^4.9.4"
}
}
12 changes: 12 additions & 0 deletions examples/loyalty-payments/infra/src/app.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
import { App, Stack, CfnOutput } from "aws-cdk-lib";
import { Service } from "@eventual/aws-cdk";

const app = new App();
const stack = new Stack(app, "loyalty-payments")

import type * as loyaltypayments from "@loyalty-payments/service"

const service = new Service<typeof loyaltypayments>(stack, "Service", {
name: "loyalty-payments",
entry: require.resolve("@loyalty-payments/service")
});
17 changes: 17 additions & 0 deletions examples/loyalty-payments/infra/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
{
"extends": "../tsconfig.base.json",
"include": [
"src"
],
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"module": "CommonJS",
"moduleResolution": "Node"
},
"references": [
{
"path": "../packages/service"
}
]
}
21 changes: 21 additions & 0 deletions examples/loyalty-payments/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
{
"name": "loyalty-payments",
"version": "0.0.0",
"private": true,
"scripts": {
"build": "tsc -b",
"test": "NODE_OPTIONS=--experimental-vm-modules pnpm -r run test",
"watch": "tsc -b -w",
"synth": "tsc -b && pnpm --filter infra synth",
"deploy": "tsc -b && pnpm --filter infra run deploy",
"hotswap": "tsc -b && pnpm --filter infra run deploy --hotswap"
},
"devDependencies": {
"@eventual/cli": "^0.39.8",
"@tsconfig/node18": "^1",
"@types/jest": "^29",
"@types/node": "^18",
"esbuild": "^0.16.14",
"typescript": "^5"
}
}
43 changes: 43 additions & 0 deletions examples/loyalty-payments/packages/service/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
{
"name": "@loyalty-payments/service",
"type": "module",
"main": "lib/index.js",
"module": "lib/index.js",
"types": "lib/index.d.ts",
"version": "0.0.0",
"scripts": {
"test": "jest --passWithNoTests"
},
"dependencies": {
"@eventual/core": "^0.39.8",
"zod": "^3.21.4",
"jsonwebtoken": "^9.0.0",
"uuid": "^9.0.0"
},
"devDependencies": {
"@types/jsonwebtoken": "9.0.2",
"@types/uuid": "^9.0.1",
"@eventual/testing": "^0.39.8",
"esbuild": "^0.16.14",
"jest": "^29",
"ts-jest": "^29",
"typescript": "^4.9.4"
},
"jest": {
"extensionsToTreatAsEsm": [
".ts"
],
"moduleNameMapper": {
"^(\\.{1,2}/.*)\\.js$": "$1"
},
"transform": {
"^.+\\.(t|j)sx?$": [
"ts-jest",
{
"tsconfig": "tsconfig.test.json",
"useESM": true
}
]
}
}
}
56 changes: 56 additions & 0 deletions examples/loyalty-payments/packages/service/src/auth.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import {
CommandContext,
HttpError,
MiddlewareInput,
api,
} from "@eventual/core";

import jwt, { JwtPayload } from "jsonwebtoken";
import { User } from "./data.js";

const mySecret = "my-secret";

export interface AuthorizedContext {
user: User;
}

export const authorized = api.use(authorizeJWT);

export async function authorizeJWT<In extends CommandContext>({
request,
next,
context,
}: MiddlewareInput<In>) {
const auth = request.headers.get("Authorization");
if (!auth) {
throw new HttpError({
code: 401,
message: "Expected Authorization header to be preset.",
});
}
const [prefix, token] = auth.split(" ");
if (prefix?.toLowerCase() !== "Bearer") {
throw new HttpError({
code: 400,
message: "Token is not valid, must be in the form 'Bearer [token]'.",
});
}

const jwtPayload = jwt.verify(token, mySecret) as JwtPayload;
const user = await User.get({
userId: jwtPayload.iss!,
});
if (user === undefined) {
throw new HttpError({
code: 401,
message: `Unauthorized`,
});
}

return next({
...context,
// put the JWT token and user record in the context for commands to access
jwt: jwtPayload,
user,
});
}
91 changes: 91 additions & 0 deletions examples/loyalty-payments/packages/service/src/create-award.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
import { time, transaction, workflow } from "@eventual/core";
import { v4 as uuid } from "uuid";
import { Award, User } from "./data.js";

export const createAward = transaction(
"createAward",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
const awardId = uuid();
const user = await User.get({
userId: input.userId,
});

await Award.set({
awardId,
userId: input.userId,
amount: input.amount,
awardTime: new Date().toISOString(),
company: "TODO",
currency: input.currency,
expired: false,
});

await User.set({
...user,
credits: {
...user.credits,
[input.currency]: (user.credits[input.currency] ?? 0) + input.amount,
},
});
}
);

// every time an Award is created, start a workflow to track it, e.g. expire it
export const onAwardCreated = Award.stream(
"onAwardCreated",
{
operations: ["insert"],
},
async (event) => {
if (event.operation === "insert") {
await awardPointsWorkflow.startExecution({
executionName: event.newValue.awardId,
input: event.newValue,
});
}
}
);

export const awardPointsWorkflow = workflow(
"awardPoints",
async (input: {
awardId: string;
userId: string;
amount: number;
expiry?: string;
currency: string;
}) => {
if (input.expiry) {
// wait until the time it expires
await time(input.expiry);

// then expire it
await expireAward(input.awardId);
}
}
);

/**
* Use a Transaction to atomically get/set the Award record to expire it
*/
export const expireAward = transaction(
"expireAward",
async (awardId: string) => {
const award = await Award.get({
awardId,
});

if (!award.expired) {
Award.set({
...award,
expired: true,
});
}
}
);
Loading