Version Packages

packages/backend-common/CHANGELOG.md

@@ -1,5 +1,62 @@
 # @backstage/backend-common
 
+## 0.8.0
+
+### Minor Changes
+
+- 22fd8ce2a: Introducing: a standard API for App Integrators to configure cache stores and Plugin Developers to interact with them.
+
+  Two cache stores are currently supported.
+
+  - `memory`, which is a very simple in-memory key/value store, intended for local development.
+  - `memcache`, which can be used to connect to a memcache host.
+
+  Configuring and working with cache stores is very similar to the process for database connections.
+
+  ```yaml
+  backend:
+    cache:
+      store: memcache
+      connection: user:pass@cache.example.com:11211
+  ```
+
+  ```typescript
+  import { CacheManager } from '@backstage/backend-common';
+
+  // Instantiating a cache client for a plugin.
+  const cacheManager = CacheManager.fromConfig(config);
+  const somePluginCache = cacheManager.forPlugin('somePlugin');
+  const cacheClient = somePluginCache.getClient();
+
+  // Using the cache client:
+  const cachedValue = await cacheClient.get('someKey');
+  if (cachedValue) {
+    return cachedValue;
+  } else {
+    const someValue = await someExpensiveProcess();
+    await cacheClient.set('someKey', someValue);
+  }
+  await cacheClient.delete('someKey');
+  ```
+
+  Cache clients deal with TTLs in milliseconds. A TTL can be provided as a defaultTtl when getting a client, or may be passed when setting specific objects. If no TTL is provided, data will be persisted indefinitely.
+
+  ```typescript
+  // Getting a client with a default TTL
+  const cacheClient = somePluginCache.getClient({
+    defaultTtl: 3600000,
+  });
+
+  // Setting a TTL on a per-object basis.
+  cacheClient.set('someKey', data, { ttl: 3600000 });
+  ```
+
+  Configuring a cache store is optional. Even when no cache store is configured, the cache manager will dutifully pass plugins a manager that resolves a cache client that does not actually write or read any data.
+
+### Patch Changes
+
+- f9fb4a205: Prep work for mysql support in backend-common
+
 ## 0.7.0
 
 ### Minor Changes

packages/backend-common/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-common",
   "description": "Common functionality library for Backstage backends",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "private": false,
@@ -76,8 +76,8 @@
     }
   },
   "devDependencies": {
-    "@backstage/cli": "^0.6.10",
-    "@backstage/test-utils": "^0.1.10",
+    "@backstage/cli": "^0.6.11",
+    "@backstage/test-utils": "^0.1.11",
     "@types/archiver": "^5.1.0",
     "@types/compression": "^1.7.0",
     "@types/concat-stream": "^1.6.0",