Does this have feature parity with snoowrap? #42

FoxxMD · 2022-01-19T17:42:32Z

FoxxMD
Jan 19, 2022

I've looked over the docs/migration section but nowhere does it mention if I can do everything in snoots that I can do in snoowrap.

Even if it means refactoring to do things the "snoots" way, could I fullly convert a project using every feature in snoowrap to using snoots?

Answered by thislooksfun

Jan 20, 2022

Short answer

Not yet, check #46 for progress

Long answer

There are still several large areas of the codebase that need work, namely own-user methods, private messaging, modmail, and flairs. For a full class-by-class rundown of what is missing see below.

Snoowrap Classes:

Notes/caveats:

This is comparing snoowrap@1.23.0 against snoots@v1.0.0-dev.14.
The names used here are snoowrap's names. snoots' naming scheme is often different.
I tried to be as complete as possible but it's likely I missed something.
This does not cover any method parameters, just the methods themselves.

snoowrap

Missing properties
- accessToken¹
- clientId¹
- clientSecret¹
- password¹
- ratelimitExpiration
- ratelimitRemaining
- …

View full answer

thislooksfun · 2022-01-20T06:13:03Z

thislooksfun
Jan 20, 2022
Maintainer

Short answer

Not yet, check #46 for progress

Long answer

There are still several large areas of the codebase that need work, namely own-user methods, private messaging, modmail, and flairs. For a full class-by-class rundown of what is missing see below.

Snoowrap Classes:

Notes/caveats:

This is comparing snoowrap@1.23.0 against snoots@v1.0.0-dev.14.
The names used here are snoowrap's names. snoots' naming scheme is often different.
I tried to be as complete as possible but it's likely I missed something.
This does not cover any method parameters, just the methods themselves.

snoowrap

Missing properties
- accessToken¹
- clientId¹
- clientSecret¹
- password¹
- ratelimitExpiration
- ratelimitRemaining
- scope
- tokenExpiration²
- userAgent¹
- username¹
Missing methods

RedditContent (base class for all items)

Missing properties
- created¹
Misisng methods
- fetch()¹
- refresh()¹
- toJSON()¹

ReplyableContent (extends RedditContent)

Full feature parity.

VoteableContent (extends ReplyableContent)

Missing properties
- author_flair_background_color
- author_flair_css_class
- author_flair_richtext
- author_flair_template_id
- author_flair_text
- author_flair_text_color
- author_flair_type
- author_fullname¹
- downs¹
- no_follow
- removal_reason
- report_reasons²
- subreddit_id¹
- subreddit_name_prefixed¹
- ups¹

Comment (extends VoteableContent)

Missing properties
- collapsed_reason²
- controversiality
- depth²
Missing methods

RedditUser (extends RedditContent)

Properties
- features
- gold_creddits
- modhash²
- new_modmail_exists¹
- oauth_client_id²
- pref_clickgadget²
- pref_geopopular²
- pref_show_snoovatar²
- pref_top_karma_subreddits²
- subreddit
- subreddit
Methods

Submission (extends VoteableContent)

Missing properties
- clicked
- content_categories
- link_flair_background_color
- link_flair_css_class
- link_flair_richtext
- link_flair_template_id
- link_flair_text
- link_flair_text_color
- link_flair_type
- media
- media_embed
- media_only
- parent_whitelist_status
- previous_visits
- pwls²
- post_hint
- preview
- quarantine
- removal_reason
- removed_by_category
- secure_media
- secure_media_embed
- selftext
- selftext_html
- suggested_sort
- thumbnail
- view_count
- visited
- whitelist_status
- wls²
Missing Methods

LiveThread (extends RedditContent)

Unimplemented

PrivateMessage (extends ReplyableContent)

Unimplemented

Subreddit (extends RedditContent)

Missing properties
- accounts_active¹
- advertiser_category
- allow_discovery
- allow_images
- allow_videogifs
- allow_videos
- has_menu_widget
- icon_img
- icon_size
- is_enrolled_in_new_modmail¹
- key_color
- lang
- link_flair_enabled
- link_flair_position
- notification_level
- primary_color
- public_description_html
- public_description
- suggested_comment_sort
- user_can_flair_in_sr
- user_flair_background_color
- user_flair_css_class
- user_flair_enabled_in_sr
- user_flair_position
- user_flair_richtext
- user_flair_template_id
- user_flair_text
- user_flair_text_color
- whitelist_status
- wls
Missing methods

MultiReddit (extends RedditContent)

Unimplemented

ModmailConversation (extends RedditContent)

Unimplemented

ModmailConversationAuthor (extends RedditContent)

Unimplemented

WikiPage (extends RedditContent)

Unimplemented

Listing

Feature parity, but implemented very differently.

¹This will not be implemented.
²This is unlikely to be implemented.
³This relates to private messaging, which is an ongoing discussion.

7 replies

FoxxMD Jan 21, 2022
Author

Thank you for re-considering on those points. To give you a better idea of how I use them (as a single use-case) and why they'd be important:

Rate Limit

How my application responds to a 4xx response from reddit is different based on whether it is due to rate limit exhaustion or some other reason. For any other reason I have a have retry with exponential falloff but for rate limit current behavior is immediately stopped.
I sample rate limit usage and use it in conjunction with expiration to...
- Show users real-time quota IE 577/600 remaining and a real-time estimate of depletion time IE in ~5 minutes
- Have soft/hard thresholds based on both actual # remaining and expected depletion -- when soft threshold is hit i reduce polling rates and response rates to try to stay within limit without stopping all activity
- Based on rate limit usage per subreddit I turn off some subreddit behavior before others (high usage is turned off first)
(WIP) Showing graphed usage of api usage per behavior/subreddit to clients

Scope

