Merge pull request #38 from observablehq/syl/esm-migration

Use modules

Author: Sylvestre

bin/observable-database-proxy renamed to bin/observable-database-proxy.js

@@ -1,16 +1,15 @@
 #!/usr/bin/env node
 
-require = require("esm")(module);
-const exit = require("../lib/errors").exit;
-const {start, add, remove, reset, list} = require("../lib/commands");
+import {start, add, remove, reset, list} from "../lib/commands.js";
+import argv from "yargs";
 
-const name = yargs =>
+const name = (yargs) =>
   yargs.positional("name", {
     describe: "Database connector name",
-    type: "string"
+    type: "string",
   });
 
-const argv = require("yargs")
+argv
   .usage(`Usage: $0 <command> <name> [options]`)
   .command(
     `start <name> [options]`,

lib/commands.js

@@ -6,10 +6,10 @@ import {
   readConfig,
   readDecodedConfig,
   writeConfig,
-  decodeSecret
-} from "./config";
-import {server} from "./server";
-import {exit} from "./errors";
+  decodeSecret,
+} from "./config.js";
+import {server} from "./server.js";
+import {exit} from "./errors.js";
 
 export function start(argv) {
   const config = readDecodedConfig(argv.name);
@@ -25,9 +25,10 @@ export async function add(argv, reset = false) {
 
   const rl = createInterface({
     input: process.stdin,
-    output: process.stdout
+    output: process.stdout,
   });
-  const question = query => new Promise(resolve => rl.question(query, resolve));
+  const question = (query) =>
+    new Promise((resolve) => rl.question(query, resolve));
 
   if (reset) {
     if (!config[name]) exit(`No configuration found for "${name}"`);
@@ -87,7 +88,9 @@ export function list() {
   if (!config) exit(`No database proxies configured`);
   console.log(
     config
-      .map(c => `${c.name} (${c.type}) ${c.ssl === "required" ? `(SSL)` : ``}`)
+      .map(
+        (c) => `${c.name} (${c.type}) ${c.ssl === "required" ? `(SSL)` : ``}`
+      )
       .join("\n")
   );
 }

lib/config.js

@@ -1,7 +1,7 @@
 import {existsSync, readFileSync, writeFileSync} from "fs";
 import {homedir} from "os";
 import {join} from "path";
-import {exit} from "./errors";
+import {exit} from "./errors.js";
 
 const configFile = join(homedir(), ".observablehq");
 const key = `database-proxy`;
@@ -23,9 +23,9 @@ export function readDecodedConfig(name) {
     if (!raw) exit(`No configuration found for "${name}"`);
     return {...decodeSecret(raw.secret), url: raw.url};
   } else {
-    return Object.values(config).map(c => ({
+    return Object.values(config).map((c) => ({
       ...decodeSecret(c.secret),
-      url: c.url
+      url: c.url,
     }));
   }
 }

lib/mysql.js

@@ -1,10 +1,12 @@
 import {json} from "micro";
 import {createPool} from "mysql";
-import {parseUrl} from "mysql/lib/ConnectionConfig";
-import types from "mysql/lib/protocol/constants/types";
+import connectionConfig from "mysql/lib/ConnectionConfig.js";
+import types from "mysql/lib/protocol/constants/types.js";
 import JSONStream from "JSONStream";
 
-export default url => {
+const {parseUrl} = connectionConfig;
+
+export default (url) => {
   const pool = createPool(parseUrl(url));
 
   return async function query(req, res) {
@@ -14,18 +16,15 @@ export default url => {
     await new Promise((resolve, reject) => {
       const stream = pool
         .query({sql, timeout: 30e3}, params)
-        .on("fields", f => (fields = f))
+        .on("fields", (f) => (fields = f))
         .stream()
         .on("end", resolve)
-        .on("error", error => {
+        .on("error", (error) => {
           stream.destroy();
           reject(error);
         })
         .pipe(JSONStream.stringify(`{"data":[`, ",", "]"));
-      stream.pipe(
-        res,
-        {end: false}
-      );
+      stream.pipe(res, {end: false});
     });
 
     const schema = {
@@ -37,8 +36,8 @@ export default url => {
             (schema[name] = dataTypeSchema({type, charsetNr})), schema
           ),
           {}
-        )
-      }
+        ),
+      },
     };
     res.end(`,"schema":${JSON.stringify(schema)}}`);
   };

lib/postgres.js

@@ -1,9 +1,11 @@
 import {json} from "micro";
-import {Pool} from "pg";
+import pg from "pg";
 import QueryStream from "pg-query-stream";
 import JSONStream from "JSONStream";
 
-export default url => {
+const {Pool} = pg;
+
+export default (url) => {
   const pool = new Pool({connectionString: url});
 
   return async function query(req, res) {
@@ -19,10 +21,7 @@ export default url => {
           .on("end", resolve)
           .on("error", reject)
           .pipe(JSONStream.stringify(`{"data":[`, ",", "]"))
-          .pipe(
-            res,
-            {end: false}
-          );
+          .pipe(res, {end: false});
       });
 
       const schema = {
@@ -34,8 +33,8 @@ export default url => {
               (schema[name] = dataTypeSchema(dataTypeID)), schema
             ),
             {}
-          )
-        }
+          ),
+        },
       };
       res.end(`,"schema":${JSON.stringify(schema)}}`);
     } finally {

lib/server.js

@@ -6,11 +6,11 @@ import https from "https";
 import {readFileSync} from "fs";
 import {run} from "micro";
 import {createHmac, timingSafeEqual} from "crypto";
-import serializeErrors from "./serialize-errors";
-import {notFound, unauthorized, exit} from "./errors";
-import mysql from "./mysql";
-import postgres from "./postgres";
-import snowflake from "./snowflake";
+import serializeErrors from "./serialize-errors.js";
+import {notFound, unauthorized, exit} from "./errors.js";
+import mysql from "./mysql.js";
+import postgres from "./postgres.js";
+import snowflake from "./snowflake.js";
 
 export function server(config, argv) {
   const development = process.env.NODE_ENV === "development";

package.json

@@ -12,11 +12,10 @@
     "./snowflake.js": "./lib/snowflake.js"
   },
   "bin": {
-    "observable-database-proxy": "./bin/observable-database-proxy"
+    "observable-database-proxy": "./bin/observable-database-proxy.js"
   },
   "dependencies": {
     "JSONStream": "^1.3.5",
-    "esm": "^3.2.25",
     "micro": "^9.3.4",
     "mysql": "^2.17.1",
     "open": "^6.3.0",
@@ -30,7 +29,7 @@
     "nodemon": "^1.19.1"
   },
   "scripts": {
-    "dev": "NODE_ENV=development nodemon bin/observable-database-proxy",
+    "dev": "NODE_ENV=development nodemon bin/observable-database-proxy.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "Observable",

yarn.lock

@@ -708,11 +708,6 @@ escape-string-regexp@^1.0.5:
   resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
   integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=
 
-esm@^3.2.25:
-  version "3.2.25"
-  resolved "https://registry.yarnpkg.com/esm/-/esm-3.2.25.tgz#342c18c29d56157688ba5ce31f8431fbb795cc10"
-  integrity sha512-U1suiZ2oDVWv4zPO56S0NcR5QriEahGtdN2OR6FiOG4WJvcjBVFB0qI4+eKoWFH483PKGuLuu6V8Z4T5g63UVA==
-
 execa@^0.7.0:
   version "0.7.0"
   resolved "https://registry.yarnpkg.com/execa/-/execa-0.7.0.tgz#944becd34cc41ee32a63a9faf27ad5a65fc59777"