fix: support mysql sql_require_primary_key (#1685)

fixes #1678

Author: confuser

.github/workflows/build.yaml

@@ -6,7 +6,7 @@ on:
     branches:
       - master
   schedule:
-    - cron: '0 0 * * 0' # weekly
+    - cron: "0 0 * * 0" # weekly
 
 jobs:
   test:
@@ -46,18 +46,9 @@ jobs:
         run: |
           sudo systemctl start mysql.service
           sleep 5 && mysql -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY '';" -u${{ env.DB_USER }} -p${{ env.DB_PASSWORD }}
+          mysql -e "SET GLOBAL sql_require_primary_key = ON;" -uroot
       - run: npm run lint
-      # Temporary work around jest memory leaks https://github.com/facebook/jest/issues/11956
-      - run: |
-          shopt -s globstar
-          set -e
-          for x in server/test/*.test.js; do (node --expose-gc ./node_modules/.bin/jest "$x" && sh -c 'mv coverage/coverage-final.json "coverage/$(basename "$1" .js).json"' sh "$x") || exit 1; done
-          for x in cli/test/*.test.js; do (node --expose-gc ./node_modules/.bin/jest "$x" && sh -c 'mv coverage/coverage-final.json "coverage/$(basename "$1" .js).json"' sh "$x") || exit 1; done
-          npx nyc merge coverage coverage-final.json
-          rm -rf coverage
-          mkdir coverage
-          mv coverage-final.json coverage/coverage-final.json
-          npx nyc report -t coverage --reporter=lcov --report-dir=coverage
+      - run: node --expose-gc ./node_modules/.bin/jest --coverage
         env:
           DB_PASSWORD:
           LOG_LEVEL: warn
@@ -71,19 +62,19 @@ jobs:
           LOG_LEVEL: warn
           PORT: 3000
           NODE_ENV: production
-          ADMIN_USERNAME: 'admin@banmanagement.com'
-          ADMIN_PASSWORD: 'P%@#fjdVJ3Y%pdGR'
+          ADMIN_USERNAME: "admin@banmanagement.com"
+          ADMIN_PASSWORD: "P%@#fjdVJ3Y%pdGR" # Keep this as is to avoid HIBP failing checks
           CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           CYPRESS_PROJECT_ID: ${{ secrets.PROJECT_ID }}
-          CONTACT_EMAIL: 'admin@banmanagement.com'
+          CONTACT_EMAIL: "admin@banmanagement.com"
           NOTIFICATION_VAPID_PUBLIC_KEY: ${{ secrets.NOTIFICATION_VAPID_PUBLIC_KEY }}
           NOTIFICATION_VAPID_PRIVATE_KEY: ${{ secrets.NOTIFICATION_VAPID_PRIVATE_KEY }}
         with:
           install: false
           build: npm run e2e:build
           start: npm start
-          wait-on: 'http://127.0.0.1:3000'
+          wait-on: "http://127.0.0.1:3000"
           record: true
 
       - name: Coveralls Parallel

docker-compose.yml

@@ -5,6 +5,7 @@ services:
     restart: unless-stopped
     environment:
       MYSQL_ROOT_PASSWORD: password
+      MYSQL_ROOT_HOST: "%"
       MYSQL_DATABASE: bm_local_dev
     ports:
       - "3306:3306"
@@ -20,6 +21,7 @@ services:
       - --character-set-server=utf8mb4
       - --collation-server=utf8mb4_unicode_ci
       - --default-authentication-plugin=mysql_native_password
+      - --sql-require-primary-key=ON
 
 volumes:
   mysql_data:

jest.config.js

@@ -1,5 +1,7 @@
 module.exports = {
   collectCoverage: true,
   testMatch: ['/**/*.test.js'],
-  testTimeout: 20000
+  testTimeout: 20000,
+  maxWorkers: 6,
+  workerIdleMemoryLimit: '512MB'
 }

package.json

@@ -130,7 +130,7 @@
     "seed": "node scripts/seed.js",
     "seed:reset": "node scripts/seed.js --force",
     "start": "node server.js",
-    "test": "npm run lint && jest --coverage -w 1 --no-cache",
+    "test": "npm run lint && node --expose-gc ./node_modules/.bin/jest --coverage",
     "setup": "node bin/run.js setup --writeFile .env",
     "cypress": "cypress open",
     "e2e:build": "node cypress/setup.js && npm run build"

server/connections/pool.js

@@ -3,11 +3,11 @@ const { attachOnDuplicateUpdate } = require('knex-on-duplicate-update')
 
 attachOnDuplicateUpdate()
 
