Merge pull request #93 from malthe/node-test-runner

Use Node's built-in test runner

Author: malthe

.github/workflows/main.yml

@@ -17,15 +17,32 @@ permissions:
   id-token: write
 
 jobs:
-  docs:
+  build:
     runs-on: ubuntu-latest
     timeout-minutes: 1
     steps:
+      - uses: actions/checkout@v4
+      - name: NPM
+        run: |
+          set -ex
+          npm i
+          npm run prebuild
+          npm run build:cjs
+          npm run build:esm
+          echo '{"type": "commonjs"}' > dist/commonjs/package.json
+          echo '{"type": "module"}' > dist/module/package.json
+          mkdir dest
+          npm pack --pack-destination=dest
       - name: Docs
         run: npx typedoc
       - uses: actions/upload-pages-artifact@v2
         with:
           path: ./docs
+      - name: Package artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: pkg
+          path: dest
   test:
     services:
       postgres:
@@ -42,11 +59,11 @@ jobs:
           --health-retries 5
     strategy:
       matrix:
-        environment:
-        - type: node
-          version: 18.x
-        - type: node
+        version:
+        - 18.x
+        - 20.x
     runs-on: ubuntu-latest
+    needs: [build]
     timeout-minutes: 3
     steps:
       - run: |
@@ -60,53 +77,43 @@ jobs:
           set full_page_writes off
           set synchronous_commit off
           docker kill --signal=SIGHUP ${{ job.services.postgres.id }}
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.environment.version }}
-        if: matrix.environment.type == 'node'
+      - name: Use Node.js ${{ matrix.version }}
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.environment.version }}
+          node-version: ${{ matrix.version }}
+      - uses: actions/checkout@v4
       - name: Install dependencies
-        if: matrix.environment.type == 'node'
-        run: npm ci
+        run: npm i
       - name: Run tests
-        run: |
-          case $ENVIRONMENT in
-            node)
-              npm run test:prod
-              ;;
-          esac
+        run: npm run test:prod
         env:
-          ENVIRONMENT: ${{ matrix.environment.type }}
           PGSSLMODE: disable
           PGPORT: ${{ job.services.postgres.ports[5432] }}
           PGUSER: postgres
           PGPASSWORD: postgres
+      - name: Extract SSL cert
+        run: docker cp ${{ job.services.postgres.id }}:/etc/ssl/certs/ssl-cert-snakeoil.pem ./
       - name: Run tests (SSL)
+        run: npm run test:prod
+        env:
+          NODE_EXTRA_CA_CERTS: ${{ github.workspace }}/ssl-cert-snakeoil.pem
+          PGPORT: ${{ job.services.postgres.ports[5432] }}
+          PGUSER: postgres
+          PGPASSWORD: postgres
+      - uses: actions/download-artifact@v4
+      - name: "Example: Connect"
         run: |
-          docker cp ${{ job.services.postgres.id }}:/etc/ssl/certs/ssl-cert-snakeoil.pem ./
-          gen_code() {
-          cat <<- EOF
-            import { Client } from '$1';
-            const client = new Client();
-            const info = await client.connect();
-            console.log("Encrypted: " + info.encrypted);
-            await client.end();
-          EOF
-          }
+          pkg_path=`ls $PWD/pkg/ts-postgres-*.tgz`
+          cd examples/connect
+          npm i . "$pkg_path"
           set -o pipefail
-          case $ENVIRONMENT in
-            node)
-              npm run test:prod || exit 1
-              npm run build
-              gen_code ./dist/src/index.js > test.mjs
-              node test.mjs | tee /dev/stderr | grep -q true
-              ;;
-          esac
+          PGSSLMODE=disable node main.cjs | tee /dev/stderr | grep -q false
+          PGSSLMODE=require node main.cjs | tee /dev/stderr | grep -q true
+          npx tsc
+          PGSSLMODE=disable node main.mjs | tee /dev/stderr | grep -q false
+          PGSSLMODE=require node main.mjs | tee /dev/stderr | grep -q true
         env:
-          ENVIRONMENT: ${{ matrix.environment.type }}
-          NODE_EXTRA_CA_CERTS: ssl-cert-snakeoil.pem
-          PGSSLMODE: require
+          NODE_EXTRA_CA_CERTS: ${{ github.workspace }}/ssl-cert-snakeoil.pem
           PGPORT: ${{ job.services.postgres.ports[5432] }}
           PGUSER: postgres
           PGPASSWORD: postgres
@@ -116,7 +123,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    needs: [test, docs]
+    needs: [build, test]
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

CHANGES.md

@@ -1,5 +1,11 @@
 In the next release ...
 
+- Add support for ESM modules.
+
+- The database host, port and connection timeout options can now be
+  specified directly for `connect` (taking priority over the
+  provided configuration).
+
 - Fix issue handling connection error during secure startup.
 
 1.8.0 (2023-12-14)

README.md

@@ -9,20 +9,20 @@ Non-blocking PostgreSQL client for Node.js written in TypeScript.
 To install the latest version of this library:
 
 ```sh
-$ npm install ts-postgres@latest
+$ npm install ts-postgres
 ```
 
 ### Features
 
 * Fast!
-* Supports both binary and text value formats
-  * Result data is currently sent in binary format only
+* Supports binary and text value formats (result data always uses binary)
 * Multiple queries can be sent at once (pipeline)
 * Extensible value model
 * Hybrid query result object
   * Iterable (synchronous or asynchronous; one object at a time)
   * Rows and column names
   * Streaming data directly into a socket
+* Supports CommonJS and ESM modules
 
 See the [documentation](https://malthe.github.io/ts-postgres/) for a complete reference.
 
@@ -39,27 +39,23 @@ interface Greeting {
     message: string;
 }
 
-async function main() {
-    const client = new Client();
-    await client.connect();
+const client = new Client();
+await client.connect();
 
-    try {
-        // The query method is generic on the result row.
-        const result = client.query<Greeting>(
-            "SELECT 'Hello ' || $1 || '!' AS message",
-            ['world']
-        );
+try {
+    // The query method is generic on the result row.
+    const result = client.query<Greeting>(
+        "SELECT 'Hello ' || $1 || '!' AS message",
+        ['world']
+    );
 
-        for await (const obj of result) {
-            // 'Hello world!'
-            console.log(obj.message);
-        }
-    } finally {
-        await client.end();
+    for await (const obj of result) {
+        // 'Hello world!'
+        console.log(obj.message);
     }
+} finally {
+    await client.end();
 }
-
-await main();
 ```
 Waiting on the result (i.e., result iterator) returns the complete query result.
 

examples/connect/main.cjs

@@ -0,0 +1,8 @@
+const { Client } = require('ts-postgres');
+const client = new Client();
+module.exports = client.connect().then(
+  (info) => {
+    console.log("Encrypted: " + info.encrypted);
+    return client.end();
+  }
+);

examples/connect/main.mts

@@ -0,0 +1,5 @@
+import { Client } from 'ts-postgres';
+const client = new Client();
+const info = await client.connect();
+console.log("Encrypted: " + info.encrypted);
+await client.end();

examples/connect/package.json

@@ -0,0 +1,9 @@
+{
+    "devDependencies": {
+        "@types/node": "^20.0",
+        "typescript": "^4.8"
+    },
+    "dependencies": {
+        "ts-postgres": "^1.8"
+    }
+}

examples/connect/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "Node16",
+        "strict": true,
+        "noImplicitAny": true
+    }
+}