fix: parse numbers larger than MAX_SAFE_INTEGER as string (#39)

* fix: parse numbers larger than MAX_SAFE_INTEGER as string

* feat: custom deserializer and docs

.github/README.md

@@ -206,12 +206,26 @@ For more information about pipelines using REST see [here](https://blog.upstash.
 
 ### Advanced
 
-Low level `Command` classes can be imported from `@upstash/redis/commands`.
-In case you need more control about types and or (de)serialization, please use a `Command`-class directly.
+A low level `Command` class can be imported from `@upstash/redis/commands` inn case you need more control about types and or (de)serialization.
+
+By default all objects you are storing in redis are serialized using `JSON.stringify` and recursively deserialized as well. Here's an example how you could customize that behaviour:
 
 ```ts
+import { Command } from "@upstash/redis/commands"
 import { HttpClient} from "@upstash/redis/http"
-import { GetCommand} from "@upstash/redis/commands"
+
+/**
+ * TData represents what the user will enter or receive,
+ * TResult is the raw data returned from upstash, which may need to be
+ * transformed or parsed.
+ */
+const deserialize: (raw: TResult) => TData = ...
+
+class CustomGetCommand<TData, TResult> extends Command<TData | null, TResult | null> {
+  constructor(key: string, ) {
+    super(["get", key], { deserialize })
+  }
+}
 
 const client = new HttpClient({
   baseUrl: <UPSTASH_REDIS_REST_URL>,
@@ -220,11 +234,23 @@ const client = new HttpClient({
   },
 })
 
-const get = new GetCommand<OptionalCustomType>("key")
+const res = new CustomGetCommand("key").exec(client)
 
-const data = await get.exec(client)
 ```
 
+#### Javascript MAX_SAFE_INTEGER
+
+Unfortunately javascript can not handle numbers larger than `2^53 -1` safely and would return wrong results.
+In these cases the default deserializer will return them as string instead. This might cause a mismatch with your custom types.
+
+```ts
+await redis.set("key", "101600000000150081467")
+const res = await redis<number>("get")
+```
+
+In this example `res` will still be a string despite the type annotation.
+Please keep that in mind and adjust accordingly.
+
 ## Docs
 
 See [the documentation](https://docs.upstash.com/features/javascriptsdk) for details.

pkg/commands/append.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/append

pkg/commands/bitcount.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/bitcount

pkg/commands/bitop.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/bitop

pkg/commands/bitpos.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/bitpos

pkg/commands/command.test.ts

@@ -0,0 +1,21 @@
+import { Command } from "./command"
+import { keygen, newHttpClient } from "../test-utils"
+import { randomUUID } from "crypto"
+import { describe, it, expect, afterAll } from "@jest/globals"
+const client = newHttpClient()
+
+const { newKey, cleanup } = keygen()
+afterAll(cleanup)
+
+describe("deserialize large numbers", () => {
+  it("returns the correct number", async () => {
+    const key = newKey()
+    const field = randomUUID()
+    const value = "101600000000150081467"
+
+    await new Command(["hset", key, field, value]).exec(client)
+
+    const res = await new Command(["hget", key, field]).exec(client)
+    expect(res).toEqual(value)
+  })
+})

pkg/command.ts → pkg/commands/command.ts

@@ -1,14 +1,14 @@
-import { UpstashError } from "./error"
-import { HttpClient, UpstashResponse } from "./http"
-import { parseResponse } from "./util"
+import { UpstashError } from "../error"
+import { HttpClient, UpstashResponse } from "../http"
+import { parseResponse } from "../util"
 
 /**
  * Command offers default (de)serialization and the exec method to all commands.
  *
  * TData represents what the user will enter or receive,
  * TResult is the raw data returned from upstash, which may need to be transformed or parsed.
  */
-export abstract class Command<TData, TResult> {
+export class Command<TData, TResult> {
   public readonly command: string[]
   public deserialize: (result: TResult) => TData
   /**

pkg/commands/dbsize.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/dbsize

pkg/commands/decr.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/decr

pkg/commands/decrby.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/decrby

pkg/commands/del.ts

@@ -1,5 +1,5 @@
 import { NonEmptyArray } from "../types"
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/del

pkg/commands/echo.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/echo

pkg/commands/exists.ts

@@ -1,5 +1,5 @@
 import { NonEmptyArray } from "../types"
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/exists

pkg/commands/expire.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/expire

pkg/commands/expireat.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/expireat

pkg/commands/flushall.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 /**
  * @see https://redis.io/commands/flushall
  */

pkg/commands/flushdb.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 /**
  * @see https://redis.io/commands/flushdb
  */

pkg/commands/get.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/get

pkg/commands/getbit.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/getbit

pkg/commands/getrange.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/getrange

pkg/commands/getset.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/getset

pkg/commands/hdel.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hdel

pkg/commands/hexists.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hexists

pkg/commands/hget.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hget

pkg/commands/hgetall.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  *

pkg/commands/hincrby.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hincrby

pkg/commands/hincrbyfloat.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hincrbyfloat

pkg/commands/hkeys.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hkeys

pkg/commands/hlen.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hlen

pkg/commands/hmget.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 function deserialize<TData extends Record<string, unknown>>(
   fields: string[],

pkg/commands/hmset.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hmset

pkg/commands/hscan.ts

@@ -1,5 +1,5 @@
 import { ScanCommandOptions } from "./scan"
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hscan

pkg/commands/hset.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hset

pkg/commands/hsetnx.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hsetnx

pkg/commands/hstrlen.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hstrlen

pkg/commands/hvals.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/hvals

pkg/commands/incr.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/incr

pkg/commands/incrby.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/incrby

pkg/commands/incrbyfloat.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/incrbyfloat

pkg/commands/index.ts

@@ -2,6 +2,7 @@ export * from "./append"
 export * from "./bitcount"
 export * from "./bitop"
 export * from "./bitpos"
+export * from "./command"
 export * from "./dbsize"
 export * from "./decr"
 export * from "./decrby"

pkg/commands/keys.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/keys

pkg/commands/lindex.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 export class LIndexCommand<TData = string> extends Command<TData | null, unknown | null> {
   constructor(key: string, index: number) {

pkg/commands/linsert.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 export class LInsertCommand<TData = string> extends Command<number, number> {
   constructor(key: string, direction: "before" | "after", pivot: TData, value: TData) {
     super(["linsert", key, direction, pivot, value])

pkg/commands/llen.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/llen

pkg/commands/lpop.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/lpop

pkg/commands/lpush.ts

@@ -1,5 +1,5 @@
 import { NonEmptyArray } from "../types"
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/lpush

pkg/commands/lpushx.ts

@@ -1,5 +1,5 @@
 import { NonEmptyArray } from "../types"
-import { Command } from "../command"
+import { Command } from "./command"
 
 /**
  * @see https://redis.io/commands/lpushx

pkg/commands/lrange.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 export class LRangeCommand<TData = string> extends Command<TData[], unknown[]> {
   constructor(key: string, start: number, end: number) {

pkg/commands/lrem.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 export class LRemCommand<TData> extends Command<number, number> {
   constructor(key: string, count: number, value: TData) {
     super(["lrem", key, count, value])

pkg/commands/lset.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 export class LSetCommand<TData = string> extends Command<"OK", "OK"> {
   constructor(key: string, value: TData, index: number) {

pkg/commands/ltrim.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 
 export class LTrimCommand extends Command<"OK", "OK"> {
   constructor(key: string, start: number, end: number) {

pkg/commands/mget.ts

@@ -1,4 +1,4 @@
-import { Command } from "../command"
+import { Command } from "./command"
 /**
  * @see https://redis.io/commands/mget
  */