add oauth token internal pk

crates/lib/database_queries/src/queries/twitch/twitch_oauth/find.rs

@@ -11,6 +11,7 @@ use sqlx::MySqlPool;
 #[derive(Serialize, Clone)]
 pub struct TwitchOauthTokenRecord {
   /// Our internal token metadata / bookkeeping
+  pub internal_token: String,
   pub oauth_refresh_grouping_token: String,
   pub refresh_count: u32,
   pub ip_address_creation: Option<String>,
@@ -94,27 +95,28 @@ impl TwitchOauthTokenFinder {
     Ok(self.perform_query_internal(mysql_pool).await?
         .map(|record| {
           TwitchOauthTokenRecord {
-            oauth_refresh_grouping_token: record.oauth_refresh_grouping_token.clone(),
-            maybe_user_token: record.maybe_user_token.clone(),
-            maybe_user_display_name: record.maybe_user_display_name.clone(),
-            maybe_user_gravatar_hash: record.maybe_user_gravatar_hash.clone(),
-            twitch_user_id: record.twitch_user_id.clone(),
-            twitch_username: record.twitch_username.clone(),
-            twitch_username_lowercase: record.twitch_username_lowercase.clone(),
-            access_token: record.access_token.clone(),
-            maybe_refresh_token: record.maybe_refresh_token.clone(),
-            token_type: record.token_type.clone(),
-            expires_in_seconds: record.expires_in_seconds.clone(),
+            internal_token: record.internal_token,
+            oauth_refresh_grouping_token: record.oauth_refresh_grouping_token,
+            maybe_user_token: record.maybe_user_token,
+            maybe_user_display_name: record.maybe_user_display_name,
+            maybe_user_gravatar_hash: record.maybe_user_gravatar_hash,
+            twitch_user_id: record.twitch_user_id,
+            twitch_username: record.twitch_username,
+            twitch_username_lowercase: record.twitch_username_lowercase,
+            access_token: record.access_token,
+            maybe_refresh_token: record.maybe_refresh_token,
+            token_type: record.token_type,
+            expires_in_seconds: record.expires_in_seconds,
             refresh_count: record.refresh_count,
             has_bits_read: i8_to_bool(record.has_bits_read),
             has_channel_read_redemptions: i8_to_bool(record.has_channel_read_redemptions),
             has_channel_read_subscriptions: i8_to_bool(record.has_channel_read_subscriptions),
             has_chat_edit: i8_to_bool(record.has_chat_edit),
             has_chat_read: i8_to_bool(record.has_chat_read),
-            ip_address_creation: record.ip_address_creation.clone(),
-            expires_at: record.expires_at.clone(),
-            user_deleted_at: record.user_deleted_at.clone(),
-            mod_deleted_at: record.mod_deleted_at.clone(),
+            ip_address_creation: record.ip_address_creation,
+            expires_at: record.expires_at,
+            user_deleted_at: record.user_deleted_at,
+            mod_deleted_at: record.mod_deleted_at,
           }
         }))
   }
@@ -162,6 +164,7 @@ impl TwitchOauthTokenFinder {
     // TODO/NB: Unfortunately SQLx can't statically typecheck this query
     let mut query = r#"
 SELECT
+    twitch_oauth_tokens.internal_token,
     twitch_oauth_tokens.oauth_refresh_grouping_token,
     users.username as maybe_username,
     users.display_name as maybe_user_display_name,
@@ -253,6 +256,7 @@ LEFT OUTER JOIN users
 #[derive(sqlx::FromRow)]
 pub struct TwitchOauthTokenRecordInternal {
   /// Our internal token metadata / bookkeeping
+  pub internal_token: String,
   pub oauth_refresh_grouping_token: String,
   pub refresh_count: u32,
   pub ip_address_creation: Option<String>,

crates/lib/database_queries/src/queries/twitch/twitch_oauth/insert.rs

@@ -4,6 +4,7 @@ use container_common::anyhow_result::AnyhowResult;
 use log::info;
 use log::warn;
 use sqlx::MySqlPool;
+use crate::tokens::Tokens;
 
 pub struct TwitchOauthTokenInsertBuilder {
   // ===== Required Fields =====
@@ -133,6 +134,9 @@ impl TwitchOauthTokenInsertBuilder {
   }
 
   pub async fn insert(&mut self, mysql_pool: &MySqlPool) -> AnyhowResult<()> {
+    // An internal token that we may use in the future.
+    let internal_token = Tokens::new_twitch_oauth_internal_token()?;
+
     // NB: We have to duplicate these since the string literals must not
     // include concatenation. Boo.
     let query = if let Some(expires_in_seconds) = self.expires_in_seconds {
@@ -140,6 +144,7 @@ impl TwitchOauthTokenInsertBuilder {
         r#"
 INSERT INTO twitch_oauth_tokens
 SET
+  internal_token = ?,
   oauth_refresh_grouping_token = ?,
   maybe_user_token = ?,
   twitch_user_id = ?,
@@ -158,6 +163,7 @@ SET
   ip_address_creation = ?,
   expires_at = DATE_ADD(NOW(), INTERVAL ? SECOND)
         "#,
+        internal_token.clone(),
         self.oauth_grouping_token.clone(),
         self.maybe_user_token.clone(),
         self.twitch_user_id.clone(),
@@ -181,6 +187,7 @@ SET
         r#"
 INSERT INTO twitch_oauth_tokens
 SET
+  internal_token = ?,
   oauth_refresh_grouping_token = ?,
   maybe_user_token = ?,
   twitch_user_id = ?,
@@ -199,6 +206,7 @@ SET
   ip_address_creation = ?,
   expires_at = NULL
         "#,
+        internal_token.clone(),
         self.oauth_grouping_token.clone(),
         self.maybe_user_token.clone(),
         self.twitch_user_id.clone(),

crates/lib/database_queries/src/tokens.rs

@@ -73,6 +73,10 @@ impl Tokens {
 
   // ========== [Twitch] Tokens not typically visible to users ==========
 
+  pub fn new_twitch_oauth_internal_token() -> AnyhowResult<String> {
+    random_prefix_crockford_token("TOI:", 32, false)
+  }
+
   pub fn new_twitch_oauth_grouping_token() -> AnyhowResult<String> {
     random_prefix_crockford_token("OG:", 32, false)
   }