Update Invite to match Discord changes #2500

My-Name-Is-Jeff · 2023-07-15T00:46:33Z

Pull Request Etiquette

I have checked the PRs for upcoming features/bug fixes.
I have read the contributing guidelines.

Changes

Internal code
Library interface (affecting end-user code)
Documentation
Other: _____

Closes Issue: NaN

Description

Discord made all the previous expanded Invite properties (max_uses, temporary, creation, etc...) except for uses accessible without authentication, so remove the expanded property and deprecate usages

Additionally, update docs to remove the outdated notice that certain fields require expansion

Adds a new method getTimeExpires to return the expires_at field of an invite, which is null if the invite never expires

Add the FRIEND InviteType and a way to parse it

Change EntityBuilder to use the type id to determine invite type

Discord made all the properties here except for uses accessible without authentication

Update docs to remove the expansion requirement

freya022 · 2023-07-15T07:29:21Z

Could you please link the appropriate Discord API docs PR/commit that documents this change?

My-Name-Is-Jeff · 2023-07-15T08:48:48Z

Could you please link the appropriate Discord API docs PR/commit that documents this change?

There doesn't seem to be any docs changes, noticed the changes after exceptions were thrown when trying to resolve guild invites

Probably should have opened a GH Issue but thought it was redundant

MinnDevelopment · 2023-07-28T14:07:28Z

Looks like there is still a compilation issue here with the constructor usage. Have you tested whether the usage of with_expiration=true makes a difference? It doesn't seem like we use it at all, currently.

My-Name-Is-Jeff · 2023-07-28T20:44:02Z

Looks like there is still a compilation issue here with the constructor usage. Have you tested whether the usage of with_expiration=true makes a difference? It doesn't seem like we use it at all, currently.

from what I recall the with_expiration query makes no difference on the response body whether or not it its true or false

My-Name-Is-Jeff · 2023-07-28T20:54:47Z

Should compile now, missed an internal usage

MinnDevelopment · 2023-07-28T23:50:18Z

Gonna hold off on merging this, still waiting for some info regarding the API stability here.

MinnDevelopment · 2023-08-01T07:14:21Z

I've been told that the changes to expanding invites will need to be reverted. The API will not continue to return the expanded object on the resolve endpoint in the future.

My-Name-Is-Jeff · 2023-08-01T07:21:27Z

I've been told that the changes to expanding invites will need to be reverted. The API will not continue to return the expanded object on the resolve endpoint in the future.

Seems like Discord. I'll check after they revert the changes and see if there's anything left.

My-Name-Is-Jeff · 2023-08-01T07:23:59Z

Change to max_age field noted here: discord/discord-api-docs#6233

MinnDevelopment · 2023-08-14T10:17:33Z

I've gone ahead and converted this PR into a draft, until it has been adjusted. If you don't want to continue working on it, feel free to close it and open an issue instead.

discord/discord-api-docs#6233

src/main/java/net/dv8tion/jda/internal/requests/restaction/InviteActionImpl.java

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

src/main/java/net/dv8tion/jda/internal/entities/EntityBuilder.java

src/main/java/net/dv8tion/jda/internal/entities/InviteImpl.java

src/main/java/net/dv8tion/jda/internal/requests/restaction/InviteActionImpl.java

MinnDevelopment · 2023-09-14T15:20:18Z

src/main/java/net/dv8tion/jda/internal/requests/restaction/InviteActionImpl.java

@@ -67,14 +69,23 @@ public InviteActionImpl deadline(long timestamp)
        return (InviteActionImpl) super.deadline(timestamp);
    }

+    @Override
+    public boolean isRestricted()


The name "restricted" is too vague for what it represents

src/main/java/net/dv8tion/jda/internal/requests/restaction/InviteActionImpl.java

Co-authored-by: Florian Spieß <business@minn.dev>

…vites

MinnDevelopment · 2023-10-22T14:17:36Z

src/main/java/net/dv8tion/jda/api/entities/Invite.java

+     * @throws java.lang.IllegalStateException
+     *         if this is not an expanded invite
+     * @return The max uses of this invite or {@code 0} if there is no limit
+     */


The docs changes here seem unrelated to the rest of this PR, please revert them.

MinnDevelopment · 2023-10-22T14:18:19Z

