Support esModuleInterop set to false. (#1717)

* Support esModuleInterop set to false.

When testing the upcoming 4.x release, we got a bunch of typescript
errors emitted from this project.

We quickly realized this is because the library uses the esModuleInterop
flag. This makes some imports _slightly_ easier to write, but it comes
at a cost: it forces any application or library using this library to
*also* have esModuleInterop on.

The `esModuleInterop` flag is a bit of a holdover from an earlier time,
and I would not recommend using it in libraries. The main issue is that
if it's set to true, you are forcing any users of the library to also
have `esModuleInterop`, where if you keep have it set to `false` (the
default), you leave the decision to the user.

This change should have no rammifications to users with
`esModuleInterop` on, but it will enable support for those that have it
off.

This is especially good for library authors such as myself, because I
would also like to keep this flag off to not force *my* users into this
feature.

* All tests now pass!

* Move @types/redis-parser into client sub-package

and removed a comma

Author: evert

package-lock.json

@@ -1,8 +1,12 @@
-import LinkedList from 'yallist';
-import RedisParser from 'redis-parser';
+import * as LinkedList from 'yallist';
 import { AbortError } from '../errors';
 import { RedisCommandArguments, RedisCommandRawReply } from '../commands';
 
+// We need to use 'require', because it's not possible with Typescript to import
+// classes that are exported as 'module.exports = class`, without esModuleInterop
+// set to true.
+const RedisParser = require('redis-parser');
+
 export interface QueueCommandOptions {
     asap?: boolean;
     chainId?: symbol;

packages/client/lib/client/commands-queue.ts

@@ -4,7 +4,7 @@ import RedisSocket, { RedisSocketOptions, RedisNetSocketOptions, RedisTlsSocketO
 import RedisCommandsQueue, { PubSubListener, PubSubSubscribeCommands, PubSubUnsubscribeCommands, QueueCommandOptions } from './commands-queue';
 import RedisClientMultiCommand, { RedisClientMultiCommandType } from './multi-command';
 import { RedisMultiQueuedCommand } from '../multi-command';
-import EventEmitter from 'events';
+import { EventEmitter } from 'events';
 import { CommandOptions, commandOptions, isCommandOptions } from '../command-options';
 import { ScanOptions, ZMember } from '../commands/generic-transformers';
 import { ScanCommandOptions } from '../commands/SCAN';

packages/client/lib/client/index.ts

@@ -1,6 +1,6 @@
-import EventEmitter from 'events';
-import net from 'net';
-import tls from 'tls';
+import { EventEmitter } from 'events';
+import * as net from 'net';
+import * as tls from 'tls';
 import { encodeCommand } from '../commander';
 import { RedisCommandArguments } from '../commands';
 import { ConnectionTimeoutError, ClientClosedError, SocketClosedUnexpectedlyError } from '../errors';

packages/client/lib/client/socket.ts

@@ -1,9 +1,13 @@
-import calculateSlot from 'cluster-key-slot';
 import RedisClient, { InstantiableRedisClient, RedisClientType } from '../client';
 import { RedisClusterMasterNode, RedisClusterReplicaNode } from '../commands/CLUSTER_NODES';
 import { RedisClusterClientOptions, RedisClusterOptions } from '.';
 import { RedisModules, RedisScripts } from '../commands';
 
+// We need to use 'require', because it's not possible with Typescript to import
+// function that are exported as 'module.exports = function`, without esModuleInterop
+// set to true.
+const calculateSlot = require('cluster-key-slot');
+
 export interface ClusterNode<M extends RedisModules, S extends RedisScripts> {
     id: string;
     client: RedisClientType<M, S>;

packages/client/lib/cluster/cluster-slots.ts

@@ -1,9 +1,13 @@
 import { strict as assert } from 'assert';
 import testUtils, { GLOBAL } from '../test-utils';
-import calculateSlot from 'cluster-key-slot';
 import { ClusterSlotStates } from '../commands/CLUSTER_SETSLOT';
 import { SQUARE_SCRIPT } from '../client/index.spec';
 
+// We need to use 'require', because it's not possible with Typescript to import
+// function that are exported as 'module.exports = function`, without esModuleInterop
+// set to true.
+const calculateSlot = require('cluster-key-slot');
+
 describe('Cluster', () => {
     testUtils.testWithCluster('sendCommand', async cluster => {
         await cluster.connect();

packages/client/lib/cluster/index.spec.ts

@@ -20,6 +20,7 @@
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@redis/test-utils": "*",
     "@types/node": "^16.11.7",
+    "@types/redis-parser": "^3.0.0",
     "@types/sinon": "^10.0.6",
     "@types/yallist": "^4.0.1",
     "@typescript-eslint/eslint-plugin": "^5.3.1",

packages/client/lib/ts-declarations/redis-parser.d.ts

@@ -3,7 +3,7 @@ import { once } from 'events';
 import { RedisModules, RedisScripts } from '@redis/client/lib/commands';
 import RedisClient, { RedisClientType } from '@redis/client/lib/client';
 import { promiseTimeout } from '@redis/client/lib/utils';
-import path from 'path';
+import * as path from 'path';
 import { promisify } from 'util';
 import { exec } from 'child_process';
 const execAsync = promisify(exec);

packages/client/package.json

@@ -3,11 +3,11 @@
   "compilerOptions": {
     "declaration": true,
     "allowJs": true,
-    "useDefineForClassFields": true
+    "useDefineForClassFields": true,
+    "esModuleInterop": false
   },
   "files": [
-    "./packages/client/lib/ts-declarations/cluster-key-slot.d.ts",
-    "./packages/client/lib/ts-declarations/redis-parser.d.ts"
+    "./packages/client/lib/ts-declarations/cluster-key-slot.d.ts"
   ],
   "ts-node": {
     "files": true