Rewrite presence a little bit #1853

devsnek · 2017-08-30T02:04:07Z

Please describe the changes this PR makes and why it should be merged:
Adds support for the richest of presence, switches to new presence caching

Semantic versioning classification:

This PR changes the library's interface (methods or parameters added)
- This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
This PR only includes non-code changes, like changes to documentation, README, etc.

amishshah · 2017-08-30T08:43:48Z

src/stores/PresenceStore.js

+    } else {
+      this.set(data.user.id, new Presence(this.client, data));
+    }
+  }


You also have to return the presence here (all the other stores do)

SpaceEEC · 2017-08-30T09:37:58Z

src/index.js

@@ -33,7 +33,7 @@ module.exports = {
  Collector: require('./structures/interfaces/Collector'),
  DMChannel: require('./structures/DMChannel'),
  Emoji: require('./structures/Emoji'),
-  Game: require('./structures/Presence').Game,
+  Activity: require('./structures/Presence').Activity,


This should probably be moved up.

SpaceEEC · 2017-08-30T09:43:42Z

src/structures/Presence.js

+     * Assets for rich presence
+     * @type {?RichPresenceAssets}
+     */
+    this.assets = data.assets ? new RichPresenceAssets(data.assets) : null;


This should be: new RichPresenceAssets(this, data.assets)

SpaceEEC · 2017-08-30T09:47:43Z

src/structures/Presence.js

+/**
+ * Assets for a rich presence
+ */
+class RichPresenceAssets {


Shouldn't this class be exported?

SpaceEEC · 2017-08-30T09:50:05Z

src/stores/ClientPresenceStore.js

+  }
+
+  async setClientPresence({ status, since, afk, activity }) {
+    const applicationID = activity.application ? activity.application.id || activity.application : null;


Omitting optional parameter activity throws an error here, for examply by using ClientUser#setAFK.

SpaceEEC · 2017-08-30T10:11:28Z

src/stores/ClientPresenceStore.js

+  async setClientPresence({ status, since, afk, activity }) {
+    const applicationID = activity.application ? activity.application.id || activity.application : null;
+    let assets = new Collection();
+    if (activity.assets && applicationID) {


Same error with activity being undefined here.

SpaceEEC · 2017-08-30T10:16:25Z

src/stores/ClientPresenceStore.js

+      since: since != null ? since : null, // eslint-disable-line eqeqeq
+      status: status || this.clientPresence.status,
+      game: activity ? {
+        type: Constants.ActivityTypes.indexOf(activity.type || 'PLAYING') || activity.type || 0,


You can no longer pass a numeric type here (except 0). because indexOf returns -1 in that case which is not falsy.

SpaceEEC · 2017-08-30T10:20:57Z

src/structures/ClientUser.js

-   * @param {?string} game Game being played
-   * @param {Object} [options] Options for setting the game
+   * Sets the activity the client user is playing.
+   * @param {?string} name activity being played


Uppercase A instead of a lowercase one.

SpaceEEC · 2017-08-30T10:21:30Z

src/structures/Presence.js

    );
  }
 }

 /**
- * Represents a game that is part of a user's presence.
+ * Represents a activity that is part of a user's presence.


an activity

SpaceEEC · 2017-08-30T10:25:26Z

src/structures/Presence.js

+   */
+  smallImageURL({ format, size } = {}) {
+    if (!this.smallImage) return null;
+    return this.client.rest.cdn


This class does not have a client property.

SpaceEEC · 2017-08-30T10:25:37Z

src/structures/Presence.js

+   */
+  largeImageURL({ format, size } = {}) {
+    if (!this.largeImage) return null;
+    return this.client.rest.cdn


Same here, no client property.

SpaceEEC · 2017-08-30T20:55:44Z

src/structures/Presence.js

@@ -92,6 +92,21 @@ class Activity {
    this.applicationID = data.application_id || null;

    /**
+     * Timestamps for the activity
+     * @type {Object}


This is nullable.
And maybe add @property here to describe what it actually is?

SpaceEEC · 2017-08-30T20:55:53Z

src/structures/Presence.js

+
+    /**
+     * Party of the activity
+     * @type {Object}


Same as above.

SpaceEEC · 2017-08-30T20:56:57Z

src/stores/ClientPresenceStore.js

@@ -40,6 +40,8 @@ class ClientPresenceStore extends PresenceStore {
          large_image: assets.get(activity.assets.largeImage) || activity.assets.largeImage,
          small_image: assets.get(activity.assets.smallImage) || activity.assets.smallImage,
        } : undefined,
+        timestamps: activity.timestamps || undefined,


This should convert the Date object back to a unix timestamp.

BigBrainAFK · 2017-09-01T20:03:16Z

src/stores/ClientPresenceStore.js

+        type: Constants.ActivityTypes.indexOf(activity.type || 'PLAYING') || activity.type || 0,
+        name: activity.name,
+        url: activity.url,
+        description: activity.description,


Not sure myself but I tested it a bit and I think it needs to be 'details' and not 'description'

… into their date stores (#1869) * refactor/fix(DataStores): move instantiating of store related classes into the relevant create methods and fixed FetchMemberOptions * Renamed ChannelStore's constructor parameter for claritiy * define client property before creating items from passed iterable to avoid the client property being undefined * Fix fetching members with a limit * add static Channel#create back and moved channel instantiating there * make ChannelStore's constructor accept an iterable * make iterable an optional parameter, allow to just pass client and options * fixed a little typo in docs of <User>.displayAvatarURL() (#1872) * Rewrite presence a little bit (#1853) * such presence many good * Update PresenceStore.js * Update index.js * Update ClientPresenceStore.js * Update Presence.js * Update ClientPresenceStore.js * Update ClientUser.js * Update Presence.js * add timestamps and party * Update Presence.js * Update PresenceStore.js * Update ClientPresenceStore.js * Update ClientPresenceStore.js * fix: made options.type optional in ClientUser#setActivity (#1875) * fix: made options.type optional in ClientUser#setActivity * some changes, smol fix due to too many types being possible, it should just be defaulted to 0. this means streamers will have to set the type manually, though. also mistake with activity.name check * docs(Collection): Adjust exists documentation (#1876) Since the return value of Collection#exists is basically just a boolean of Collection#find's result, the same documentation and arguments can and should be applied. * refactor(Emoji): remove Guild#deleteEmoji in favour of Emoji#delete (#1877) * refactor/fix(DataStores): move instantiating of store related classes into the relevant create methods and fixed FetchMemberOptions * Renamed ChannelStore's constructor parameter for claritiy * define client property before creating items from passed iterable to avoid the client property being undefined * Fix fetching members with a limit * add static Channel#create back and moved channel instantiating there * make ChannelStore's constructor accept an iterable * make iterable an optional parameter, allow to just pass client and options * rebase, this time with saving the file * address issue with falsy activity throwing errors when setting client's presence

such presence many good

f4716e3

devsnek changed the title ~~such presence many good~~ Rewrite presence a little bit Aug 30, 2017

iCrawl added reason: API support labels Aug 30, 2017

amishshah requested changes Aug 30, 2017

View reviewed changes

Update PresenceStore.js

bc846b1

SpaceEEC requested changes Aug 30, 2017

View reviewed changes

devsnek added 7 commits August 30, 2017 09:24

Update index.js

d154eba

Update ClientPresenceStore.js

83d0edc

Update Presence.js

4be81ca

Update ClientPresenceStore.js

aa7677f

Update ClientUser.js

1299312

Update Presence.js

6bfca26

add timestamps and party

383ad36

amishshah approved these changes Aug 30, 2017

View reviewed changes

SpaceEEC requested changes Aug 30, 2017

View reviewed changes

devsnek added 4 commits August 30, 2017 14:52

Update Presence.js

0fc0961

Update PresenceStore.js

402ee16

Update ClientPresenceStore.js

bf2a590

Update ClientPresenceStore.js

6ab49e6

BigBrainAFK approved these changes Sep 2, 2017

View reviewed changes

amishshah merged commit c4df250 into discordjs:master Sep 2, 2017

devsnek deleted the good-presence branch September 2, 2017 22:57

This was referenced May 26, 2021

[Snyk] Security upgrade ws from 3.3.3 to 7.4.6 Bhanditz/discord.js#1

Open

[Snyk] Security upgrade ws from 7.3.1 to 7.4.6 baby636/discord.js#6

Open

M0diis mentioned this pull request Oct 6, 2022

[Snyk] Fix for 2 vulnerabilities M0diis/discord.js#6

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite presence a little bit #1853

Rewrite presence a little bit #1853

devsnek commented Aug 30, 2017 •

edited

amishshah Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017 •

edited

SpaceEEC Aug 30, 2017

devsnek Aug 30, 2017

SpaceEEC Aug 30, 2017 •

edited

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017 •

edited

SpaceEEC Aug 30, 2017

SpaceEEC Aug 30, 2017

devsnek Aug 30, 2017

BigBrainAFK Sep 1, 2017

Rewrite presence a little bit #1853

Rewrite presence a little bit #1853

Conversation

devsnek commented Aug 30, 2017 • edited

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

SpaceEEC Aug 30, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SpaceEEC Aug 30, 2017 • edited

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

SpaceEEC Aug 30, 2017 • edited

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

devsnek commented Aug 30, 2017 •

edited

SpaceEEC Aug 30, 2017 •

edited

SpaceEEC Aug 30, 2017 •

edited

SpaceEEC Aug 30, 2017 •

edited