@upstash/redis 1.0.0-alpha.2 → 1.0.0-alpha.7

package/pkg/commands/zunionstore.test.ts

@@ -1,215 +0,0 @@
-import { keygen, newHttpClient } from "../test-utils"
-import { randomUUID } from "crypto"
-import { describe, it, expect, afterAll } from "@jest/globals"
-import { ZUnionStoreCommand } from "./zunionstore"
-import { ZAddCommand } from "./zadd"
-
-const client = newHttpClient()
-
-const { newKey, cleanup } = keygen()
-afterAll(cleanup)
-
-describe("command format", () => {
-  describe("without options", () => {
-    it("builds the correct command", () => {
-      expect(new ZUnionStoreCommand("destination", 1, "key").command).toEqual([
-        "zunionstore",
-        "destination",
-        "1",
-        "key",
-      ])
-    })
-  })
-  describe("with multiple keys", () => {
-    it("builds the correct command", () => {
-      expect(new ZUnionStoreCommand("destination", 2, ["key1", "key2"]).command).toEqual([
-        "zunionstore",
-        "destination",
-        "2",
-        "key1",
-        "key2",
-      ])
-    })
-  })
-  describe("with single weight", () => {
-    it("builds the correct command", () => {
-      expect(new ZUnionStoreCommand("destination", 1, "key", { weight: 4 }).command).toEqual([
-        "zunionstore",
-        "destination",
-        "1",
-        "key",
-        "weights",
-        "4",
-      ])
-    })
-  })
-  describe("with multiple weights", () => {
-    it("builds the correct command", () => {
-      expect(
-        new ZUnionStoreCommand("destination", 2, ["key1", "key2"], { weights: [2, 3] }).command,
-      ).toEqual(["zunionstore", "destination", "2", "key1", "key2", "weights", "2", "3"])
-    })
-    describe("with aggregate", () => {
-      describe("sum", () => {
-        it("builds the correct command", () => {
-          expect(
-            new ZUnionStoreCommand("destination", 1, "key", { aggregate: "sum" }).command,
-          ).toEqual(["zunionstore", "destination", "1", "key", "aggregate", "sum"])
-        })
-      })
-      describe("min", () => {
-        it("builds the correct command", () => {
-          expect(
-            new ZUnionStoreCommand("destination", 1, "key", { aggregate: "min" }).command,
-          ).toEqual(["zunionstore", "destination", "1", "key", "aggregate", "min"])
-        })
-      })
-      describe("max", () => {
-        it("builds the correct command", () => {
-          expect(
-            new ZUnionStoreCommand("destination", 1, "key", { aggregate: "max" }).command,
-          ).toEqual(["zunionstore", "destination", "1", "key", "aggregate", "max"])
-        })
-      })
-    })
-    describe("complex", () => {
-      it("builds the correct command", () => {
-        expect(
-          new ZUnionStoreCommand("destination", 2, ["key1", "key2"], {
-            weights: [4, 2],
-            aggregate: "max",
-          }).command,
-        ).toEqual([
-          "zunionstore",
-          "destination",
-          "2",
-          "key1",
-          "key2",
-          "weights",
-          "4",
-          "2",
-          "aggregate",
-          "max",
-        ])
-      })
-    })
-  })
-})
-
-describe("without options", () => {
-  it("returns the number of elements in the new set ", async () => {
-    const destination = newKey()
-    const key1 = newKey()
-    const key2 = newKey()
-    const score1 = 1
-    const member1 = randomUUID()
-    const score2 = 2
-    const member2 = randomUUID()
-
-    await new ZAddCommand(key1, { score: score1, member: member1 }).exec(client)
-    await new ZAddCommand(key2, { score: score2, member: member2 }).exec(client)
-
-    const res = await new ZUnionStoreCommand(destination, 2, [key1, key2]).exec(client)
-    expect(res).toBe(2)
-  })
-})
-
-describe("with weights", () => {
-  describe("single weight", () => {
-    it("returns the number of elements in the new set ", async () => {
-      const destination = newKey()
-      const key1 = newKey()
-      const key2 = newKey()
-      const score1 = 1
-      const member1 = randomUUID()
-      const score2 = 2
-      const member2 = randomUUID()
-
-      await new ZAddCommand(key1, { score: score1, member: member1 }).exec(client)
-      await new ZAddCommand(key2, { score: score2, member: member2 }).exec(client)
-
-      const res = await new ZUnionStoreCommand(destination, 2, [key1, key2], {
-        weights: [2, 3],
-      }).exec(client)
-      expect(res).toBe(2)
-    })
-  })
-  describe("multiple weight", () => {
-    it("returns the number of elements in the new set ", async () => {
-      const destination = newKey()
-      const key1 = newKey()
-      const key2 = newKey()
-      const score1 = 1
-      const member1 = randomUUID()
-      const score2 = 2
-      const member2 = randomUUID()
-
-      await new ZAddCommand(key1, { score: score1, member: member1 }).exec(client)
-      await new ZAddCommand(key2, { score: score2, member: member2 }).exec(client)
-
-      const res = await new ZUnionStoreCommand(destination, 2, [key1, key2], {
-        weights: [1, 2],
-      }).exec(client)
-      expect(res).toBe(2)
-    })
-  })
-})
-describe("aggregate", () => {
-  describe("sum", () => {
-    it("returns the number of elements in the new set ", async () => {
-      const destination = newKey()
-      const key1 = newKey()
-      const key2 = newKey()
-      const score1 = 1
-      const member1 = randomUUID()
-      const score2 = 2
-      const member2 = randomUUID()
-
-      await new ZAddCommand(key1, { score: score1, member: member1 }).exec(client)
-      await new ZAddCommand(key2, { score: score2, member: member2 }).exec(client)
-
-      const res = await new ZUnionStoreCommand(destination, 2, [key1, key2], {
-        aggregate: "sum",
-      }).exec(client)
-      expect(res).toBe(2)
-    })
-  })
-  describe("min", () => {
-    it("returns the number of elements in the new set ", async () => {
-      const destination = newKey()
-      const key1 = newKey()
-      const key2 = newKey()
-      const score1 = 1
-      const member1 = randomUUID()
-      const score2 = 2
-      const member2 = randomUUID()
-
-      await new ZAddCommand(key1, { score: score1, member: member1 }).exec(client)
-      await new ZAddCommand(key2, { score: score2, member: member2 }).exec(client)
-
-      const res = await new ZUnionStoreCommand(destination, 2, [key1, key2], {
-        aggregate: "min",
-      }).exec(client)
-      expect(res).toBe(2)
-    })
-  })
-  describe("max", () => {
-    it("returns the number of elements in the new set ", async () => {
-      const destination = newKey()
-      const key1 = newKey()
-      const key2 = newKey()
-      const score1 = 1
-      const member1 = randomUUID()
-      const score2 = 2
-      const member2 = randomUUID()
-
-      await new ZAddCommand(key1, { score: score1, member: member1 }).exec(client)
-      await new ZAddCommand(key2, { score: score2, member: member2 }).exec(client)
-
-      const res = await new ZUnionStoreCommand(destination, 2, [key1, key2], {
-        aggregate: "max",
-      }).exec(client)
-      expect(res).toBe(2)
-    })
-  })
-})

