eitri-cli 1.8.0-beta.2 → 1.9.0-beta.1

package/eitri-cli-v2/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "eitri-cli-v2"
+version = "0.1.0"
+license = "ISC"
+edition = "2021"
+exclude = ["index.node"]
+
+[lib]
+crate-type = ["cdylib"]
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+homedir = "0.2.1"
+httpmock = "0.7.0"
+neon = "1"
+once_cell = "1.19.0"
+reqwest = { version = "0.11.24", features = ["json", "multipart", "cookies"] }
+serde = { version = "1.0.197", features = ["derive"] }
+serde_derive = "1.0.197"
+serde_json = "1.0.114"
+tokio = { version = "1.36.0", features = ["full"] }

package/eitri-cli-v2/README.md

@@ -0,0 +1,119 @@
+# eitri-cli-v2
+
+This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
+
+## Installing eitri-cli-v2
+
+Installing eitri-cli-v2 requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
+
+You can install the project with npm. In the project directory, run:
+
+```sh
+$ npm install
+```
+
+This fully installs the project, including installing any dependencies and running the build.
+
+## Building eitri-cli-v2
+
+If you have already installed the project and only want to run the build, run:
+
+```sh
+$ npm run build
+```
+
+This command uses the [cargo-cp-artifact](https://github.com/neon-bindings/cargo-cp-artifact) utility to run the Rust build and copy the built library into `./index.node`.
+
+## Exploring eitri-cli-v2
+
+After building eitri-cli-v2, you can explore its exports at the Node REPL:
+
+```sh
+$ npm install
+$ node
+> require('.').hello()
+"hello node"
+```
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm install`
+
+Installs the project, including running `npm run build`.
+
+### `npm build`
+
+Builds the Node addon (`index.node`) from source.
+
+Additional [`cargo build`](https://doc.rust-lang.org/cargo/commands/cargo-build.html) arguments may be passed to `npm build` and `npm build-*` commands. For example, to enable a [cargo feature](https://doc.rust-lang.org/cargo/reference/features.html):
+
+```
+npm run build -- --feature=beetle
+```
+
+#### `npm build-debug`
+
+Alias for `npm build`.
+
+#### `npm build-release`
+
+Same as [`npm build`](#npm-build) but, builds the module with the [`release`](https://doc.rust-lang.org/cargo/reference/profiles.html#release) profile. Release builds will compile slower, but run faster.
+
+### `npm test`
+
+Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/).
+
+## Project Layout
+
+The directory structure of this project is:
+
+```
+eitri-cli-v2/
+├── Cargo.toml
+├── README.md
+├── index.node
+├── package.json
+├── src/
+|   └── lib.rs
+└── target/
+```
+
+### Cargo.toml
+
+The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.
+
+### README.md
+
+This file.
+
+### index.node
+
+The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the `"main"` key in `package.json`.
+
+Under the hood, a [Node addon](https://nodejs.org/api/addons.html) is a [dynamically-linked shared object](https://en.wikipedia.org/wiki/Library_(computing)#Shared_libraries). The `"build"` script produces this file by copying it from within the `target/` directory, which is where the Rust build produces the shared object.
+
+### package.json
+
+The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.
+
+### src/
+
+The directory tree containing the Rust source code for the project.
+
+### src/lib.rs
+
+The Rust library's main module.
+
+### target/
+
+Binary artifacts generated by the Rust build.
+
+## Learn More
+
+To learn more about Neon, see the [Neon documentation](https://neon-bindings.com).
+
+To learn more about Rust, see the [Rust documentation](https://www.rust-lang.org).
+
+To learn more about Node, see the [Node documentation](https://nodejs.org).

package/eitri-cli-v2/index.js

@@ -0,0 +1,2 @@
+const os = require('os')
+module.exports = os.platform() === 'win32' ? require('./index.win32.node'): require('./index.unix.node')

package/eitri-cli-v2/node_modules/.yarn-integrity

@@ -0,0 +1,16 @@
+{
+  "systemParams": "linux-x64-108",
+  "modulesFolders": [
+    "node_modules"
+  ],
+  "flags": [],
+  "linkedModules": [],
+  "topLevelPatterns": [
+    "cargo-cp-artifact@^0.1"
+  ],
+  "lockfileEntries": {
+    "cargo-cp-artifact@^0.1": "https://registry.yarnpkg.com/cargo-cp-artifact/-/cargo-cp-artifact-0.1.8.tgz#353814f49f6aa76601a4bcb3ea5f3071180b90de"
+  },
+  "files": [],
+  "artifacts": {}
+}

package/eitri-cli-v2/node_modules/cargo-cp-artifact/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 The Neon Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/eitri-cli-v2/node_modules/cargo-cp-artifact/README.md

@@ -0,0 +1,93 @@
+# cargo-cp-artifact
+
+`cargo-cp-artifact` is a small command line utility for parsing cargo metadata output and copying a compiler artifact to a desired location.
+
+## Installation
+
+```sh
+npm install -g cargo-cp-artifact
+```
+
+## Usage
+
+```
+cargo-cp-artifact --artifact artifact-kind crate-name output-file -- wrapped-command
+```
+
+`cargo-cp-artifact` accepts a list of crate name and artifact kind to output file mappings and a command to wrap.`cargo-cp-artifact` will read `stdout` of the wrapped command and parse it as [cargo metadata](https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages). Compiler artifacts that match arguments provided will be copied to the target destination.
+
+When wrapping a `cargo` command, it is necessary to include a `json` format to `--message-format`.
+
+### Arguments
+
+Multiple arguments are allowed to copy multiple build artifacts.
+
+#### `--artifact`
+
+_Alias: `-a`_
+
+Followed by *three* arguments: `artifact-kind crate-name output-file`
+
+#### `--npm`
+
+_Alias: `-n`_
+
+Followed by *two* arguments: `artifact-kind output-file`
+
+The crate name will be read from the `npm_package_name` environment variable. If the package name includes a namespace (`@namespace/package`), the namespace will be removed when matching the crate name (`package`).
+
+### Artifact Kind
+
+Valid artifact kinds are `bin`, `cdylib`, and `dylib`. They may be abbreviated as `b`, `c`, and `d` respectively.
+
+For example, `-ac` is the equivalent of `--artifact cdylib`.
+
+## Examples
+
+### Wrapping cargo
+
+```sh
+cargo-cp-artifact -a cdylib my-crate lib/index.node -- cargo build --message-format=json-render-diagnostics
+```
+
+### Parsing a file
+
+```sh
+cargo-cp-artifact -a cdylib my-crate lib/index.node -- cat build-output.txt
+```
+
+### `npm` script
+
+`package.json`
+```json
+{
+    "name": "my-crate",
+    "scripts": {
+        "build": "cargo-cp-artifact -nc lib/index.node -- cargo build --message-format=json-render-diagnostics"
+    }
+}
+```
+
+```sh
+npm run build
+
+# Additional arguments may be passed
+npm run build -- --feature=serde
+```
+
+## Why does this exist?
+
+At the time of writing, `cargo` does not include a configuration for outputting a library or binary to a specified location. An `--out-dir` option [exists on nightly](https://github.com/rust-lang/cargo/issues/6790), but does not allow specifying the name of the file.
+
+It surprisingly difficult to reliably find the location of a cargo compiler artifact. It is impacted by many parameters, including:
+
+* Build profile
+* Target, default or specified
+* Crate name and name transforms
+
+However, `cargo` can emit metadata on `stdout` while continuing to provide human readable diagnostics on `stderr`. The metadata may be parsed to more easily and reliably find the location of compiler artifacts.
+
+`cargo-cp-artifact` chooses to wrap a command as a child process instead of reading `stdin` for two reasons:
+
+1. Removes the need for `-o pipefile` when integrating with build tooling which may need to be platform agnostic.
+2. Allows additional arguments to be provided when used in an [`npm` script](https://docs.npmjs.com/cli/v6/using-npm/scripts).

package/eitri-cli-v2/node_modules/cargo-cp-artifact/bin/cargo-cp-artifact.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+
+const run = require("..");
+
+run(process.argv.slice(2), process.env);

package/eitri-cli-v2/node_modules/cargo-cp-artifact/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "cargo-cp-artifact",
+  "version": "0.1.8",
+  "description": "Copies compiler artifacts emitted by rustc by parsing Cargo metadata",
+  "main": "src/index.js",
+  "files": [
+    "bin",
+    "src"
+  ],
+  "bin": {
+    "cargo-cp-artifact": "bin/cargo-cp-artifact.js"
+  },
+  "scripts": {
+    "test": "mocha test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/neon-bindings/neon.git"
+  },
+  "keywords": [
+    "cargo",
+    "rust",
+    "neon"
+  ],
+  "author": "K.J. Valencik",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/neon-bindings/neon/issues"
+  },
+  "homepage": "https://github.com/neon-bindings/neon/tree/main/pkgs/cargo-cp-artifact",
+  "devDependencies": {
+    "mocha": "^10.0.0"
+  }
+}

package/eitri-cli-v2/node_modules/cargo-cp-artifact/src/args.js

@@ -0,0 +1,131 @@
+"use strict";
+
+class ParseError extends Error {}
+
+const NPM_ENV = "npm_package_name";
+const EXPECTED_COMMAND = [
+  "Missing command to execute.",
+  [
+    "cargo-cp-artifct -a cdylib my-crate index.node",
+    "--",
+    "cargo build --message-format=json-render-diagnostics",
+  ].join(" "),
+].join("\n");
+
+function validateArtifactType(artifactType) {
+  switch (artifactType) {
+    case "b":
+    case "bin":
+      return "bin";
+    case "c":
+    case "cdylib":
+      return "cdylib";
+    case "d":
+    case "dylib":
+      return "dylib";
+    default:
+  }
+
+  throw new ParseError(`Unexpected artifact type: ${artifactType}`);
+}
+
+function getArtifactName({ artifactType, crateName }) {
+  return `${artifactType}:${crateName}`;
+}
+
+function getCrateNameFromEnv(env) {
+  if (!env.hasOwnProperty(NPM_ENV)) {
+    throw new ParseError(
+      [
+        `Could not find the \`${NPM_ENV}\` environment variable.`,
+        "Expected to be executed from an `npm` command.",
+      ].join(" ")
+    );
+  }
+
+  const name = env[NPM_ENV];
+  const firstSlash = name.indexOf("/");
+
+  // This is a namespaced package; assume the crate is the un-namespaced version
+  if (name[0] === "@" && firstSlash > 0) {
+    return name.slice(firstSlash + 1);
+  }
+
+  return name;
+}
+
+function parse(argv, env) {
+  const artifacts = {};
+  let tokens = argv;
+
+  function getNext() {
+    if (!tokens.length) {
+      throw new ParseError(EXPECTED_COMMAND);
+    }
+
+    const next = tokens[0];
+    tokens = tokens.slice(1);
+    return next;
+  }
+
+  function getArtifactType(token) {
+    if (token[1] !== "-" && token.length === 3) {
+      return validateArtifactType(token[2]);
+    }
+
+    return validateArtifactType(getNext());
+  }
+
+  function pushArtifact(artifact) {
+    const name = getArtifactName(artifact);
+
+    artifacts[name] = artifacts[name] || [];
+    artifacts[name].push(artifact.outputFile);
+  }
+
+  while (tokens.length) {
+    const token = getNext();
+
+    // End of CLI arguments
+    if (token === "--") {
+      break;
+    }
+
+    if (
+      token === "--artifact" ||
+      (token.length <= 3 && token.startsWith("-a"))
+    ) {
+      const artifactType = getArtifactType(token);
+      const crateName = getNext();
+      const outputFile = getNext();
+
+      pushArtifact({ artifactType, crateName, outputFile });
+      continue;
+    }
+
+    if (token === "--npm" || (token.length <= 3 && token.startsWith("-n"))) {
+      const artifactType = getArtifactType(token);
+      const crateName = getCrateNameFromEnv(env);
+      const outputFile = getNext();
+
+      pushArtifact({ artifactType, crateName, outputFile });
+      continue;
+    }
+
+    throw new ParseError(`Unexpected option: ${token}`);
+  }
+
+  if (!tokens.length) {
+    throw new ParseError(EXPECTED_COMMAND);
+  }
+
+  const cmd = getNext();
+
+  return {
+    artifacts,
+    cmd,
+    args: tokens,
+  };
+}
+
+module.exports = { ParseError, getArtifactName, parse };

