Add MongoStorage for FSM (MongoDB driver) #1407

selfkilla666 · 2024-02-05T23:51:31Z

Description

Adding a new class aiogram.fsm.storage.MongoStorage - MongoDB driver for aiogram's Finite State Machine. It works on the base of asynchronous motor module to work with MongoDB. Was developed as part of an in-house project, and finalized to add to the aiogram library. Can be used via:

from aiogram import Dispatcher
from aiogram.fsm.storage.mongo import MongoStorage

from motor.motor_asyncio import AsyncIOMotorClient


MONGODB_CLUSTER_URI = environ.get("MONGODB_CLUSTER_URI", "No URL!")

mongo_client: AsyncIOMotorClient = AsyncIOMotorClient(MONGODB_CLUSTER_URI)
mongo_storage: MongoStorage = MongoStorage(mongo_client)
dispatcher: Dispatcher = Dispatcher(storage=mongo_storage)

or initialize directly for the URI:

mongo_storage: MongoStorage = MongoStorage.from_url(MONGODB_CLUSTER_URI)

Otherwise, the module works like all other FSM-Storage. Documentation and dependency updates are also included.

Type of change

Please delete options that are not relevant.

Documentation (typos, code examples or any documentation update)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

This FSM storage module for MongoDB was written for in-house development (bot), and was tested for performance in a business project. Only documentation, dependencies, and black-style code reformatting were added to add it to the standard aiogram library. There are no ready unit tests available (yet).

Test Configuration:

Operating System: Windows 10 / Ubuntu 22.04 LTS
Python version: 3.12

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

Update: I added a unit test to check MongoStorage and it passes successfully

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

github-actions · 2024-02-05T23:51:49Z

✔️ Changelog found.

Thank you for adding a description of the changes

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

JrooTJunior

What about events isolation mechanism based on the Mongo? It can be safely used?

JrooTJunior · 2024-02-09T19:32:35Z

tests/test_fsm/storage/test_mongo.py

+from aiogram.fsm.storage.mongo import AIOGRAM_DATABASE_NAME
+
+
+MONGO_TEST_URI: str = "mongodb+srv://bot:25sFG3vj7H2T4j5R@mongostorage-aiogram-te.pugxfxq.mongodb.net/?retryWrites=true&w=majority"


WTF? Why was this connection string hardcoded? It should be configured outside of tests, just like Redis.

JrooTJunior · 2024-02-09T19:40:27Z

tests/test_fsm/storage/test_mongo.py

+    client.close()
+
+
+class TestMongoStorage:


You don't need to implement additional test-cases for the new storage.
Just implement fixture for Mingo Storage like this: https://github.com/aiogram/aiogram/blob/dev-3.x/tests/conftest.py#L47-L62
and then add fixture usage for already defined test-cases: https://github.com/aiogram/aiogram/blob/dev-3.x/tests/test_fsm/storage/test_storages.py#L14

Additional tests is needed only for specific methods that is not covered by other tests.

JrooTJunior · 2024-02-09T19:46:06Z

aiogram/fsm/storage/mongo.py

+from aiogram.fsm.state import State
+from aiogram.fsm.storage.base import BaseStorage
+from aiogram.fsm.storage.base import StateType
+from aiogram.fsm.storage.base import StorageKey


Why this import lines was separated? It can be grouped.

JrooTJunior · 2024-02-09T19:46:23Z

aiogram/fsm/storage/mongo.py

+try:
+    from motor.motor_asyncio import AsyncIOMotorClient
+    from motor.motor_asyncio import AsyncIOMotorDatabase
+    from motor.motor_asyncio import AsyncIOMotorCollection


The same question with imports.

JrooTJunior · 2024-02-09T19:48:28Z

aiogram/fsm/storage/mongo.py

+    _client: AsyncIOMotorClient
+    _database: AsyncIOMotorDatabase
+    _states_collection: AsyncIOMotorCollection
+    _data_collection: AsyncIOMotorCollection


Why this attributes type-hinted in two places at the same time?

You don't need to write type-hints on the class level if you specify it in the init method or vice versa.

JrooTJunior · 2024-02-09T19:55:29Z

aiogram/fsm/storage/mongo.py

+        if isinstance(value, str):
+            return value
+        if isinstance(value, State):
+            return value.state


What happens if value has any other type than NoneType, str or State?

JrooTJunior · 2024-02-09T19:55:48Z

