#1983 - Changed Redis client to ioredis for local development

[andrewsignori-aot]

While using the standalone mode (local development only) the configuration used was meant to be used by ioredis client but it was configured to use redis client. For reference only, this is the method on the Typeorm source code where the initialization of the specific client happens: https://github.com/typeorm/typeorm/blob/master/src/cache/RedisQueryResultCache.ts#L50
This is the Typeorm documention that states that the connection can happen using redis or ioredis client: https://orkhan.gitbook.io/typeorm/docs/caching

Expected by redis client

As shown below, the redis client requires a socket configuration. because the information about the host/port was not properly provided to redis client the connectivity was established on localhost:6379 by default, which explains why it was working from our localhost ad failing from the docker-compose.
redis client configuration options: https://github.com/redis/node-redis/blob/master/docs/client-configuration.md

 if (config.redis.redisStandaloneMode) {
  return {
    type: "redis",
    options: {
      socket: {
        host: config.redis.redisHost,
        port: config.redis.redisPort,
      },
      password: config.redis.redisPassword,
    },
    duration: ORM_CACHE_LIFETIME,
  };
}

Expected by ioredis client

ioredis configuration options: https://github.com/luin/ioredis/blob/v4/API.md#new-redisport-host-options

if (config.redis.redisStandaloneMode) {
  return {
    type: "ioredis",
    options: {
      host: config.redis.redisHost,
      port: config.redis.redisPort,
      password: config.redis.redisPassword,
    },
    duration: ORM_CACHE_LIFETIME,
  };
}

Why use ioredis client?

ioredis is also a Bull Queue framework dependency and it is also already used for the cluster mode, so it seems better to just use the same client for the standalone connection.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[github-actions]

Backend Unit Tests Coverage Report

Totals
Statements:	17.92% ( 2092 / 11673 )
Methods:	8.23% ( 123 / 1494 )
Lines:	20.7% ( 1833 / 8854 )
Branches:	10.26% ( 136 / 1325 )

[github-actions]

E2E Workflow Workers Coverage Report

Totals
Statements:	49.81% ( 267 / 536 )
Methods:	41.56% ( 32 / 77 )
Lines:	55.33% ( 218 / 394 )
Branches:	26.15% ( 17 / 65 )

[github-actions]

E2E Queue Consumers Coverage Report

Totals
Statements:	69.4% ( 390 / 562 )
Methods:	59.15% ( 42 / 71 )
Lines:	71.52% ( 344 / 481 )
Branches:	40% ( 4 / 10 )

[github-actions]

E2E SIMS API Coverage Report

Totals
Statements:	43.54% ( 3042 / 6986 )
Methods:	37.65% ( 340 / 903 )
Lines:	48.62% ( 2535 / 5214 )
Branches:	19.22% ( 167 / 869 )

[andrepestana-aot]

Good catch!

[ann-aot]

👍 Good catch

[sh16011993]

Good catch, LGTM 👍

[dheepak-aot]

Great catch and thanks for the fix.

As discussed we can make a recommendation to typeorm to update their documentation as it was misleading.

[guru-aot]

Great find before deploying to prod @andrewsignori-aot :)