@upstash/redis 1.16.1-rc.4 → 1.17.0

package/README.md

@@ -100,3 +100,19 @@ the url and token
 ```sh
 UPSTASH_REDIS_REST_URL=".." UPSTASH_REDIS_REST_TOKEN=".." deno test -A
 ```
+
+### Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Deno, Cloudflare, Vercel)
+- Runtime version (node@18.x)
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
+```

package/esm/pkg/http.js

@@ -35,6 +35,15 @@ 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";
         }

package/esm/platforms/cloudflare.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.
  */
@@ -15,7 +16,7 @@ export class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -26,11 +27,17 @@ 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, {
             automaticDeserialization: config.automaticDeserialization,
@@ -58,6 +65,6 @@ export class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ ...opts, url, token });
+        return new Redis({ ...opts, url, token }, env);
     }
 }

package/esm/platforms/node_with_fetch.js

@@ -1,6 +1,7 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
 import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 import "isomorphic-fetch";
 /**
  * Serverless redis client for upstash.
@@ -21,12 +22,23 @@ 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,

package/esm/platforms/nodejs.js

@@ -1,6 +1,7 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
 import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 /**
  * Serverless redis client for upstash.
  */
@@ -20,12 +21,23 @@ 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,

package/esm/version.js

@@ -0,0 +1 @@
+export const VERSION = "v1.17.0";

package/package.json

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

package/script/pkg/http.js

@@ -38,6 +38,15 @@ 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";
         }

package/script/platforms/cloudflare.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.
  */
@@ -41,7 +42,7 @@ class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -52,11 +53,17 @@ 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, {
             automaticDeserialization: config.automaticDeserialization,
@@ -84,7 +91,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ ...opts, url, token });
+        return new Redis({ ...opts, url, token }, env);
     }
 }
 exports.Redis = Redis;

package/script/platforms/node_with_fetch.js

@@ -27,6 +27,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");
 require("isomorphic-fetch");
 /**
  * Serverless redis client for upstash.
@@ -47,12 +48,23 @@ 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,

package/script/platforms/nodejs.js

@@ -27,6 +27,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.
  */
@@ -46,12 +47,23 @@ 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,

package/script/version.js

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

package/types/pkg/http.d.ts

@@ -67,6 +67,23 @@ 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;

package/types/platforms/cloudflare.d.ts

@@ -1,6 +1,9 @@
 import * as core from "../pkg/redis.js";
 import type { Requester, UpstashRequest, UpstashResponse } from "../pkg/http.js";
 import { RequesterConfig } from "../pkg/http.js";
+declare type Env = {
+    UPSTASH_DISABLE_TELEMETRY?: string;
+};
 export type { Requester, UpstashRequest, UpstashResponse };
 /**
  * Connection credentials for upstash redis.
@@ -15,7 +18,7 @@ export declare type RedisConfigCloudflare = {
      * UPSTASH_REDIS_REST_TOKEN
      */
     token: string;
-} & core.RedisOptions & RequesterConfig;
+} & core.RedisOptions & RequesterConfig & Env;
 /**
  * Serverless redis client for upstash.
  */
@@ -31,9 +34,10 @@ export declare class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config: RedisConfigCloudflare);
+    constructor(config: RedisConfigCloudflare, env?: Env);
     static fromEnv(env?: {
         UPSTASH_REDIS_REST_URL: string;
         UPSTASH_REDIS_REST_TOKEN: string;
+        UPSTASH_DISABLE_TELEMETRY?: string;
     }, opts?: Omit<RedisConfigCloudflare, "url" | "token">): Redis;
 }

package/types/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "v1.17.0";