@upstash/redis 1.19.1 → 1.19.3

package/README.md

@@ -83,8 +83,9 @@ console.log(data)
 
 ## Troubleshooting
 
-We have a [dedicated page](https://docs.upstash.com/troubleshooting) for common
-problems. If you can't find a solution, please
+We have a
+[dedicated page](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting)
+for common problems. If you can't find a solution, please
 [open an issue](https://github.com/upstash/upstash-redis/issues/new).
 
 ## Docs

package/esm/pkg/http.js

@@ -35,15 +35,6 @@ export class HttpClient {
             "Content-Type": "application/json",
             ...config.headers,
         };
-        if (config.telemetry?.runtime) {
-            this.headers["Upstash-Telemetry-Runtime"] = config.telemetry.runtime;
-        }
-        if (config.telemetry?.platform) {
-            this.headers["Upstash-Telemetry-Platform"] = config.telemetry.platform;
-        }
-        if (config.telemetry?.sdk) {
-            this.headers["Upstash-Telemetry-Sdk"] = config.telemetry.sdk;
-        }
         if (this.options.responseEncoding === "base64") {
             this.headers["Upstash-Encoding"] = "base64";
         }
@@ -61,6 +52,23 @@ export class HttpClient {
             };
         }
     }
+    mergeTelemetry(telemetry) {
+        function merge(obj, key, value) {
+            if (!value) {
+                return obj;
+            }
+            if (obj[key]) {
+                obj[key] = [obj[key], value].join(",");
+            }
+            else {
+                obj[key] = value;
+            }
+            return obj;
+        }
+        this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
+    }
     async request(req) {
         const requestOptions = {
             method: "POST",

package/esm/pkg/redis.js

@@ -31,6 +31,12 @@ export class Redis {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "enableTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Wrap a new middleware around the HTTP client.
          */
@@ -43,6 +49,27 @@ export class Redis {
                 this.client.request = (req) => middleware(req, makeRequest);
             }
         });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                if (!this.enableTelemetry) {
+                    return;
+                }
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *
@@ -1165,6 +1192,7 @@ export class Redis {
         });
         this.client = client;
         this.opts = opts;
