StatesV2: Support for topics, multibots, and business messages #2321

coder2020official · 2024-06-23T10:35:06Z

~~Only sync memorystorage working now~~

coder2020official · 2024-06-25T07:50:55Z

@Badiboy I might need your opinion for further development. Have you used states before I ask you a question?

Badiboy · 2024-06-25T14:47:21Z

@coder2020official I never used States :(

coder2020official · 2024-07-12T17:13:09Z

Finished for sync - only left thing is to add a "bridge" between old and new formats of states to ease switching between these two.

…t to avoid conflicts, added support of statesv2 to async(only memory storage)

coder2020official · 2024-07-17T12:18:46Z

telebot/async_telebot.py

+        self.bot_id = None
+
+        if token_check:
+            result = apihelper.get_me(token)


@Badiboy do you think this is a good idea

So basically due to sync init, I had to call getMe from apihelper to obtain types.User due to token_check being true(new param)

So basically due to sync init, I had to call getMe from apihelper to obtain types.User due to token_check being true(new param)

Looks a bit ugly, but functional.

coder2020official · 2024-07-19T16:32:29Z

coder2020official · 2024-07-19T16:33:46Z

Pickle storage is the worst out of all. I had some bugs when simultaneously testing my states code.
I will investigate the issue and add a warning that pickle should NOT be used for production. Maybe for testing to a small audience.

coder2020official · 2024-07-19T16:37:44Z

Breaking changes will be here

state="*" filter will check for existing state, instead of returning True in StateFilter, which is useless;
get_data returns an EMPTY dictionary instead of None if the key does not exist.
State storage format completely changed: in order to avoid state loss, StateRedisStorage().migrate_format(bot_id) should be used (only for redis as it is supposed to be the only storage used for production)
StateContext was renamed into StateDataContext; It should not impact users unless they deliberately use it for some reason(idk); Though in this case none of our examples featured this class directly, nor it was recommended to use

…return empty dict on get_data & raise runtimeerror on key not existing

…te name

… states="*"

coder2020official · 2024-07-21T17:58:11Z

@Badiboy i need your opinion on something I addressed before. Check the comment above(about sync call in async, I tagged you there)

…y redis as it should be used for production.

coder2020official · 2024-07-25T13:25:55Z

@Badiboy I am nearly done with this PR.
I have provided all breaking changes which I believe are all reasonable; If they were not - I provided a way to fix backward compatibility(e.g migrate_format for Redis storage to avoid data loss)

Now, I would like you to review:

Folder & file names. I have moved states to a folder called states, with aio and sync folders. Do you think these names are fine? Maybe I should rename "aio" to "asyncio"?
the whole code :) (or at least the main files - init.py, async_telebot.py, etc to ensure backward compatibility, etc)

coder2020official · 2024-07-25T13:26:13Z

All that is left is cleaning up the code, which I will do after you proceed with the review

coder2020official · 2024-07-27T10:14:39Z

@Badiboy I am fully done, need your review

Badiboy · 2024-07-27T13:54:15Z

@coder2020official I saw the request but I'm not sure when I'll be able to pass all of this:

Especially as far as I never used states.

coder2020official · 2024-07-27T13:59:48Z

You can review only crucial files(not new ones, etc), e.g init, async_telebot.py, etc
All new files or storages do not require a review

coder2020official · 2024-07-27T14:00:59Z

Also I have addressed all breaking changes above

Badiboy · 2024-07-28T09:12:34Z

telebot/__init__.py

+        if validate_token:
+            util.validate_token(self.token)
+
+        self.bot_id = util.extract_bot_id(self.token) # subject to change in future, unspecified


May cause error if token is not in valid form. extract_bot_id should return NONE if extract fails.

But validate_token raises an error if token is not in valid form?

Yes. But only if validate_token is enabled. It's optional.

oh yes. Btw, you are fine with validate_token being True by default?

I saw it. I'm not happy, but as far it is not breaking and can be disabled - I can deal with it.

Badiboy · 2024-07-28T09:18:15Z