package/pkg/commands/zunionstore.ts

@@ -1,55 +0,0 @@
-import { Command } from "../command"
-
-export type ZUnionStoreCommandOptions = {
-  aggregate?: "sum" | "min" | "max"
-} & (
-  | {
-      weight: number
-      weights?: never
-    }
-  | {
-      weight?: never
-      weights: number[]
-    }
-  | {
-      weight?: never
-      weights?: never
-    }
-)
-
-/**
- * @see https://redis.io/commands/zunionstore
- */
-export class ZUnionStoreCommand extends Command<number, number> {
-  constructor(destination: string, numKeys: 1, key: string, opts?: ZUnionStoreCommandOptions)
-  constructor(
-    destination: string,
-    numKeys: number,
-    keys: string[],
-    opts?: ZUnionStoreCommandOptions,
-  )
-  constructor(
-    destination: string,
-    numKeys: number,
-    keyOrKeys: string | string[],
-    opts?: ZUnionStoreCommandOptions,
-  ) {
-    const command: unknown[] = ["zunionstore", destination, numKeys]
-    if (Array.isArray(keyOrKeys)) {
-      command.push(...keyOrKeys)
-    } else {
-      command.push(keyOrKeys)
-    }
-    if (opts) {
-      if ("weights" in opts && opts.weights) {
-        command.push("weights", ...opts.weights)
-      } else if ("weight" in opts && typeof opts.weight === "number") {
-        command.push("weights", opts.weight)
-      }
-      if ("aggregate" in opts) {
-        command.push("aggregate", opts.aggregate)
-      }
-    }
-    super(command)
-  }
-}

