Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update ioredis to v5, make it a devDependency of the cache packages #172

Merged
merged 1 commit into from
Apr 11, 2022

Conversation

ide
Copy link
Member

@ide ide commented Apr 10, 2022

Why

ioredis v5 ships with its own TypeScript declarations. The breaking changes from v4 to v5 affect the code that instantiates ioredis, not the code that uses it. As such, I believe that entity is still technically compatible with ioredis v4, but for the sake of keeping our test matrix smaller, this commit uses just ioredis v5 in tests and makes v5 a peer dependency of entity-cache-adapter-redis.

Additionally ioredis was a dependency of entity-cache-adapter-redis. I changed it to a devDependency and changed the import to import type since the package is used only for type checking.

ioredis v5.0.0 changelog: https://github.com/luin/ioredis/releases/tag/v5.0.0. Notably it drops support for Node 10 and for custom Promise libraries, neither of which we use.

Test Plan

Building all packages (yarn) and testing them (yarn test) with Lerna succeeds

@ide ide requested a review from wschurman as a code owner April 10, 2022 18:56
@codecov
Copy link

codecov bot commented Apr 10, 2022

Codecov Report

Merging #172 (d77714e) into master (9c44e8e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #172   +/-   ##
=======================================
  Coverage   96.14%   96.14%           
=======================================
  Files          80       80           
  Lines        1972     1972           
  Branches      209      209           
=======================================
  Hits         1896     1896           
  Misses         75       75           
  Partials        1        1           
Flag Coverage Δ
integration 96.14% <ø> (ø)
unittest 96.14% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...ntity-cache-adapter-redis/src/RedisCacheAdapter.ts 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9c44e8e...d77714e. Read the comment docs.

…ages

Why: ioredis v5 ships with its own TypeScript declarations. The breaking changes from v4 to v5 affect the code that instantiates ioredis, not the code that uses it. As such, I believe that entity is still technically compatible with ioredis v4, but for the sake of keeping our test matrix smaller, this commit uses just ioredis v5 in tests and makes v5 a peer dependency of `entity-cache-adapter-redis`.

Additionally ioredis was a dependency of `entity-cache-adapter-redis`. I changed it to a devDependency and changed the import to `import type` since the package is used only for type checking.

ioredis v5.0.0 changelog: https://github.com/luin/ioredis/releases/tag/v5.0.0. Notable it drops support for Node 10 and for custom Promise libraries, neither of which we use.

Test Plan: building all packages and testing them with Lerna succeeds
@ide ide merged commit 9fcfbf7 into master Apr 11, 2022
@ide ide deleted the @ide/redis branch April 11, 2022 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants