sqs example

Author: Ryan Miville

examples/sqs/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: "26.0.2"
+          gleam-version: "1.5.1"
+          rebar3-version: "3"
+          # elixir-version: "1.15.4"
+      - run: gleam deps download
+      - run: gleam test
+      - run: gleam format --check src test

examples/sqs/.gitignore

@@ -0,0 +1,10 @@
+*.beam
+*.ez
+/build
+erl_crash.dump
+
+# sst
+.sst
+
+node_modules
+.DS_Store

examples/sqs/README.md

@@ -0,0 +1,24 @@
+# sqs
+
+[![Package Version](https://img.shields.io/hexpm/v/sqs)](https://hex.pm/packages/sqs)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/sqs/)
+
+```sh
+gleam add sqs@1
+```
+```gleam
+import sqs
+
+pub fn main() {
+  // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/sqs>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```

examples/sqs/bun.lockb

@@ -0,0 +1,13 @@
+name = "sqs"
+version = "1.0.0"
+target = "javascript"
+
+[dependencies]
+gleam_stdlib = ">= 0.34.0 and < 2.0.0"
+glambda = { path = "../.." }
+gleam_http = ">= 3.7.0 and < 4.0.0"
+gleam_javascript = ">= 0.13.0 and < 1.0.0"
+
+
+[dev-dependencies]
+gleeunit = ">= 1.0.0 and < 2.0.0"

examples/sqs/gleam.toml

@@ -0,0 +1 @@
+console.log("Hello via Bun!");

examples/sqs/index.ts

@@ -0,0 +1,17 @@
+# This file was generated by Gleam
+# You typically do not need to edit this file
+
+packages = [
+  { name = "glambda", version = "0.1.0", build_tools = ["gleam"], requirements = ["gleam_http", "gleam_javascript", "gleam_stdlib"], source = "local", path = "../.." },
+  { name = "gleam_http", version = "3.7.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_http", source = "hex", outer_checksum = "EA66440C2269F7CED0F6845E5BD0DB68095775D627FA709A841CA78A398D6D56" },
+  { name = "gleam_javascript", version = "0.13.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_javascript", source = "hex", outer_checksum = "F98328FCF573DA6F3A35D7F6CB3F9FF19FD5224CCBA9151FCBEAA0B983AF2F58" },
+  { name = "gleam_stdlib", version = "0.40.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "86606B75A600BBD05E539EB59FABC6E307EEEA7B1E5865AFB6D980A93BCB2181" },
+  { name = "gleeunit", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "F7A7228925D3EE7D0813C922E062BFD6D7E9310F0BEE585D3A42F3307E3CFD13" },
+]
+
+[requirements]
+glambda = { path = "../.." }
+gleam_http = { version = ">= 3.7.0 and < 4.0.0" }
+gleam_javascript = { version = ">= 0.13.0 and < 1.0.0" }
+gleam_stdlib = { version = ">= 0.34.0 and < 2.0.0" }
+gleeunit = { version = ">= 1.0.0 and < 2.0.0" }

examples/sqs/manifest.toml

@@ -0,0 +1,18 @@
+{
+  "name": "sqs",
+  "type": "module",
+  "scripts": {
+    "dev": "gleam build && sst dev"
+  },
+  "devDependencies": {
+    "@types/aws-lambda": "8.10.145",
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "@aws-sdk/client-sqs": "^3.678.0",
+    "sst": "3.2.48"
+  }
+}

examples/sqs/package.json

@@ -0,0 +1,18 @@
+import { Resource } from "sst";
+import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs";
+const client = new SQSClient();
+
+export const handler = async (event) => {
+  // send a message
+  await client.send(
+    new SendMessageCommand({
+      QueueUrl: Resource.MyQueue.url,
+      MessageBody: "Hello from the subscriber",
+    }),
+  );
+
+  return {
+    statusCode: 200,
+    body: JSON.stringify({ status: "sent" }, null, 2),
+  };
+};

examples/sqs/publisher.js

@@ -0,0 +1,18 @@
+import glambda.{
+  type Context, type SqsBatchResponse, type SqsEvent, SqsBatchResponse,
+}
+import gleam/io
+import gleam/javascript/promise.{type Promise}
+import gleam/option.{type Option, None}
+
+pub fn handle_request(
+  event: SqsEvent,
+  _ctx: Context,
+) -> Promise(Option(SqsBatchResponse)) {
+  io.debug(event)
+  promise.resolve(None)
+}
+
+pub fn handler(event, ctx) {
+  glambda.sqs_handler(handle_request)(event, ctx)
+}

examples/sqs/src/sqs.gleam

@@ -0,0 +1,19 @@
+/* This file is auto-generated by SST. Do not edit. */
+/* tslint:disable */
+/* eslint-disable */
+/* deno-fmt-ignore-file */
+import "sst"
+export {}
+declare module "sst" {
+  export interface Resource {
+    "MyApp": {
+      "name": string
+      "type": "sst.aws.Function"
+      "url": string
+    }
+    "MyQueue": {
+      "type": "sst.aws.Queue"
+      "url": string
+    }
+  }
+}

examples/sqs/sst-env.d.ts

@@ -0,0 +1,32 @@
+/// <reference path="./.sst/platform/config.d.ts" />
+
+export default $config({
+  app(input) {
+    return {
+      name: "sqs",
+      removal: input?.stage === "production" ? "retain" : "remove",
+      home: "aws",
+      providers: {
+        aws: {
+          region: "us-east-1",
+          profile: "personal",
+        },
+      },
+    };
+  },
+  async run() {
+    const queue = new sst.aws.Queue("MyQueue");
+    queue.subscribe("build/dev/javascript/sqs/sqs.handler");
+
+    const app = new sst.aws.Function("MyApp", {
+      handler: "publisher.handler",
+      link: [queue],
+      url: true,
+    });
+
+    return {
+      app: app.url,
+      queue: queue.url,
+    };
+  },
+});

examples/sqs/sst.config.ts

@@ -0,0 +1,12 @@
+import gleeunit
+import gleeunit/should
+
+pub fn main() {
+  gleeunit.main()
+}
+
+// gleeunit test functions end in `_test`
+pub fn hello_world_test() {
+  1
+  |> should.equal(1)
+}

examples/sqs/test/sqs_test.gleam

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    // Enable latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}

examples/sqs/tsconfig.json

@@ -364,6 +364,22 @@ pub fn eventbridge_handler(handler: Handler(EventBridgeEvent, Nil)) -> JsHandler
   }
 }
 
+pub fn sqs_handler(
+  handler: Handler(SqsEvent, Option(SqsBatchResponse)),
+) -> JsHandler {
+  fn(event: JsEvent, ctx: JsContext) -> Promise(JsResult) {
+    let event = to_sqs_event(event)
+    let ctx = to_context(ctx)
+    handler(event, ctx)
+    |> promise.map(fn(resp) {
+      case resp {
+        Some(resp) -> from_sqs_batch_response(resp)
+        None -> Void
+      }
+    })
+  }
+}
+
 // --- FFI --------------------------------------------------------------------
 
 @external(javascript, "./glambda_ffi.mjs", "toApiGatewayProxyEventV2")
@@ -379,3 +395,9 @@ fn to_context(ctx: JsContext) -> Context
 
 @external(javascript, "./glambda_ffi.mjs", "toEventBridgeEvent")
 pub fn to_eventbridge_event(event: JsEvent) -> EventBridgeEvent
+
+@external(javascript, "./glambda_ffi.mjs", "toSqsEvent")
+pub fn to_sqs_event(event: JsEvent) -> SqsEvent
+
+@external(javascript, "./glambda_ffi.mjs", "fromSqsBatchResponse")
+pub fn from_sqs_batch_response(result: SqsBatchResponse) -> JsResult

src/glambda.gleam

@@ -19,6 +19,12 @@ import {
   ClientContextEnv,
   ApiGatewayEventValidity,
   EventBridgeEvent,
+  SqsEvent,
+  SqsRecord,
+  SqsRecordAttributes,
+  SqsMessageAttribute,
+  SqsBatchResponse,
+  SqsBatchItemFailure,
 } from "./glambda.mjs";
 
 export function toApiGatewayProxyEventV2(event) {
@@ -225,3 +231,67 @@ export function toEventBridgeEvent(event) {
     event.detail,
   );
 }
+
+export function toSqsEvent(event) {
+  return new SqsEvent(List.fromArray(event.Records.map(toSqsRecord)));
+}
+
+function toSqsRecord(record) {
+  return new SqsRecord(
+    record.messageId,
+    record.receiptHandle,
+    record.body,
+    toSqsRecordAttributes(record.attributes),
+    toMessageAttributes(record.messageAttributes),
+    record.md5OfBody,
+    record.eventSource,
+    record.eventSourceARN,
+    record.awsRegion,
+  );
+}
+
+function toSqsRecordAttributes(attrs) {
+  return new SqsRecordAttributes(
+    maybe(attrs.AWSTraceHeader),
+    attrs.ApproximateReceiveCount,
+    attrs.SentTimestamp,
+    attrs.SenderId,
+    attrs.ApproximateFirstReceiveTimestamp,
+    maybe(attrs.SequenceNumber),
+    maybe(attrs.MessageGroupId),
+    maybe(attrs.MessageDeduplicationId),
+    maybe(attrs.DeadLetterQueueSourceArn),
+  );
+}
+
+function toMessageAttributes(attrs) {
+  let entries = Object.entries(attrs).map(([key, value]) => {
+    let v = toSqsMessageAttribute(value);
+    return [key, v];
+  });
+  return $dict.from_list(List.fromArray(entries));
+}
+
+function toSqsMessageAttribute(attr) {
+  return new SqsMessageAttribute(
+    maybe(attr.stringValue),
+    maybe(attr.binaryValue),
+    maybe(attr.stringListValue),
+    maybe(attr.binaryListValue),
+    attr.dataType,
+  );
+}
+
+export function fromSqsBatchResponse(response) {
+  return {
+    batchItemFailures: response.batch_item_failures
+      .toArray()
+      .map(fromSqsBatchItemFailure),
+  };
+}
+
+function fromSqsBatchItemFailure(failure) {
+  return {
+    itemIdentifier: failure.item_identifier,
+  };
+}