feat: use ssl config for mysql connections, update build process DMD-1605

.github/workflows/publish.yml

@@ -9,30 +9,35 @@ jobs:
     build-and-test:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
-                  cache: 'yarn'
-            - run: yarn install --frozen-lockfile
+                  node-version: 22
+            - name: Enable corepack
+              run: corepack enable
+            - run: yarn install --immutable
             - run: yarn test
 
     npm-publish:
-        needs: build-and-test
+        needs: build-and-publish
         runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            issues: write
+            pull-requests: write
+            id-token: write # to enable use of OIDC for trusted publishing and npm provenance
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
               with:
-                  node-version: 16
-                  cache: 'yarn'
-            - run: yarn install --frozen-lockfile
+                  persist-credentials: false
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 22
+            - name: Enable corepack
+              run: corepack enable
+            - run: yarn install --immutable
             - run: yarn build
-            - name: 'Semantic Release'
-              run: npx semantic-release
+            - name: Semantic Release
+              run: npx semantic-release --branches master
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-                  NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-                  HUSKY: 0
-                  CI: true

.github/workflows/pull_request.yml

@@ -12,7 +12,8 @@ jobs:
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
-                  node-version: 16
-                  cache: 'yarn'
-            - run: yarn install --frozen-lockfile
+                  node-version: 22
+            - name: Enable corepack
+              run: corepack enable
+            - run: yarn install --immutable
             - run: yarn test

.gitignore

@@ -1,4 +1,5 @@
 lib
 node_modules
 coverage
-.idea
+.idea
+.yarn

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

__tests__/execute-query.spec.js

