chore: bump unleash-client to v6 and deprecate unleashInstanceId (#180)

README.md

@@ -367,7 +367,7 @@ You **must configure** these three variables for the proxy to start successfully
 | n/a | `PORT` or `PROXY_PORT` | 3000 | no | The port where the proxy should listen. |
 | proxyBasePath | `PROXY_BASE_PATH` | "" | no | The base path to run the proxy from. "/proxy" will be added at the end. For instance, if `proxyBasePath` is `"base/path"`, the proxy will run at `/base/path/proxy`. |
 | unleashAppName | `UNLEASH_APP_NAME` | "unleash-proxy" | no | App name to used when registering with Unleash |
-| unleashInstanceId | `UNLEASH_INSTANCE_ID` | `generated` | no | Unleash instance id to used when registering with Unleash |
+| unleashInstanceId | `UNLEASH_INSTANCE_ID` | `generated` | deprecated | Unleash instance id to used when registering with Unleash |
 | refreshInterval | `UNLEASH_FETCH_INTERVAL` | 5000 | no | How often the proxy should query Unleash for updates, defined in ms. |
 | metricsInterval | `UNLEASH_METRICS_INTERVAL` | 30000 | no | How often the proxy should send usage metrics back to Unleash, defined in ms. |
 | metricsJitter | `UNLEASH_METRICS_JITTER` | 0 | no | Adds jitter to the metrics interval to avoid multiple instances sending metrics at the same time, defined in ms. |

package.json

@@ -46,7 +46,7 @@
     "openapi-types": "^11.0.0",
     "qs": "^6.9.7",
     "type-is": "^1.6.18",
-    "unleash-client": "^5.6.1"
+    "unleash-client": "^6.0.0"
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",

src/config.ts

@@ -49,6 +49,10 @@ export interface IProxyConfig {
     unleashUrl: string;
     unleashApiToken: string;
     unleashAppName: string;
+    /**
+     * @deprecated This property is deprecated and will be removed in a future version.
+     * Note: This property is currently a no-op (no operation) and does not affect the automatically generated instanceId.
+     */
     unleashInstanceId: string;
     customStrategies?: Strategy[];
     clientKeys: string[];

src/create-client.ts

@@ -12,7 +12,6 @@ export const createSingletonClient = (config: IProxyConfig): Client => {
     const unleash = initialize({
         url: config.unleashUrl,
         appName: config.unleashAppName,
-        instanceId: config.unleashInstanceId,
         environment: config.environment,
         refreshInterval: config.refreshInterval,
         projectName: config.projectName,
@@ -49,7 +48,6 @@ export const createNewClient = (config: IProxyConfig): Client => {
     const unleash = new Unleash({
         url: config.unleashUrl,
         appName: config.unleashAppName,
-        instanceId: config.unleashInstanceId,
         environment: config.environment,
         refreshInterval: config.refreshInterval,
         projectName: config.projectName,

yarn.lock

@@ -4962,10 +4962,10 @@ unique-slug@^4.0.0:
   dependencies:
     imurmurhash "^0.1.4"
 
-unleash-client@^5.6.1:
-  version "5.6.1"
-  resolved "https://registry.yarnpkg.com/unleash-client/-/unleash-client-5.6.1.tgz#a730da7cced1fa2ccdf3d41d0d8f93f8bb0e8976"
-  integrity sha512-ZmFDhnq0c3Y4CEp+S3ureS9jZFMG/mtyafv4zxW4pmG0vc7xgxE9zBX296lrrrINsc2G0/2uJeoO+9b0bks+mg==
+unleash-client@^6.0.0:
+  version "6.0.0"
+  resolved "https://registry.yarnpkg.com/unleash-client/-/unleash-client-6.0.0.tgz#03af4bd3177647e356b6c7a572d94ec611c2da4f"
+  integrity sha512-qvnFtlV5zCGhXC/4Soqe1FCRjes61HuJYXysHwnUplNd5qItX51S9f+oRu2WzIdBp+kiYU5SwT2sSWEJK+OTaQ==
   dependencies:
     http-proxy-agent "^7.0.2"
     https-proxy-agent "^7.0.5"