Merge pull request #15 from rafalkrupinski/feature/add_nats_result_backend

add nats result backend - continuation

Author: chandr-andr

.github/workflows/test.yaml

@@ -3,55 +3,34 @@ name: Testing taskiq-nats
 on: pull_request
 
 jobs:
-  black:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run black check
-        run: poetry run black --check .
-  flake8:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run flake8 check
-        run: poetry run flake8 --count .
-  mypy:
+  lint:
+    strategy:
+      matrix:
+        cmd:
+          - black
+          - ruff
+          - mypy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: "3.9"
+          python-version: "3.11"
+          cache: "poetry"
       - name: Install deps
-        uses: knowsuchagency/poetry-install@v1
-        env:
-          POETRY_VIRTUALENVS_CREATE: false
-      - name: Run mypy check
-        run: poetry run mypy .
+        run: poetry install
+      - name: Run lint check
+        run: poetry run pre-commit run -a ${{ matrix.cmd }}
   pytest:
     strategy:
       matrix:
-        py_version: ["3.8", "3.9", "3.10", "3.11"]
+        py_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v2
         with:

.pre-commit-config.yaml

@@ -1,58 +1,40 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
-    hooks:
-      - id: check-ast
-      - id: trailing-whitespace
-      - id: check-toml
-      - id: end-of-file-fixer
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.4.0
+  hooks:
+  - id: check-ast
+  - id: trailing-whitespace
+  - id: check-toml
+  - id: end-of-file-fixer
 
-  - repo: https://github.com/asottile/add-trailing-comma
-    rev: v2.1.0
-    hooks:
-      - id: add-trailing-comma
+- repo: https://github.com/asottile/add-trailing-comma
+  rev: v2.1.0
+  hooks:
+  - id: add-trailing-comma
 
-  - repo: local
-    hooks:
-      - id: black
-        name: Format with Black
-        entry: poetry run black
-        language: system
-        types: [python]
+- repo: local
+  hooks:
+  - id: black
+    name: Format with Black
+    entry: poetry run black
+    language: system
+    types: [ python ]
 
-      - id: autoflake
-        name: autoflake
-        entry: poetry run autoflake
-        language: system
-        types: [python]
-        args: [--in-place, --remove-all-unused-imports, --remove-duplicate-keys]
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.6.0
+  hooks:
+  - id: ruff
+    name: ruff-check
+    pass_filenames: false
+    args:
+    - --fix
+    - taskiq_nats
+    - tests
 
-      - id: isort
-        name: isort
-        entry: poetry run isort
-        language: system
-        types: [python]
-
-      - id: flake8
-        name: Check with Flake8
-        entry: poetry run flake8
-        language: system
-        pass_filenames: false
-        types: [python]
-        args: [--count, taskiq_nats, tests]
-
-      - id: mypy
-        name: Validate types with MyPy
-        entry: poetry run mypy
-        language: system
-        pass_filenames: false
-        types: [python]
-        args: [taskiq_nats, tests]
-
-      - id: yesqa
-        name: Remove usless noqa
-        entry: poetry run yesqa
-        language: system
-        types: [python]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.11.1
+  hooks:
+  - id: mypy
+    pass_filenames: false

README.md

@@ -119,3 +119,40 @@ Here's the constructor parameters:
 * `durable` - durable name of the consumer. It's used to share messages between different consumers.
 * `pull_consume_batch` - maximum number of message that can be fetched each time.
 * `pull_consume_timeout` - timeout for messages fetch. If there is no messages, we start fetching messages again.
+
+
+## NATS Result Backend
+It's possible to use NATS JetStream to store tasks result.
+```python
+import asyncio
+from taskiq_nats import PullBasedJetStreamBroker
+from taskiq_nats.result_backend import NATSObjectStoreResultBackend
+
+
+result_backend = NATSObjectStoreResultBackend(
+    servers="localhost",
+)
+broker = PullBasedJetStreamBroker(
+    servers="localhost",
+).with_result_backend(
+    result_backend=result_backend,
+)
+
+
+@broker.task
+async def awesome_task() -> str:
+    return "Hello, NATS!"
+
+
+async def main() -> None:
+    await broker.startup()
+    task = await awesome_task.kiq()
+    res = await task.wait_result()
+    print(res)
+    await broker.shutdown()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+```

docker-compose.yml

@@ -5,7 +5,7 @@ version: '3.7'
 # successfully.
 services:
   nats:
-    image: nats:2.9.15-alpine
+    image: nats:2.10.12-alpine
     command:
       - "-m"
       - "8222"