@@ -26,9 +26,23 @@ describe('serverless mysql utility', () => {
             // when
             await executeQuery('', dbConfig);
 
-            // then
+            // then - implementation adds ssl: {} when undefined so mysql uses secure connection (required for caching_sha2_password)
             expect(getPool).toHaveBeenCalledTimes(1);
-            expect(getPool).toHaveBeenCalledWith(dbConfig);
+            expect(getPool).toHaveBeenCalledWith(expect.objectContaining({ ...dbConfig, ssl: {} }));
+        });
+
+        it('should pass through ssl config when provided', async () => {
+            const dbConfig = {
+                database: chance.word(),
+                host: chance.word(),
+                password: chance.word(),
+                user: chance.word(),
+                ssl: { ca: chance.string() },
+            };
+
+            await executeQuery('', dbConfig);
+
+            expect(getPool).toHaveBeenCalledWith(expect.objectContaining({ ssl: dbConfig.ssl }));
         });
 
         it('should successfully query mysql on the first try', async () => {
@@ -84,9 +98,9 @@ describe('serverless mysql utility', () => {
             // when
             await executeQueryWithParams('', [], dbConfig);
 
-            // then
+            // then - implementation adds ssl: {} when undefined so mysql uses secure connection (required for caching_sha2_password)
             expect(getPool).toHaveBeenCalledTimes(1);
-            expect(getPool).toHaveBeenCalledWith(dbConfig);
+            expect(getPool).toHaveBeenCalledWith(expect.objectContaining({ ...dbConfig, ssl: {} }));
         });
 
         it('should successfully query mysql on the first try', async () => {

__tests__/execute-transaction.spec.js

@@ -34,9 +34,23 @@ describe('execute Transaction', () => {
         // when
         await executeTransaction(queries, dbConfig);
 
-        // then
+        // then - implementation adds ssl: {} when undefined so mysql uses secure connection (required for caching_sha2_password)
         expect(getPool).toHaveBeenCalledTimes(1);
-        expect(getPool).toHaveBeenCalledWith(dbConfig);
+        expect(getPool).toHaveBeenCalledWith({ ...dbConfig, ssl: {} });
+    });
+
+    it('should pass through ssl config when provided', async () => {
+        const dbConfig = {
+            database: chance.word(),
+            host: chance.word(),
+            password: chance.word(),
+            user: chance.word(),
+            ssl: { ca: chance.string() },
+        };
+
+        await executeTransaction([], dbConfig);
+
+        expect(getPool).toHaveBeenCalledWith(expect.objectContaining({ ssl: dbConfig.ssl }));
     });
 
     it('should successfully query mysql on the first try', async () => {

__tests__/stream-query.spec.ts

@@ -35,4 +35,32 @@ describe('A Stream Query Function', () => {
         // then
         expect(result).toBeDefined();
     });
+
+    it('should pass through ssl when provided in dbConfig', async () => {
+        // given: dbConfig with ssl defined so the ssl branch on line 18 is covered
+        const query = chance.string();
+        const sslConfig = { rejectUnauthorized: true };
+        const dbConfig = { ssl: sslConfig };
+
+        (createPool as jest.Mock).mockReturnValue({
+            pool: {
+                query: jest.fn().mockReturnValue({
+                    stream: jest.fn().mockReturnValue({
+                        once: jest.fn().mockImplementation((event, callback) => {
+                            if (event === 'fields') {
+                                callback();
+                            }
+                        }),
+                        removeListener: jest.fn(),
+                    }),
+                }),
+            },
+        });
+
+        // when
+        await streamQuery(query, dbConfig);
+
+        // then: createPool was called with ssl from dbConfig (not default {})
+        expect(createPool).toHaveBeenCalledWith(expect.objectContaining({ ssl: sslConfig }));
+    });
 });

package.json

@@ -6,7 +6,7 @@
     "author": "@TractorZoom",
     "license": "MIT",
     "scripts": {
-        "build": "rimraf lib && tsc --project tsconfig.build.json && cp package.json lib",
+        "build": "npx rimraf lib && tsc --project tsconfig.build.json && cp package.json lib",
         "commit": "git-cz",
         "test": "jest",
         "prettier:all": "prettier --write './**/*.*'",
@@ -19,9 +19,6 @@
         "@babel/preset-env": "7.20.2",
         "@commitlint/cli": "17.4.2",
         "@commitlint/config-conventional": "17.4.2",
-        "@semantic-release/changelog": "6.0.2",
-        "@semantic-release/git": "10.0.1",
-        "@semantic-release/release-notes-generator": "10.0.3",
         "@types/jest": "29.5.3",
         "@types/node": "16.18.11",
         "@typescript-eslint/eslint-plugin": "5.48.2",
@@ -40,7 +37,7 @@
         "jest": "29.3.1",
         "prettier": "2.8.3",
         "pretty-quick": "3.1.3",
-        "semantic-release": "19.0.5",
+        "semantic-release": "^25.0.3",
         "ts-jest": "29.0.3",
         "typescript": "4.9.4",
         "uuid": "9.0.0"
@@ -67,5 +64,6 @@
         "serverless-mysql",
         "sql"
     ],
-    "types": "index.d.ts"
+    "types": "index.d.ts",
+    "packageManager": "yarn@4.12.0+sha512.f45ab632439a67f8bc759bf32ead036a1f413287b9042726b7cc4818b7b49e14e9423ba49b18f9e06ea4941c1ad062385b1d8760a8d5091a1a31e5f6219afca8"
 }

release.config.js

@@ -28,24 +28,16 @@ module.exports = {
         [
             '@semantic-release/release-notes-generator',
             {
-                preset: 'angular',
                 parserOpts: {
                     noteKeywords: ['breaking', 'chore'],
                 },
+                preset: 'angular',
                 writerOpts: {
                     commitsSort: ['subject', 'scope'],
                 },
             },
         ],
-        '@semantic-release/changelog',
         '@semantic-release/github',
         '@semantic-release/npm',
-        [
-            '@semantic-release/git',
-            {
-                assets: ['package.json'],
-                message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
-            },
-        ],
     ],
 };

src/execute-query.ts

@@ -15,6 +15,7 @@ async function wrap<T extends RowData[] | QueryInfo>(
         host: dbConfig.host,
         password: dbConfig.password,
         user: dbConfig.user,
+        ssl: dbConfig.ssl !== undefined ? dbConfig.ssl : {},
     });
 
     let data: T;

src/execute-transaction.ts

@@ -13,6 +13,7 @@ export async function executeTransaction(queries: string[], dbConfig: Connection
             host: dbConfig.host,
             password: dbConfig.password,
             user: dbConfig.user,
+            ssl: dbConfig.ssl !== undefined ? dbConfig.ssl : {},
         });
 
         conn = await pool.getConnection();

src/stream-query.ts

@@ -15,6 +15,7 @@ export const streamQuery = (
             host: dbConfig.host,
             password: dbConfig.password,
             user: dbConfig.user,
+            ssl: dbConfig.ssl !== undefined ? dbConfig.ssl : {},
         });
 
         const queryStream = pool.pool.query(query).stream(streamOptions);