package/eitri-cli-v2/node_modules/cargo-cp-artifact/src/index.js

@@ -0,0 +1,164 @@
+"use strict";
+
+const { spawn } = require("child_process");
+const {
+  promises: { copyFile, mkdir, stat, unlink },
+} = require("fs");
+const { dirname, extname } = require("path");
+const readline = require("readline");
+
+const { ParseError, getArtifactName, parse } = require("./args");
+
+function run(argv, env) {
+  const options = parseArgs(argv, env);
+  const copied = {};
+
+  const cp = spawn(options.cmd, options.args, {
+    stdio: ["inherit", "pipe", "inherit"],
+    shell: process.platform === "win32",
+  });
+
+  const rl = readline.createInterface({ input: cp.stdout });
+
+  cp.on("error", (err) => {
+    if (options.cmd === "cargo" && err.code === "ENOENT") {
+      console.error(`Error: could not find the \`cargo\` executable.
+
+You can find instructions for installing Rust and Cargo at:
+
+    https://www.rust-lang.org/tools/install
+
+`);
+    } else {
+      console.error(err);
+    }
+    process.exitCode = 1;
+  });
+
+  cp.on("exit", (code) => {
+    if (!process.exitCode) {
+      process.exitCode = code;
+    }
+  });
+
+  rl.on("line", (line) => {
+    try {
+      processCargoBuildLine(options, copied, line);
+    } catch (err) {
+      console.error(err);
+      process.exitCode = 1;
+    }
+  });
+
+  process.on("exit", () => {
+    Object.keys(options.artifacts).forEach((name) => {
+      if (!copied[name]) {
+        console.error(`Did not copy "${name}"`);
+
+        if (!process.exitCode) {
+          process.exitCode = 1;
+        }
+      }
+    });
+  });
+}
+
+function processCargoBuildLine(options, copied, line) {
+  const data = JSON.parse(line);
+  const { filenames, reason, target } = data;
+
+  if (!data || reason !== "compiler-artifact" || !target) {
+    return;
+  }
+
+  const { kind: kinds, name } = data.target;
+
+  if (!Array.isArray(kinds) || !Array.isArray(filenames)) {
+    return;
+  }
+
+  // `kind` and `filenames` zip up as key/value pairs
+  kinds.forEach((kind, i) => {
+    const filename = filenames[i];
+    const key = getArtifactName({ artifactType: kind, crateName: name });
+    const outputFiles = options.artifacts[key];
+
+    if (!outputFiles || !filename) {
+      return;
+    }
+
+    Promise.all(
+      outputFiles.map((outputFile) => copyArtifact(filename, outputFile))
+    )
+      .then(() => {
+        copied[key] = true;
+      })
+      .catch((err) => {
+        process.exitCode = 1;
+        console.error(err);
+      });
+  });
+}
+
+async function isNewer(filename, outputFile) {
+  try {
+    const prevStats = await stat(outputFile);
+    const nextStats = await stat(filename);
+
+    return nextStats.mtime > prevStats.mtime;
+  } catch (_err) {}
+
+  return true;
+}
+
+async function copyArtifact(filename, outputFile) {
+  if (!(await isNewer(filename, outputFile))) {
+    return;
+  }
+
+  const outputDir = dirname(outputFile);
+
+  // Don't try to create the current directory
+  if (outputDir && outputDir !== ".") {
+    await mkdir(outputDir, { recursive: true });
+  }
+
+  // Apple Silicon (M1, etc.) requires shared libraries to be signed. However,
+  // the macOS code signing cache isn't cleared when overwriting a file.
+  // Deleting the file before copying works around the issue.
+  //
+  // Unfortunately, this workaround is incomplete because the file must be
+  // deleted from the location it is loaded. If further steps in the user's
+  // build process copy or move the file in place, the code signing cache
+  // will not be cleared.
+  //
+  // https://github.com/neon-bindings/neon/issues/911
+  if (extname(outputFile) === ".node") {
+    try {
+      await unlink(outputFile);
+    } catch (_e) {
+      // Ignore errors; the file might not exist
+    }
+  }
+
+  await copyFile(filename, outputFile);
+}
+
+function parseArgs(argv, env) {
+  try {
+    return parse(argv, env);
+  } catch (err) {
+    if (err instanceof ParseError) {
+      quitError(err.message);
+    } else {
+      throw err;
+    }
+  }
+}
+
+function quitError(msg) {
+  console.error(msg);
+  process.exit(1);
+}
+
+module.exports = run;

