diff --git a/packages/redis-next/package.json b/packages/redis-next/package.json index a28c512f4..60d7225c0 100644 --- a/packages/redis-next/package.json +++ b/packages/redis-next/package.json @@ -3,10 +3,13 @@ "version": "2.5.4", "description": "Redis storage adapter for Keyv", "main": "src/index.js", + "types": "src/index.d.ts", "scripts": { - "test": "xo && c8 ava --serial", - "test:ci": "xo && ava --serial", - "clean": "rm -rf node_modules && rm -rf ./coverage" + "test": "yarn build && xo && c8 ava --serial", + "test:ci": "yarn build && xo && ava --serial", + "build": "tsc", + "prepublishOnly": "yarn build", + "clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./dist" }, "xo": { "rules": { @@ -72,7 +75,6 @@ "tsd": { "directory": "test" }, - "types": "./src/index.d.ts", "engines": { "node": ">= 12" }, diff --git a/packages/redis-next/src/index.d.ts b/packages/redis-next/src/index.d.ts deleted file mode 100644 index 3882bb89c..000000000 --- a/packages/redis-next/src/index.d.ts +++ /dev/null @@ -1,31 +0,0 @@ -/* eslint-disable @typescript-eslint/consistent-type-definitions */ -import {EventEmitter} from 'events'; -import type{Store, StoredData} from 'keyv'; -import type{Redis, Cluster} from 'ioredis'; - -declare class KeyvRedis extends EventEmitter implements Store { - readonly ttlSupport: false; - namespace?: string | undefined; - opts: Record; - redis: any; - constructor(options?: KeyvRedis.Options | Redis | Cluster); - constructor(uri: string | Redis | Cluster, options?: KeyvRedis.Options); - get(key: string): Promise; - getMany?( - keys: string[] - ): Array> | Promise>> | undefined; - set(key: string, value: Value, ttl?: number): any; - delete(key: string): boolean | Promise; - deleteMany(keys: string[]): boolean; - clear(): void | Promise; - iterator(namespace: string | undefined): AsyncGenerator; - has?(key: string): boolean | Promise; - disconnect(): void; -} -declare namespace KeyvRedis { - interface Options { - uri?: string | undefined; - dialect?: string | undefined; - } -} -export = KeyvRedis; diff --git a/packages/redis-next/test/test-next.js b/packages/redis-next/test/test-next.js new file mode 100644 index 000000000..fb99786fb --- /dev/null +++ b/packages/redis-next/test/test-next.js @@ -0,0 +1,110 @@ +const test = require('ava'); +const keyvTestSuite = require('@keyv/test-suite').default; +const {keyvOfficialTests, keyvIteratorTests} = require('@keyv/test-suite'); +const Keyv = require('keyv'); +const Redis = require('ioredis'); +const KeyvRedis = require('../dist/index.js'); + +const REDIS_HOST = 'localhost'; +const redisURI = `redis://${REDIS_HOST}`; + +keyvOfficialTests(test, Keyv, redisURI, 'redis://foo'); + +const store = () => new KeyvRedis(redisURI); + +keyvTestSuite(test, Keyv, store); +keyvIteratorTests(test, Keyv, store); + +test('reuse a redis instance', async t => { + const redis = new Redis(redisURI); + redis.foo = 'bar'; + const keyv = new KeyvRedis(redis); + t.is(keyv.redis.foo, 'bar'); + + await keyv.set('foo', 'bar'); + const value = await redis.get('foo'); + t.true(value === 'bar'); + t.true(await keyv.get('foo') === value); +}); + +test('set an undefined key', async t => { + const redis = new Redis(redisURI); + const keyv = new KeyvRedis(redis); + + await keyv.set('foo2', undefined); + const result = await keyv.get('foo2'); + t.true(result === undefined); +}); + +test.serial('Async Iterator 0 element test', async t => { + const redis = new Redis(redisURI); + const keyv = new KeyvRedis(redis); + await keyv.clear(); + const iterator = keyv.iterator('keyv'); + const key = await iterator.next(); + t.is(key.value, undefined); +}); + +test.serial('close connection successfully', async t => { + const redis = new Redis(redisURI); + const keyv = new KeyvRedis(redis); + t.is(await keyv.get('foo'), undefined); + await keyv.disconnect(); + try { + await keyv.get('foo'); + t.fail(); + } catch { + t.pass(); + } +}); + +test('should support tls', async t => { + const options = {tls: {rejectUnauthorized: false}}; + const redis = new Redis('rediss://localhost:6380', options); + const keyvRedis = new KeyvRedis(redis); + await keyvRedis.set('foo', 'bar'); + t.true(await keyvRedis.get('foo') === 'bar'); +}); + +test('close tls connection successfully', async t => { + const options = {tls: {rejectUnauthorized: false}}; + const redis = new Redis('rediss://localhost:6380', options); + const keyvRedis = new KeyvRedis(redis); + t.is(await keyvRedis.get('foo5'), undefined); + await keyvRedis.disconnect(); + try { + await keyvRedis.get('foo5'); + t.fail(); + } catch { + t.pass(); + } +}); + +test('.clear cleaned namespace', async t => { + // Setup + const keyv = new Keyv(redisURI, { + adapter: 'redis', + namespace: 'v3', + }); + + const length = 1; + const key = [...Array.from({length}).keys()].join(''); + + await keyv.set(key, 'value', 1); + + await new Promise(r => { + setTimeout(r, 250); + }); + + await keyv.clear(); + await keyv.disconnect(); + + // Test + const redis = new Redis(redisURI); + + // Namespace should also expire after calling clear + t.true(await redis.exists('namespace:v3') === 0); + + // Memory of each key should be null + t.true(await redis.memory('USAGE', 'namespace:v3') === null); +}); diff --git a/packages/redis-next/tsconfig.json b/packages/redis-next/tsconfig.json new file mode 100644 index 000000000..c203b6ae8 --- /dev/null +++ b/packages/redis-next/tsconfig.json @@ -0,0 +1,106 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": [ + "src/**/*" + ], +}