feat(*): make redis required (#2030)

BREAKING CHANGE: a working Redis instance is now required

Author: garrappachc

.github/workflows/test.yml

@@ -53,6 +53,11 @@ jobs:
         ports:
           - 27017:27017
 
+      redis:
+        image: redis:7-alpine
+        ports:
+          - 6379:6379
+
       gameserver1:
         image: tf2pickuppl/tf2-gameserver
         ports:
@@ -110,6 +115,7 @@ jobs:
         CLIENT_URL: 'http://localhost:4200'
         BOT_NAME: 'tf2pickup.pl'
         MONGODB_URI: 'mongodb://localhost:27017/tf2pickuppl_e2e_tests'
+        REDIS_URL: 'redis://localhost:6379'
         STEAM_API_KEY: 'FAKE_API_KEY'
         KEY_STORE_PASSPHRASE: 'a_password'
         SUPER_USER: '76561199195756652'
@@ -138,6 +144,11 @@ jobs:
         ports:
           - 27017:27017
 
+      redis:
+        image: redis:7-alpine
+        ports:
+          - 6379:6379
+
     steps:
     - name: Checkout repository
       uses: actions/checkout@v3
@@ -158,6 +169,7 @@ jobs:
         CLIENT_URL: 'http://localhost:4200'
         BOT_NAME: 'tf2pickup.pl'
         MONGODB_URI: 'mongodb://localhost:27017/tf2pickuporg_fresh'
+        REDIS_URL: 'redis://localhost:6379'
         STEAM_API_KEY: 'FAKE_API_KEY'
         KEY_STORE_PASSPHRASE: 'a_password'
         SUPER_USER: '76561199195756652'

package.json

@@ -33,7 +33,6 @@
     "app-root-path": "3.1.0",
     "async-mutex": "0.4.0",
     "cache-manager": "4.1.0",
-    "cache-manager-mongodb": "0.3.0",
     "cache-manager-redis-store": "3.0.1",
     "class-transformer": "0.5.1",
     "class-validator": "0.13.2",

src/app.module.ts

@@ -32,7 +32,6 @@ import { LogsTfModule } from './logs-tf/logs-tf.module';
 import { PlayerActionsLoggerModule } from './player-actions-logger/player-actions-logger.module';
 import { QueueConfigModule } from './queue-config/queue-config.module';
 import * as redisStore from 'cache-manager-redis-store';
-import * as mongoStore from 'cache-manager-mongodb';
 
 @Module({
   imports: [
@@ -55,20 +54,13 @@ import * as mongoStore from 'cache-manager-mongodb';
       imports: [EnvironmentModule],
       inject: [Environment],
       useFactory: (environment: Environment) => {
-        if (environment.redisUrl) {
-          const redisClientOptions: RedisClientOptions = {
-            url: environment.redisUrl,
-          };
-          return {
-            store: redisStore,
-            ...redisClientOptions,
-          };
-        } else {
-          return {
-            store: mongoStore,
-            uri: formatMongoose(environment.mongoDbUri),
-          };
-        }
+        const redisClientOptions: RedisClientOptions = {
+          url: environment.redisUrl,
+        };
+        return {
+          store: redisStore,
+          ...redisClientOptions,
+        };
       },
       isGlobal: true,
     }),

src/environment-schema.ts

@@ -17,7 +17,7 @@ export const environmentSchema = object({
   CLIENT_URL: string().required(),
   BOT_NAME: string().required(),
   MONGODB_URI: string().required().uri(),
-  REDIS_URL: any().optional(),
+  REDIS_URL: string().required().uri(),
   STEAM_API_KEY: string().required(),
   LOGS_TF_API_KEY: string().required(),
   KEY_STORE_PASSPHRASE: string().required(),

yarn.lock

@@ -3919,13 +3919,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"async@npm:1.5.2":
-  version: 1.5.2
-  resolution: "async@npm:1.5.2"
-  checksum: fe5d6214d8f15bd51eee5ae8ec5079b228b86d2d595f47b16369dec2e11b3ff75a567bb5f70d12d79006665fbbb7ee0a7ec0e388524eefd454ecbe651c124ebd
-  languageName: node
-  linkType: hard
-
 "async@npm:3.2.3":
   version: 3.2.3
   resolution: "async@npm:3.2.3"
@@ -4070,16 +4063,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"bl@npm:^2.2.1":
-  version: 2.2.1
-  resolution: "bl@npm:2.2.1"
-  dependencies:
-    readable-stream: ^2.3.5
-    safe-buffer: ^5.1.1
-  checksum: 4f5d9b258919646a8d02f1731379e53b6f6309e34596ae02afbc3aeb183910bd2d0b70681f889b7c620ca48f65dc1cd0992ee1266c90d6d7c3be60688d141233
-  languageName: node
-  linkType: hard
-
 "bl@npm:^4.0.3, bl@npm:^4.1.0":
   version: 4.1.0
   resolution: "bl@npm:4.1.0"
@@ -4102,13 +4085,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"bluebird@npm:^3.5.3":
-  version: 3.7.2
-  resolution: "bluebird@npm:3.7.2"
-  checksum: 869417503c722e7dc54ca46715f70e15f4d9c602a423a02c825570862d12935be59ed9c7ba34a9b31f186c017c23cac6b54e35446f8353059c101da73eac22ef
-  languageName: node
-  linkType: hard
-
 "body-parser@npm:1.20.1":
   version: 1.20.1
   resolution: "body-parser@npm:1.20.1"
@@ -4213,13 +4189,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"bson@npm:^1.1.4":
-  version: 1.1.6
-  resolution: "bson@npm:1.1.6"
-  checksum: 75762c9b7e0b3156cb0f38c7eb9ffcade53f0b04ac87dece9cba38f6dc570d9af91251de6a8988b294063cfaa21894c60ac9e85c34176accb3674acb092d66a7
-  languageName: node
-  linkType: hard
-
 "bson@npm:^4.6.2":
   version: 4.6.3
   resolution: "bson@npm:4.6.3"
@@ -4330,18 +4299,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"cache-manager-mongodb@npm:0.3.0":
-  version: 0.3.0
-  resolution: "cache-manager-mongodb@npm:0.3.0"
-  dependencies:
-    bluebird: ^3.5.3
-    cache-manager: ^2.9.0
-    lodash: ^4.17.15
-    mongodb: ^3.6.3
-  checksum: 7fc1aaa3a9a90f7c28571be607ec150089e43825f62c6738f6295aa78b8e0182c648bf4421085d1936d35f5b2ac6deaadb24d7930f768164feb8ff06c7c9081f
-  languageName: node
-  linkType: hard
-
 "cache-manager-redis-store@npm:3.0.1":
   version: 3.0.1
   resolution: "cache-manager-redis-store@npm:3.0.1"
@@ -4362,17 +4319,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"cache-manager@npm:^2.9.0":
-  version: 2.11.1
-  resolution: "cache-manager@npm:2.11.1"
-  dependencies:
-    async: 1.5.2
-    lodash.clonedeep: 4.5.0
-    lru-cache: 4.0.0
-  checksum: 1f4c2a5ee5c34636791ac0187e025f25bf656e4ea91a9984c73d91f8d1b4f904156ad5c77333a643b22e1becf80cdf37f7b87f611b3a9fcf4ff5fbe356c0755c
-  languageName: node
-  linkType: hard
-
 "cacheable-lookup@npm:^6.0.4":
   version: 6.0.4
   resolution: "cacheable-lookup@npm:6.0.4"
@@ -5385,13 +5331,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"denque@npm:^1.4.1":
-  version: 1.5.1
-  resolution: "denque@npm:1.5.1"
-  checksum: 4375ad19d5cea99f90effa82a8cecdaa10f4eb261fbcd7e47cd753ff2737f037aac8f7f4e031cc77f3966314c491c86a0d3b20c128aeee57f791b4662c45108e
-  languageName: node
-  linkType: hard
-
 "denque@npm:^2.0.1":
   version: 2.0.1
   resolution: "denque@npm:2.0.1"
@@ -8775,7 +8714,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"lodash.clonedeep@npm:4.5.0, lodash.clonedeep@npm:^4.5.0":
+"lodash.clonedeep@npm:^4.5.0":
   version: 4.5.0
   resolution: "lodash.clonedeep@npm:4.5.0"
   checksum: 92c46f094b064e876a23c97f57f81fbffd5d760bf2d8a1c61d85db6d1e488c66b0384c943abee4f6af7debf5ad4e4282e74ff83177c9e63d8ff081a4837c3489
@@ -8900,16 +8839,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"lru-cache@npm:4.0.0":
-  version: 4.0.0
-  resolution: "lru-cache@npm:4.0.0"
-  dependencies:
-    pseudomap: ^1.0.1
-    yallist: ^2.0.0
-  checksum: 3a3b2120d31c7ead43855489290130ba7f4f0e653424f542d4f738bb9956df3b6b9016f3efc646b5a5075d675db084ad0921abec2cc2fe1058dc2e78e968a11a
-  languageName: node
-  linkType: hard
-
 "lru-cache@npm:^5.1.1":
   version: 5.1.1
   resolution: "lru-cache@npm:5.1.1"
@@ -9489,36 +9418,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"mongodb@npm:^3.6.3":
-  version: 3.7.3
-  resolution: "mongodb@npm:3.7.3"
-  dependencies:
-    bl: ^2.2.1
-    bson: ^1.1.4
-    denque: ^1.4.1
-    optional-require: ^1.1.8
-    safe-buffer: ^5.1.2
-    saslprep: ^1.0.0
-  dependenciesMeta:
-    saslprep:
-      optional: true
-  peerDependenciesMeta:
-    aws4:
-      optional: true
-    bson-ext:
-      optional: true
-    kerberos:
-      optional: true
-    mongodb-client-encryption:
-      optional: true
-    mongodb-extjson:
-      optional: true
-    snappy:
-      optional: true
-  checksum: ef7690fe6ee7d1752f121b14e59b3fabfddc60ff0536babce6c945703ad0010de9e6fa7de4c91b99275c256876a72a06899ce27893aba0838c2b542088bd1044
-  languageName: node
-  linkType: hard
-
 "mongodb@npm:~4.9.0":
   version: 4.9.0
   resolution: "mongodb@npm:4.9.0"
@@ -9980,15 +9879,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"optional-require@npm:^1.1.8":
-  version: 1.1.8
-  resolution: "optional-require@npm:1.1.8"
-  dependencies:
-    require-at: ^1.0.6
-  checksum: 437db76f713052925185ae80837b593877f75101154e8937f50d33b0b07bd500c214efc9016748642109b6e3e1197eb0513a2963eb06bcf3890f88a2724b1c87
-  languageName: node
-  linkType: hard
-
 "optionator@npm:^0.8.1":
   version: 0.8.3
   resolution: "optionator@npm:0.8.3"
@@ -10611,13 +10501,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"pseudomap@npm:^1.0.1":
-  version: 1.0.2
-  resolution: "pseudomap@npm:1.0.2"
-  checksum: 856c0aae0ff2ad60881168334448e898ad7a0e45fe7386d114b150084254c01e200c957cf378378025df4e052c7890c5bd933939b0e0d2ecfcc1dc2f0b2991f5
-  languageName: node
-  linkType: hard
-
 "pump@npm:^3.0.0":
   version: 3.0.0
   resolution: "pump@npm:3.0.0"
@@ -10822,7 +10705,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"readable-stream@npm:^2.2.2, readable-stream@npm:^2.3.5, readable-stream@npm:~2.3.6":
+"readable-stream@npm:^2.2.2, readable-stream@npm:~2.3.6":
   version: 2.3.7
   resolution: "readable-stream@npm:2.3.7"
   dependencies:
@@ -10960,13 +10843,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"require-at@npm:^1.0.6":
-  version: 1.0.6
-  resolution: "require-at@npm:1.0.6"
-  checksum: 7753a6ebad99855ef015d5533a787c65e883c94c23371368eebf6f1c7e2a078811013b204823152cbab206a00e825e8e5ca09416fd835a489fa30bf064fbe6d9
-  languageName: node
-  linkType: hard
-
 "require-directory@npm:^2.1.1":
   version: 2.1.1
   resolution: "require-directory@npm:2.1.1"
@@ -11157,7 +11033,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"safe-buffer@npm:5.2.1, safe-buffer@npm:^5.0.1, safe-buffer@npm:^5.1.0, safe-buffer@npm:^5.1.1, safe-buffer@npm:^5.1.2, safe-buffer@npm:~5.2.0":
+"safe-buffer@npm:5.2.1, safe-buffer@npm:^5.0.1, safe-buffer@npm:^5.1.0, safe-buffer@npm:~5.2.0":
   version: 5.2.1
   resolution: "safe-buffer@npm:5.2.1"
   checksum: b99c4b41fdd67a6aaf280fcd05e9ffb0813654894223afb78a31f14a19ad220bba8aba1cb14eddce1fcfb037155fe6de4e861784eb434f7d11ed58d1e70dd491
@@ -11178,7 +11054,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"saslprep@npm:^1.0.0, saslprep@npm:^1.0.3":
+"saslprep@npm:^1.0.3":
   version: 1.0.3
   resolution: "saslprep@npm:1.0.3"
   dependencies:
@@ -11336,7 +11212,6 @@ __metadata:
     app-root-path: 3.1.0
     async-mutex: 0.4.0
     cache-manager: 4.1.0
-    cache-manager-mongodb: 0.3.0
     cache-manager-redis-store: 3.0.1
     class-transformer: 0.5.1
     class-validator: 0.13.2
@@ -13028,13 +12903,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"yallist@npm:^2.0.0":
-  version: 2.1.2
-  resolution: "yallist@npm:2.1.2"
-  checksum: 9ba99409209f485b6fcb970330908a6d41fa1c933f75e08250316cce19383179a6b70a7e0721b89672ebb6199cc377bf3e432f55100da6a7d6e11902b0a642cb
-  languageName: node
-  linkType: hard
-
 "yallist@npm:^3.0.2":
   version: 3.1.1
   resolution: "yallist@npm:3.1.1"