-module.exports = (config, logger, pool = { min: 0, max: 10 }) => {
+module.exports = (config, logger, pool = { min: 0, max: 5 }) => {
   return knex({
     client: 'mysql2',
     asyncStackTraces: true,
-    // log: logger,
-    connection: config
+    connection: config,
+    pool
   })
 }

server/data/migrations/sqls/20180122081331-acls-up.sql

@@ -61,10 +61,8 @@ CREATE TABLE `bm_web_role_resources` (
   `role_id` INT UNSIGNED NOT NULL,
   `resource_id` INT UNSIGNED NOT NULL,
   `value` int(11) UNSIGNED DEFAULT NULL,
-  KEY `bm_web_group_resources_group_id_index` (`role_id`),
-  KEY `bm_web_group_resources_resource_id_index` (`resource_id`),
+  PRIMARY KEY (`role_id`, `resource_id`),
   KEY `bm_web_group_resources_value_index` (`value`),
-  KEY `bm_web_group_resources_group_id_resource_id_index` (`role_id`,`resource_id`),
   CONSTRAINT `bm_web_role_resources_resource_id_fk` FOREIGN KEY (`resource_id`) REFERENCES `bm_web_resources` (`resource_id`) ON DELETE CASCADE ON UPDATE CASCADE,
   CONSTRAINT `bm_web_role_resources_role_id_fk` FOREIGN KEY (`role_id`) REFERENCES `bm_web_roles` (`role_id`) ON DELETE CASCADE ON UPDATE CASCADE
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

server/test/createServer.mutation.test.js

@@ -191,9 +191,10 @@ describe('Mutation create server', () => {
 
     await pool('bm_players').insert(player)
 
-    // Create temp user
-    await pool.raw('CREATE USER \'foobarcreate\'@\'localhost\' IDENTIFIED BY \'password\';')
-    await pool.raw('GRANT ALL ON *.* TO \'foobarcreate\'@\'localhost\';')
+    // Create temp user (use % to allow connections from any host, needed for Docker)
+    await pool.raw('DROP USER IF EXISTS \'foobarcreate\'@\'%\';')
+    await pool.raw('CREATE USER \'foobarcreate\'@\'%\' IDENTIFIED BY \'password\';')
+    await pool.raw('GRANT ALL ON *.* TO \'foobarcreate\'@\'%\';')
     await pool.raw('FLUSH PRIVILEGES;')
     const server = await createServer(unparse(player.id), setup.dbPool.client.config.connection.database)
 
@@ -220,7 +221,7 @@ describe('Mutation create server', () => {
       .send({ query })
 
     // Delete custom user
-    await pool('mysql.user').where('user', 'foobarcreate').del()
+    await pool.raw('DROP USER IF EXISTS \'foobarcreate\'@\'%\';')
 
     assert.strictEqual(statusCode, 200)
 

server/test/deleteServer.mutation.test.js

@@ -137,7 +137,8 @@ describe('Mutation delete server', () => {
 
     await pool('bm_players').insert(player)
 
-    // Create temp user
+    // Create temp user (use % to allow connections from any host, needed for Docker)
+    await pool.raw('DROP USER IF EXISTS \'foobardelete\'@\'%\';')
     await pool.raw('CREATE USER \'foobardelete\'@\'%\' IDENTIFIED BY \'password\';')
     await pool.raw('GRANT ALL ON *.* TO \'foobardelete\'@\'%\';')
     await pool.raw('FLUSH PRIVILEGES;')
@@ -166,7 +167,7 @@ describe('Mutation delete server', () => {
       .send({ query: createQuery })
 
     // Delete custom user
-    await pool('mysql.user').where('user', 'foobardelete').del()
+    await pool.raw('DROP USER IF EXISTS \'foobardelete\'@\'%\';')
     await pool.raw('FLUSH PRIVILEGES;')
 
     assert.strictEqual(createStatusCode, 200)

server/test/fixtures/server.js

@@ -1,5 +1,4 @@
 const { randomBytes } = require('crypto')
-const { encrypt } = require('../../data/crypto')
 const tables = JSON.stringify(
   {
     players: 'bm_players',
@@ -41,7 +40,7 @@ module.exports = async function (consoleId, database) {
   }
 
   if (process.env.DB_PASSWORD) {
-    server.password = await encrypt(process.env.ENCRYPTION_KEY, process.env.DB_PASSWORD)
+    server.password = process.env.DB_PASSWORD
   }
 
   return server

server/test/lib/setup.js

@@ -8,6 +8,7 @@ const { setupPool, setupServersPool } = require('../../connections')
 const { createServer, createPlayer } = require('../fixtures')
 const loaders = require('../../graphql/loaders')
 const { hash } = require('../../data/hash')
+const { encrypt } = require('../../data/crypto')
 
 module.exports = async (disableTestMigrations) => { // eslint-disable-line max-statements
   const dbName = 'bm_web_tests_' + randomBytes(4).toString('hex')
@@ -79,6 +80,11 @@ module.exports = async (disableTestMigrations) => { // eslint-disable-line max-s
   // Create a server
   const server = await createServer(playerConsole.id, dbName)
 
+  // Encrypt password before storing (setupServersPool will decrypt it when reading)
+  if (server.password) {
+    server.password = await encrypt(process.env.ENCRYPTION_KEY, server.password)
+  }
+
   await dbPool('bm_web_servers').insert(server)
 
   const serversPool = await setupServersPool({ dbPool, logger, disableInterval: true })