+        this.enableTelemetry = opts?.enableTelemetry ?? true;
     }
     createScript(script) {
         return new Script(this, script);

package/esm/platforms/cloudflare.js

@@ -27,21 +27,21 @@ export class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const telemetry = {};
-        if (!env?.UPSTASH_DISABLE_TELEMETRY) {
-            telemetry.platform = "cloudflare";
-            telemetry.sdk = `@upstash/redis@${VERSION}`;
-        }
         const client = new HttpClient({
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
             responseEncoding: config.responseEncoding,
-            telemetry,
         });
         super(client, {
+            enableTelemetry: !env?.UPSTASH_DISABLE_TELEMETRY,
             automaticDeserialization: config.automaticDeserialization,
         });
+        // This is only added of the user has not disabled telemetry
+        this.addTelemetry({
+            platform: "cloudflare",
+            sdk: `@upstash/redis@${VERSION}`,
+        });
     }
     /*
      * Create a new Upstash Redis instance from environment variables on cloudflare.

package/esm/platforms/fastly.js

@@ -1,5 +1,6 @@
 import * as core from "../pkg/redis.js";
 import { HttpClient } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -37,5 +38,9 @@ export class Redis extends core.Redis {
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
         });
+        this.addTelemetry({
+            sdk: `@upstash/redis@${VERSION}`,
+            platform: "fastly",
+        });
     }
 }

package/esm/platforms/node_with_fetch.js

@@ -35,26 +35,25 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const telemetry = {};
-        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
-            telemetry.runtime = `node@${process.version}`;
-            telemetry.platform = process.env.VERCEL
-                ? "vercel"
-                : process.env.AWS_REGION
-                    ? "aws"
-                    : "unknown";
-            telemetry.sdk = `@upstash/redis@${VERSION}`;
-        }
         const client = new HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             //  agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
-            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${VERSION}`,
         });
     }
     /**

package/esm/platforms/nodejs.js

@@ -29,26 +29,25 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const telemetry = {};
-        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
-            telemetry.runtime = `node@${process.version}`;
-            telemetry.platform = process.env.VERCEL
-                ? "vercel"
-                : process.env.AWS_REGION
-                    ? "aws"
-                    : "unknown";
-            telemetry.sdk = `@upstash/redis@${VERSION}`;
-        }
         const client = new HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
-            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${VERSION}`,
         });
     }
     /**

package/esm/version.js

@@ -1 +1 @@
-export const VERSION = "v1.19.1";
+export const VERSION = "v1.19.3";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v1.19.1",
+  "version": "v1.19.3",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",

package/script/pkg/http.js

@@ -38,15 +38,6 @@ class HttpClient {
             "Content-Type": "application/json",
             ...config.headers,
         };
-        if (config.telemetry?.runtime) {
-            this.headers["Upstash-Telemetry-Runtime"] = config.telemetry.runtime;
-        }
-        if (config.telemetry?.platform) {
-            this.headers["Upstash-Telemetry-Platform"] = config.telemetry.platform;
-        }
-        if (config.telemetry?.sdk) {
-            this.headers["Upstash-Telemetry-Sdk"] = config.telemetry.sdk;
-        }
         if (this.options.responseEncoding === "base64") {
             this.headers["Upstash-Encoding"] = "base64";
         }
@@ -64,6 +55,23 @@ class HttpClient {
             };
         }
     }
+    mergeTelemetry(telemetry) {
+        function merge(obj, key, value) {
+            if (!value) {
+                return obj;
+            }
+            if (obj[key]) {
+                obj[key] = [obj[key], value].join(",");
+            }
+            else {
+                obj[key] = value;
+            }
+            return obj;
+        }
+        this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
+    }
     async request(req) {
         const requestOptions = {
             method: "POST",

package/script/pkg/redis.js

@@ -34,6 +34,12 @@ class Redis {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "enableTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Wrap a new middleware around the HTTP client.
          */
@@ -46,6 +52,27 @@ class Redis {
                 this.client.request = (req) => middleware(req, makeRequest);
             }
         });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                if (!this.enableTelemetry) {
+                    return;
+                }
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *
@@ -1168,6 +1195,7 @@ class Redis {
         });
         this.client = client;
         this.opts = opts;
