aedes 0.51.2 → 1.0.0

package/.github/actions/sticky-pr-comment/action.yml

@@ -0,0 +1,55 @@
+name: "Sticky PR Comment"
+description: "Posts or updates a pull request comment identified by a tag."
+inputs:
+  file:
+    description: "Path to the file whose contents are to be posted"
+    required: true
+  tag:
+    description: "Unique tag to identify the comment (e.g. <!-- BENCHMARK_REPORT_COMMENT -->)"
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - name: Read file and set as output
+      id: file
+      shell: bash
+      run: |
+        echo "body<<EOF" >> $GITHUB_OUTPUT
+        cat "${{ inputs.file }}" >> $GITHUB_OUTPUT
+        echo "EOF" >> $GITHUB_OUTPUT
+
+    - name: Post or update PR comment
+      uses: actions/github-script@v7
+      with:
+        github-token: ${{ github.token }}
+        script: |
+          const tag = `${{ inputs.tag }}`;
+          const body = `${tag}\n${{ steps.file.outputs.body }}`;
+          const pr = context.payload.pull_request?.number;
+          if (!pr) {
+            core.setFailed("No pull request found in context.");
+            return;
+          }
+          const { data: comments } = await github.rest.issues.listComments({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: pr,
+          });
+          const tagged = comments.find(comment =>
+            comment.body.includes(tag)
+          );
+          if (tagged) {
+            await github.rest.issues.updateComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              comment_id: tagged.id,
+              body: body,
+            });
+          } else {
+            await github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: pr,
+              body: body,
+            });
+          }

package/.github/workflows/benchmark-compare-serial.yml

@@ -0,0 +1,60 @@
+name: "Benchmark Report"
+
+description: "Runs benchmarks and posts or updates a sticky PR comment with the results."
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: read
+
+jobs:
+  benchmark:
+    name: Benchmark
+    runs-on: ubuntu-latest
+    env: 
+      nodeVersion: 20
+      mainRef: "main"
+    steps:
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.nodeVersion }}
+
+      # Run benchmark on main branch
+      - name: Checkout main branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.mainRef }}
+          path: main-source
+
+      - name: Install dependencies (main)
+        run: npm install --ignore-scripts
+        working-directory: main-source
+
+      - name: Run benchmark on main
+        run: node benchmarks/runBenchmarks.js > ../results.main.csv
+        working-directory: main-source
+
+      # Run benchmark on PR branch
+      - name: Checkout PR branch
+        uses: actions/checkout@v4
+        with:
+          path: pr-source
+
+      - name: Install dependencies (PR)
+        run: npm install --ignore-scripts
+        working-directory: pr-source
+
+      - name: Run benchmark on PR branch
+        run: node benchmarks/runBenchmarks.js > ../results.branch.csv
+        working-directory: pr-source
+
+      # Generate the report
+      - name: Generate report
+        shell: bash
+        run: |
+          cat results.main.csv results.branch.csv | node main-source/benchmarks/report.js >> $GITHUB_STEP_SUMMARY
+
+     

package/.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: [16, 18, 20]
+        node-version: [ 20, 22, 24]
         os: [ubuntu-latest, windows-latest, macOS-latest]
       fail-fast: false
     steps:
@@ -59,20 +59,15 @@ jobs:
       - name: Run tests
         run: |
           npm run test:ci
-
-      - name: Coveralls Parallel
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.github_token }}
-          parallel: true
-          flag-name: run-${{ matrix.node-version }}-${{ matrix.os }}
-
-  coverage:
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Coveralls Finished
-        uses: coverallsapp/github-action@master
+      
+      - name: Upload coverage reports to Codecov
+        # only let the first job upload coverage info
+        if: strategy.job-index == 0
+        uses: codecov/codecov-action@v5
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          parallel-finished: true
+          directory: coverage
+          fail_ci_if_error: true
+          flags: unittests
+          name: codecov-aedes
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

package/.release-it.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://unpkg.com/release-it@19/schema/release-it.json",
+  "github": {
+    "release": true
+  },
+  "git": {
+    "tagName": "v${version}",
+    "requireBranch": "main"
+  },
+  "hooks": {
+    "before:init": [
+      "npm run test:ci"
+    ]
+  },
+  "npm": {
+    "publish": true
+  }
+}

package/.taprc

@@ -1,6 +1,15 @@
-ts: false
-jsx: false
-flow: false
-coverage: true
-strict: true
-check-coverage: false
+# vim: set filetype=yaml :
+coverage-report:
+  - text
+allow-incomplete-coverage: true
+browser: false
+timeout: 60
+include:
+  - "**/@(test?(s)|__test?(s)__)/**/*.@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
+  - "**/*.@(test?(s)|spec).@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
+  - "**/test?(s).@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
+exclude:
+  - "**/@(fixture*(s)|dist)/**"
+snapshot-clean-cwd: true
+color: true
+reporter: tap

package/README.md

@@ -5,7 +5,7 @@
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/moscajs/aedes/graphs/commit-activity)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/moscajs/aedes/pulls)\
-[![Coverage Status](https://coveralls.io/repos/moscajs/aedes/badge.svg?branch=main&service=github)](https://coveralls.io/github/moscajs/aedes?branch=main)
+[![codecov](https://codecov.io/gh/moscajs/aedes/graph/badge.svg?token=6SdoJIgIjg)](https://codecov.io/gh/moscajs/aedes)
 [![Known Vulnerabilities](https://snyk.io/test/github/moscajs/aedes/badge.svg)](https://snyk.io/test/github/moscajs/aedes)\
 ![node](https://img.shields.io/node/v/aedes)
 [![NPM version](https://img.shields.io/npm/v/aedes.svg?style=flat)](https://www.npmjs.com/aedes)
@@ -22,6 +22,7 @@ Barebone MQTT server that can run on any stream servers
   - [Features](#features)
   - [Examples](#examples)
   - [Clusters](#clusters)
+  - [Bridge connections](#bridge-connections)
   - [Extensions](#extensions)
   - [Middleware Plugins](#middleware-plugins)
     - [Persistence](#persistence)
@@ -37,6 +38,7 @@ Barebone MQTT server that can run on any stream servers
   - [Made with Aedes](#made-with-aedes)
   - [Collaborators](#collaborators)
   - [Contribution](#contribution)
+  - [Security notice](#security-notice)
   - [Support](#support)
     - [Backers](#backers)
     - [Sponsors](#sponsors)
@@ -52,12 +54,12 @@ npm install aedes
 
 ## Docker
 
-Check Docker docs [here](https://github.com/moscajs/aedes-cli#docker)
+Check the [Docker docs](https://github.com/moscajs/aedes-cli#docker)
 
 ## API
 
-- [Aedes object](./docs/Aedes.md)
-- [Client object](./docs/Client.md)
+- [Aedes class](./docs/Aedes.md)
+- [Client class](./docs/Client.md)
 
 ## Features
 

package/aedes.d.ts

@@ -1,9 +1,3 @@
-import Aedes, { AedesOptions } from './types/instance'
-
-export declare function createBroker(options?: AedesOptions): Aedes
-
 export * from './types/instance'
 export * from './types/packet'
 export * from './types/client'
-
-export { default } from './types/instance'