feat: add sdk_version to HANDSHAKE message (#262)

* feat: add sdk_version to HANDSHAKE message * fix: remove try/catch * fix: fix the handshake test * fix: check mobileVersion against minimum for handshake sdk * fix: remove semver, manually parse and compare major version from mobile_app_version * chore: update interface & mock to have mobileAppVersion and sdkVersion * fix: return UNKNOWN_VERSION_NUMBER when cannot parse
discord · Oct 1, 2024 · 86a3a17 · 86a3a17
1 parent 5c2f6cb
commit 86a3a17
Show file tree

Hide file tree

Showing 9 changed files with 128 additions and 90 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -58,6 +58,7 @@
     "@rollup/plugin-commonjs": "^26.0.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-typescript": "^11.1.6",
+    "@rollup/plugin-json": "^6.1.0",
     "@types/events": "^3.0.0",
     "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^8.6.0",

diff --git a/rollup.config.mjs b/rollup.config.mjs
@@ -1,6 +1,7 @@
 import typescript from '@rollup/plugin-typescript';
 import {nodeResolve} from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
 import {join} from 'path';
 
 const srcDir = join(__dirname, 'src');
@@ -53,8 +54,9 @@ function buildConfig(format) {
         declaration: true,
         outDir: outDir,
       }),
+      json(),
     ],
   };
 }
 
-export default [buildConfig('cjs'), buildConfig('esm')];
+export default [buildConfig('cjs'), buildConfig('esm')];
diff --git a/src/Constants.ts b/src/Constants.ts
@@ -36,3 +36,6 @@ export const Permissions = Object.freeze({
   CREATE_INSTANT_INVITE: BigFlagUtils.getFlag(0),
   ADMINISTRATOR: BigFlagUtils.getFlag(3),
 });
+
+export const UNKNOWN_VERSION_NUMBER = -1;
+export const HANDSHAKE_SDK_VERSION_MINIUM_MOBILE_VERSION = 250;
diff --git a/src/Discord.ts b/src/Discord.ts
@@ -6,11 +6,17 @@ import commands, {Commands} from './commands';
 import {v4 as uuidv4} from 'uuid';
 import {SDKError} from './error';
 import {EventSchema, ERROR, Events as RPCEvents} from './schema/events';
-import {Platform, RPCCloseCodes} from './Constants';
+import {
+  Platform,
+  RPCCloseCodes,
+  HANDSHAKE_SDK_VERSION_MINIUM_MOBILE_VERSION,
+  UNKNOWN_VERSION_NUMBER,
+} from './Constants';
 import getDefaultSdkConfiguration from './utils/getDefaultSdkConfiguration';
 import {ConsoleLevel, consoleLevels, wrapConsoleMethod} from './utils/console';
 import type {TSendCommand, TSendCommandPayload} from './schema/types';
 import {IDiscordSDK, MaybeZodObjectArray, SdkConfiguration} from './interface';
+import {version as sdkVersion} from '../package.json';
 
 export enum Opcodes {
   HANDSHAKE = 0,
@@ -46,12 +52,22 @@ function getRPCServerSource(): [Window, string] {
   return [window.parent.opener ?? window.parent, !!document.referrer ? document.referrer : '*'];
 }
 
+interface HandshakePayload {
+  v: number;
+  encoding: string;
+  client_id: string;
+  frame_id: string;
+  sdk_version?: string;
+}
+
 export class DiscordSDK implements IDiscordSDK {
   readonly clientId: string;
   readonly instanceId: string;
   readonly platform: Platform;
   readonly guildId: string | null;
   readonly channelId: string | null;
+  readonly sdkVersion: string = sdkVersion;
+  readonly mobileAppVersion: string | null = null;
   readonly configuration: SdkConfiguration;
   readonly source: Window | WindowProxy | null = null;
   readonly sourceOrigin: string = '';
@@ -135,6 +151,8 @@ export class DiscordSDK implements IDiscordSDK {
 
     this.guildId = urlParams.get('guild_id');
     this.channelId = urlParams.get('channel_id');
+
+    this.mobileAppVersion = urlParams.get('mobile_app_version');
     // END Capture URL Query Params
 
     [this.source, this.sourceOrigin] = getRPCServerSource();
@@ -195,19 +213,29 @@ export class DiscordSDK implements IDiscordSDK {
     }
   }
 
+  private parseMajorMobileVersion(): number {
+    if (this.mobileAppVersion && this.mobileAppVersion.includes('.')) {
+      try {
+        return parseInt(this.mobileAppVersion.split('.')[0]);
+      } catch {
+        return UNKNOWN_VERSION_NUMBER;
+      }
+    }
+    return UNKNOWN_VERSION_NUMBER;
+  }
+
   private handshake() {
-    this.source?.postMessage(
-      [
-        Opcodes.HANDSHAKE,
-        {
-          v: 1,
-          encoding: 'json',
-          client_id: this.clientId,
-          frame_id: this.frameId,
-        },
-      ],
-      this.sourceOrigin,
-    );
+    const handshakePayload: HandshakePayload = {
+      v: 1,
+      encoding: 'json',
+      client_id: this.clientId,
+      frame_id: this.frameId,
+    };
+    const majorMobileVersion = this.parseMajorMobileVersion();
+    if (this.platform === Platform.DESKTOP || majorMobileVersion >= HANDSHAKE_SDK_VERSION_MINIUM_MOBILE_VERSION) {
+      handshakePayload['sdk_version'] = this.sdkVersion;
+    }
+    this.source?.postMessage([Opcodes.HANDSHAKE, handshakePayload], this.sourceOrigin);
   }
 
   private addOnReadyListener() {

diff --git a/src/__tests__/discordSdk.test.ts b/src/__tests__/discordSdk.test.ts
@@ -4,6 +4,7 @@
 import {Opcodes} from '../Discord';
 import {DiscordSDK, Events, Platform} from '../index';
 import {DISPATCH} from '../schema/common';
+import {version as sdkVersion} from '../../package.json';
 
 describe('DiscordSDK', () => {
   it('Can be constructed and await a "ready" event', async () => {
@@ -48,6 +49,7 @@ describe('DiscordSDK', () => {
           encoding: 'json',
           frame_id: frame_id,
           v: 1,
+          sdk_version: sdkVersion,
         },
       ],
       '*',