package/eitri-cli-v2/package-lock.json

@@ -0,0 +1,26 @@
+{
+  "name": "eitri-cli-v2",
+  "version": "0.1.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "eitri-cli-v2",
+      "version": "0.1.0",
+      "hasInstallScript": true,
+      "license": "ISC",
+      "devDependencies": {
+        "cargo-cp-artifact": "^0.1"
+      }
+    },
+    "node_modules/cargo-cp-artifact": {
+      "version": "0.1.8",
+      "resolved": "https://registry.npmjs.org/cargo-cp-artifact/-/cargo-cp-artifact-0.1.8.tgz",
+      "integrity": "sha512-3j4DaoTrsCD1MRkTF2Soacii0Nx7UHCce0EwUf4fHnggwiE4fbmF2AbnfzayR36DF8KGadfh7M/Yfy625kgPlA==",
+      "dev": true,
+      "bin": {
+        "cargo-cp-artifact": "bin/cargo-cp-artifact.js"
+      }
+    }
+  }
+}

package/eitri-cli-v2/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "eitri-cli-v2",
+  "version": "0.1.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "cargo-cp-artifact -nc index.unix.node -- cargo build --message-format=json-render-diagnostics",
+    "build:win32": "cargo-cp-artifact -nc index.win32.node -- cargo build --message-format=json-render-diagnostics --target x86_64-pc-windows-gnu",
+    "build-debug": "npm run build --",
+    "build-release": "npm run build -- --release",
+    "build-release:win32": "npm run build:win32 -- --release",
+    "install": "npm run build-release",
+    "install:win32": "npm run build-release:win32",
+    "test": "cargo test"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "cargo-cp-artifact": "^0.1"
+  }
+}

package/eitri-cli-v2/src/commands/mod.rs

@@ -0,0 +1 @@
+pub mod publish;