feat: allow passing url to adapter to connect to redis

Author: TillaTheHun0

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+deno task staged

.lintstagedrc.json

@@ -0,0 +1,7 @@
+{
+  "*.{md,json,js,ts}": ["deno fmt"],
+  "README.md": [
+    "deno run -A --no-lock npm:markdown-toc-gen@1 insert",
+    "deno fmt"
+  ]
+}

README.md

@@ -2,43 +2,59 @@
 <p align="center">A Cache port adapter for Redis in the <a href="https://hyper.io/">hyper</a>  service framework</p>
 </p>
 <p align="center">
-  <a href="https://nest.land/package/hyper-adapter-redis"><img src="https://nest.land/badge.svg" alt="Nest Badge" /></a>
   <a href="https://github.com/hyper63/hyper-adapter-redis/actions/workflows/test-and-publish.yml"><img src="https://github.com/hyper63/hyper-adapter-redis/actions/workflows/test-and-publish.yml/badge.svg" alt="Test" /></a>
   <a href="https://github.com/hyper63/hyper-adapter-redis/tags/"><img src="https://img.shields.io/github/tag/hyper63/hyper-adapter-redis" alt="Current Version" /></a>
 </p>
 
 ---
 
-## Table of Contents
+<!-- toc -->
 
 - [Getting Started](#getting-started)
 - [Installation](#installation)
 - [Features](#features)
 - [Methods](#methods)
 - [Contributing](#contributing)
+- [Testing](#testing)
 - [License](#license)
 
+<!-- tocstop -->
+
 ## Getting Started
 
 ```js
-import { default as redis } from 'https://x.nest.land/hyper-adapter-redis@1.2.9/mod.js'
+import { default as redis } from 'https://raw.githubusercontent.com/hyper63/hyper-adapter-redis/v3.1.0/mod.js'
 
 export default {
   app: opine,
   adapter: [
     {
       port: 'cache',
       plugins: [
-        redis({
-          hostname: Deno.env.get('REDIS_HOST'),
-          port: Deno.env.get('REDIS_PORT'), // defaults to 6379
-        }),
+        redis({ url: 'http://user@[email protected]:6379' }),
       ],
     },
   ],
 }
 ```
 
+You can also pass a separate `hostname` and `port` to the adapter:
+
+```js
+redis({ hostname: 'redis.host', port: 6380 }),
+```
+
+> `port` will always default to `6379` if not provided, then `443` if the `url` protocol is `https`
+> then finally `80`
+
+To connect to a Redis Cluster, pass the `cluster` flag:
+
+```js
+redis({ url: 'http://user@[email protected]:6379', cluster: true })
+```
+
+The adapter will automatically discover all nodes in the Cluster.
+
 ## Installation
 
 This is a Deno module available to import from
@@ -47,7 +63,7 @@ This is a Deno module available to import from
 deps.js
 
 ```js
-export { default as redis } from 'https://x.nest.land/hyper-adapter-redis@1.2.9/mod.js'
+export { default as redis } from 'https://raw.githubusercontent.com/hyper63/hyper-adapter-redis/v3.1.0/mod.js'
 ```
 
 ## Features

adapter.js

@@ -41,23 +41,20 @@ const mapTtl = (ttl) =>
 /**
  * @typedef Options
  * @property {number} scanCount
+ * @property {any} client
  *
- * @param {*} client
  * @param {Options} options
- * @returns
  */
-export default function (client, options) {
+export default function ({ redis, scanCount }) {
   // redis commands
   // key: Promise<string>
-  const get = Async.fromPromise(client.get.bind(client))
+  const get = Async.fromPromise(redis.get.bind(redis))
   // key, value, { px, ex }: Promise<string>
-  const set = Async.fromPromise(client.set.bind(client))
+  const set = Async.fromPromise(redis.set.bind(redis))
   // key, key, key: Promise<string[]>
-  const del = Async.fromPromise(client.del.bind(client))
+  const del = Async.fromPromise(redis.del.bind(redis))
   // cursor, { type, pattern }: Promise<[string, string[]]>
-  const scan = Async.fromPromise(client.scan.bind(client))
-
-  const { scanCount } = options
+  const scan = Async.fromPromise(redis.scan.bind(redis))
 
   const index = () => {
     return Promise.resolve(HyperErr({ status: 501, msg: 'Not Implemented' }))

adapter.test.js

@@ -11,9 +11,7 @@ const baseStubClient = {
   scan: resolves(),
 }
 
-const baseOptions = { scanCount: 100 }
-
-const createAdapter = (client, options) => cachePort(factory(client, options))
+const createAdapter = (redis) => cachePort(factory({ redis, scanCount: 100 }))
 
 Deno.test('adapter', async (t) => {
   await t.step('listDocs', async (t) => {
@@ -33,7 +31,7 @@ Deno.test('adapter', async (t) => {
         ...baseStubClient,
         get: resolves(JSON.stringify({ bam: 'baz' })),
         scan,
-      }, baseOptions)
+      })
 
       results = await adapter.listDocs({
         store: 'word',
@@ -58,7 +56,7 @@ Deno.test('adapter', async (t) => {
         ...baseStubClient,
         get: resolves(JSON.stringify(doc)),
         scan: resolves(['0', ['key']]),
-      }, baseOptions)
+      })
 
       const result = await adapter.listDocs({
         store: 'foo',
@@ -73,7 +71,7 @@ Deno.test('adapter', async (t) => {
 
   await t.step('createStore', async (t) => {
     await t.step('should create a logical keyspace in redis', async () => {
-      const adapter = createAdapter(baseStubClient, baseOptions)
+      const adapter = createAdapter(baseStubClient)
 
       const result = await adapter.createStore('foo')
       assert(result.ok)
@@ -83,7 +81,7 @@ Deno.test('adapter', async (t) => {
       const adapter = createAdapter({
         ...baseStubClient,
         get: resolves(undefined), // looking up store produces undefined
-      }, baseOptions)
+      })
 
       const err = await adapter.createDoc({
         store: 'foo',
@@ -106,7 +104,7 @@ Deno.test('adapter', async (t) => {
         ...baseStubClient,
         del,
         scan: resolves(['0', []]),
-      }, baseOptions)
+      })
 
       const result = await adapter.destroyStore('foo')
 
@@ -123,7 +121,7 @@ Deno.test('adapter', async (t) => {
           ...baseStubClient,
           del,
           scan: resolves(['0', ['{foo}_baz', '{foo}_bar']]),
-        }, baseOptions)
+        })
 
         const result = await adapter.destroyStore('foo')
 
@@ -149,7 +147,7 @@ Deno.test('adapter', async (t) => {
           k === 'store_foo'
             ? Promise.resolve(JSON.stringify({ active: true }))
             : Promise.resolve(null),
-      }, baseOptions)
+      })
 
       const result = await adapter.createDoc({
         store: 'foo',
@@ -171,7 +169,7 @@ Deno.test('adapter', async (t) => {
             k === 'store_foo'
               ? Promise.resolve(JSON.stringify({ active: true })) // store
               : Promise.resolve(JSON.stringify({ foo: 'bar' })), // doc already exists
-        }, baseOptions)
+        })
 
         const err = await adapter.createDoc({
           store: 'foo',
@@ -201,7 +199,7 @@ Deno.test('adapter', async (t) => {
             k === 'store_foo'
               ? Promise.resolve(JSON.stringify({ foo: 'bar' }))
               : Promise.resolve(undefined), // not found
-        }, baseOptions)
+        })
 
         await adapter.createDoc({
           store: 'foo',
@@ -235,7 +233,7 @@ Deno.test('adapter', async (t) => {
             ? Promise.resolve(JSON.stringify({ active: true })) // store
             : (assertEquals(k, '{foo}_bar'), Promise.resolve(JSON.stringify(value)))
         },
-      }, baseOptions)
+      })
 
       const result = await adapter.getDoc({
         store: 'foo',
@@ -252,7 +250,7 @@ Deno.test('adapter', async (t) => {
           k === 'store_foo'
             ? Promise.resolve(JSON.stringify({ foo: 'bar' }))
             : Promise.resolve(undefined),
-      }, baseOptions)
+      })
 
       const err = await adapter.getDoc({
         store: 'foo',
@@ -281,15 +279,14 @@ Deno.test('adapter', async (t) => {
           k === 'store_foo'
             ? Promise.resolve(JSON.stringify({ active: true }))
             : Promise.resolve(undefined),
-      }, baseOptions)
+      })
 
       const result = await adapter.updateDoc({
         store: 'foo',
         key: 'bar',
         value: { hello: 'world' },
         ttl: String(123),
       })
-      console.log(result)
       assert(result.ok)
     })
 
@@ -306,7 +303,7 @@ Deno.test('adapter', async (t) => {
             k === 'store_foo'
               ? Promise.resolve(JSON.stringify({ foo: 'bar' }))
               : Promise.resolve(undefined), // not found
-        }, baseOptions)
+        })
 
         await adapter.updateDoc({
           store: 'foo',
@@ -334,7 +331,7 @@ Deno.test('adapter', async (t) => {
       const adapter = createAdapter({
         ...baseStubClient,
         get: (k) => k === 'store_foo' ? Promise.resolve('{"active": true}') : Promise.resolve(null),
-      }, baseOptions)
+      })
 
       const result = await adapter.deleteDoc({
         store: 'foo',

deno.jsonc

@@ -1,5 +1,7 @@
 {
   "tasks": {
+    "prepare": "deno run -A npm:husky@^8 install",
+    "staged": "deno run -A npm:lint-staged@^13",
     "cache": "deno cache --lock=deno.lock --lock-write deps.js dev_deps.js",
     "test": "deno lint && deno fmt --check && deno test -A --unstable --no-check",
     "test:suite": "deno test --allow-net --allow-env --no-check --no-lock --import-map=https://raw.githubusercontent.com/hyper63/hyper/hyper-test%40v2.1.4/packages/test/import_map.json https://raw.githubusercontent.com/hyper63/hyper/hyper-test%40v2.1.4/packages/test/mod.js",