feat(themes): Create APIs for managing themes

[ThisIsMani]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

Description

This PR adds APIs to manage themes.
These are the following APIs

1. Create Theme
2. Delete Theme
3. Update Theme
4. Upload Asset
5. Find Theme by Theme ID
6. Find Theme by Lineage

Additional Changes

• This PR modifies the API contract
• This PR modifies the database schema
• This PR modifies application configuration/environment variables

todo!()

Motivation and Context

Closes #6553

How did you test it?

1. Create Theme

   curl --location 'http://localhost:8080/user/theme' \
   --header 'Content-Type: application/json' \
   --header 'api-key: ••••••' \
   --data '{
       "lineage": {
           "entity_type": "profile",
           "tenant_id": "t1",
           "org_id": "o1",
           "merchant_id": "m1",
           "profile_id": "p1"
       },
       "theme_name": "Test",
       "theme_data": {
           "settings": {
               "colors": {
                   "primary": "#3498db",
                   "sidebar": "#2ecc71"
               },
               "buttons": {
                   "primary": {
                       "hoverBackgroundColor": "#27ae60"
                   }
               }
           }
       }
   }'
   

2. Delete Theme

   curl --location --request DELETE 'http://localhost:8080/user/theme/087c79dc-640c-4a2a-8552-6fa4e868cc63?entity_type=profile&tenant_id=t1&org_id=o1&merchant_id=m1&profile_id=p1' \
   --header 'api-key: ••••••'
   

3. Update Theme

   curl --location --request PUT 'http://localhost:8080/user/theme/087c79dc-640c-4a2a-8552-6fa4e868cc63' \
   --header 'Content-Type: application/json' \
   --header 'api-key: test_admin' \
   --data '{
       "lineage": {
           "entity_type": "profile",
           "tenant_id": "t1",
           "org_id": "o1",
           "merchant_id": "m1",
           "profile_id": "p1"
       },
       "theme_data": {
           "settings": {
               "colors": {
                   "primary": "#3498xb",
                   "sidebar": "#2ecc71"
               },
               "buttons": {
                   "primary": {
                       "hoverBackgroundColor": "#27ae60"
                   }
               }
           }
       }
   }'
   

4. Upload Asset

   curl --location 'http://localhost:8080/user/theme/087c79dc-640c-4a2a-8552-6fa4e868cc63?entity_type=profile&tenant_id=t1&org_id=o1&merchant_id=m1&profile_id=p1' \
   --header 'api-key: ••••••' \
   --form 'asset_name="logo.png"' \
   --form 'asset_data=@"path to file"'
   

5. Get Theme by Theme ID

   curl --location 'http://localhost:8080/user/theme/087c79dc-640c-4a2a-8552-6fa4e868cc63' \
   --header 'api-key: ••••••'
   

6. Get Theme by Lineage

   curl --location 'http://localhost:8080/user/theme?entity_type=merchant&tenant_id=t1&org_id=o1&merchant_id=m1&profile_id=p1' \
   --header 'api-key: ••••••'
   

Responses

• Delete Theme and Upload Asset: 200 OK
• Everything else

  {
      "theme_id": "087c79dc-640c-4a2a-8552-6fa4e868cc63",
      "theme_name": "Test",
      "entity_type": "profile",
      "tenant_id": "t1",
      "org_id": "o1",
      "merchant_id": "m1",
      "profile_id": "p1",
      "theme_data": {
          "settings": {
              "colors": {
                  "primary": "#3498db",
                  "sidebar": "#2ecc71"
              },
              "typography": null,
              "buttons": {
                  "primary": {
                      "backgroundColor": null,
                      "textColor": null,
                      "hoverBackgroundColor": "#27ae60"
                  },
                  "secondary": null
              },
              "borders": null,
              "spacing": null
          },
          "urls": null
      }
  }
  

Checklist

• I formatted the code cargo +nightly fmt --all
• I addressed lints thrown by cargo clippy
• I reviewed the submitted code
• I added unit tests for my changes where possible

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
crates/router/src/core/errors/user.rs	64% smaller
crates/router/src/routes/lock_utils.rs	33% smaller
crates/api_models/src/events/user.rs	29% smaller
crates/common_utils/src/types/theme.rs	5% smaller
crates/diesel_models/src/user/theme.rs	3% smaller
Cargo.lock	Unsupported file format
config/config.example.toml	Unsupported file format
config/deployments/env_specific.toml	Unsupported file format
config/development.toml	Unsupported file format
config/docker_compose.toml	Unsupported file format
crates/api_models/Cargo.toml	Unsupported file format
crates/api_models/src/user.rs	0% smaller
crates/api_models/src/user/theme.rs	0% smaller
crates/diesel_models/src/query/user/theme.rs	0% smaller
crates/router/src/configs/secrets_transformers.rs	0% smaller
crates/router/src/configs/settings.rs	0% smaller
crates/router/src/core/user.rs	0% smaller
crates/router/src/core/user/theme.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/router/src/db/user/theme.rs	0% smaller
crates/router/src/routes/app.rs	0% smaller
crates/router/src/routes/user.rs	0% smaller
crates/router/src/routes/user/theme.rs	0% smaller
crates/router/src/utils/user.rs	0% smaller
crates/router/src/utils/user/theme.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

[SanchithHegde]

Won't / Shouldn't the uploaded data be the same as request.theme_data? Do we necessarily need to retrieve the file and deserialize it again?

[ThisIsMani]

The uploaded data should be same (in theory). But I don't want to completely trust that. I retrieved the data again so that caller can make sure that data is correctly set in S3 and get_theme API wouldn't respond with different data.

[racnan]

Nit

[racnan]

find_by_theme_id could be a better choice here.

[racnan]

sanitize the string. Shouldnt be empty.

[ThisIsMani]

Yeah, will do when user APIs for themes are introduced.

[racnan]

how will you handle if upload fails but DB inserts.

[ThisIsMani]

Caller can hit update API to change only the theme, which will upload the theme in S3.

[racnan]

if we cannot do delete, can we rename the directory in s3 and prefix/suffix it with some deleted identifier?

[ThisIsMani]

Yeah, will check this.

[racnan]

These can be chained using async_map and stuff.

[racnan]

use constants.

[ThisIsMani]

These are used only one time. Will move them once we are using it one more time.