feat!: introduce nestjs-sqs v3 (#85)

* chore(ci)!: drop support for node v16, adding node v22

* chore(deps)!: bump sqs-consumer to v11, use vitest and biome

* chore(ci): enrich emq config

* feat(test): apply vitest

* refactor: apply Biome lint and format

* chore(ci): run tests on ubuntu 24.04

* docs: update install command

* chore(ci): run tests before publish

.editorconfig

@@ -1,14 +1,6 @@
 # http://editorconfig.org
 root = true
 
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
 # Use 4 spaces for the Python files
 [*.py]
 indent_size = 4

.github/build/elasticmq.conf

@@ -1,5 +1,20 @@
 include classpath("application.conf")
 
+node-address {
+  protocol = http
+  host = localhost
+  port = 9324
+  context-path = ""
+}
+
+rest-sqs {
+  enabled = true
+  bind-port = 9324
+  bind-hostname = "0.0.0.0"
+  # Possible values: relaxed, strict
+  sqs-limits = strict
+}
+
 akka.http.server.request-timeout = 30 seconds
 
 queues {
@@ -20,3 +35,8 @@ queues {
       fifo = true
     }
 }
+
+aws {
+  region = us-west-2
+  accountId = 000000000000
+}

.github/workflows/publish.yml

@@ -5,8 +5,50 @@ on:
     types: [created]
 
 jobs:
+  test:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        node-version:
+          - 18.x
+          - 20.x
+          - 22.x
+    services:
+      elasticmq:
+        image: softwaremill/elasticmq
+        options: -p 9324:9324 --name elasticmq
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: ElasticMQ Configuration
+        run: |
+          cp ${{ github.workspace }}/.github/build/elasticmq.conf /tmp/elasticmq.conf
+          docker cp /tmp/elasticmq.conf elasticmq:/opt/elasticmq.conf
+          docker restart elasticmq
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        name: Use Node.js ${{ matrix.node-version }}
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Check lint
+        run: pnpm biome ci
+
+      - name: Run Tests
+        run: pnpm run test:e2e
+
+
   publish-npm:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
+    needs: test
     permissions:
       contents: read
       id-token: write

.github/workflows/test.yml

@@ -4,14 +4,14 @@ on: push
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     strategy:
       matrix:
         node-version:
-          - 16.x
           - 18.x
           - 20.x
+          - 22.x
 
     services:
       elasticmq:
@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: ElasticMQ Configuration
         run: |
@@ -29,9 +29,9 @@ jobs:
           docker restart elasticmq
 
       - name: Setup pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         name: Use Node.js ${{ matrix.node-version }}
         with:
           node-version: ${{ matrix.node-version }}
@@ -41,7 +41,7 @@ jobs:
         run: pnpm install
 
       - name: Check lint
-        run: pnpm run lint
+        run: pnpm biome ci
 
       - name: Run Tests
         run: pnpm run test:e2e

.gitignore

@@ -75,4 +75,5 @@ Temporary Items
 dist/
 node_modules/
 
-*.tgz
+*.tgz
+tsconfig.vitest-temp.json

.vscode/settings.json

@@ -1,3 +1,14 @@
 {
-  "typescript.tsdk": "node_modules/typescript/lib"
-}
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "eslint.enable": false,
+  "prettier.enable": false,
+  "biome.enabled": true,
+  "[json]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "never",
+    "quickfix.biome": "always",
+    "source.organizeImports.biome": "always"
+  }
+}

README.md

@@ -13,7 +13,7 @@ This library internally uses [bbc/sqs-producer](https://github.com/bbc/sqs-produ
 ## Installation
 
 ```shell script
-$ npm i --save @ssut/nestjs-sqs
+npm i --save @ssut/nestjs-sqs @aws-sdk/client-sqs
 ```
 
 ## Quick Start

auto-imports.d.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by unplugin-auto-import
+export {}
+declare global {
+  const afterAll: typeof import('vitest')['afterAll']
+  const afterEach: typeof import('vitest')['afterEach']
+  const assert: typeof import('vitest')['assert']
+  const beforeAll: typeof import('vitest')['beforeAll']
+  const beforeEach: typeof import('vitest')['beforeEach']
+  const chai: typeof import('vitest')['chai']
+  const describe: typeof import('vitest')['describe']
+  const expect: typeof import('vitest')['expect']
+  const it: typeof import('vitest')['it']
+  const suite: typeof import('vitest')['suite']
+  const test: typeof import('vitest')['test']
+  const vi: typeof import('vitest')['vi']
+  const vitest: typeof import('vitest')['vitest']
+}

biome.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "files": {
+    "include": ["e2e/**/*.ts", "lib/**/*.ts"],
+    "ignore": ["dist/"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 120,
+    "formatWithErrors": false,
+    "lineEnding": "lf"
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "javascript": {
+    "formatter": {
+      "lineWidth": 120,
+      "semicolons": "always",
+      "quoteStyle": "single",
+      "arrowParentheses": "always",
+      "jsxQuoteStyle": "double"
+    },
+    "parser": {
+      "unsafeParameterDecoratorsEnabled": true
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": false,
+      "complexity": {
+        "noBannedTypes": "error",
+        "noUselessTypeConstraint": "error"
+      },
+      "correctness": {
+        "noPrecisionLoss": "error",
+        "noUnusedVariables": "warn",
+        "useArrayLiterals": "off"
+      },
+      "style": {
+        "noInferrableTypes": "off",
+        "noNamespace": "error",
+        "noNonNullAssertion": "warn",
+        "useAsConstAssertion": "error",
+        "useBlockStatements": "off",
+        "useConst": "warn"
+      },
+      "suspicious": {
+        "noAssignInExpressions": "warn",
+        "noExplicitAny": "off",
+        "noExtraNonNullAssertion": "error",
+        "noMisleadingInstantiator": "error",
+        "noUnsafeDeclarationMerging": "error",
+        "useGetterReturn": "off"
+      }
+    }
+  }
+}