package/pkg/commands/zz.ts

@@ -1 +0,0 @@
-export const x = 1

package/pkg/error.ts

@@ -1,9 +0,0 @@
-/**
- * Result of a bad request to upstash
- */
-export class UpstashError extends Error {
-  constructor(message: string) {
-    super(message)
-    this.name = "UpstashError"
-  }
-}

package/pkg/fastly.ts

@@ -1,54 +0,0 @@
-import * as core from "./redis"
-import { HttpClient } from "./http"
-
-/**
- * Connection credentials for upstash redis.
- * Get them from https://console.upstash.com/redis/<uuid>
- */
-export type RedisConfigFastly = {
-  /**
-   * UPSTASH_REDIS_REST_URL
-   */
-  url: string
-
-  /**
-   * UPSTASH_REDIS_REST_TOKEN
-   */
-  token: string
-
-  /**
-   * A Request can be forwarded to any backend defined on your service. Backends
-   * can be created via the Fastly CLI, API, or web interface, and are
-   * referenced by name.
-   */
-  backend: string
-}
-
-/**
- * Serverless redis client for upstash.
- */
-export class Redis extends core.Redis {
-  /**
-   * Create a new redis client
-   *
-   * @example
-   * ```typescript
-   *    const redis = new Redis({
-   *        url: "<UPSTASH_REDIS_REST_URL>",
-   *        token: "<UPSTASH_REDIS_REST_TOKEN>",
-   *        backend: "upstash-db",
-   *    });
-   * ```
-   */
-  constructor(config: RedisConfigFastly) {
-    const client = new HttpClient({
-      baseUrl: config.url,
-      headers: {
-        authorization: `Bearer ${config.token}`,
-      },
-      options: { backend: config.backend },
-    })
-
-    super(client)
-  }
-}

package/pkg/http.test.ts