telebot/__init__.py

@@ -1172,6 +1184,9 @@ def polling(self, non_stop: Optional[bool]=False, skip_pending: Optional[bool]=F
        if restart_on_change:
            self._setup_change_detector(path_to_watch)

+        if not self._user:


We discussed that get_me should be optional.

Yep, my bad, for sync there's no need for this as self.user is a property that already does this

Badiboy · 2024-07-28T09:18:56Z

telebot/__init__.py

        """
-        Reset data for a user in chat.
+        Reset data for a user in chat: sets the 'data' fieldi to an empty dictionary.


fieldi => field?

Badiboy · 2024-07-28T09:20:08Z

telebot/async_telebot.py

+        if validate_token:
+            util.validate_token(self.token)
+
+        self.bot_id: int = util.extract_bot_id(self.token) # subject to change, unspecified


May cause error if token is not in valid form. extract_bot_id should return NONE if extract fails.

Badiboy · 2024-07-28T09:21:07Z

telebot/async_telebot.py

@@ -424,7 +437,8 @@ async def _process_polling(self, non_stop: bool=False, interval: int=0, timeout:
            # show warning
            logger.warning("Setting non_stop to False will stop polling on API and system exceptions.")

-        self._user = await self.get_me()
+        if not self._user:
+            self._user = await self.get_me()


We discussed that get_me should be optional.

I will return this to the original version, where it is called by default?

Badiboy · 2024-07-28T09:29:01Z

@coder2020official I checked only main files. All related to states are on your responcibility )

…sing error when extracting a bot id

coder2020official · 2024-07-28T09:51:47Z

Anything else left?

Badiboy · 2024-07-28T21:17:34Z

I don't understand your last commits.

bot_id is available only for ones who used validate_token? Independently if token is valid or not? As I noted before, I propose still trying to get bot_id, but just handle the case when it cannot be extracted. It's not too hard.

Badiboy · 2024-07-28T21:19:16Z

You totally removed get_me from sync:

And make it every time in async

Instead of make it optional in both versions?

coder2020official · 2024-07-29T02:45:57Z

I returned them to their original versions.
Removing in sync will still cause a request to be done, as self.user will be empty, and it is a property.

Before, async would always call a getme request

coder2020official · 2024-07-29T04:51:52Z

For 1), ok will fix it

coder2020official · 2024-07-30T10:49:04Z

fixed 1), addressed 2)

Badiboy · 2024-07-30T22:07:05Z

LGTM, let's go )

coder2020official · 2024-07-31T14:34:59Z

merge?

coder2020official · 2024-07-31T16:36:53Z

@Badiboy bot api update was released just now.
I propose first releasing bot API update, then merge this

coder2020official · 2024-08-05T11:54:35Z

Need to change version to 4.23.0

Badiboy · 2024-08-05T16:19:22Z

Have nothing against it. Push it here and merge.

coder2020official · 2024-08-05T17:04:50Z

I am afk, so we will have to delay this a little
No reason to rush anyways

coder2020official · 2024-08-11T11:58:17Z

@Badiboy done, merging since you approved.
Next version will need to be 4.23.0

coder2020official · 2024-08-11T11:58:50Z

We will also need a special changelog for next version with changes specifically for states.

coder2020official · 2024-08-11T12:01:51Z

States

Breaking changes

state="*" filter now checks if state exists.
get_data returns an empty dictionary if record does not exist
State storage format completely changed: in order to avoid state loss, StateRedisStorage().migrate_format(bot_id) should be used (only for redis as it is supposed to be the only storage used for production)

Features of new states

Support for business bots
Support for topics
Support for multibots

To automatically set business_message_id or message_thread_id, check for examples that use StateContext:
https://github.com/eternnoir/pyTelegramBotAPI/blob/master/examples/custom_states.py

Added statesv2

fce1c3d

coder2020official added 8 commits July 8, 2024 17:11

Sync states v2 early version

7e5a044

all update types are supported for states(theoretically)

4a7bc5d

Merge branch 'master' into statesv2

90a8f32

Merge branch 'eternnoir:master' into statesv2

5e4598d

added redis support(not fully tested)

676597c

Added redis dependency check

5bd4271

fix test

a79fd77

Added pickle and renamed method

c29bf0e

Fixed bugs, renamed StateContext for retrieve_data to StateDataContex…

15bced9

…t to avoid conflicts, added support of statesv2 to async(only memory storage)

coder2020official commented Jul 17, 2024

View reviewed changes

Async version fully supported, partially tested.

ff6485d

coder2020official added the breaking changes label Jul 19, 2024

coder2020official mentioned this pull request Jul 19, 2024

remove optional dependency aioredis #2195

Closed

3 tasks

coder2020official added 4 commits July 21, 2024 20:15

rewrote pickle sync with lock decorators, few changes to storages to …

af79db6

…return empty dict on get_data & raise runtimeerror on key not existing

Improved docstrings, fixed bugs, allow accessing statecontext via sta…

1adca13

…te name

Removed aioredis from optional dependencies, breaking change made for…

adae7a9

… states="*"

Updated examples

d33db85

Added migrate_format to migrate from old format of states to new. Onl…

536ffa2

…y redis as it should be used for production.

coder2020official requested a review from Badiboy July 25, 2024 13:26

coder2020official marked this pull request as ready for review July 25, 2024 13:26

code cleanuop & renamed aio -> asyncio

dbfa514

coder2020official requested review from Badiboy and removed request for Badiboy July 27, 2024 10:14

Remove apihelper following the validate_token not using getMe

2dbf190

Badiboy reviewed Jul 28, 2024

View reviewed changes

coder2020official added 2 commits July 28, 2024 14:48

Reverted changes regarding self._user, fixed validate_token=False cau…

b10e8d7

…sing error when extracting a bot id

fix docstring

6108e35

make extract_bot_id return None in case validation fails

30ebe75

Fix versions

d44ebce

coder2020official merged commit 21e92fb into eternnoir:master Aug 11, 2024
7 checks passed

StatesV2: Support for topics, multibots, and business messages #2321

StatesV2: Support for topics, multibots, and business messages #2321

Conversation

coder2020official commented Jun 23, 2024 • edited Loading

coder2020official commented Jun 25, 2024

Badiboy commented Jun 25, 2024

coder2020official commented Jul 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coder2020official commented Jul 19, 2024 • edited Loading

coder2020official commented Jul 19, 2024

coder2020official commented Jul 19, 2024 • edited Loading

coder2020official commented Jul 21, 2024 • edited Loading

coder2020official commented Jul 25, 2024

coder2020official commented Jul 25, 2024

coder2020official commented Jul 27, 2024

Badiboy commented Jul 27, 2024 • edited Loading

coder2020official commented Jul 27, 2024 • edited Loading

coder2020official commented Jul 27, 2024

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

Badiboy commented Jul 28, 2024

coder2020official commented Jul 28, 2024

Badiboy commented Jul 28, 2024 • edited Loading

Badiboy commented Jul 28, 2024

coder2020official commented Jul 29, 2024

coder2020official commented Jul 29, 2024

coder2020official commented Jul 30, 2024

Badiboy commented Jul 30, 2024

coder2020official commented Jul 31, 2024

coder2020official commented Jul 31, 2024

coder2020official commented Aug 5, 2024

Badiboy commented Aug 5, 2024

coder2020official commented Aug 5, 2024

coder2020official commented Aug 11, 2024

coder2020official commented Aug 11, 2024

coder2020official commented Aug 11, 2024

coder2020official commented Jun 23, 2024 •

edited

Loading

coder2020official commented Jul 19, 2024 •

edited

Loading

coder2020official commented Jul 19, 2024 •

edited

Loading

coder2020official commented Jul 21, 2024 •

edited

Loading

Badiboy commented Jul 27, 2024 •

edited

Loading

coder2020official commented Jul 27, 2024 •

edited

Loading

Badiboy commented Jul 28, 2024 •

edited

Loading