aiogram/fsm/storage/mongo.py

+        )
+
+    @staticmethod
+    def resolve_state(value) -> None | str:


value should be typed

JrooTJunior · 2024-02-09T19:57:50Z

aiogram/fsm/storage/mongo.py

+
+        updated_data: dict = await self.get_data(key)
+        updated_data.update(data)
+        await self.set_data(key, updated_data)


You can implement update method in a more safe way with Mongo instead of doing two separated operations.

JrooTJunior · 2024-02-09T19:59:37Z

pyproject.toml

@@ -61,6 +61,9 @@ fast = [
 redis = [
    "redis[hiredis]~=5.0.1",
 ]
+mongo = [
+    "motor>=3.3.2"


Motor 4.x could potentially break the aiogram, so you should use stricter conditions for version selection.

Trailing comma should also be used here.

JrooTJunior · 2024-02-09T20:03:16Z

CHANGES/1407.feature.rst

@@ -0,0 +1 @@
+Adding a new class :code:`aiogram.fsm.storage.MongoStorage` - MongoDB driver for aiogram's Finite State Machine. It works on the base of asynchronous :code:`motor` module to work with MongoDB.


Use Added instead of Adding word.

Write something like this:

Suggested change

Adding a new class :code:`aiogram.fsm.storage.MongoStorage` - MongoDB driver for aiogram's Finite State Machine. It works on the base of asynchronous :code:`motor` module to work with MongoDB.

Added new storage :code:`aiogram.fsm.storage.MongoStorage` for Finite State Machine based on Mongo DB (using :code:`motor` library)

JrooTJunior · 2024-02-18T22:46:29Z

@selfkilla666, any news?

JrooTJunior · 2024-02-26T00:16:08Z

Mongo Storage seems to have been cursed 😞

3 unfinished PR's with this storage implementation.

selfkilla666 added 5 commits February 6, 2024 00:34

Create mongo.py

5b5b2ff

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

Add code for MongoStorage

4ccd554

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

Code refactored to black-style & Added documentation

6f8b716

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

Update dependencies (mongo)

21a1906

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

Add motor module check and error message

a7b1dff

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

github-actions bot added the 3.x Issue or PR for stable 3.x version label Feb 5, 2024

selfkilla666 added 2 commits February 6, 2024 01:57

Add changelog for aiogram#1407

9206441

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

Add tests for MongoStorage

d6059a8

Signed-off-by: selfkilla666 <selfkilla666@yahoo.com>

JrooTJunior requested changes Feb 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MongoStorage for FSM (MongoDB driver) #1407

Add MongoStorage for FSM (MongoDB driver) #1407

selfkilla666 commented Feb 5, 2024 •

edited

github-actions bot commented Feb 5, 2024 •

edited

JrooTJunior left a comment

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior Feb 9, 2024

JrooTJunior commented Feb 18, 2024

JrooTJunior commented Feb 26, 2024

		from aiogram.fsm.storage.mongo import AIOGRAM_DATABASE_NAME


		MONGO_TEST_URI: str = "mongodb+srv://bot:25sFG3vj7H2T4j5R@mongostorage-aiogram-te.pugxfxq.mongodb.net/?retryWrites=true&w=majority"

		@@ -0,0 +1 @@
		Adding a new class :code:`aiogram.fsm.storage.MongoStorage` - MongoDB driver for aiogram's Finite State Machine. It works on the base of asynchronous :code:`motor` module to work with MongoDB.

	Adding a new class :code:`aiogram.fsm.storage.MongoStorage` - MongoDB driver for aiogram's Finite State Machine. It works on the base of asynchronous :code:`motor` module to work with MongoDB.
	Added new storage :code:`aiogram.fsm.storage.MongoStorage` for Finite State Machine based on Mongo DB (using :code:`motor` library)

Add MongoStorage for FSM (MongoDB driver) #1407

Are you sure you want to change the base?

Add MongoStorage for FSM (MongoDB driver) #1407

Conversation

selfkilla666 commented Feb 5, 2024 • edited

Description

Type of change

How Has This Been Tested?

Checklist:

github-actions bot commented Feb 5, 2024 • edited

✔️ Changelog found.

JrooTJunior left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JrooTJunior commented Feb 18, 2024

JrooTJunior commented Feb 26, 2024

selfkilla666 commented Feb 5, 2024 •

edited

github-actions bot commented Feb 5, 2024 •

edited