Skip to content

Commit 6ab0fb8

Browse files
CahidArdaCahidArda
committed
fix: replace throw on missing env with warning
1 parent 45ed724 commit 6ab0fb8

File tree

6 files changed

+104
-39
lines changed

6 files changed

+104
-39
lines changed

‎pkg/error.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export class UpstashError extends Error {
1111
export class UrlError extends Error {
1212
constructor(url: string) {
1313
super(
14-
`Upstash Redis client was passed an invalid URL. You should pass the URL together with https. Received: "${url}". `
14+
`Upstash Redis client was passed an invalid URL. You should pass a URL starting with https. Received: "${url}". `
1515
);
1616
this.name = "UrlError";
1717
}

‎pkg/http.ts

+11-1
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ export class HttpClient implements Requester {
127127
};
128128
public readYourWrites: boolean;
129129
public upstashSyncToken = "";
130+
private hasCredentials: boolean;
130131

131132
public readonly retry: {
132133
attempts: number;
@@ -157,7 +158,7 @@ export class HttpClient implements Requester {
157158
* - `$` asserts the position at the end of the string.
158159
*/
159160
const urlRegex = /^https?:\/\/[^\s#$./?].\S*$/;
160-
if (!urlRegex.test(this.baseUrl)) {
161+
if (this.baseUrl && !urlRegex.test(this.baseUrl)) {
161162
throw new UrlError(this.baseUrl);
162163
}
163164

@@ -167,6 +168,8 @@ export class HttpClient implements Requester {
167168
...config.headers,
168169
};
169170

171+
this.hasCredentials = Boolean(this.baseUrl && this.headers.authorization.split(" ")[1]);
172+
170173
if (this.options.responseEncoding === "base64") {
171174
this.headers["Upstash-Encoding"] = "base64";
172175
}
@@ -206,6 +209,13 @@ export class HttpClient implements Requester {
206209
backend: this.options.backend,
207210
};
208211

212+
if (!this.hasCredentials) {
213+
throw new Error(
214+
"[Upstash Redis] Redis client was initialized without url or token." +
215+
" Failed to execute command."
216+
);
217+
}
218+
209219
/**
210220
* We've recieved a new `upstash-sync-token` in the previous response. We use it in the next request to observe the effects of previous requests.
211221
*/

‎platforms/cloudflare.ts

+19-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
21
import type { RequesterConfig } from "../pkg/http";
32
import { HttpClient } from "../pkg/http";
43
import * as core from "../pkg/redis";
@@ -56,27 +55,35 @@ export class Redis extends core.Redis {
5655
*/
5756
constructor(config: RedisConfigCloudflare, env?: Env) {
5857
if (!config.url) {
59-
throw new Error(
58+
console.warn(
6059
`[Upstash Redis] The 'url' property is missing or undefined in your Redis config.`
6160
);
6261
}
6362

6463
if (!config.token) {
65-
throw new Error(
64+
console.warn(
6665
`[Upstash Redis] The 'token' property is missing or undefined in your Redis config.`
6766
);
6867
}
6968

70-
if (config.url.startsWith(" ") || config.url.endsWith(" ") || /\r|\n/.test(config.url)) {
71-
console.warn("The redis url contains whitespace or newline, which can cause errors!");
69+
if (config.url!.startsWith(" ") || config.url!.endsWith(" ") || /\r|\n/.test(config.url!)) {
70+
console.warn(
71+
"[Upstash Redis] The redis url contains whitespace or newline, which can cause errors!"
72+
);
7273
}
73-
if (config.token.startsWith(" ") || config.token.endsWith(" ") || /\r|\n/.test(config.token)) {
74-
console.warn("The redis token contains whitespace or newline, which can cause errors!");
74+
if (
75+
config.token!.startsWith(" ") ||
76+
config.token!.endsWith(" ") ||
77+
/\r|\n/.test(config.token!)
78+
) {
79+
console.warn(
80+
"[Upstash Redis] The redis token contains whitespace or newline, which can cause errors!"
81+
);
7582
}
7683

7784
const client = new HttpClient({
7885
retry: config.retry,
79-
baseUrl: config.url,
86+
baseUrl: config.url!,
8087
headers: { authorization: `Bearer ${config.token}` },
8188
responseEncoding: config.responseEncoding,
8289
signal: config.signal,
@@ -127,13 +134,13 @@ export class Redis extends core.Redis {
127134
const token = env?.UPSTASH_REDIS_REST_TOKEN ?? UPSTASH_REDIS_REST_TOKEN;
128135

129136
if (!url) {
130-
throw new Error(
131-
"Unable to find environment variable: `UPSTASH_REDIS_REST_URL`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_URL`"
137+
console.warn(
138+
"[Upstash Redis] Unable to find environment variable: `UPSTASH_REDIS_REST_URL`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_URL`"
132139
);
133140
}
134141
if (!token) {
135-
throw new Error(
136-
"Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`"
142+
console.warn(
143+
"[Upstash Redis] Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`"
137144
);
138145
}
139146
return new Redis({ ...opts, url, token }, env);

‎platforms/fastly.ts

+15-7
Original file line numberDiff line numberDiff line change
@@ -53,26 +53,34 @@ export class Redis extends core.Redis {
5353
*/
5454
constructor(config: RedisConfigFastly) {
5555
if (!config.url) {
56-
throw new Error(
56+
console.warn(
5757
`[Upstash Redis] The 'url' property is missing or undefined in your Redis config.`
5858
);
5959
}
6060

6161
if (!config.token) {
62-
throw new Error(
62+
console.warn(
6363
`[Upstash Redis] The 'token' property is missing or undefined in your Redis config.`
6464
);
6565
}
6666

67-
if (config.url.startsWith(" ") || config.url.endsWith(" ") || /\r|\n/.test(config.url)) {
68-
console.warn("The redis url contains whitespace or newline, which can cause errors!");
67+
if (config.url!.startsWith(" ") || config.url!.endsWith(" ") || /\r|\n/.test(config.url!)) {
68+
console.warn(
69+
"[Upstash Redis] The redis url contains whitespace or newline, which can cause errors!"
70+
);
6971
}
70-
if (config.token.startsWith(" ") || config.token.endsWith(" ") || /\r|\n/.test(config.token)) {
71-
console.warn("The redis token contains whitespace or newline, which can cause errors!");
72+
if (
73+
config.token!.startsWith(" ") ||
74+
config.token!.endsWith(" ") ||
75+
/\r|\n/.test(config.token!)
76+
) {
77+
console.warn(
78+
"[Upstash Redis] The redis token contains whitespace or newline, which can cause errors!"
79+
);
7280
}
7381

7482
const client = new HttpClient({
75-
baseUrl: config.url,
83+
baseUrl: config.url!,
7684
retry: config.retry,
7785
headers: { authorization: `Bearer ${config.token}` },
7886
options: { backend: config.backend },

‎platforms/nodejs.ts

+22-18
Original file line numberDiff line numberDiff line change
@@ -102,37 +102,41 @@ export class Redis extends core.Redis {
102102
}
103103

104104
if (!configOrRequester.url) {
105-
throw new Error(
105+
console.warn(
106106
`[Upstash Redis] The 'url' property is missing or undefined in your Redis config.`
107107
);
108108
}
109109

110110
if (!configOrRequester.token) {
111-
throw new Error(
111+
console.warn(
112112
`[Upstash Redis] The 'token' property is missing or undefined in your Redis config.`
113113
);
114114
}
115115

116116
if (
117-
configOrRequester.url.startsWith(" ") ||
118-
configOrRequester.url.endsWith(" ") ||
119-
/\r|\n/.test(configOrRequester.url)
117+
configOrRequester.url!.startsWith(" ") ||
118+
configOrRequester.url!.endsWith(" ") ||
119+
/\r|\n/.test(configOrRequester.url!)
120120
) {
121-
console.warn("The redis url contains whitespace or newline, which can cause errors!");
121+
console.warn(
122+
"[Upstash Redis] The redis url contains whitespace or newline, which can cause errors!"
123+
);
122124
}
123125
if (
124-
configOrRequester.token.startsWith(" ") ||
125-
configOrRequester.token.endsWith(" ") ||
126-
/\r|\n/.test(configOrRequester.token)
126+
configOrRequester.token!.startsWith(" ") ||
127+
configOrRequester.token!.endsWith(" ") ||
128+
/\r|\n/.test(configOrRequester.token!)
127129
) {
128-
console.warn("The redis token contains whitespace or newline, which can cause errors!");
130+
console.warn(
131+
"[Upstash Redis] The redis token contains whitespace or newline, which can cause errors!"
132+
);
129133
}
130134

131135
const client = new HttpClient({
132-
baseUrl: configOrRequester.url,
136+
baseUrl: configOrRequester.url!,
133137
retry: configOrRequester.retry,
134138
headers: { authorization: `Bearer ${configOrRequester.token}` },
135-
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
139+
136140
agent: configOrRequester.agent,
137141
responseEncoding: configOrRequester.responseEncoding,
138142
cache: configOrRequester.cache ?? "no-store",
@@ -172,21 +176,21 @@ export class Redis extends core.Redis {
172176
*/
173177
static fromEnv(config?: Omit<RedisConfigNodejs, "url" | "token">): Redis {
174178
// @ts-ignore process will be defined in node
175-
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
179+
176180
if (process.env === undefined) {
177181
throw new TypeError(
178-
'Unable to get environment variables, `process.env` is undefined. If you are deploying to cloudflare, please import from "@upstash/redis/cloudflare" instead'
182+
'[Upstash Redis] Unable to get environment variables, `process.env` is undefined. If you are deploying to cloudflare, please import from "@upstash/redis/cloudflare" instead'
179183
);
180184
}
181-
// @ts-ignore process will be defined in node
182185
const url = process.env.UPSTASH_REDIS_REST_URL;
183186
if (!url) {
184-
throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_URL`");
187+
console.warn("[Upstash Redis] Unable to find environment variable: `UPSTASH_REDIS_REST_URL`");
185188
}
186-
// @ts-ignore process will be defined in node
187189
const token = process.env.UPSTASH_REDIS_REST_TOKEN;
188190
if (!token) {
189-
throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
191+
console.warn(
192+
"[Upstash Redis] Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`"
193+
);
190194
}
191195
return new Redis({ ...config, url, token });
192196
}

‎platforms/platform.test.ts

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import { describe, expect, test } from "bun:test";
2+
import { Redis as NodeRedis } from "./nodejs";
3+
import { Redis as CloudflareRedis } from "./cloudflare";
4+
import { Redis as FastlyRedis } from "./fastly";
5+
6+
describe("should allow creating a client without credentials but fail when requesting", () => {
7+
test("nodejs", () => {
8+
const redis = new NodeRedis({ url: undefined, token: undefined });
9+
10+
const throws = redis.get("foo");
11+
expect(throws).toThrow(
12+
"[Upstash Redis] Redis client was initialized without url or token." +
13+
" Failed to execute command."
14+
);
15+
});
16+
17+
test("cloudflare", () => {
18+
const redis = new CloudflareRedis({ url: undefined, token: undefined });
19+
20+
const throws = redis.get("foo");
21+
expect(throws).toThrow(
22+
"[Upstash Redis] Redis client was initialized without url or token." +
23+
" Failed to execute command."
24+
);
25+
});
26+
27+
test("fastly", () => {
28+
const redis = new FastlyRedis({ url: undefined, token: undefined, backend: "upstash-db" });
29+
30+
const throws = redis.get("foo");
31+
expect(throws).toThrow(
32+
"[Upstash Redis] Redis client was initialized without url or token." +
33+
" Failed to execute command."
34+
);
35+
});
36+
});

0 commit comments

Comments
 (0)