ci: add PlanetScale to CI

Author: sidorares

.eslintrc

@@ -1,7 +1,7 @@
 {
   "extends": ["prettier", "eslint:recommended",  "plugin:markdown/recommended"],
   "parserOptions": {
-    "ecmaVersion": 2017
+    "ecmaVersion": 2022
   },
   "plugins": ["markdown", "async-await"],
   "env": {

.github/workflows/ci-linux.yml

@@ -33,6 +33,7 @@ jobs:
         mysql-version: ["mysql:8.0.18", "mysql:8.0.22", "mysql:5.7"]
         use-compression: [0]
         use-tls: [0]
+        mysql_connection_url_key: [""]
         # TODO - add mariadb to the matrix. currently few tests are broken due to mariadb incompatibilities
         include:
           - node-version: "16.x"
@@ -51,26 +52,32 @@ jobs:
             mysql-version: "mysql:5.7"
             use-compression: 0
             use-tls: 0
-          - node-version: "12.x"
-            mysql-version: "mysql:5.7"
-            use-compression: 0
-            use-tls: 0
-          - filter: "test-select-1"
+          - filter: "test-select-1" # a number of tests does not work with mysql 5.1 due to old sql syntax, just testing basic connection
             node-version: "16.x"
             mysql-version: "datagrip/mysql:5.1"
             use-compression: 0
             use-tls: 0
+          - node-version: "18.x"
+            mysql_connection_url_key: "PS_MYSQL_URL"
+            use-compression: 0
+            use-tls: 0
+    env:
+      MYSQL_CONNECTION_URL: ${{ secrets[matrix.mysql_connection_url_key] }}
 
-    name: Node.js ${{ matrix.node-version }} - DB ${{ matrix.mysql-version }} - SSL=${{matrix.use-tls}} Compression=${{matrix.use-compression}}
+    name: Node.js ${{ matrix.node-version }} - DB ${{ matrix.mysql-version }}${{ matrix.mysql_connection_url_key }} - SSL=${{matrix.use-tls}} Compression=${{matrix.use-compression}}
 
     steps:
       - uses: actions/checkout@v3
+
       - name: Set up MySQL
-        run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_ROOT_PASSWORD=${{ env.MYSQL_PASSWORD }} -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/examples/custom-conf:/etc/mysql/conf.d -v $PWD/examples/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
+        if: ${{ !startsWith(env.MYSQL_CONNECTION_URL, 'mysql://') }}
+        run: docker run -d -e MYSQL_ALLOW_EMPTY_PASSWORD=1 -e MYSQL_DATABASE=${{ env.MYSQL_DATABASE }} -v $PWD/mysqldata:/var/lib/mysql/ -v $PWD/examples/custom-conf:/etc/mysql/conf.d -v $PWD/examples/ssl/certs:/certs -p ${{ env.MYSQL_PORT }}:3306 ${{ matrix.mysql-version }}
+
       - name: Set up Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+
       - name: Cache dependencies
         uses: actions/cache@v3
         with:
@@ -80,14 +87,16 @@ jobs:
 
       - name: Install npm dependencies
         run: npm ci
+
       - name: Wait mysql server is ready
+        if: ${{ !startsWith(env.MYSQL_CONNECTION_URL, 'mysql://') }}
         run: node tools/wait-up.js
 
       - name: Run tests
         run: FILTER=${{matrix.filter}} MYSQL_USE_TLS=${{ matrix.use-tls }} MYSQL_USE_COMPRESSION=${{ matrix.use-compression }} npm run coverage-test
 
       - run: echo "coverage-artifact-name=`echo -n "${{github.run_id}}-${{ matrix.node-version }}-${{ matrix.mysql-version }}-${{matrix.use-tls}}-${{matrix.use-compression}}" | shasum | cut -d " " -f 1`"  >> $GITHUB_ENV   
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         with:
           name: coverage-${{env.coverage-artifact-name}}
           path: coverage/cobertura-coverage.xml

package-lock.json

@@ -80,7 +80,6 @@
     "eslint-plugin-async-await": "0.0.0",
     "eslint-plugin-markdown": "^3.0.0",
     "husky": "^8.0.2",
-    "is-async-supported": "^1.2.0",
     "lint-staged": "^13.0.3",
     "mocha": "^10.0.0",
     "portfinder": "^1.0.28",

package.json

@@ -54,6 +54,12 @@ exports.waitDatabaseReady = function(callback) {
 };
 
 exports.createConnection = function(args) {
+
+  const driver = require('../index.js');
+  if (!args?.port && process.env.MYSQL_CONNECTION_URL) {
+    return driver.createConnection({ ...args, uri: process.env.MYSQL_CONNECTION_URL })
+  }
+
   if (!args) {
     args = {};
   }
@@ -80,8 +86,6 @@ exports.createConnection = function(args) {
     connectTimeout: args && args.connectTimeout,
   };
 
-  // previously we had an adapter logic to benchmark against mysqljs/mysql and libmariaclient
-  const driver = require('../index.js');
   const conn = driver.createConnection(params);
   return conn;
 };
@@ -114,10 +118,15 @@ exports.getConfig = function(input) {
 };
 
 exports.createPool = function(args) {
+  let driver = require('../index.js');
+  if (!args?.port && process.env.MYSQL_CONNECTION_URL) {
+    return driver.createPool({ ...args, uri: process.env.MYSQL_CONNECTION_URL })
+  }
+
   if (!args) {
     args = {};
   }
-  let driver = require('../index.js');
+
   if (process.env.BENCHMARK_MYSQL1) {
     driver = require('mysql');
   }
@@ -126,9 +135,9 @@ exports.createPool = function(args) {
 };
 
 exports.createPoolCluster = function(args = {}) {
-  let driver = require('../index.js');
-  if (process.env.BENCHMARK_MYSQL1) {
-    driver = require('mysql');
+  const driver = require('../index.js');
+  if (!args?.port && process.env.MYSQL_CONNECTION_URL) {
+    return driver.createPoolCluster({ ...args, uri: process.env.MYSQL_CONNECTION_URL })
   }
   return driver.createPoolCluster(args)
 }

test/common.js

@@ -1,5 +1,10 @@
 'use strict';
 
+if (`${process.env.MYSQL_CONNECTION_URL}`.includes('pscale_pw_')) {
+  console.log('skipping test for planetscale (unsupported non utf8 charsets)');
+  process.exit(0);
+}
+
 const mysql = require('../../../../index.js');
 const common = require('../../../common');
 const connection = common.createConnection();

test/integration/connection/encoding/test-charset-results.js

@@ -1,5 +1,10 @@
 'use strict';
 
+if (`${process.env.MYSQL_CONNECTION_URL}`.includes('pscale_pw_')) {
+  console.log('skipping test for planetscale (unsupported non utf8 charsets)');
+  process.exit(0);
+}
+
 const common = require('../../../common');
 const assert = require('assert');
 

test/integration/connection/encoding/test-client-encodings.js

@@ -3,6 +3,11 @@
 const common = require('../../../common');
 const assert = require('assert');
 
+if (`${process.env.MYSQL_CONNECTION_URL}`.includes('pscale_pw_')) {
+  console.log('skipping test for planetscale');
+  process.exit(0);
+}
+
 // 4 bytes in utf8
 const pileOfPoo = '💩';
 

test/integration/connection/encoding/test-non-bmp-chars.js

@@ -8,14 +8,14 @@ const text = 'привет, мир';
 
 connection.query('SET character_set_client=koi8r', err => {
   assert.ifError(err);
-  connection.query('SELECT ?', [text], (err, rows) => {
+  connection.query(`SELECT ? as result`, [text], (err, rows) => {
     assert.ifError(err);
-    assert.equal(rows[0][text], text);
+    assert.equal(rows[0].result, text);
     connection.query('SET character_set_client=cp1251', err => {
       assert.ifError(err);
-      connection.query('SELECT ?', [text], (err, rows) => {
+      connection.query(`SELECT ? as result`, [text], (err, rows) => {
         assert.ifError(err);
-        assert.equal(rows[0][text], text);
+        assert.equal(rows[0].result, text);
         connection.end();
       });
     });

test/integration/connection/encoding/test-track-encodings.js

@@ -4,6 +4,12 @@ const common = require('../../common');
 const connection = common.createConnection();
 const assert = require('assert');
 
+// TODO - this could be re-enabled
+if (`${process.env.MYSQL_CONNECTION_URL}`.includes('pscale_pw_')) {
+  console.log('skipping test for planetscale');
+  process.exit(0);
+}
+
 let rows = undefined;
 let fields = undefined;
 let rows1 = undefined;