Impossible to set Redis config

[Ilshidur]

First of all, I really like your lib. Keep up the good work !

I'm facing issues when trying to set the Redis cache options.
I got this :

this.api = new KindredApi.Kindred({
  key: apiKey,
  defaultRegion: region,
  debug: !prod,
  showKey: true,
  showHeaders: false,
  limits: prod ? KindredApi.LIMITS.PROD : KindredApi.LIMITS.DEV,
  spread: false,
  retryOptions: {
    auto: true,
    numberOfRetriesBeforeBreak: 3,
  },
  timeout: 5000,
  cache: new KindredApi.RedisCache({ // Problem here, I can't set the options
    host: cache.redis.host || 'localhost',
    port: cache.redis.port || 6379,
    keyPrefix: cache.redis.prefix || 'league-tooltips_',
  }),
  cacheTTL: {
    STATIC: cache.TTL,
  },
});

The problem is that it is impossible to set the Redis config I want. They always get overridden by your default config. See here. Your code behaves this way : whatever the user gives, the default options are overriding it.

The way to fix this is to change the line to this :

var options = Object.assign({
  host: '127.0.0.1',
  port: 6379,
  keyPrefix: 'kindredAPI-'
}, opts || {});

The second problem is that the Wiki needs more docs about the RedisCache options. I had to dig in the lib code.

If you don't have the time to fix this, I can send you a PR with the fixed code :)

[Ilshidur]

Submitted a pull request.

[cnguy]

@Ilshidur

Hey, sorry about that actually. I completely forgot about the Redis options even though I knew it was a problem (I always had my redis stuffs on default so I forgot about it being an issue). I'll check out your PR.

[Ilshidur]

No problem ! I can also help you to write the RedisCache docs if necessary ;-)

[cnguy]

@Ilshidur

If you want to, I'd appreciate it. If anything, I'll write it by the end of the day.

[cnguy]

@Ilshidur To run the tests, also set KEY_TO_RATE_LIMIT to your dev key (there's a test that mocks the 429 retries until successful). I'll add this to docs as well (Contributing?).

edit: I also have to update this test now that the rate limit has changed.

published to 2.0.74

Updated Wiki Docs to show current Redis options (https://github.com/ChauTNguyen/kindred-api/wiki/Caching#redis-cache-example) and also updated the README to have a small configurable Redis example in the README Introduction section.

[Ilshidur]

Awesome ! Closing the issue, since you solved it :)