comq 0.5.0 → 0.5.1-dev.1

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'fix: '
+labels: Bug
+assignees: temich
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: "dev"
+    labels:
+      - "dependency"
+      - "actions"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "dev"
+    labels:
+      - "dependency"

package/.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '15 8 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+tema.gurtovoy@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Toa
+Copyright (c) 2023-present Artem Gurtovoi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/examples/readme.md

@@ -2,6 +2,8 @@
 
 To run examples please start RabbitMQ server with `docker compose up -d` in the package root.
 
+> Try to run example first.
+
 ## RPC
 
 Run in two terminals:

package/features/steps/events.js

@@ -115,10 +115,14 @@ Then('all events have been received',
 async function consume (group, exchange) {
   this.consumed ??= {}
 
-  return this.io.consume(exchange, group, async (payload) => {
+  const consumer = async (payload) => {
     this.consumed[group] = payload
     this.eventsConsumedCount++
-  })
+  }
+
+  return group === undefined
+    ? this.io.consume(exchange, consumer)
+    : this.io.consume(exchange, group, consumer)
 }
 
 /**

package/lerna.json

@@ -1,5 +1,5 @@
 {
   "useWorkspaces": true,
-  "version": "0.5.0",
+  "version": "0.5.1-dev.1",
   "conventionalCommits": true
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comq",
-  "version": "0.5.0",
+  "version": "0.5.1-dev.1",
   "description": "ComQ",
   "author": {
     "name": "Artem Gurtovoi",
@@ -14,6 +14,10 @@
   "bugs": {
     "url": "https://github.com/toa-io/comq/issues"
   },
+  "keywords": [
+    "AMQP",
+    "RabbitMQ"
+  ],
   "engines": {
     "node": ">= 12.0.0"
   },
@@ -23,13 +27,13 @@
   "main": "source/index.js",
   "types": "types/index.d.ts",
   "devDependencies": {
-    "@cucumber/cucumber": "9.0.0",
+    "@cucumber/cucumber": "9.0.1",
     "@toa.io/command": "0.3.0",
     "@toa.io/mock": "0.3.0",
     "@toa.io/tomato": "0.4.0-dev.2",
     "@toa.io/yaml": "0.4.0-dev.2",
     "@types/amqplib": "0.10.1",
-    "@types/jest": "29.4.2",
+    "@types/jest": "29.5.0",
     "husky": "8.0.3",
     "jest": "29.5.0",
     "randomstring": "1.2.3",

package/readme.md

@@ -124,8 +124,8 @@ Event message is delivered to a single Consumer within *each group*.
 > Typically, the value of `group` refers to the name of a microservice running in multiple
 > instances.
 
-If the `group` is `undefined` or omitted, a unique value is generated and the queue is declared as
-exclusive.
+If the `group` is `undefined` or omitted, a queue for the Consumer is asserted as exclusive with
+auto-generated name.
 
 ### Example
 

package/source/channel.js

@@ -104,7 +104,7 @@ class Channel {
         await this.#publish(exchange, DEFAULT, buffer, options)
       }))
 
-  async throw (queue, buffer, options) {
+  async fire (queue, buffer, options) {
     try {
       await this.#publish(DEFAULT, queue, buffer, options)
     } catch (exception) {

package/source/io.js

@@ -83,7 +83,12 @@ class IO {
 
   consume = lazy(this, this.#createEventChannel,
     async (exchange, group, callback) => {
-      const exclusive = group === undefined || callback === undefined // 2 arguments passed
+      if (callback === undefined) { // 2 arguments passed
+        callback = group
+        group = undefined
+      }
+
+      const exclusive = group === undefined
       const queue = exclusive ? undefined : io.concat(exchange, group)
       const consumer = this.#getEventConsumer(callback)
 
@@ -184,7 +189,7 @@ class IO {
       const buffer = contentType === OCTETS ? reply : encode(reply, contentType)
       const properties = { contentType, correlationId }
 
-      await this.#replies.throw(message.properties.replyTo, buffer, properties)
+      await this.#replies.fire(message.properties.replyTo, buffer, properties)
     })
 
   /**

package/source/shards/channel.js

@@ -63,8 +63,8 @@ class Channel {
     await this.#one((channel) => channel.publish(exchange, buffer, options))
   }
 
-  async throw (queue, buffer, options) {
-    await this.#one((channel) => channel.throw(queue, buffer, options))
+  async fire (queue, buffer, options) {
+    await this.#one((channel) => channel.fire(queue, buffer, options))
   }
 
   async seal () {

package/test/channel.test.js

@@ -283,7 +283,7 @@ describe('send', () => {
   })
 })
 
-describe('throw', () => {
+describe('fire', () => {
   const queue = generate()
   const buffer = randomBytes(10)
   const options = { contentType: 'application/octet-stream' }
@@ -294,11 +294,11 @@ describe('throw', () => {
   })
 
   it('should be', async () => {
-    expect(channel.throw).toBeDefined()
+    expect(channel.fire).toBeDefined()
   })
 
   it('should publish a message', async () => {
-    await channel.throw(queue, buffer, options)
+    await channel.fire(queue, buffer, options)
 
     const call = chan.publish.mock.calls[0]
 
@@ -311,7 +311,7 @@ describe('throw', () => {
   it('should ignore exceptions', async () => {
     chan.publish.mockImplementation(() => { throw new Error() })
 
-    await expect(channel.throw(queue, buffer, options)).resolves.not.toThrow()
+    await expect(channel.fire(queue, buffer, options)).resolves.not.toThrow()
   })
 
   it('should wait for unpause', async () => {
@@ -342,7 +342,7 @@ describe('throw', () => {
       chan.emit('drain')
     })
 
-    await channel.throw(queue, buffer, options)
+    await channel.fire(queue, buffer, options)
 
     expect(chan.publish).toHaveBeenCalledTimes(3)
   })
@@ -900,7 +900,7 @@ describe('transient', () => {
   it('should not ignore exceptions on `throw()`', async () => {
     chan.publish.mockImplementation(() => { throw new Error('Channel closed') })
 
-    await expect(channel.throw(queue, buffer)).rejects.toThrow()
+    await expect(channel.fire(queue, buffer)).rejects.toThrow()
   })
 
   it('should expose index', async () => {

package/test/connection.mock.js

@@ -7,7 +7,7 @@ const channel = /** @type {jest.MockedFunction<(sharded?: boolean, index?: numbe
     consume: jest.fn(async () => undefined),
     deliver: jest.fn(async () => undefined),
     send: jest.fn(async () => undefined),
-    throw: jest.fn(async () => undefined),
+    fire: jest.fn(async () => undefined),
     subscribe: jest.fn(async () => undefined),
     publish: jest.fn(async () => undefined),
     diagnose: jest.fn(async () => undefined),

package/test/io.consume.test.js

@@ -84,6 +84,18 @@ describe.each(['omitted', 'undefined'])('exclusive consumption (group is %s)', (
     expect(events).toBeDefined()
     expect(events.subscribe).toHaveBeenCalledWith(exchange, undefined, expect.any(Function))
   })
+
+  it('should pass messages to the consumer', async () => {
+    const emit = events.subscribe.mock.calls[0][2]
+    const content = generate()
+    const contentType = 'text/plain'
+    const properties = { contentType }
+    const message = { content, properties }
+
+    await emit(message)
+
+    expect(consumer).toHaveBeenCalledWith(message.content)
+  })
 })
 
 /**

package/test/io.reply.test.js

@@ -91,7 +91,7 @@ describe('reply', () => {
   beforeEach(async () => {
   })
 
-  it('should `throw` reply', async () => {
+  it('should `fire` reply', async () => {
     await io.reply(queue, produce)
 
     requests = await findChannel('request')
@@ -107,7 +107,7 @@ describe('reply', () => {
     const reply = await produce.mock.results[0].value
     const buffer = encode(reply, properties.contentType)
 
-    expect(replies.throw).toHaveBeenCalledWith(properties.replyTo, buffer, expect.anything())
+    expect(replies.fire).toHaveBeenCalledWith(properties.replyTo, buffer, expect.anything())
   })
 
   it('should throw if producer returned undefined', async () => {
@@ -177,7 +177,7 @@ describe('encoding', () => {
       contentType: properties.contentType
     }
 
-    expect(replies.throw).toHaveBeenCalledWith(properties.replyTo, reply, props)
+    expect(replies.fire).toHaveBeenCalledWith(properties.replyTo, reply, props)
   })
 
   it('should set octet-stream for Buffer reply', async () => {
@@ -198,7 +198,7 @@ describe('encoding', () => {
 
     await producer(message)
 
-    expect(replies.throw)
+    expect(replies.fire)
       .toHaveBeenCalledWith(
         expect.any(String),
         buffer,

package/test/shards/channel.test.js

@@ -140,7 +140,7 @@ describe.each(['consume', 'subscribe'])('%s', (method) => {
   })
 })
 
-describe.each(/** @type {string[]} */['send', 'publish', 'throw'])('%s', (method) => {
+describe.each(/** @type {string[]} */['send', 'publish', 'fire'])('%s', (method) => {
   const label = generate()
   const buffer = randomBytes(8)
   const options = { contentType: generate() }

package/types/channel.d.ts

@@ -23,7 +23,7 @@ declare namespace comq {
 
     publish(exchange: string, buffer: Buffer, options?: Options.Publish): Promise<void>
 
-    throw(queue: string, buffer: Buffer, options?: Options.Publish): Promise<void>
+    fire(queue: string, buffer: Buffer, options?: Options.Publish): Promise<void>
 
     seal(): Promise<void>
 

package/.github/labels.yaml

@@ -1,15 +0,0 @@
-- name: "Bug"
-  description: "Something isn't working"
-  color: "d73a4a"
-- name: "Critical"
-  description: "Immediate action required"
-  color: "ffff00"
-- name: "Docs"
-  description: "Documentation improvements"
-  color: "0075ca"
-- name: "Feature"
-  description: "Feature request"
-  color: "73E25B"
-- name: "Improvement"
-  description: "Make something better"
-  color: "6A1877"

package/.github/workflows/labels.yaml

@@ -1,18 +0,0 @@
-name: Labels
-
-on:
-  push:
-    branches:
-      - 'dev'
-    paths:
-      - '.github/labels.yml'
-      - '.github/workflows/labels.yml'
-
-jobs:
-  labeler:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v4