feat: add support for cleaning up custom formats

- fixes #191
raydak-labs · Feb 10, 2025 · c6f0152 · c6f0152
1 parent 8b75779
commit c6f0152
Show file tree

Hide file tree

Showing 9 changed files with 95 additions and 2 deletions.
diff --git a/docs/docs/configuration/_include/config-file-sample.yml b/docs/docs/configuration/_include/config-file-sample.yml
@@ -39,6 +39,12 @@ sonarr:
     # since v1.11.0. You can disable instances. Optional
     # enabled: false
 
+    # since v1.12.0. Optional
+    # delete_unmanaged_custom_formats:
+    #   enabled: true
+    #   ignore: # optional
+    #     - some-cf
+
     quality_definition:
       type: series # Quality definition type for Sonarr
 

diff --git a/docs/docs/configuration/config-file.md b/docs/docs/configuration/config-file.md
@@ -278,6 +278,29 @@ Notes:
 - clone order will be displayed in `DEBUG` log
 - **experimental**, available since `v1.10.0`
 
+## Cleanup / Deleting CustomFormats {#cleanup-custom-formats}
+
+You can now enable the option to delete all custom formats which are not managed and used in the quality profiles.
+Additionally you can provide exceptions which should be ignored from deletions.
+
+```yml
+# ...
+
+sonarr:
+  instance1:
+    # ...
+
+    # since v1.12.0. Optional
+    delete_unmanaged_custom_formats:
+      enabled: true
+      ignore: # optional
+        - some-cf
+```
+
+Notes:
+
+- **experimental**, available since `v1.12.0`
+
 ## Usage
 
 1. Create both `config.yml` and `secrets.yml` files

diff --git a/examples/full/config/config.yml b/examples/full/config/config.yml
@@ -46,6 +46,12 @@ sonarr:
     # since v1.11.0, optional, for disabling instances
     enabled: false
 
+    # since v1.12.0. Optional
+    # delete_unmanaged_custom_formats:
+    #   enabled: true
+    #   ignore:
+    #     - CustomFormatToKeep
+
     quality_definition:
       type: series
 

diff --git a/src/__generated__/ky-client.ts b/src/__generated__/ky-client.ts
diff --git a/src/config.ts b/src/config.ts
@@ -306,6 +306,10 @@ export const mergeConfigsAndTemplates = async (
     mergedTemplates.custom_formats.push(...instanceConfig.custom_formats);
   }
 
+  if (instanceConfig.delete_unmanaged_custom_formats) {
+    mergedTemplates.delete_unmanaged_custom_formats = instanceConfig.delete_unmanaged_custom_formats;
+  }
+
   if (instanceConfig.quality_profiles) {
     mergedTemplates.quality_profiles.push(...instanceConfig.quality_profiles);
   }

diff --git a/src/custom-formats.ts b/src/custom-formats.ts
@@ -21,6 +21,13 @@ export const deleteAllCustomFormats = async () => {
   }
 };
 
+export const deleteCustomFormat = async (customFormat: MergedCustomFormatResource) => {
+  const api = getUnifiedClient();
+
+  await api.deleteCustomFormat(customFormat.id + "");
+  logger.info(`Deleted CF: '${customFormat.name}'`);
+};
+
 export const loadServerCustomFormats = async (): Promise<MergedCustomFormatResource[]> => {
   if (getEnvs().LOAD_LOCAL_SAMPLES) {
     return loadJsonFile<MergedCustomFormatResource[]>(path.resolve(__dirname, "../tests/samples/cfs.json"));

diff --git a/src/index.ts b/src/index.ts
@@ -8,7 +8,7 @@ import { MergedCustomFormatResource } from "./__generated__/mergedTypes";
 import { ServerCache } from "./cache";
 import { configureApi, getUnifiedClient, unsetApi } from "./clients/unified-client";
 import { getConfig, mergeConfigsAndTemplates } from "./config";
-import { calculateCFsToManage, loadCustomFormatDefinitions, loadServerCustomFormats, manageCf } from "./custom-formats";
+import { calculateCFsToManage, deleteCustomFormat, loadCustomFormatDefinitions, loadServerCustomFormats, manageCf } from "./custom-formats";
 import { logHeading, logInstanceHeading, logger } from "./logger";
 import { calculateMediamanagementDiff, calculateNamingDiff } from "./media-management";
 import { calculateQualityDefinitionDiff, loadQualityDefinitionFromServer } from "./quality-definitions";
@@ -28,7 +28,7 @@ const pipeline = async (globalConfig: InputConfigSchema, instanceConfig: InputCo
 
   const serverCache = new ServerCache(serverQD, [], serverCFs, languages);
 
-  logger.info(`Server objects: CustomFormats ${serverCFs.length}}`);
+  logger.info(`Server objects: CustomFormats ${serverCFs.length}`);
 
   const { config } = await mergeConfigsAndTemplates(globalConfig, instanceConfig, arrType);
 
@@ -51,6 +51,32 @@ const pipeline = async (globalConfig: InputConfigSchema, instanceConfig: InputCo
     serverCache.cf = await loadServerCustomFormats();
   }
 
+  if (config.delete_unmanaged_custom_formats?.enabled) {
+    const idToCf = mergedCFs.carrIdMapping;
+
+    const mm = Array.from(idsToManage).reduce((p, c) => {
+      const cfName = idToCf.get(c)?.carrConfig.name;
+      if (cfName != null) {
+        p.set(cfName, true);
+      }
+      return p;
+    }, new Map<string, boolean>());
+
+    config.delete_unmanaged_custom_formats.ignore?.forEach((e) => {
+      mm.set(e, true);
+    });
+
+    const cfsToDelete = serverCache.cf.filter((e) => (e.name && mm.get(e.name)) !== true);
+
+    if (cfsToDelete.length > 0) {
+      logger.info(`Deleting ${cfsToDelete.length} CustomFormats ...`);
+
+      for (const element of cfsToDelete) {
+        await deleteCustomFormat(element);
+      }
+    }
+  }
+
   logger.info(`CustomFormats synchronized`);
 
   const qualityDefinition = config.quality_definition?.type;

diff --git a/src/types/common.types.ts b/src/types/common.types.ts
@@ -74,6 +74,7 @@ export type MappedTemplates = Partial<
     | "media_management"
     | "media_naming"
     | "media_naming_api"
+    | "delete_unmanaged_custom_formats"
   >
 >;
 

diff --git a/src/types/config.types.ts b/src/types/config.types.ts
@@ -44,6 +44,17 @@ export type InputConfigArrInstance = {
    * since v1.11.0
    */
   enabled?: boolean;
+  /**
+   * since v1.12.0
+   * Deletes all CustomFormats which are not defined in any qualityprofile
+   */
+  delete_unmanaged_custom_formats?: {
+    enabled: boolean;
+    /**
+     * Names of custom formats to ignore deleting
+     */
+    ignore?: string[];
+  };
   quality_definition?: {
     type?: string;
     preferred_ratio?: number; // 0.0 - 1.0