Merge pull request #343 from FoxxMD/caching

feat: Caching and persistent scrobble queues

Author: FoxxMD

.devcontainer/compose.yml

@@ -0,0 +1,25 @@
+version: '3.7'
+services:
+  # Update this to the name of the service you want to work with in your docker-compose.yml file
+  app:
+    # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer 
+    # folder. Note that the path of the Dockerfile and context is relative to the *primary* 
+    # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
+    # array). The sample below assumes your primary file is in the root of your project.
+    #
+    # build:
+    #   context: .
+    #   dockerfile: .devcontainer/Dockerfile
+
+    image: mcr.microsoft.com/devcontainers/javascript-node:1-20-bookworm
+
+    volumes:
+      # Update this to wherever you want VS Code to mount the folder of your project
+      - ..:/workspaces:cached
+    command: sleep infinity
+
+  valkey:
+    image: valkey/valkey
+    env_file:
+      - path: ./.env
+        required: false

.devcontainer/devcontainer.json

@@ -3,7 +3,13 @@
 {
 	"name": "Node.js",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/javascript-node:1-20-bookworm",
+	"dockerComposeFile": [
+		"compose.yml"
+	],
+
+	"service": "app",
+
+	"workspaceFolder": "/workspaces",
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},

.gitignore

@@ -118,7 +118,9 @@ dist
 .pnp.*
 
 config/*.json
+config/mscache
 config/yti-*
+config/*.cache
 *.txt
 .idea/
 

.mocharc.json

@@ -3,5 +3,8 @@
   "extension": "ts",
   "import": "tsx/esm",
   "spec": "./src/backend/tests/**/*.test.ts",
+  "file": [
+    "./src/backend/tests/setup.ts"
+  ],
   "exit": true
 }

docsite/docs/configuration/configuration.mdx

@@ -186,6 +186,93 @@ Useful when running with [docker](../installation/installation.mdx#docker) so th
 
 </details>
 
+#### Caching
+
+Multi-scrobbler can cache some of its data for the purpose of **persisting queued and dead scrobbles** after restarting.
+
+It supports caching using either:
+
+* **File** cache stored in the `CONFIG_DIR` directory (next to your File/[AIO](./?configType=aio#configuration-types) file)
+* [**Valkey**](https://valkey.io/), an open-source fork of Redis.
+
+**File** caching is **enabled by default** when no other configuration is present.
+
+The type of cache used, and it's connection properties, can be configured through ENV or **AIO** config.
+
+##### Caching Configuration
+
+<Tabs groupId="cache" queryString>
+
+<TabItem value="file" label="File">
+
+**File** cache is stored in the `CONFIG_DIR` directory using the pre-defined file name `ms-scrobble.cache`.
+
+It is **enabled by default** if `CACHE_SCROBBLE`, or the respective AIO configuration, is not defined.
+
+<Tabs groupId="configType" queryString>
+
+<TabItem value="env" label="ENV">
+
+| Environmental Variable | Required? | Default              | Description                                                  |
+| :--------------------- | --------- | -------------------- | ------------------------------------------------------------ |
+| `CACHE_SCROBBLE`       | No        | `file`               | The cache type to use                                        |
+| `CACHE_SCROBBLE_CONN`  | No        | The config directory | The directory, within the container, to store the cache file |
+
+</TabItem>
+
+<TabItem value="aio" label="AIO">
+
+```json5 title="config.json"
+{
+    "cache": {
+        "scrobble": {
+            "provider": "file",
+            "connection": "/config"
+        }
+    },
+    // ...
+}
+```
+
+</TabItem>
+
+</Tabs>
+</TabItem>
+
+<TabItem value="valkey" label="Valkey">
+
+<Tabs groupId="configType" queryString>
+
+<TabItem value="env" label="ENV">
+
+| Environmental Variable | Required? | Default              | Description                                                  |
+| :--------------------- | --------- | -------------------- | ------------------------------------------------------------ |
+| `CACHE_SCROBBLE`       | Yes        | `valkey`               | The cache type to use                                      |
+| `CACHE_SCROBBLE_CONN`  | Yes        |  | The host/IP and port to connect to, prefixed with `redis://` -- EX: `redis://192.168.0.120:6379` |
+
+</TabItem>
+
+<TabItem value="aio" label="AIO">
+
+```json5 title="config.json"
+{
+    "cache": {
+        "scrobble": {
+            "provider": "valkey",
+            "connection": "redis://192.168.0.120:6379"
+        }
+    },
+    // ...
+}
+```
+
+</TabItem>
+
+</Tabs>
+</TabItem>
+
+</Tabs>
+
 #### Debug Mode
 
 Turning on Debug Mode will