Skip to content

Commit

Permalink
feat: bring dynamodb
Browse files Browse the repository at this point in the history
  • Loading branch information
skyrpex committed Feb 23, 2024
1 parent 54aa78b commit 3b9ae60
Show file tree
Hide file tree
Showing 11 changed files with 2,196 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/dynamodb-pull.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: dynamodb-pull
on:
pull_request:
paths:
- dynamodb/**
jobs:
build-dynamodb:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
sparse-checkout: dynamodb
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 20.x
registry-url: https://registry.npmjs.org
- name: Install winglang
run: npm i -g winglang
- name: Install dependencies
run: npm install --include=dev
working-directory: dynamodb
- name: Test
run: wing test
working-directory: dynamodb
- name: Pack
run: wing pack
working-directory: dynamodb
56 changes: 56 additions & 0 deletions .github/workflows/dynamodb-release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: dynamodb-release
on:
push:
branches:
- main
paths:
- dynamodb/**
- "!dynamodb/package-lock.json"
jobs:
build-dynamodb:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
sparse-checkout: dynamodb
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 20.x
registry-url: https://registry.npmjs.org
- name: Install winglang
run: npm i -g winglang
- name: Install dependencies
run: npm install --include=dev
working-directory: dynamodb
- name: Test
run: wing test
working-directory: dynamodb
- name: Pack
run: wing pack
working-directory: dynamodb
- name: Get package version
run:
echo WINGLIB_VERSION=$(node -p "require('./package.json').version") >>
"$GITHUB_ENV"
working-directory: dynamodb
- name: Publish
run:
npm publish --access=public --registry https://registry.npmjs.org --tag
latest *.tgz
working-directory: dynamodb
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Tag commit
uses: tvdias/[email protected]
with:
repo-token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
tag: dynamodb-v${{ env.WINGLIB_VERSION }}
- name: GitHub release
uses: softprops/action-gh-release@v1
with:
name: dynamodb v${{ env.WINGLIB_VERSION }}
tag_name: dynamodb-v${{ env.WINGLIB_VERSION }}
files: "*.tgz"
token: ${{ secrets.PROJEN_GITHUB_TOKEN }}
2 changes: 2 additions & 0 deletions dynamodb/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
target/
node_modules/
21 changes: 21 additions & 0 deletions dynamodb/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Wing

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
58 changes: 58 additions & 0 deletions dynamodb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# dynamodb

## Prerequisites

- [winglang](https://winglang.io).

## Installation

```sh
npm i @winglibs/dynamodb
```

## Usage

```js
bring dynamodb;

let table = new dynamodb.Table(
attributeDefinitions: [
{
attributeName: "id",
attributeType: "S",
},
],
keySchema: [
{
attributeName: "id",
keyType: "HASH",
},
],
);

// Streams.
table.setStreamConsumer(inflight (record) => {
log("record processed = {Json.stringify(record)}");
});

// Put and query.
test "put and query" {
table.put(
item: {
id: "1",
body: "hello",
},
);
let response = table.query(
keyConditionExpression: "id = :id",
expressionAttributeValues: {":id": "1"},
);
assert(response.count == 1);
assert(response.items.at(0).get("id").asStr() == "1");
assert(response.items.at(0).get("body").asStr() == "hello");
}
```

## License

This library is licensed under the [MIT License](./LICENSE).
170 changes: 170 additions & 0 deletions dynamodb/lib.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
export { default as getPort } from "get-port";

import * as child_process from "node:child_process";

export const spawn = async (options) => {
let child = child_process.spawn(options.command, options.arguments, {
cwd: options.cwd,
env: options.env,
});

child.stdout.on("data", (data) => options.onData?.(data.toString()));
child.stderr.on("data", (data) => options.onData?.(data.toString()));

return {
kill() {
child.kill("SIGINT");
},
};
};

import * as dynamodb from "@aws-sdk/client-dynamodb";
import { DynamoDBDocument } from "@aws-sdk/lib-dynamodb";

// export interface CreateClientOptions {
// endpoint: string;
// }

export const createClient = (endpoint) => {
return new dynamodb.DynamoDB({
region: "local",
credentials: {
accessKeyId: "local",
secretAccessKey: "local",
},
endpoint,
});
};

export const createDocumentClient = (endpoint) => {
const client = createClient(endpoint);
return DynamoDBDocument.from(client, {
marshallOptions: {
removeUndefinedValues: true,
convertEmptyValues: true,
},
unmarshallOptions: {
wrapNumbers: true,
},
});
};

// const x = DynamoDBDocument.from();
// x.transactWrite({
// TransactItems: [
// {
// Put: {}
// }
// ]
// })

import * as streams from "@aws-sdk/client-dynamodb-streams";

// export const createStreamsClient = (endpoint) => {
// return new streams.DynamoDBStreams({
// region: "local",
// credentials: {
// accessKeyId: "local",
// secretAccessKey: "local",
// },
// endpoint,
// });
// };

/**
* @param {import("@aws-sdk/client-dynamodb-streams").DynamoDBStreams} client
* @param {string} StreamArn
* @param {(record: any) => void|Promise<void>} handler
*/
const processStreamRecords = async (client, StreamArn, handler) => {
// while (true) {
// try {
const { StreamDescription } = await client.describeStream({ StreamArn });

for (const { ShardId } of StreamDescription.Shards) {
const shardIteratorData = await client.getShardIterator({
StreamArn,
ShardId,
ShardIteratorType: "TRIM_HORIZON",
});

let shardIterator = shardIteratorData.ShardIterator;
while (shardIterator) {
const recordsData = await client.getRecords({
ShardIterator: shardIterator,
});

for (const record of recordsData.Records) {
try {
await handler(record);
} catch (error) {
console.error("Error processing stream record:", error, record);
}
}

shardIterator = recordsData.NextShardIterator;

// AWS DynamoDB fetches records 4 times a second.
await new Promise((resolve) => setTimeout(resolve, 250));
}
}
// } catch (error) {
// console.error("Error processing stream records:", error);
// console.error("error name", error.name);
// // if (error.name === "TrimmedDataAccessException") {
// // // Ignore...
// // } else {
// // throw error;
// // }
// }

// console.log("something went wrong");
// await new Promise((resolve) => setTimeout(resolve, 250));
// }
};

const processRecords = async (endpoint, tableName, handler) => {
while (true) {
const client = new streams.DynamoDBStreams({
region: "local",
credentials: {
accessKeyId: "local",
secretAccessKey: "local",
},
endpoint,
});

try {
const { Streams } = await client.listStreams({ TableName: tableName });
await Promise.all(
Streams.map(({ StreamArn }) =>
processStreamRecords(client, StreamArn, handler)
)
);
} catch (error) {
if (error.message.includes("ECONNREFUSED")) {
// Stop processing records when the host is down.
throw error;
} else if (error.name === "TrimmedDataAccessException") {
// Ignore. This error seems to be a bug in DynamoDB Local.
// The desired behavior is to retry processing the records.
} else if (error.name === "ExpiredIteratorException") {
// Ignore. This error happens after the computer wakes up from sleep.
} else {
throw error;
}
await new Promise((resolve) => setTimeout(resolve, 250));
}
}
};

export const processRecordsAsync = async (endpoint, tableName, handler) => {
processRecords(endpoint, tableName, handler).catch((error) => {
if (error.message.includes("ECONNREFUSED")) {
// Ignore. This error happens when reloading the console.
// We can safely end the execution here.
} else {
console.error(error);
}
});
};
Loading

0 comments on commit 3b9ae60

Please sign in to comment.