Ideas for scratchattach 2.0

[TimMcCool]

New / updated features in 2.0 (will be released in early October 2024)

These are only ideas for now. I don't know yet how many of these I'll actually implement.
If you want to help by submitting a pull request, please choose the v2 branch as base.

New classes related to the Scratch Community:

• Session.connect_user_by_id
• Session.get_message_events -> MessageEvents class
• Session.create_project
• Session.create_remix
• scratchattach.get_comment, Session.connect_comment -> Comment class
• scratchattach.get_class, Session.connect_class -> Class class (for classrooms) cancled because there are no APIs for classrooms at all
• Update (or deprecate) existing forum classes and methods so they work without ScratchDB
• Session.connect_filterbot -> FilterBot class (a bot automatically deleting spam comments)
• ScratchActivity class for messages and other user activity items

New cloud classes:

• scratchattach.get_cloud, Session.connect_cloud -> Cloud class
• Cloud.connect_events, Cloud.get_events -> CloudEvents class
• Cloud.connect_recorder -> CloudRecorder class
• Cloud.connect_requests -> CloudRequests class (1)
• Cloud.connect_storage -> CloudStorage class (1)
• MultiCloudEvents, MultiCloudRequests, MultiCloudStorage classes (1)

New common methods:

• objectify (convert list of dicts to list of corresponding objects)
• api_request (performs a Scratch API request and automatically raises error based on API response)

Project JSON editing capabilities:

• ProjectJSON class with attributs like .user_agent, .block_count, .assets etc. (2)
• ProjectJSON.assets returns list of (new) Asset objects with attributes like .asset_id .type .download() etc. (2)
• list is also returned by Session.backpack() (2)
• maybe more features, like .add_var(), .convert_to_cloud_var() etc. (2)
• test backpack features

New features for cloud requests:

• packet loss prevention (issue Proposal: Add TCP-Like packet-loss-prevention #235 ) (1)
• multithread cloud variable sets (not sure if possible) unnecessary because I found out how to set multiple vars simulatenously (1)
• better event loop: Event class of threading module
  - add asyncio cloud requests canceled
• debug CloudRequests, MultiEventHandler, CloudRequestsAsync and CloudStorage
• add .ping method to Cloud Requests (send data to Scratch without a priorly received event) (1)

Other stuff:

• TwCloudServer: a class for creating a websocket cloud server compatible with TurboWarp (3)
• ScratchAuth: a class with methods for authenticating a user's Scratch account in a app (3)
• Overhaul cloud variable methods for better error handling and prevent mass reconnects
• add method for parent_comment
• set multiple cloud vars simultaneously (maybe possible?)

[TimMcCool]

Generally, I'll try to increase consistencies in how scratchattach's classes work in v2.0.

I'll also make it so if you (for example)

1. run session.connect_user to get a User object and then
2. run user.followers() method to get the user's followers as list objects,

any methods requiring authentication will also work on the objects returned in step 2). Your session will be connected to all objects you get from an object where your session is connected,
so you can flawlessly follow all users returned from user.followers, user.following etc. without having to run session.connect_user on them
(the same will also apply to projects, studios etc.)

[mas6y6]

Oh! I like this so this whats you been doing this entire time!

[mas6y6]

You should add support for Multiple clients to run and if one goes down it can be redirected to an other client and you can also make it like a url that it requests things from one server or node like what I was planning to do with ScratchAttach Nexor

[TheCommCraft]

Are you using the profile comment api to get username by userid? Am Mi., 25. Sept. 2024 um 19:13 Uhr schrieb mas6y6 ***@***.***

…

: You should add support for Multiple clients to run and if one goes down it can be redirected to an other client and you can also make it like a url that it requests things from one server or node like what I was planning to do with ScratchAttach Nexor — Reply to this email directly, view it on GitHub <#242 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATCKMZUW54RVIY44WYXPPK3ZYLVMDAVCNFSM6AAAAABO2X47SKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNZUGY4DAMZUGE> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[TimMcCool]

Are you using the profile comment api to get username by userid? Am Mi., 25. Sept. 2024 um 19:13 Uhr schrieb mas6y6 @.***
…
: You should add support for Multiple clients to run and if one goes down it can be redirected to an other client and you can also make it like a url that it requests things from one server or node like what I was planning to do with ScratchAttach Nexor — Reply to this email directly, view it on GitHub <#242 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ATCKMZUW54RVIY44WYXPPK3ZYLVMDAVCNFSM6AAAAABO2X47SKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNZUGY4DAMZUGE . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Yes. I'm planning to first check if the ID can be found in a DB run by PhilHub, and then use the profile comment API. (I'll put a warning saying that the API creates a message and shouldn't be used in large-scale)

[TheCommCraft]

You can just delete the comment to delete the message Tim ***@***.***> schrieb am Mi., 25. Sept. 2024, 21:02:

…

Are you using the profile comment api to get username by userid? Am Mi., 25. Sept. 2024 um 19:13 Uhr schrieb mas6y6 *@*.*** … <#m_596885099696569768_> : You should add support for Multiple clients to run and if one goes down it can be redirected to an other client and you can also make it like a url that it requests things from one server or node like what I was planning to do with ScratchAttach Nexor — Reply to this email directly, view it on GitHub <#242 (comment) <#242 (comment)>>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ATCKMZUW54RVIY44WYXPPK3ZYLVMDAVCNFSM6AAAAABO2X47SKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNZUGY4DAMZUGE . You are receiving this because you are subscribed to this thread.Message ID: *@*.***> Yes. (I'll put a warning saying that the API creates a message and shouldn't be used in large-scale) — Reply to this email directly, view it on GitHub <#242 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATCKMZWEARA357VF54MU4OLZYMCCVAVCNFSM6AAAAABO2X47SKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNZUHEZDQOJWGA> . You are receiving this because you commented.Message ID: ***@***.***>

[TimMcCool]

The rate limit for posting comments isn't active when the new comment is deleted, this makes it possible to use the method for getting a user by id without having to implement a cooldown

[TheCommCraft]

So it's even better Tim ***@***.***> schrieb am Mi., 25. Sept. 2024, 23:17:

…

The rate limit for posting comments isn't active when the new comment is deleted, this makes it possible to use the method for getting a user by id without having to implement a cooldown — Reply to this email directly, view it on GitHub <#242 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATCKMZTYZ7UEC3VZFTYTS73ZYMSAHAVCNFSM6AAAAABO2X47SKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNZVGI3TQMJXGY> . You are receiving this because you commented.Message ID: ***@***.***>

[starlightsparks]

I do beg your pardon; Does Session.create_project create a project? If so, is this not a bot-performed social action?

[TheCommCraft]

Maybe .push or .send would be better than .ping

[TimMcCool]

An option for using proxies will be part of v2.0

[TheCommCraft]

I saw a couple of bugs in the code, I'll make a fix pull request soon.