@magda/scripts 2.3.3 → 3.0.0-alpha.1

package/acs-cmd/acs-cmd-admin-set.js

@@ -1,15 +1,16 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist, ADMIN_ROLE_ID } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { recordExist, ADMIN_ROLE_ID } from "./utils.js";
 
 const pool = getDBPool();
 
 program
     .description("Make a user an Admin user")
-    .option("<userId>", "User ID")
+    .argument("<userId>", "User ID")
     .version(pkg.version)
     .action(async (userId) => {
         try {

package/acs-cmd/acs-cmd-admin-unset.js

@@ -1,15 +1,16 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist, ADMIN_ROLE_ID } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { recordExist, ADMIN_ROLE_ID } from "./utils.js";
 
 const pool = getDBPool();
 
 program
     .description("Remove Admin role / status from a user")
-    .option("<userId>", "User ID")
+    .argument("<userId>", "User ID")
     .version(pkg.version)
     .action(async (userId) => {
         try {

package/acs-cmd/acs-cmd-admin.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/acs-cmd/acs-cmd-assign-permission.js

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { recordExist } from "./utils.js";
 
 const pool = getDBPool();
 
 program
     .description("assign the permission to a role")
-    .option("<permissionId>", "Permission ID")
-    .option("<roleId>", "Role ID")
+    .argument("<permissionId>", "Permission ID")
+    .argument("<roleId>", "Role ID")
     .version(pkg.version)
     .action(async (permissionId, roleId) => {
         try {

package/acs-cmd/acs-cmd-assign-role.js

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { recordExist } from "./utils.js";
 
 const pool = getDBPool();
 
 program
     .description("assign the role to a user")
-    .option("<roleId>", "Role ID")
-    .option("<userId>", "User ID")
+    .argument("<roleId>", "Role ID")
+    .argument("<userId>", "User ID")
     .version(pkg.version)
     .action(async (roleId, userId) => {
         try {

package/acs-cmd/acs-cmd-assign.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/acs-cmd/acs-cmd-create-operation.js

@@ -1,18 +1,19 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
 
 const pool = getDBPool();
 
 program
     .version(pkg.version)
     .description(`A tool for creating operations. Version: ${pkg.version}`)
-    .option("<permission>", "Permission name")
-    .option("<uri>", "Operation uri")
-    .option("<name>", "Operation name")
-    .option("<description>", "Operation description")
+    .argument("<permission>", "Permission name")
+    .argument("<uri>", "Operation uri")
+    .argument("<name>", "Operation name")
+    .argument("<description>", "Operation description")
     .action(async (permissionName, uri, name, description) => {
         try {
             await pool.query("BEGIN TRANSACTION");

package/acs-cmd/acs-cmd-create-permission.js

@@ -1,17 +1,17 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
 
 const pool = getDBPool();
 
 program
     .version(pkg.version)
     .description(`A tool for creating permissions. Version: ${pkg.version}`)
-    .option("<name>", "Permission name")
-    .option("<description>", "Permission description")
+    .argument("<name>", "Permission name")
+    .argument("<description>", "Permission description")
     .action(async (name, description) => {
         try {
             await pool.query(

package/acs-cmd/acs-cmd-create.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/acs-cmd/acs-cmd-jwt.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const buildJwt = require("@magda/typescript-common/dist/session/buildJwt")
-    .default;
+import { program } from "commander";
+import chalk from "chalk";
+import buildJwt from "@magda/typescript-common/dist/session/buildJwt.js";
 
 const DEFAULT_JWT_SECRET = "squirrel";
 
@@ -11,8 +11,8 @@ program
     .description(
         `calculate JWT token (only for testing purpose). Version: ${pkg.version}`
     )
-    .option("<userId>", "User ID")
-    .option(
+    .argument("<userId>", "User ID")
+    .argument(
         "[jwtSecret]",
         "Optional JWT secret. Default value: `" + DEFAULT_JWT_SECRET + "`"
     )

package/acs-cmd/acs-cmd-list-permissions.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { table } = require("table");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { table } from "table";
 
 const pool = getDBPool();
 

package/acs-cmd/acs-cmd-list-resources.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { table } = require("table");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { table } from "table";
 
 const pool = getDBPool();
 

package/acs-cmd/acs-cmd-list-roles.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { table } = require("table");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { table } from "table";
 
 const pool = getDBPool();
 

package/acs-cmd/acs-cmd-list-users.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { table } = require("table");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { table } from "table";
 
 const pool = getDBPool();
 

package/acs-cmd/acs-cmd-list.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/acs-cmd/acs-cmd-remove-permission.js

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { recordExist } from "./utils.js";
 
 const pool = getDBPool();
 
 program
     .description("Remove a permission from a role")
-    .option("<permissionId>", "Permission ID")
-    .option("<roleId>", "Role ID")
+    .argument("<permissionId>", "Permission ID")
+    .argument("<roleId>", "Role ID")
     .version(pkg.version)
     .action(async (permissionId, roleId) => {
         try {

package/acs-cmd/acs-cmd-remove-role.js

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const getDBPool = require("../db/getDBPool");
-const { recordExist } = require("./utils");
+import { program } from "commander";
+import chalk from "chalk";
+import getDBPool from "../db/getDBPool.js";
+import { recordExist } from "./utils.js";
 
 const pool = getDBPool();
 
 program
     .description("Remove a role from a user")
-    .option("<roleId>", "Role ID")
-    .option("<userId>", "User ID")
+    .argument("<roleId>", "Role ID")
+    .argument("<userId>", "User ID")
     .version(pkg.version)
     .action(async (roleId, userId) => {
         try {

package/acs-cmd/acs-cmd-remove.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/acs-cmd/index.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("../package.json");
-const program = require("commander");
-const chalk = require("chalk");
+import { program } from "commander";
+import chalk from "chalk";
 
 program
     .version(pkg.version)

package/acs-cmd/utils.js

@@ -1,4 +1,4 @@
-async function recordExist(pool, table, record) {
+export async function recordExist(pool, table, record) {
     if (!Object.keys(record).length) {
         throw new Error("record cannot be an empty object!");
     }
@@ -19,7 +19,4 @@ async function recordExist(pool, table, record) {
     return true;
 }
 
-const ADMIN_ROLE_ID = "00000000-0000-0003-0000-000000000000";
-
-module.exports.recordExist = recordExist;
-module.exports.ADMIN_ROLE_ID = ADMIN_ROLE_ID;
+export const ADMIN_ROLE_ID = "00000000-0000-0003-0000-000000000000";

package/build-changed.js

@@ -1,10 +1,11 @@
-const childProcess = require("child_process");
-const getAllPackages = require("./getAllPackages");
-const isScalaPackage = require("./isScalaPackage");
-const findLastModifiedFile = require("./findLastModifiedFile");
-const path = require("path");
-const toposort = require("toposort");
-const yargs = require("yargs");
+import { require } from "@magda/esm-utils";
+import childProcess from "child_process";
+import getAllPackages from "./getAllPackages.js";
+import isScalaPackage from "./isScalaPackage";
+import findLastModifiedFile from "./findLastModifiedFile";
+import path from "path";
+import toposort from "toposort";
+import yargs from "yargs";
 
 const argv = yargs.config().help().option("skipDocker", {
     describe: "Skip the build/push of the docker image.",

package/check-release-version.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
-const path = require("path");
-const fse = require("fs-extra");
-const chalk = require("chalk");
+import { require } from "@magda/esm-utils";
+const pkg = require("./package.json");
+import path from "path";
+import fse from "fs-extra";
+import chalk from "chalk";
 
 const cwdPath = process.cwd();
-const pkg = fse.readJsonSync(path.join(cwdPath, "scripts", "package.json"));
+
 if (!pkg || !pkg["version"]) {
     console.error(chalk.red("Cannot find package.json at: " + cwdPath));
     process.exit(-1);

package/create-api-key.js

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("./package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const bcrypt = require("bcrypt");
-const crypto = require("crypto");
-const getDBPool = require("./db/getDBPool");
-const isUuid = require("isuuid");
+import { program } from "commander";
+import chalk from "chalk";
+import bcrypt from "bcrypt";
+import crypto from "crypto";
+import getDBPool from "./db/getDBPool.js";
+import isUuid from "isuuid";
 const { table } = require("table");
 
 program

package/create-docker-context-for-node-component.js

@@ -1,18 +1,16 @@
 #!/usr/bin/env node
 
-const childProcess = require("child_process");
-const fse = require("fs-extra");
-const path = require("path");
-const process = require("process");
-const yargs = require("yargs");
-const _ = require("lodash");
-const isSubDir = require("is-subdir");
-const {
-    getVersions,
-    getTags,
-    getName,
-    getRepository
-} = require("./docker-util");
+import childProcess from "child_process";
+import fse from "fs-extra";
+import path from "path";
+import process from "process";
+import yargs from "yargs";
+import _ from "lodash";
+import isSubDir from "is-subdir";
+import { getVersions, getTags, getName, getRepository } from "./docker-util.js";
+import { __dirname as getCurDirPath, require } from "@magda/esm-utils";
+
+const __dirname = getCurDirPath();
 
 // --- cache dependencies data from package.json
 const packageDependencyDataCache = {};
@@ -315,7 +313,7 @@ function preparePackage(packageDir, destDir) {
 
                 const productionPackages = _.uniqBy(
                     getPackageList(packageDir, path.resolve(packageDir, "..")),
-                    (package) => package.path
+                    (pkg) => pkg.path
                 );
 
                 prepareNodeModules(src, dest, productionPackages);
@@ -349,7 +347,14 @@ function prepareNodeModules(packageDir, destDir, productionPackages) {
             const type = stat.isFile() ? "file" : "junction";
             fse.ensureSymlinkSync(srcPath, dest, type);
         } catch (e) {
-            fse.copySync(srcPath, dest);
+            // see all error codes here: https://man7.org/linux/man-pages/man2/symlink.2.html#ERRORS
+            if (e?.code === "EEXIST") {
+                //console.log(`symlink ${srcPath} already exists, skip.`);
+                // the link already exists, we choose to not attempt to overwrite it.
+                // this means that the local dependency (in nearest node_modules) will higher priority than hoisted dependency (in root node_modules).
+                return;
+            }
+            throw e;
         }
     });
 }

package/create-jwt-token.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
+import { require } from "@magda/esm-utils";
 const pkg = require("./package.json");
-const program = require("commander");
-const chalk = require("chalk");
-const isUuid = require("isuuid");
-const buildJwt = require("@magda/typescript-common/dist/session/buildJwt")
-    .default;
+import { program } from "commander";
+import chalk from "chalk";
+import isUuid from "isuuid";
+import buildJwt from "@magda/typescript-common/dist/session/buildJwt.js";
 
 program
     .version(pkg.version)

package/create-region-synonym-file.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
-const _ = require("lodash");
-const yargs = require("yargs");
-const fs = require("fs");
-const request = require("request");
-const StreamArray = require("stream-json/streamers/StreamArray");
+import _ from "lodash";
+import yargs from "yargs";
+import fs from "fs";
+import fetch from "node-fetch";
+import StreamArray from "stream-json/streamers/StreamArray.js";
 
 function getDefaultRegionSourceConfig() {
     try {
@@ -85,28 +85,13 @@ function createLineFromRegionData(regionConfig, item) {
 }
 
 async function getRemoteDataFileStream(url) {
-    return new Promise((resolve, reject) => {
-        request
-            .get(url)
-            .on("error", (e) => reject(e))
-            .on("response", (response) => {
-                try {
-                    if (
-                        response.statusCode >= 200 &&
-                        response.statusCode <= 299
-                    ) {
-                        resolve(response.pipe(StreamArray.withParser()));
-                    } else {
-                        throw new Error(
-                            `Request failed ${url}, statusCode: ${response.statusCode}`
-                        );
-                    }
-                } catch (e) {
-                    console.error(e);
-                    reject(e);
-                }
-            });
-    });
+    const res = await fetch(url);
+    if (!res.ok) {
+        throw new Error(
+            `Request failed ${url}, statusCode: ${res.status} ${res.statusText}`
+        );
+    }
+    return res.body.pipe(StreamArray.withParser());
 }
 
 async function processRegionDataPipeline(regionConfig, targetStream) {

package/create-secrets/askQuestions.js

@@ -1,12 +1,12 @@
-const inquirer = require("inquirer");
-const trim = require("lodash/trim");
-const fs = require("fs");
-const path = require("path");
-const moment = require("moment");
-const chalk = require("chalk");
-const pwgen = require("./pwgen");
-const partial = require("lodash/partial");
-const stripJsonComments = require("strip-json-comments");
+import inquirer from "inquirer";
+import trim from "lodash/trim.js";
+import fs from "fs";
+import path from "path";
+import moment from "moment";
+import chalk from "chalk";
+import pwgen from "./pwgen.js";
+import partial from "lodash/partial.js";
+import stripJsonComments from "strip-json-comments";
 
 const questions = [
     {
@@ -774,7 +774,7 @@ function askStartSecretsCreationWithoutQuestions(config) {
         .then((answers) => answers["deploy-now"]);
 }
 
-function askIfCreateNamespace(namespace) {
+export function askIfCreateNamespace(namespace) {
     return inquirer
         .prompt([
             {
@@ -796,7 +796,7 @@ function askIfCreateNamespace(namespace) {
         .then((answers) => answers["if-create-namespace"]);
 }
 
-function askQuestions(config) {
+export function askQuestions(config) {
     return new Promise(function (resolve, reject) {
         const creationTime = config.get("creation-time");
         let p;
@@ -817,7 +817,7 @@ function askQuestions(config) {
     });
 }
 
-function getEnvVarInfo() {
+export function getEnvVarInfo() {
     return questions.map((item) => ({
         name: settingNameToEnvVarName(item.name),
         dataType: item.dataType ? item.dataType : "string",
@@ -826,14 +826,8 @@ function getEnvVarInfo() {
     }));
 }
 
-function settingNameToEnvVarName(settingName) {
+export function settingNameToEnvVarName(settingName) {
     return settingName.replace(/\-/g, "_").toUpperCase();
 }
 
-module.exports = {
-    askQuestions,
-    getEnvVarInfo,
-    settingNameToEnvVarName,
-    askIfCreateNamespace,
-    settingNameToEnvVarName
-};
+export default askQuestions;