Display X/Twitter API rate limits

[s3rgiosan]

Description of the Change

Display X/Twitter API rate limits

How to test the Change

Changelog Entry

Added - Admin dashboard widget for easy access to API usage statistics.
Changed - Display API usage statistics in the "Autopost to X/Twitter" block editor panel.

Credits

Props @s3rgiosan

Checklist:

• I agree to follow this project's Code of Conduct.
• I have updated the documentation accordingly.
• I have added Critical Flows, Test Cases, and/or End-to-End Tests to cover my change.
• All new and existing tests pass.

[s3rgiosan]

Dashboard widget

Block editor

[iamdharmesh]

Thanks a lot for the PR, @s3rgiosan! This looks great and tests well. I just have a few points to discuss before we conclude and mark this as ready for merge:

1. The rate limit for the 15-minute window is very high (1079999 out of 1080000). I don't think it will ever be utilized. How about we drop displaying it and only show the 24-hour limit for the user and app?

2. In the Block editor panel, the note under the limits currently appears for each account. Maybe we should display it only once, similar to how it's done for the dashboard widget. Additionally, how about keeping the rate limits data hidden until the account toggle is enabled?

Thank you.

[s3rgiosan]

Hi @iamdharmesh

The rate limit for the 15-minute window is very high (1079999 out of 1080000). I don't think it will ever be utilized. How about we drop displaying it and only show the 24-hour limit for the user and app?

Agreed. Since those headers are already being stored, they'll be available if we ever need to display them. I've removed them from both the dashboard and the block editor panel.

In the Block editor panel, the note under the limits currently appears for each account. Maybe we should display it only once, similar to how it's done for the dashboard widget. Additionally, how about keeping the rate limits data hidden until the account toggle is enabled?

Both things were addressed. Can you review again?

Thanks!

[iamdharmesh]

Hi @s3rgiosan,

Thanks for the quick updates on this; it looks great now. Apologies for bringing up one more thing to discuss. As we are using the same app for all accounts, it would be great if the limits could be updated for each account whenever a tweet is posted from any account. Currently, it only reflects on the account from which the tweet was made. This is not a major issue and only comes into play when multiple accounts are connected to the site (which is not always the case), but I just wanted to hear your thoughts on this. Otherwise, everything looks good to me.

Thank you.

[s3rgiosan]

@iamdharmesh Does the plugin support multiple connected apps, or is it limited to a single one? If it's limited to one, we could store the app's rate limits at a global level instead of per account. Alternatively, whenever a tweet is made, we could iterate through all accounts to update their corresponding app limit values.

[iamdharmesh]

@iamdharmesh Does the plugin support multiple connected apps, or is it limited to a single one?

@s3rgiosan it is limited to a single app. All user accounts are connected using the same app.

[s3rgiosan]

Thanks. I'll take a look and update the PR

[s3rgiosan]

Hi @iamdharmesh — I’ve updated the PR as requested. The limits are now displayed per user account, followed by the app limits. The app limits are fetched from the first user account.
When a tweet is sent, only the user account that sent the tweet gets its user-specific limits updated, and all user accounts are updated for "global" and app limits.

Dashboard

With one account

With more than one account

[iamdharmesh]

@s3rgiosan Thanks for making all the changes here! Things look good, test well, and are ready to be merged.

Note: I made some minor changes to fix the user rate limit reset issue for another user and updated the UI slightly