After making a test call snoowrap updates scope for the current authenticated user when it refreshes the token. I then makes checks against scope and mod permissions to determine if my bot can perform some actions like...

The bot must have bot mod permission Manager Flairs and the oauth scope flair in order to set flair on users/posts.
The bot must have modself oauth permission in order to check for and accept moderator invites. I check this before enabling programmatic invitation management per bot as well as giving the user a hint the bot must have it.

Requests

One other feature I'd like to touch on is access to http requests.

Exposing Raw Authenticated Request/Response

It looks like the main snoots client does expose get and post "raw" authenticated calls so that does kind of cover oauthRequest() which you have marked as not implementing (🤔 ). If those are actually exposed and raw responses are available that's all good 👍

Having access to those means that if there is something snoots has not implemented, or has not implemented the way I would need, I can always extend the client with my own method and use those functions to cover that. Just don't make them private ;)

Client Extensibility

You also have rawRequest() marked as not implementing. Understandable but I'd urge you to consider exposing got to the user so we can take full advantage of hooks, events, and plugins.

One use-case for this, that I already use a la overriding rawRequest in snoowrap, is configuring the requests to route through a local proxy server so that I can simulate network issues and 4xx/5xx responses from reddit to my application. If you just expose got to the user we can implement this kind of behavior ourselves without anymore work on your end.

FoxxMD Jan 21, 2022
Author

Realizing this should probably be in #4 instead of here? Should I move my comments to there?

thislooksfun Jan 21, 2022
Maintainer

From #4:

To make tracking these easier, please make separate threads for each piece of feedback.

So no, it's actually better here.

As for your reasoning I haven't had time to respond in detail, but I will get to it either later tonight or tomorrow.

thislooksfun Jan 22, 2022
Maintainer

@FoxxMD Alright, I've now had some time to review what you said. Thank you for the insight into how these fields are currently being used with snoowrap. You make some excellent points, and I will say that I definitely want to make usage like that possible with snoots.

How my application responds to a 4xx response from reddit is different based on whether it is due to rate limit exhaustion or some other reason.

That makes perfect sense. For a while now I have been planning to add a feature to snoots that mirrors snoowrap continueAfterRatelimitError flag. I could also add a built-in exponential retry for certain classes of error if that would be useful.

Show users real-time quota IE 577/600 remaining and a real-time estimate of depletion time IE in ~5 minutes

Have soft/hard thresholds based on both actual # remaining and expected depletion

Turn off some subreddit behavior before others

Showing graphed usage of api usage per behavior/subreddit to clients

All fantastic ideas, all will be possible.

snoowrap updates scope for the current authenticated user when it refreshes the token

Yes, I noticed that. Currently snoots is just discarding the scope(s), but a future version will definitely expose that (see #43 for progress).

The main snoots client does expose get and post "raw" authenticated calls so that does kind of cover oauthRequest() which you have marked as not implementing (🤔 ).

Those raw methods are only going to be exposed until snoots reaches feature parity with the reddit api. That being said, once that happens they will only be made protected, never private, so you can still freely extend the class to use them directly should you absolutely need to (though it would be greatly appreciated if you'd open an issue / PR so we can all benefit!).

As for why I said I wouldn't implement it, snoowrap exposes separate oauthRequest(), credentialedClientRequest() and unauthenticatedRequest() methods. Snoots has the same three code paths, but the switching between them is handled internally based on the authentication state (oauth if it has a token, credentialedClient if it only has creds, and unauthenticated if it has neither). If you need to manually switch between these auth levels using snoots you need to make at least 3 clients, one for each desired auth level.

Additionally, I am now planning a refactor of the internal request framework to make it more structured, more extensible, and more mockable. This refactor will allow for all the super-low-level inspection you want (including entirely bypassing any built-in error handling and retry mechanisms, should that be necessary). More details soon, still gotta iron out exactly how I want to do it.

Thanks again for the feedback!

thislooksfun Mar 4, 2022
Maintainer

@FoxxMD Just FYI, I will be tracking progress towards feature parity in #46, so go bookmark that for future updates.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Does this have feature parity with snoowrap? #42

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 1 comment 7 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

Does this have feature parity with snoowrap? #42

FoxxMD Jan 19, 2022

Short answer

Long answer

Snoowrap Classes:

Notes/caveats:

snoowrap

Replies: 1 comment · 7 replies

thislooksfun Jan 20, 2022 Maintainer

Short answer

Long answer

Snoowrap Classes:

Notes/caveats:

snoowrap

RedditContent (base class for all items)

ReplyableContent (extends RedditContent)

VoteableContent (extends ReplyableContent)

Comment (extends VoteableContent)

RedditUser (extends RedditContent)

Submission (extends VoteableContent)

LiveThread (extends RedditContent)

PrivateMessage (extends ReplyableContent)

Subreddit (extends RedditContent)

MultiReddit (extends RedditContent)

ModmailConversation (extends RedditContent)

ModmailConversationAuthor (extends RedditContent)

WikiPage (extends RedditContent)

Listing

FoxxMD Jan 21, 2022 Author

Rate Limit

Scope

Requests

Exposing Raw Authenticated Request/Response

Client Extensibility

FoxxMD Jan 21, 2022 Author

thislooksfun Jan 21, 2022 Maintainer

thislooksfun Jan 22, 2022 Maintainer

thislooksfun Mar 4, 2022 Maintainer

FoxxMD
Jan 19, 2022

Replies: 1 comment 7 replies

thislooksfun
Jan 20, 2022
Maintainer

FoxxMD Jan 21, 2022
Author

FoxxMD Jan 21, 2022
Author

thislooksfun Jan 21, 2022
Maintainer

thislooksfun Jan 22, 2022
Maintainer

thislooksfun Mar 4, 2022
Maintainer