src/main/java/net/dv8tion/jda/api/entities/Invite.java

@@ -312,13 +316,12 @@ default String getUrl()
    /**
     * Whether this Invite grants only temporary access or not.
     *
-     * <p>This works only for expanded invites and will throw a {@link IllegalStateException} otherwise!
+     * <p>This works only for expanded invites and will throw a {@link IllegalStateException} otherwise!</p>


Suggested change

* This works only for expanded invites and will throw a {@link IllegalStateException} otherwise!

* This works only for expanded invites and will throw a {@link IllegalStateException} otherwise!

MinnDevelopment · 2023-10-22T14:18:59Z

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

+    /**
+     * The maximum age, 30 days, in seconds, for a restricted invite.
+     *
+     * <p>A restricted invite is an invite that is created in a non-community server</p>


Suggested change

* A restricted invite is an invite that is created in a non-community server

* A restricted invite is an invite that is created in a non-community server

MinnDevelopment · 2023-10-22T14:23:02Z

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

+     *
+     * @see #MAX_RESTRICTED_AGE
+     */
+    boolean hasCommunityRestrictions();


Missing @return docs

MinnDevelopment · 2023-10-22T14:23:29Z

src/main/java/net/dv8tion/jda/api/requests/restaction/InviteAction.java

    /**
     * Sets the max age in seconds for the invite. Set this to {@code 0} if the invite should never expire. Default is {@code 86400} (24 hours).
     * {@code null} will reset this to the default value.
     *
+     * <p>Invites in non-community servers are not allowed to be permanent, with an allowed range of {@code 1} (1 second) to {@code 2592000} (30 days).


Suggested change

* Invites in non-community servers are not allowed to be permanent, with an allowed range of {@code 1} (1 second) to {@code 2592000} (30 days).

* Invites in {@link #hasCommunityRestrictions() non-community} servers are not allowed to be permanent, with an allowed range of {@code 1} (1 second) to {@code 2592000} (30 days).

MinnDevelopment · 2023-10-22T14:27:19Z

src/main/java/net/dv8tion/jda/internal/requests/restaction/InviteActionImpl.java

+        if (nonCommunityRestricted)
+        {
+            Checks.check(maxAge != null && maxAge >= 1 && maxAge <= MAX_RESTRICTED_AGE,
+                "maxAge for invites in non-community guilds must be between 1 second and 30 days!");


Suggested change

"maxAge for invites in non-community guilds must be between 1 second and 30 days!");

"The maximum age for invites in non-community guilds must be between 1 second and 30 days!");

Also, the API Docs say 7 days is the maximum, are the docs wrong?

Seems like they haven't merged the API doc changes yet? Not sure if the changes are live

The client also limits it to 7 days:

https://github.com/discord/discord-api-docs/pull/6233/files#diff-160acb4654c611c67c4ee46b2ce5dda2be82212af8d1d00cd0256ef6edda1e95L1177

This line changes the docs value from 7 days to 30 days, but hasn't been merged yet

My-Name-Is-Jeff added 2 commits July 14, 2023 20:29

Fix EntityBuilder checking for max_uses to check Invite expanded status

c31055b

Discord made all the properties here except for uses accessible without authentication

Change Invite to only count uses as expanded

40d9e99

Update docs to remove the expansion requirement

My-Name-Is-Jeff marked this pull request as draft July 15, 2023 00:53

My-Name-Is-Jeff changed the title ~~Update Invite to accommodate Discord making only the uses field require expansion~~ Update Invite to match Discord changes Jul 15, 2023

My-Name-Is-Jeff added 4 commits July 14, 2023 21:47

Remove expanded field from Invite

97d863c

Add getTimeExpires to Invite

fc3fb16

Cleanup code changes

3d5f088

feat: Add the Friend InviteType

54db46a

My-Name-Is-Jeff marked this pull request as ready for review July 15, 2023 02:32

MinnDevelopment added the type: enhancement label Jul 28, 2023

fix: Update InviteCreateHandler to remove expanded and add expires_at

226416b

MinnDevelopment added the status: freezer this is currently put on hold label Jul 28, 2023

MinnDevelopment removed the status: freezer this is currently put on hold label Aug 14, 2023

MinnDevelopment marked this pull request as draft August 14, 2023 10:16

My-Name-Is-Jeff added 3 commits August 31, 2023 21:28

Merge remote-tracking branch 'upstream/master' into patch/invites

5e67c36

Re-introduce invite expansion

1ee67fc

Add restrictions on max_age for non-community guilds

f8b14ed

discord/discord-api-docs#6233

My-Name-Is-Jeff marked this pull request as ready for review September 1, 2023 02:20

My-Name-Is-Jeff commented Sep 1, 2023

View reviewed changes

src/main/java/net/dv8tion/jda/internal/requests/restaction/InviteActionImpl.java Show resolved Hide resolved

MinnDevelopment requested changes Sep 14, 2023

View reviewed changes

Apply suggestions from code review

5f16289

Co-authored-by: Florian Spieß <business@minn.dev>

My-Name-Is-Jeff marked this pull request as draft September 15, 2023 23:46

My-Name-Is-Jeff added 3 commits September 24, 2023 17:53

Time created is only available on expanded invites again

31f2f94

Merge remote-tracking branch 'origin/fix/invitebuilder' into patch/in…

37c6187

…vites

Rename isRestricted function

575ee0f

My-Name-Is-Jeff marked this pull request as ready for review September 24, 2023 21:58

My-Name-Is-Jeff requested a review from MinnDevelopment September 24, 2023 21:58

MinnDevelopment reviewed Oct 22, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Invite to match Discord changes #2500

Update Invite to match Discord changes #2500

My-Name-Is-Jeff commented Jul 15, 2023 •

edited

freya022 commented Jul 15, 2023

My-Name-Is-Jeff commented Jul 15, 2023 •

edited

MinnDevelopment commented Jul 28, 2023

My-Name-Is-Jeff commented Jul 28, 2023

My-Name-Is-Jeff commented Jul 28, 2023

MinnDevelopment commented Jul 28, 2023

MinnDevelopment commented Aug 1, 2023

My-Name-Is-Jeff commented Aug 1, 2023

My-Name-Is-Jeff commented Aug 1, 2023

MinnDevelopment commented Aug 14, 2023

MinnDevelopment Sep 14, 2023

MinnDevelopment Oct 22, 2023

MinnDevelopment Oct 22, 2023

MinnDevelopment Oct 22, 2023

MinnDevelopment Oct 22, 2023

MinnDevelopment Oct 22, 2023

MinnDevelopment Oct 22, 2023

My-Name-Is-Jeff Oct 27, 2023

MinnDevelopment Oct 28, 2023

My-Name-Is-Jeff Oct 28, 2023

	* <p>This works only for expanded invites and will throw a {@link IllegalStateException} otherwise!</p>
	* <p>This works only for expanded invites and will throw a {@link IllegalStateException} otherwise!

	* <p>A restricted invite is an invite that is created in a non-community server</p>
	* <p>A restricted invite is an invite that is created in a non-community server

	* <p>Invites in non-community servers are not allowed to be permanent, with an allowed range of {@code 1} (1 second) to {@code 2592000} (30 days).
	* <p>Invites in {@link #hasCommunityRestrictions() non-community} servers are not allowed to be permanent, with an allowed range of {@code 1} (1 second) to {@code 2592000} (30 days).

	"maxAge for invites in non-community guilds must be between 1 second and 30 days!");
	"The maximum age for invites in non-community guilds must be between 1 second and 30 days!");

Update Invite to match Discord changes #2500

Are you sure you want to change the base?

Update Invite to match Discord changes #2500

Conversation

My-Name-Is-Jeff commented Jul 15, 2023 • edited

Pull Request Etiquette

Changes

Description

freya022 commented Jul 15, 2023

My-Name-Is-Jeff commented Jul 15, 2023 • edited

MinnDevelopment commented Jul 28, 2023

My-Name-Is-Jeff commented Jul 28, 2023

My-Name-Is-Jeff commented Jul 28, 2023

MinnDevelopment commented Jul 28, 2023

MinnDevelopment commented Aug 1, 2023

My-Name-Is-Jeff commented Aug 1, 2023

My-Name-Is-Jeff commented Aug 1, 2023

MinnDevelopment commented Aug 14, 2023

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

My-Name-Is-Jeff commented Jul 15, 2023 •

edited

My-Name-Is-Jeff commented Jul 15, 2023 •

edited