+        this.enableTelemetry = opts?.enableTelemetry ?? true;
     }
     createScript(script) {
         return new script_js_1.Script(this, script);

package/script/platforms/cloudflare.js

@@ -53,21 +53,21 @@ class Redis extends core.Redis {
             /\r|\n/.test(config.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const telemetry = {};
-        if (!env?.UPSTASH_DISABLE_TELEMETRY) {
-            telemetry.platform = "cloudflare";
-            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
-        }
         const client = new http_js_1.HttpClient({
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
             responseEncoding: config.responseEncoding,
-            telemetry,
         });
         super(client, {
+            enableTelemetry: !env?.UPSTASH_DISABLE_TELEMETRY,
             automaticDeserialization: config.automaticDeserialization,
         });
+        // This is only added of the user has not disabled telemetry
+        this.addTelemetry({
+            platform: "cloudflare",
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
+        });
     }
     /*
      * Create a new Upstash Redis instance from environment variables on cloudflare.

package/script/platforms/fastly.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -63,6 +64,10 @@ class Redis extends core.Redis {
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
         });
+        this.addTelemetry({
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
+            platform: "fastly",
+        });
     }
 }
 exports.Redis = Redis;

package/script/platforms/node_with_fetch.js

@@ -61,26 +61,25 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const telemetry = {};
-        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
-            telemetry.runtime = `node@${process.version}`;
-            telemetry.platform = process.env.VERCEL
-                ? "vercel"
-                : process.env.AWS_REGION
-                    ? "aws"
-                    : "unknown";
-            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
-        }
         const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             //  agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
-            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
         });
     }
     /**

package/script/platforms/nodejs.js

@@ -55,26 +55,25 @@ class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
-        const telemetry = {};
-        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
-            telemetry.runtime = `node@${process.version}`;
-            telemetry.platform = process.env.VERCEL
-                ? "vercel"
-                : process.env.AWS_REGION
-                    ? "aws"
-                    : "unknown";
-            telemetry.sdk = `@upstash/redis@${version_js_1.VERSION}`;
-        }
         const client = new http_js_1.HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
             agent: configOrRequester.agent,
             responseEncoding: configOrRequester.responseEncoding,
-            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
         });
     }
     /**

package/script/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "v1.19.1";
+exports.VERSION = "v1.19.3";

package/types/pkg/http.d.ts

@@ -1,3 +1,4 @@
+import { Telemetry } from "./types.js";
 export declare type UpstashRequest = {
     path?: string[];
     /**
@@ -67,23 +68,6 @@ export declare type HttpClientConfig = {
     options?: Options;
     retry?: RetryConfig;
     agent?: any;
-    telemetry?: {
-        /**
-         * Upstash-Telemetry-Sdk
-         * @example @upstash/redis@v1.1.1
-         */
-        sdk?: string;
-        /**
-         * Upstash-Telemetry-Platform
-         * @example cloudflare
-         */
-        platform?: string;
-        /**
-         * Upstash-Telemetry-Runtime
-         * @example node@v18
-         */
-        runtime?: string;
-    };
 } & RequesterConfig;
 export declare class HttpClient implements Requester {
     baseUrl: string;
@@ -98,5 +82,6 @@ export declare class HttpClient implements Requester {
         backoff: (retryCount: number) => number;
     };
     constructor(config: HttpClientConfig);
+    mergeTelemetry(telemetry: Telemetry): void;
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }

package/types/pkg/redis.d.ts

@@ -3,6 +3,7 @@ import { Requester, UpstashRequest, UpstashResponse } from "./http.js";
 import { Pipeline } from "./pipeline.js";
 import type { CommandArgs } from "./types.js";
 import { Script } from "./script.js";
+import { Telemetry } from "./types.js";
 export declare type RedisOptions = {
     /**
      * Automatically try to deserialize the returned data from upstash using `JSON.deserialize`
@@ -10,6 +11,7 @@ export declare type RedisOptions = {
      * @default true
      */
     automaticDeserialization?: boolean;
+    enableTelemetry?: boolean;
 };
 /**
  * Serverless redis client for upstash.
@@ -17,6 +19,7 @@ export declare type RedisOptions = {
 export declare class Redis {
     protected client: Requester;
     protected opts?: CommandOptions<any, any>;
+    protected enableTelemetry: boolean;
     /**
      * Create a new redis client
      *
@@ -33,6 +36,10 @@ export declare class Redis {
      * Wrap a new middleware around the HTTP client.
      */
     use: <TResult = unknown>(middleware: (r: UpstashRequest, next: <TResult_1 = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult_1>>) => Promise<UpstashResponse<TResult>>) => void;
+    /**
+     * Technically this is not private, we can hide it from intellisense by doing this
+     */
+    protected addTelemetry: (telemetry: Telemetry) => void;
     createScript(script: string): Script;
     /**
      * Create a new pipeline that allows you to send requests in bulk.

package/types/pkg/types.d.ts

@@ -1 +1,18 @@
 export declare type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>[0];
+export declare type Telemetry = {
+    /**
+     * Upstash-Telemetry-Sdk
+     * @example @upstash/redis@v1.1.1
+     */
+    sdk?: string;
+    /**
+     * Upstash-Telemetry-Platform
+     * @example cloudflare
+     */
+    platform?: string;
+    /**
+     * Upstash-Telemetry-Runtime
+     * @example node@v18
+     */
+    runtime?: string;
+};

package/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "v1.19.1";
+export declare const VERSION = "v1.19.3";