feat(webserver): Use hash IDs rather than numeric row IDs in external…

… API (TabbyML#1382)

* feat(webserver): Use hash IDs rather than numeric row IDs in external API

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes (attempt 2/3)

* Fix unit test, apply suggested changes

* [autofix.ci] apply automated fixes

* Revert lib.rs

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

ee/tabby-db/Cargo.toml

@@ -12,8 +12,11 @@ prod-db = []
 [dependencies]
 anyhow.workspace = true
 chrono = { workspace = true, features = ["serde"] }
+hash-ids = "0.2.1"
+lazy_static.workspace = true
 sqlx = { version = "0.7.3", features = ["sqlite", "chrono", "runtime-tokio"] }
 tabby-common = { path = "../../crates/tabby-common" }
+thiserror.workspace = true
 tokio = { workspace = true, features = ["fs"] }
 uuid.workspace = true
 

ee/tabby-db/src/lib.rs

@@ -1,6 +1,7 @@
 pub use email_setting::EmailSettingDAO;
 pub use github_oauth_credential::GithubOAuthCredentialDAO;
 pub use google_oauth_credential::GoogleOAuthCredentialDAO;
+use hash_ids::HashIds;
 pub use invitations::InvitationDAO;
 pub use job_runs::JobRunDAO;
 pub use repositories::RepositoryDAO;
@@ -18,14 +19,35 @@ mod repositories;
 mod users;
 
 use anyhow::Result;
+use lazy_static::lazy_static;
 use sqlx::sqlite::SqliteConnectOptions;
 
+lazy_static! {
+    static ref HASHER: HashIds = HashIds::builder().with_salt("tabby-id-serializer").finish();
+}
+
+#[derive(thiserror::Error, Debug)]
+#[error("Invalid ID")]
+pub struct InvalidIDError;
+
 #[derive(Clone)]
 pub struct DbConn {
     pool: Pool<Sqlite>,
 }
 
 impl DbConn {
+    pub fn to_id(rowid: i32) -> String {
+        HASHER.encode(&[rowid as u64])
+    }
+
+    pub fn to_rowid(id: &str) -> Result<i32, InvalidIDError> {
+        HASHER
+            .decode(id)
+            .first()
+            .map(|i| *i as i32)
+            .ok_or(InvalidIDError)
+    }
+
     #[cfg(any(test, feature = "testutils"))]
     pub async fn new_in_memory() -> Result<Self> {
         use std::str::FromStr;

ee/tabby-webserver/src/schema/dao.rs

@@ -1,6 +1,7 @@
+use juniper::ID;
 use tabby_db::{
-    EmailSettingDAO, GithubOAuthCredentialDAO, GoogleOAuthCredentialDAO, InvitationDAO, JobRunDAO,
-    RepositoryDAO, UserDAO,
+    DbConn, EmailSettingDAO, GithubOAuthCredentialDAO, GoogleOAuthCredentialDAO, InvitationDAO,
+    JobRunDAO, RepositoryDAO, UserDAO,
 };
 
 use super::{email::EmailSetting, repository::Repository};
@@ -13,7 +14,7 @@ use crate::schema::{
 impl From<InvitationDAO> for auth::Invitation {
     fn from(val: InvitationDAO) -> Self {
         Self {
-            id: juniper::ID::new(val.id.to_string()),
+            id: ID::new(DbConn::to_id(val.id)),
             email: val.email,
             code: val.code,
             created_at: val.created_at,
@@ -24,7 +25,7 @@ impl From<InvitationDAO> for auth::Invitation {
 impl From<JobRunDAO> for job::JobRun {
     fn from(run: JobRunDAO) -> Self {
         Self {
-            id: juniper::ID::new(run.id.to_string()),
+            id: ID::new(DbConn::to_id(run.id)),
             job_name: run.job_name,
             start_time: run.start_time,
             finish_time: run.finish_time,
@@ -38,7 +39,7 @@ impl From<JobRunDAO> for job::JobRun {
 impl From<UserDAO> for auth::User {
     fn from(val: UserDAO) -> Self {
         auth::User {
-            id: juniper::ID::new(val.id.to_string()),
+            id: ID::new(DbConn::to_id(val.id)),
             email: val.email,
             is_admin: val.is_admin,
             auth_token: val.auth_token,
@@ -77,7 +78,7 @@ impl From<GoogleOAuthCredentialDAO> for OAuthCredential {
 impl From<RepositoryDAO> for Repository {
     fn from(value: RepositoryDAO) -> Self {
         Repository {
-            id: juniper::ID::new(value.id.to_string()),
+            id: ID::new(DbConn::to_id(value.id)),
             name: value.name,
             git_url: value.git_url,
         }

ee/tabby-webserver/src/schema/mod.rs

@@ -5,7 +5,7 @@ pub mod job;
 pub mod repository;
 pub mod worker;
 
-use std::{num::ParseIntError, sync::Arc};
+use std::sync::Arc;
 
 use auth::{
     validate_jwt, AuthenticationService, Invitation, RefreshTokenError, RefreshTokenResponse,
@@ -21,6 +21,7 @@ use juniper_axum::{
     FromAuth,
 };
 use tabby_common::api::{code::CodeSearch, event::RawEventLogger};
+use tabby_db::{DbConn, InvalidIDError};
 use tracing::{error, warn};
 use validator::ValidationErrors;
 use worker::{Worker, WorkerService};
@@ -67,7 +68,7 @@ pub enum CoreError {
     Other(#[from] anyhow::Error),
 
     #[error("Malformed ID input")]
-    InvalidIDError(#[from] ParseIntError),
+    InvalidID(#[from] InvalidIDError),
 }
 
 impl<S: ScalarValue> IntoFieldError<S> for CoreError {
@@ -304,7 +305,7 @@ impl Mutation {
     async fn update_user_active(ctx: &Context, id: ID, active: bool) -> Result<bool> {
         ctx.locator
             .auth()
-            .update_user_active(id.parse()?, active)
+            .update_user_active(DbConn::to_rowid(&id)?, active)
             .await?;
         Ok(true)
     }
@@ -358,7 +359,7 @@ impl Mutation {
                 "Failed to send invitation email, please check your SMTP settings are correct: {e}"
             );
         }
-        Ok(ID::new(invitation.id.to_string()))
+        Ok(ID::new(DbConn::to_id(invitation.id)))
     }
 
     async fn create_repository(

ee/tabby-webserver/src/service/auth.rs

@@ -298,8 +298,8 @@ impl AuthenticationService for DbConn {
     }
 
     async fn delete_invitation(&self, id: ID) -> Result<ID> {
-        let id = id.parse::<i32>()?;
-        Ok(ID::new(self.delete_invitation(id).await?.to_string()))
+        let id = DbConn::to_rowid(&id)?;
+        Ok(ID::new(DbConn::to_id(self.delete_invitation(id).await?)))
     }
 
     async fn reset_user_auth_token(&self, email: &str) -> Result<()> {
@@ -569,7 +569,7 @@ mod tests {
 
         // Used invitation should have been deleted,  following delete attempt should fail.
         assert!(conn
-            .delete_invitation(invitation.id.parse::<i32>().unwrap())
+            .delete_invitation(DbConn::to_rowid(&invitation.id).unwrap())
             .await
             .is_err());
     }

ee/tabby-webserver/src/service/repository.rs

@@ -35,15 +35,15 @@ impl RepositoryService for DbConn {
         Ok(self
             .create_repository(input.name, input.git_url)
             .await
-            .map(|i| ID::new(i.to_string()))?)
+            .map(|id| ID::new(DbConn::to_id(id)))?)
     }
 
     async fn delete_repository(&self, id: ID) -> Result<bool> {
-        self.delete_repository(id.parse()?).await
+        self.delete_repository(DbConn::to_rowid(&id)?).await
     }
 
     async fn update_repository(&self, id: ID, name: String, git_url: String) -> Result<bool> {
-        self.update_repository(id.parse()?, name, git_url)
+        self.update_repository(DbConn::to_rowid(&id)?, name, git_url)
             .await
             .map(|_| true)
     }