@@ -1,34 +0,0 @@
-import { HttpClient } from "./http"
-
-import { describe, expect, it } from "@jest/globals"
-import { newHttpClient } from "./test-utils"
-it("remove trailing slash from urls", () => {
-  const client = new HttpClient({
-    baseUrl: "https://example.com/",
-  })
-
-  expect(client.baseUrl).toBe("https://example.com")
-})
-
-describe("when the request is invalid", () => {
-  it("throws", async () => {
-    const client = newHttpClient()
-    expect(() =>
-      client.request({
-        body: ["get", "1", "2"],
-      }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot()
-  })
-})
-
-describe("whithout authorization", () => {
-  it("throws", async () => {
-    const client = newHttpClient()
-    client.headers = {}
-    expect(() =>
-      client.request({
-        body: ["get", "1", "2"],
-      }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot()
-  })
-})

package/pkg/http.ts

@@ -1,62 +0,0 @@
-import "isomorphic-fetch"
-import { UpstashError } from "./error"
-
-export type HttpRequest = {
-  path?: string[]
-  /**
-   * Request body will be serialized to json
-   */
-  body?: unknown
-}
-
-export type UpstashResponse<TResult> = {
-  result?: TResult
-  error?: string
-}
-
-export type HttpClientConfig = {
-  headers?: Record<string, string>
-  baseUrl: string
-  options?: {
-    backend?: string
-  }
-}
-
-export class HttpClient {
-  public baseUrl: string
-  public headers: Record<string, string>
-  public readonly options?: { backend?: string }
-
-  public constructor(config: HttpClientConfig) {
-    this.baseUrl = config.baseUrl.replace(/\/$/, "")
-
-    this.headers = {
-      "Content-Type": "application/json",
-      ...config.headers,
-    }
-
-    this.options = config.options
-  }
-
-  public async request<TResponse>(req: HttpRequest): Promise<TResponse> {
-    if (!req.path) {
-      req.path = []
-    }
-
-    // fetch is defined by isomorphic fetch
-    // eslint-disable-next-line no-undef
-    const res = await fetch([this.baseUrl, ...req.path].join("/"), {
-      method: "POST",
-      headers: this.headers,
-      body: JSON.stringify(req.body),
-      // @ts-expect-error
-      backend: this.options?.backend,
-    })
-    const body = await res.json()
-    if (!res.ok) {
-      throw new UpstashError(body.error)
-    }
-
-    return body as TResponse
-  }
-}

package/pkg/index.ts

@@ -1,2 +0,0 @@
-export * from "./nodejs"
-export * from "./error"

package/pkg/nodejs.ts

@@ -1,83 +0,0 @@
-import * as core from "./redis"
-import { HttpClient } from "./http"
-import "isomorphic-fetch"
-
-/**
- * Connection credentials for upstash redis.
- * Get them from https://console.upstash.com/redis/<uuid>
- */
-export type RedisConfigNodejs = {
-  /**
-   * UPSTASH_REDIS_REST_URL
-   */
-  url: string
-
-  /**
-   * UPSTASH_REDIS_REST_TOKEN
-   */
-  token: string
-
-  // requestOptions?: {
-  //   /**
-  //    * **fastly only**
-  //    *
-  //    * A Request can be forwarded to any backend defined on your service. Backends
-  //    * can be created via the Fastly CLI, API, or web interface, and are
-  //    * referenced by name.
-  //    */
-  //   backend?: string
-  // }
-}
-
-/**
- * Serverless redis client for upstash.
- */
-export class Redis extends core.Redis {
-  /**
-   * Create a new redis client
-   *
-   * @example
-   * ```typescript
-   * const redis = new Redis({
-   *  url: "<UPSTASH_REDIS_REST_URL>",
-   *  token: "<UPSTASH_REDIS_REST_TOKEN>",
-   * });
-   * ```
-   */
-  constructor(config: RedisConfigNodejs) {
-    const client = new HttpClient({
-      baseUrl: config.url,
-      headers: {
-        authorization: `Bearer ${config.token}`,
-      },
-    })
-
-    super(client)
-  }
-
-  /**
-   * Create a new Upstash Redis instance from environment variables.
-   *
-   * Use this to automatically load connection secrets from your environment
-   * variables. For instance when using the Vercel integration.
-   *
-   * This tries to load `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` from
-   * your environment using `process.env`.
-   */
-  static fromEnv(): Redis {
-    if (typeof process?.env === "undefined") {
-      throw new Error(
-        "Unable to get environment variables, `process.env` is undefined. If you are deploying to cloudflare, please use `Redis.onCloudflare()` instead",
-      )
-    }
-    const url = process.env["UPSTASH_REDIS_REST_URL"]
-    if (!url) {
-      throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_URL`")
-    }
-    const token = process.env["UPSTASH_REDIS_REST_TOKEN"]
-    if (!token) {
-      throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`")
-    }
-    return new Redis({ url, token })
-  }
-}

package/pkg/pipeline.test.ts

@@ -1,177 +0,0 @@
-import { Pipeline } from "./pipeline"
-import { keygen, newHttpClient } from "./test-utils"
-import { randomUUID } from "crypto"
-import { describe, it, expect, afterEach } from "@jest/globals"
-const client = newHttpClient()
-
-const { newKey, cleanup } = keygen()
-afterEach(cleanup)
-
-describe("with single command", () => {
-  it("works with multiple commands", async () => {
-    const p = new Pipeline(client)
-    p.set(newKey(), randomUUID())
-    const res = await p.exec()
-    expect(res).toHaveLength(1)
-    expect(res[0]).toBe("OK")
-  })
-})
-
-describe("when chaining in a for loop", () => {
-  it("works", async () => {
-    const key = newKey()
-    const res = await new Pipeline(client).set(key, randomUUID()).get(key).exec()
-
-    expect(res).toHaveLength(2)
-  })
-})
-
-describe("when chaining inline", () => {
-  it("works", async () => {
-    const key = newKey()
-    const p = new Pipeline(client)
-    for (let i = 0; i < 10; i++) {
-      p.set(key, randomUUID())
-    }
-
-    const res = await p.exec()
-    expect(res).toHaveLength(10)
-  })
-})
-
-describe("when no commands were added", () => {
-  it("throws", async () => {
-    expect(() => new Pipeline(client).exec()).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"Pipeline is empty"`,
-    )
-  })
-})
-
-describe("when one command throws an error", () => {
-  it("throws", async () => {
-    const p = new Pipeline(client).set("key", "value").hget("key", "field")
-    expect(() => p.exec()).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"Command 2 [ hget ] failed: WRONGTYPE Operation against a key holding the wrong kind of value"`,
-    )
-  })
-})
-
-describe("use all the things", () => {
-  it("works", async () => {
-    const p = new Pipeline(client)
-
-    const persistentKey = newKey()
-    const persistentKey2 = newKey()
-
-    p.append(newKey(), "hello")
-      .bitcount(newKey(), 0, 1)
-      .bitop("and", newKey(), newKey())
-      .bitpos(newKey(), 0, 1)
-      .dbsize()
-      .decr(newKey())
-      .decrby(newKey(), 1)
-      .del(newKey())
-      .echo("hello")
-      .exists(newKey())
-      .expire(newKey(), 5)
-      .expireat(newKey(), Math.floor(new Date().getTime() / 1000) + 60)
-      .flushall()
-      .flushdb()
-      .get(newKey())
-      .getbit(newKey(), 0)
-      .getrange(newKey(), 0, 1)
-      .getset(newKey(), "hello")
-      .hdel(newKey(), "field")
-      .hexists(newKey(), "field")
-      .hget(newKey(), "field")
-      .hgetall(newKey())
-      .hincrby(newKey(), "field", 1)
-      .hincrbyfloat(newKey(), "field", 1.5)
-      .hkeys(newKey())
-      .hlen(newKey())
-      .hmget(newKey(), newKey())
-      .hmset(newKey(), { field: "field", value: "value" })
-      .hscan(newKey(), 0)
-      .hset(newKey(), "field", "value")
-      .hsetnx(newKey(), "field", "value")
-      .hstrlen(newKey(), "field")
-      .hvals(newKey())
-      .incr(newKey())
-      .incrby(newKey(), 1)
-      .incrbyfloat(newKey(), 1.5)
-      .keys("*")
-      .lindex(newKey(), 0)
-      .linsert(newKey(), "before", "pivot", "value")
-      .llen(newKey())
-      .lpop(newKey())
-      .lpush(persistentKey, "element")
-      .lpushx(newKey(), "element1", "element2")
-      .lrange(newKey(), 0, 1)
-      .lrem(newKey(), 1, "value")
-      .lset(persistentKey, "value", 0)
-      .ltrim(newKey(), 0, 1)
-      .mget<[string, string]>(newKey(), newKey())
-      .mset({ key1: "value", key2: "value" })
-      .msetnx({ key3: "value", key4: "value" })
-      .persist(newKey())
-      .pexpire(newKey(), 1000)
-      .pexpireat(newKey(), new Date().getTime() + 1000)
-      .ping()
-      .psetex(newKey(), 1, "value")
-      .pttl(newKey())
-      .randomkey()
-      .rename(persistentKey, persistentKey2)
-      .renamenx(persistentKey2, newKey())
-      .rpop(newKey())
-      .rpush(newKey(), "element1", "element2")
-      .rpushx(newKey(), "element1", "element2")
-      .sadd(newKey(), "memeber1", "member2")
-      .scan(0)
-      .scard(newKey())
-      .sdiff(newKey())
-      .sdiffstore(newKey(), newKey())
-      .set(newKey(), "value")
-      .setbit(newKey(), 1, 1)
-      .setex(newKey(), 1, "value")
-      .setnx(newKey(), "value")
-      .setrange(newKey(), 1, "value")
-      .sinter(newKey(), newKey())
-      .sinterstore(newKey(), newKey())
-      .sismember(newKey(), "member")
-      .smembers(newKey())
-      .smove(newKey(), newKey(), "member")
-      .spop(newKey())
-      .srandmember(newKey())
-      .srem(newKey(), "member")
-      .sscan(newKey(), 0)
-      .strlen(newKey())
-      .sunion(newKey())
-      .sunionstore(newKey(), newKey())
-      .time()
-      .touch()
-      .ttl(newKey())
-      .type(newKey())
-      .unlink()
-      .zadd(newKey(), { score: 0, member: "member" })
-      .zcard(newKey())
-      .zcount(newKey(), 0, 1)
-      .zincrby(newKey(), 1, "member")
-      .zinterstore(newKey(), 1, [newKey()])
-      .zlexcount(newKey(), "-", "+")
-      .zpopmax(newKey())
-      .zpopmin(newKey())
-      .zrange(newKey(), 0, 1)
-      .zrank(newKey(), "member")
-      .zrem(newKey(), "member")
-      .zremrangebylex(newKey(), "-", "+")
-      .zremrangebyrank(newKey(), 0, 1)
-      .zremrangebyscore(newKey(), 0, 1)
-      .zrevrank(newKey(), "member")
-      .zscan(newKey(), 0)
-      .zscore(newKey(), "member")
-      .zunionstore(newKey(), 1, [newKey()])
-
-    const res = await p.exec()
-    expect(res).toHaveLength(107)
-  })
-})