refactor: Replace xdg with directories (#95)

* Replace `xdg` with `directories`

This enables us to build stackablectl for Windows as `xdg` didn't support
Windows.

* Rename `XDG_*` to `USER_DIR_*`

* Remove unused struct

* Add MPL-2.0 to allowed licenses

Author: Techassi

Cargo.lock

@@ -15,6 +15,7 @@ bcrypt = "0.15"
 clap = { version = "4.2.1", features = ["derive", "env"] }
 clap_complete = "4.2"
 comfy-table = { version = "7.0", features = ["custom_styling"] }
+directories = "5.0"
 dotenvy = "0.15"
 futures = "0.3"
 gobuild = "0.1.0-alpha.2"
@@ -45,7 +46,6 @@ utoipa = { version = "3.3", features = ["indexmap"] }
 utoipa-swagger-ui = { version = "3.1", features = ["axum"] }
 uuid = { version = "1.4.0", features = ["v4"] }
 which = "4.4"
-xdg = "2.4"
 
 [patch."https://github.com/stackabletech/operator-rs.git"]
 # TODO: Switch to released version

Cargo.toml

@@ -31,23 +31,20 @@ allow = [
     "LicenseRef-webpki",
     "MIT",
     "Unicode-DFS-2016",
-    "Zlib"
+    "Zlib",
+    "MPL-2.0",
 ]
 private = { ignore = true }
 
 [[licenses.clarify]]
 name = "ring"
 expression = "LicenseRef-ring"
-license-files = [
-    { path = "LICENSE", hash = 0xbd0eed23 },
-]
+license-files = [{ path = "LICENSE", hash = 0xbd0eed23 }]
 
 [[licenses.clarify]]
 name = "webpki"
 expression = "LicenseRef-webpki"
-license-files = [
-    { path = "LICENSE", hash = 0x001c7e6c },
-]
+license-files = [{ path = "LICENSE", hash = 0x001c7e6c }]
 
 [sources]
 unknown-registry = "deny"

deny.toml

@@ -14,6 +14,7 @@ stackable-cockpit = { path = "../stackable-cockpit", features = ["openapi"] }
 clap_complete.workspace = true
 clap.workspace = true
 comfy-table.workspace = true
+directories.workspace = true
 dotenvy.workspace = true
 indexmap.workspace = true
 lazy_static.workspace = true
@@ -27,4 +28,3 @@ snafu.workspace = true
 tokio.workspace = true
 tracing-subscriber.workspace = true
 tracing.workspace = true
-xdg.workspace = true

rust/stackablectl/Cargo.toml

@@ -1,7 +1,8 @@
 use std::env;
 
 use clap::{Parser, Subcommand, ValueEnum};
-use snafu::{ResultExt, Snafu};
+use directories::ProjectDirs;
+use snafu::Snafu;
 use tracing::{debug, instrument, Level};
 
 use stackable_cockpit::{
@@ -21,8 +22,9 @@ use crate::{
         release::ReleaseArgs, stack::StackArgs, stacklets::StackletsArgs,
     },
     constants::{
-        CACHE_HOME_PATH, ENV_KEY_DEMO_FILES, ENV_KEY_RELEASE_FILES, ENV_KEY_STACK_FILES,
-        REMOTE_DEMO_FILE, REMOTE_RELEASE_FILE, REMOTE_STACK_FILE,
+        ENV_KEY_DEMO_FILES, ENV_KEY_RELEASE_FILES, ENV_KEY_STACK_FILES, REMOTE_DEMO_FILE,
+        REMOTE_RELEASE_FILE, REMOTE_STACK_FILE, USER_DIR_APPLICATION_NAME,
+        USER_DIR_ORGANIZATION_NAME, USER_DIR_QUALIFIER,
     },
 };
 
@@ -123,9 +125,14 @@ impl Cli {
         if self.no_cache {
             Ok(CacheSettings::disabled())
         } else {
-            let xdg = xdg::BaseDirectories::with_prefix(CACHE_HOME_PATH)
-                .context(cache_settings_error::XdgSnafu)?;
-            Ok(CacheSettings::disk(xdg.get_cache_home()))
+            let project_dir = ProjectDirs::from(
+                USER_DIR_QUALIFIER,
+                USER_DIR_ORGANIZATION_NAME,
+                USER_DIR_APPLICATION_NAME,
+            )
+            .ok_or(CacheSettingsError::UserDir)?;
+
+            Ok(CacheSettings::disk(project_dir.cache_dir()))
         }
     }
 }
