API module: The Phantom Menace #536
Comments
|
+1 for removing the bangified methods. The only use case I can see for them is if you want some process to die if the function fails. That's simple enough for a user to do by themselves, and the benefit of being able to clean all of this up would be welcome. I think it's a bad idea (probably), but want to point out the possibility of putting these (and other) functions in broader context modules. Think like As for the constants module, I'd opt to leave it as is. There's a lot of things in there that are scoped such that they wouldn't fit under any of the suggested modules, and I'm not sure there's a lot to be gained from such an internal facing module. Good stuff! |
|
I like it. I second the suggestion to move functions into I think I saw mention of using delegates for this in the discord, which I think is a good idea and, imo, will help keep the API module clean. (Edit: to be clear I think retaining the existing API module and using it to delegate to the implementations is the right play, as it prevents this being a breaking change. The API module can later be deprecated in a major release) |
|
I am in favour of these as well. I agree delegates are probably a good idea to keep it compatible for now. One thought I have. Should we change |
|
Agree on this, that is more idiomatic, I'll rewrite later today. |
|
I do think to save the hellish possibility of 4k+ lines of new code as well as maintaining a huge api.ex file we really should just drop these methods for 1.0, but I'm open to looking more into the delegates. |
|
Not sure if anyone is working on this, but I'd love to take a stab at it if nobody else is. |
When I open
api.ex, my Emacs lags. This is simply unacceptable, as Emacs is known to be blazingly fast. I pondered, why could this be, why would my Emacs have anything above mere milliseconds of delay on opening a file. Then it hit me.I have decided that this will not do, and that we must scope out all methods to respective sub-modules. In the words of Craig:
I have hence decided to form an opinionated list of how we should do this restructure to kick off the discussion process, I encourage as much feedback as we can get here. I used
Nostrum.Api.__info__(:functions) |> Keyword.keys |> Enum.uniqto get this list.The convention I have used below is the newly scoped module, then the current name (under
Nostrum.Api) and the post-move module name.Thoughts
Migration
Would be very cool to try make this migration as simple as possible, maybe looking at custom Credo checks or other utilities to scan for usages of old
Nostrum.Apicalls or aliases and recommending the changes.Bangified methods
At the same time we make this change, we should ensure that all methods have a bangified equivalent if they can potentially return an API error.
I also wish there was a better way to do bangified functions, or to offload that to the user, because it makes the API functions list twice as complicated as it needs to be. In my mind, I want to shove
bangifyto the user-side and let them upgrade things to exceptions, but I don't know if that's as idiomatic/a good idea.Thoughts on this greatly appreciated, I wish we could do away with them, (and frankly, we already are missing enough of them that I think users would find ways to just handle things better)
Food for thought: Constants
I would also like to ask the question of how we handle the
Constantsmodule and if that also requires any form of refactoring after these changes.Guild module
Slightly related, but since the proposed Guild module is huge, I'd like to suggest:
Nostrum.Api.Expressions, like the API calls it)create_guild_integrations, it's not even a documented routeOther notes
I have only looked at public functions in the
Apimodule, there are a lot of private internals that would need to be figured out.The Modules
Nostrum.Apirequest=>requestrequest_multipart=>request_multipartNostrum.Api.ApplicationCommandsbatch_edit_application_command_permissions=>batch_edit_permissionsbulk_overwrite_global_application_commands=>bulk_overwrite_global_commandsbulk_overwrite_guild_application_commands=>bulk_overwrite_guild_commandscreate_global_application_command=>create_global_commandcreate_guild_application_command=>create_guild_commanddelete_global_application_command=>delete_global_commanddelete_guild_application_command=>delete_guild_commandedit_application_command_permissions=>edit_command_permissionsedit_global_application_command=>edit_global_commandedit_guild_application_command=>edit_guild_commandget_application_command_permissions=>get_command_permissionsget_global_application_commands=>get_global_commandsget_guild_application_command_permissions=>get_guild_command_permissionsget_guild_application_commands=>get_guild_commandsNostrum.Api.AutoModerationcreate_guild_auto_moderation_rule=>create_auto_moderation_ruledelete_guild_auto_moderation_rule=>delete_auto_moderation_ruleget_guild_auto_moderation_rule=>get_auto_moderation_ruleget_guild_auto_moderation_rules=>get_auto_moderation_rulesmodify_guild_auto_moderation_rule=>modify_auto_moderation_ruleNostrum.Api.Channeladd_pinned_channel_message=>pinbulk_delete_messages=>bulk_delete_messagescreate_guild_channel=>createdelete_channel=>deletedelete_channel_permissions=>delete_permissionsdelete_pinned_channel_message=>unpinedit_channel_permissions=>edit_permissionsget_channel=>getget_channel_messages=>get_messagesget_channel_webhooks=>get_webhooksget_pinned_messages=>get_pinsmodify_channel=>modifystart_typing=>start_typingNostrum.Api.Guildadd_guild_member=>add_memberbegin_guild_prune=>begin_prunecreate_guild_ban=>ban_membercreate_guild_emoji=>create_emojicreate_guild_integrations=>create_integrationdelete_guild=>deletedelete_guild_emoji=>delete_emojidelete_guild_integrations=>delete_integrationget_guild=>getget_guild_audit_log=>get_audit_logget_guild_ban=>get_banget_guild_bans=>get_bansget_guild_channels=>get_channelsget_guild_emoji=>get_emojiget_guild_integrations=>get_guild_integrationsget_guild_member=>get_memberget_guild_prune_count=>estimate_prune_countget_guild_roles=>get_rolesget_scheduled_events=>get_scheduled_eventsget_guild_webhooks=>get_webhooksget_guild_widget=>get_widgetget_voice_region=>get_voice_regionleave_guild=>leavelist_guild_emojis=>list_guild_emojislist_guild_members=>get_memberslist_voice_regions=>list_voice_regionsmodify_current_user_nick=>modify_self_nickmodify_guild=>modifymodify_guild_channel_positions=>modify_channel_positionsmodify_guild_emoji=>modify_emojimodify_guild_integrations=>modify_integrationsmodify_guild_member=>modify_membermodify_guild_role_positions=>modify_role_positionsmodify_guild_widget=>modify_widgetremove_guild_ban=>unban_memberremove_guild_member=>kick_membersync_guild_integrations=>sync_integrationsNostrum.Api.Interactionscreate_followup_message=>create_followup_messagecreate_interaction_response=>create_responsedelete_interaction_followup_message=>delete_followup_messagedelete_interaction_response=>delete_responseedit_interaction_response=>edit_responseget_original_interaction_response=>get_original_responseNostrum.Api.Invitesget_invite=>getdelete_invite=>delete_inviteget_guild_invites=>get_guild_invitescreate_channel_invite=>createget_channel_invites=>get_channel_invitesNostrum.Api.Messagecreate_message=>createcreate_reaction=>reactdelete_all_reactions=>clear_reactionsdelete_message=>deletedelete_own_reaction=>unreactdelete_reaction=>delete_reactiondelete_user_reaction=>delete_user_reactionedit_message=>editget_channel_message=>getget_reactions=>get_reactionsNostrum.Api.Pollsexpire_poll=>expireget_poll_answer_voters=>get_answer_votersNostrum.Api.Roleadd_guild_member_role=>add_membercreate_guild_role=>createdelete_guild_role=>deletemodify_guild_role=>modifyremove_guild_member_role=>remove_memberNostrum.Api.ScheduledEventcreate_guild_scheduled_event=>createdelete_guild_scheduled_event=>deleteget_guild_scheduled_event=>getget_guild_scheduled_event_users=>get_usersmodify_guild_scheduled_event=>modifyNostrum.Api.Selfget_application_information=>get_application_informationget_current_user=>getget_token=>get_tokenget_user_dms=>get_dmsmodify_current_user=>modifyupdate_shard_status=>update_shard_statusupdate_status=>update_statusupdate_voice_status=>update_voice_statusNostrum.Api.Threadadd_thread_member=>add_memberget_thread_member=>get_memberget_thread_members=>get_membersjoin_thread=>joinleave_thread=>leavelist_guild_threads=>list_threadslist_joined_private_archived_threads=>list_joined_private_archived_threadslist_private_archived_threads=>list_private_archived_threadslist_public_archived_threads=>list_public_archived_threadsremove_thread_member=>remove_memberstart_thread=>createstart_thread_in_forum_channel=>create_in_forumstart_thread_with_message=>create_with_messageNostrum.Api.Usercreate_dm=>create_dmcreate_group_dm=>create_group_dmget_current_user_guilds=>get_current_user_guildsget_user=>getget_user_connections=>get_user_connectionsNostrum.Api.Webhookcreate_webhook=>createdelete_webhook=>deleteedit_webhook_message=>edit_messageexecute_git_webhook=>execute_gitexecute_slack_webhook=>execute_slackexecute_webhook=>executeget_webhook=>getget_webhook_message=>get_messageget_webhook_with_token=>get_with_tokenmodify_webhook=>modifymodify_webhook_with_token=>modify_with_tokenThe text was updated successfully, but these errors were encountered: