feat(server, ui): support custom logo (#4334)

* feat(server): support white label

* update: ui

* refetch branding logo

* update

* update

* update: query

* revert caddy change

* [autofix.ci] apply automated fixes

* lint

* [autofix.ci] apply automated fixes

* update: remove image button

* [autofix.ci] apply automated fixes

* update

* [autofix.ci] apply automated fixes

* update: license key

* update

* update: remove branding_name

* update

* update: feature enum

* update: lint

---------

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

Author: liangfung

ee/tabby-db/migrations/0048_add-branding-column.down.sql

@@ -0,0 +1,2 @@
+ALTER TABLE server_setting DROP COLUMN branding_logo;
+ALTER TABLE server_setting DROP COLUMN branding_icon;

ee/tabby-db/migrations/0048_add-branding-column.up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE server_setting ADD COLUMN branding_logo TEXT DEFAULT NULL;
+ALTER TABLE server_setting ADD COLUMN branding_icon TEXT DEFAULT NULL;

ee/tabby-db/schema.sqlite

@@ -64,7 +64,9 @@ CREATE TABLE server_setting(
   network_external_url STRING NOT NULL DEFAULT 'http://localhost:8080'
   ,
   billing_enterprise_license STRING,
-  security_disable_password_login BOOLEAN NOT NULL DEFAULT FALSE
+  security_disable_password_login BOOLEAN NOT NULL DEFAULT FALSE,
+  branding_logo TEXT DEFAULT NULL,
+  branding_icon TEXT DEFAULT NULL
 );
 CREATE TABLE email_setting(
   id INTEGER PRIMARY KEY AUTOINCREMENT,

ee/tabby-db/schema/schema.sql

@@ -10,6 +10,8 @@ pub struct ServerSettingDAO {
     pub security_disable_client_side_telemetry: bool,
     pub security_disable_password_login: bool,
     pub network_external_url: String,
+    pub branding_logo: Option<String>,
+    pub branding_icon: Option<String>,
 }
 
 const SERVER_SETTING_ROW_ID: i32 = 1;
@@ -35,7 +37,9 @@ impl DbConn {
                 network_external_url,
                 security_allowed_register_domain_list,
                 billing_enterprise_license,
-                security_disable_password_login
+                security_disable_password_login,
+                branding_logo,
+                branding_icon
             FROM server_setting
             WHERE id = ?;",
         )
@@ -106,6 +110,23 @@ impl DbConn {
         Ok(())
     }
 
+    pub async fn update_branding_setting(
+        &self,
+        branding_logo: Option<String>,
+        branding_icon: Option<String>,
+    ) -> Result<()> {
+        sqlx::query!(
+            "UPDATE server_setting SET branding_logo = ?, branding_icon = ? WHERE id = ?",
+            branding_logo,
+            branding_icon,
+            SERVER_SETTING_ROW_ID
+        )
+        .execute(&self.pool)
+        .await?;
+
+        Ok(())
+    }
+
     pub async fn read_enterprise_license(&self) -> Result<Option<String>> {
         Ok(sqlx::query_scalar(
             "SELECT billing_enterprise_license FROM server_setting WHERE id = ?;",
@@ -142,6 +163,8 @@ mod tests {
             security_disable_client_side_telemetry: false,
             security_disable_password_login: false,
             network_external_url: "http://localhost:8080".into(),
+            branding_logo: None,
+            branding_icon: None,
         }
     }
     #[test]

ee/tabby-db/schema/schema.svg

@@ -78,6 +78,10 @@ enum LdapEncryptionKind {
   LDAPS
 }
 
+enum LicenseFeature {
+  CUSTOM_LOGO
+}
+
 enum LicenseStatus {
   OK
   EXPIRED
@@ -121,6 +125,11 @@ enum Role {
   ASSISTANT
 }
 
+input BrandingSettingInput {
+  brandingLogo: String
+  brandingIcon: String
+}
+
 input CodeQueryInput {
   filepath: String
   language: String
@@ -468,6 +477,11 @@ type AuthProvider {
   kind: AuthProviderKind!
 }
 
+type BrandingSetting {
+  brandingLogo: String
+  brandingIcon: String
+}
+
 type ChatCompletionMessage {
   role: String!
   content: String!
@@ -692,6 +706,7 @@ type LicenseInfo {
   seatsUsed: Int!
   issuedAt: DateTime
   expiresAt: DateTime
+  features: [LicenseFeature!]
 }
 
 type Message {
@@ -845,6 +860,7 @@ type Mutation {
   updateEmailSetting(input: EmailSettingInput!): Boolean!
   updateSecuritySetting(input: SecuritySettingInput!): Boolean!
   updateNetworkSetting(input: NetworkSettingInput!): Boolean!
+  updateBrandingSetting(input: BrandingSettingInput!): Boolean!
   deleteEmailSetting: Boolean!
   uploadLicense(license: String!): Boolean!
   resetLicense: Boolean!
@@ -1085,6 +1101,7 @@ type Query {
   emailSetting: EmailSetting
   networkSetting: NetworkSetting!
   securitySetting: SecuritySetting!
+  brandingSetting: BrandingSetting!
   gitRepositories(after: String, before: String, first: Int, last: Int): RepositoryConnection!
   "Search files that matches the pattern in the repository."
   repositorySearch(kind: RepositoryKind!, id: ID!, rev: String, pattern: String!): [FileEntrySearchResult!]!

ee/tabby-db/src/server_setting.rs

@@ -30,6 +30,7 @@ use crate::{
         user_event::{EventKind, UserEvent},
         CoreError,
     },
+    setting::BrandingSetting,
     thread::{self},
 };
 
@@ -132,6 +133,15 @@ impl From<ServerSettingDAO> for NetworkSetting {
     }
 }
 
+impl From<ServerSettingDAO> for BrandingSetting {
+    fn from(value: ServerSettingDAO) -> Self {
+        Self {
+            branding_logo: value.branding_logo,
+            branding_icon: value.branding_icon,
+        }
+    }
+}
+
 impl TryFrom<IntegrationDAO> for Integration {
     type Error = anyhow::Error;
     fn try_from(value: IntegrationDAO) -> anyhow::Result<Self> {

ee/tabby-schema/graphql/schema.graphql

@@ -23,6 +23,11 @@ pub enum LicenseStatus {
     SeatsExceeded,
 }
 
+#[derive(GraphQLEnum, PartialEq, Debug, Clone, Deserialize)]
+pub enum LicenseFeature {
+    CustomLogo,
+}
+
 #[derive(GraphQLObject)]
 pub struct LicenseInfo {
     pub r#type: LicenseType,
@@ -31,6 +36,7 @@ pub struct LicenseInfo {
     pub seats_used: i32,
     pub issued_at: Option<DateTime<Utc>>,
     pub expires_at: Option<DateTime<Utc>>,
+    pub features: Option<Vec<LicenseFeature>>,
 }
 
 impl LicenseInfo {
@@ -89,6 +95,18 @@ impl LicenseInfo {
             duration.num_days()
         })
     }
+
+    pub fn ensure_available_features(&self, feature: LicenseFeature) -> Result<()> {
+        if let Some(features) = &self.features {
+            if features.contains(&feature) {
+                return Ok(());
+            }
+        }
+
+        Err(CoreError::InvalidLicense(
+            "Your plan doesn't include support for this feature.",
+        ))
+    }
 }
 
 #[async_trait]

ee/tabby-schema/src/dao.rs

@@ -87,7 +87,8 @@ use self::{
         RepositoryKind, RepositoryService, UpdateIntegrationInput,
     },
     setting::{
-        NetworkSetting, NetworkSettingInput, SecuritySetting, SecuritySettingInput, SettingService,
+        BrandingSetting, NetworkSetting, NetworkSettingInput, SecuritySetting,
+        SecuritySettingInput, SettingService,
     },
     user_event::{UserEvent, UserEventService},
     web_documents::{CreateCustomDocumentInput, CustomWebDocument, WebDocumentService},
@@ -422,6 +423,12 @@ impl Query {
         ctx.locator.setting().read_security_setting().await
     }
 
+    async fn branding_setting(ctx: &Context) -> Result<BrandingSetting> {
+        let license = ctx.locator.license().read().await?;
+        license.ensure_available_features(license::LicenseFeature::CustomLogo)?;
+        ctx.locator.setting().read_branding_setting().await
+    }
+
     async fn git_repositories(
         &self,
         ctx: &Context,
@@ -1375,6 +1382,18 @@ impl Mutation {
         Ok(true)
     }
 
+    async fn update_branding_setting(
+        ctx: &Context,
+        input: setting::BrandingSettingInput,
+    ) -> Result<bool> {
+        check_admin(ctx).await?;
+        let license = ctx.locator.license().read().await?;
+        license.ensure_available_features(license::LicenseFeature::CustomLogo)?;
+        input.validate()?;
+        ctx.locator.setting().update_branding_setting(input).await?;
+        Ok(true)
+    }
+
     async fn delete_email_setting(ctx: &Context) -> Result<bool> {
         check_admin(ctx).await?;
         ctx.locator.email().delete_setting().await?;