@@ -184,12 +191,10 @@ pub enum OutputType {
 #[derive(Debug, Snafu)]
 #[snafu(module)]
 pub enum CacheSettingsError {
-    #[snafu(display("unable to resolve XDG directories"))]
-    Xdg { source: xdg::BaseDirectoriesError },
+    #[snafu(display("unable to resolve user directories"))]
+    UserDir,
 }
 
-pub struct InheritStackDemoArgs {}
-
 /// Returns a list of paths or urls based on the default (remote) file and
 /// files provided via the env variable.
 fn get_files(default_file: &str, env_key: &str) -> Result<Vec<PathOrUrl>, PathOrUrlParseError> {

rust/stackablectl/src/cli/mod.rs

@@ -15,4 +15,6 @@ pub const HELM_REPO_URL_STABLE: &str = "https://repo.stackable.tech/repository/h
 pub const HELM_REPO_URL_TEST: &str = "https://repo.stackable.tech/repository/helm-test/";
 pub const HELM_REPO_URL_DEV: &str = "https://repo.stackable.tech/repository/helm-dev/";
 
-pub const CACHE_HOME_PATH: &str = "stackablectl";
+pub const USER_DIR_APPLICATION_NAME: &str = "stackablectl";
+pub const USER_DIR_ORGANIZATION_NAME: &str = "Stackable";
+pub const USER_DIR_QUALIFIER: &str = "tech";

rust/stackablectl/src/constants.rs

@@ -12,14 +12,14 @@ type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A
 export interface paths {
   "/demos": {
     /**
-     * Retrieves all demos. 
+     * Retrieves all demos.
      * @description Retrieves all demos.
      */
     get: operations["get_demos"];
   };
   "/demos/{name}": {
     /**
-     * Retrieves one demo identified by `name`. 
+     * Retrieves one demo identified by `name`.
      * @description Retrieves one demo identified by `name`.
      */
     get: operations["get_demo"];
@@ -32,21 +32,21 @@ export interface paths {
   };
   "/releases": {
     /**
-     * Retrieves all releases. 
+     * Retrieves all releases.
      * @description Retrieves all releases.
      */
     get: operations["get_releases"];
   };
   "/releases/{name}": {
     /**
-     * Retrieves one release identified by `name`. 
+     * Retrieves one release identified by `name`.
      * @description Retrieves one release identified by `name`.
      */
     get: operations["get_release"];
   };
   "/stacklets": {
     /**
-     * Retrieves all stacklets. 
+     * Retrieves all stacklets.
      * @description Retrieves all stacklets.
      */
     get: operations["get_stacklets"];
@@ -64,18 +64,18 @@ export interface components {
       /** @description An optional link to a documentation page */
       documentation?: string | null;
       /** @description A variable number of labels (tags) */
-      labels?: (string)[];
+      labels?: string[];
       /** @description A variable number of Helm or YAML manifests */
-      manifests?: (components["schemas"]["ManifestSpec"])[];
+      manifests?: components["schemas"]["ManifestSpec"][];
       /** @description A variable number of supported parameters */
-      parameters?: (components["schemas"]["Parameter"])[];
+      parameters?: components["schemas"]["Parameter"][];
       /** @description The name of the underlying stack */
       stackableStack: string;
       /**
        * @description Supported namespaces this demo can run in. An empty list indicates that
        * the demo can run in any namespace.
        */
-      supportedNamespaces?: (string)[];
+      supportedNamespaces?: string[];
     };
     DisplayCondition: {
       condition: string;
@@ -116,7 +116,7 @@ export interface components {
     SessionToken: string;
     Stacklet: {
       /** @description Multiple cluster conditions. */
-      conditions: (components["schemas"]["DisplayCondition"])[];
+      conditions: components["schemas"]["DisplayCondition"][];
       /**
        * @description Endpoint addresses the product is reachable at.
        * The key is the service name (e.g. `web-ui`), the value is the URL.
@@ -144,23 +144,25 @@ export type external = Record<string, never>;
 export interface operations {
 
   /**
-   * Retrieves all demos. 
+   * Retrieves all demos.
    * @description Retrieves all demos.
    */
   get_demos: {
     responses: {
       /** @description Retrieving a list of demos succeeded */
       200: {
         content: {
-          "application/json": (components["schemas"]["DemoSpecV2"])[];
+          "application/json": components["schemas"]["DemoSpecV2"][];
         };
       };
       /** @description Retrieving a list of demos failed */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   /**
-   * Retrieves one demo identified by `name`. 
+   * Retrieves one demo identified by `name`.
    * @description Retrieves one demo identified by `name`.
    */
   get_demo: {
@@ -172,7 +174,9 @@ export interface operations {
         };
       };
       /** @description Retrieving the demo with 'name' failed */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   log_in: {
@@ -199,38 +203,40 @@ export interface operations {
     };
   };
   /**
-   * Retrieves all releases. 
+   * Retrieves all releases.
    * @description Retrieves all releases.
    */
   get_releases: {
     responses: {
       /** @description Retrieving a list of releases succeeded */
       200: {
         content: {
-          "application/json": (components["schemas"]["ReleaseSpec"])[];
+          "application/json": components["schemas"]["ReleaseSpec"][];
         };
       };
       /** @description Retrieving a list of releases failed */
-      404: never;
+      404: {
+        content: never;
+      };
     };
   };
   /**
-   * Retrieves one release identified by `name`. 
+   * Retrieves one release identified by `name`.
    * @description Retrieves one release identified by `name`.
    */
   get_release: {
     responses: {
     };
   };
   /**
-   * Retrieves all stacklets. 
+   * Retrieves all stacklets.
    * @description Retrieves all stacklets.
    */
   get_stacklets: {
     responses: {
       200: {
         content: {
-          "application/json": (components["schemas"]["Stacklet"])[];
+          "application/json": components["schemas"]["Stacklet"][];
         };
       };
     };