Refreshable connections, refactoring, access-token endpoint
- Aded /users/@me/connections/:connection_name/:connection_id/access-token
- Replaced `access_token` property on ConnectedAccount with `token_data` object for refreshing tokens
- Made a common interface for connection things like ComonOAuthTokenResponse
- Added `RefreshableConnection` class
- Added token refresh to Spotify connection (disabled)
4 files changed, 55 insertions, 5 deletions
diff --git a/src/util/connections/Connection.ts b/src/util/connections/Connection.ts
index 164cfac7..8b60b0d2 100644
--- a/src/util/connections/Connection.ts
+++ b/src/util/connections/Connection.ts
@@ -1,9 +1,11 @@
import crypto from "crypto";
import { ConnectedAccount } from "../entities";
-import { OrmUtils } from "../imports";
import { ConnectedAccountSchema, ConnectionCallbackSchema } from "../schemas";
import { DiscordApiErrors } from "../util";
+/**
+ * A connection that can be used to connect to an external service.
+ */
export default abstract class Connection {
id: string;
settings: { enabled: boolean };
@@ -21,7 +23,9 @@ export default abstract class Connection {
* Processes the callback
* @param args Callback arguments
*/
- abstract handleCallback(params: ConnectionCallbackSchema): Promise<ConnectedAccount | null>;
+ abstract handleCallback(
+ params: ConnectionCallbackSchema,
+ ): Promise<ConnectedAccount | null>;
/**
* Gets a user id from state
@@ -54,12 +58,25 @@ export default abstract class Connection {
this.states.delete(state);
}
- async createConnection(data: ConnectedAccountSchema): Promise<ConnectedAccount> {
- const ca = OrmUtils.mergeDeep(new ConnectedAccount(), data) as ConnectedAccount;
+ /**
+ * Creates a Connected Account in the database.
+ * @param data connected account data
+ * @returns the new connected account
+ */
+ async createConnection(
+ data: ConnectedAccountSchema,
+ ): Promise<ConnectedAccount> {
+ const ca = ConnectedAccount.create({ ...data });
await ca.save();
return ca;
}
+ /**
+ * Checks if a user has an exist connected account for the given extenal id.
+ * @param userId the user id
+ * @param externalId the connection id to find
+ * @returns
+ */
async hasConnection(userId: string, externalId: string): Promise<boolean> {
const existing = await ConnectedAccount.findOne({
where: {
diff --git a/src/util/connections/ConnectionStore.ts b/src/util/connections/ConnectionStore.ts
index 406e8232..759b6de7 100644
--- a/src/util/connections/ConnectionStore.ts
+++ b/src/util/connections/ConnectionStore.ts
@@ -1,5 +1,7 @@
import Connection from "./Connection";
+import RefreshableConnection from "./RefreshableConnection";
export class ConnectionStore {
- public static connections: Map<string, Connection> = new Map();
+ public static connections: Map<string, Connection | RefreshableConnection> =
+ new Map();
}
diff --git a/src/util/connections/RefreshableConnection.ts b/src/util/connections/RefreshableConnection.ts
new file mode 100644
index 00000000..0008cbc0
--- /dev/null
+++ b/src/util/connections/RefreshableConnection.ts
@@ -0,0 +1,30 @@
+import { ConnectedAccount } from "../entities";
+import { ConnectedAccountCommonOAuthTokenResponse } from "../interfaces";
+import Connection from "./Connection";
+
+/**
+ * A connection that can refresh its token.
+ */
+export default abstract class RefreshableConnection extends Connection {
+ refreshEnabled = true;
+ /**
+ * Refreshes the token for a connected account.
+ * @param connectedAccount The connected account to refresh
+ */
+ abstract refreshToken(
+ connectedAccount: ConnectedAccount,
+ ): Promise<ConnectedAccountCommonOAuthTokenResponse>;
+
+ /**
+ * Refreshes the token for a connected account and saves it to the database.
+ * @param connectedAccount The connected account to refresh
+ */
+ async refresh(
+ connectedAccount: ConnectedAccount,
+ ): Promise<ConnectedAccountCommonOAuthTokenResponse> {
+ const tokenData = await this.refreshToken(connectedAccount);
+ connectedAccount.token_data = tokenData;
+ await connectedAccount.save();
+ return tokenData;
+ }
+}
diff --git a/src/util/connections/index.ts b/src/util/connections/index.ts
index e15d0c8c..8d20bf27 100644
--- a/src/util/connections/index.ts
+++ b/src/util/connections/index.ts
@@ -2,3 +2,4 @@ export * from "./Connection";
export * from "./ConnectionConfig";
export * from "./ConnectionLoader";
export * from "./ConnectionStore";
+export * from "./RefreshableConnection";
|
