chore: aligned CICD with js-quic

WIP: updated prebuild script

WIP: ignored binding.gyp so that `npm i` doesn't trigger build

WIP: added all optional deps

WIP: update package lock optional deps

WIP: removed unneeded optional deps

WIP: removed trailing comma in package.json

WIP: fixed prebuild

WIP: added recursive to mkdir to avoid errors on exist

Author: amydevs

.gitignore

@@ -7,8 +7,8 @@
 /builds
 # node-gyp
 /build
-# prebuildify
-/prebuilds
+/prebuild
+/prepublishOnly
 
 # Logs
 logs

.gitlab-ci.yml

@@ -83,7 +83,7 @@ check:test:
         coverage_format: cobertura
         path: ./tmp/coverage/cobertura-coverage.xml
     paths:
-      - ./prebuilds/
+      - ./prebuild/
   coverage: '/All files[^|]*\|[^|]*\s+([\d\.]+)/'
   rules:
     # Runs on feature commits and ignores version commits
@@ -193,7 +193,7 @@ build:windows:
         coverage_format: cobertura
         path: ./tmp/coverage/cobertura-coverage.xml
     paths:
-      - ./prebuilds/
+      - ./prebuild/
   coverage: '/All files[^|]*\|[^|]*\s+([\d\.]+)/'
   rules:
     # Runs on staging commits and ignores version commits
@@ -243,6 +243,9 @@ build:prerelease:
     - build:macos
   # Don't interrupt publishing job
   interruptible: false
+  variables:
+    # Set the prerelease tag for prepublishOnly script
+    npm_config_tag: 'prerelease'
   script:
     - echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > ./.npmrc
     - echo 'Publishing library prerelease'
@@ -251,12 +254,12 @@ build:prerelease:
       npm publish --tag prerelease --access public;
       '
     - >
-      for d in prebuilds/*; do
+      for d in prebuild/*; do
         tar \
           --create \
           --verbose \
-          --file="prebuilds/$(basename $d).tar" \
-          --directory=prebuilds \
+          --file="prebuild/$(basename $d).tar" \
+          --directory=prebuild \
           "$(basename $d)";
       done
   after_script:
@@ -323,12 +326,12 @@ release:distribution:
       npm publish --access public;
       '
     - >
-      for d in prebuilds/*; do
+      for d in /*; do
         tar \
           --create \
           --verbose \
-          --file="prebuilds/$(basename $d).tar" \
-          --directory=prebuilds \
+          --file="prebuild/$(basename $d).tar" \
+          --directory=prebuild \
           "$(basename $d)";
       done
   after_script:

.npmignore

@@ -12,4 +12,8 @@
 /benches
 /build
 /builds
+/prebuild
+/prepublishOnly
+/binding.gyp
 /dist/tsbuildinfo
+

package-lock.json

@@ -21,10 +21,11 @@
   "gypfile": true,
   "scripts": {
     "prepare": "tsc -p ./tsconfig.build.json",
-    "install": "node-gyp-build",
     "prebuild": "node ./scripts/prebuild.js",
     "build": "shx rm -rf ./dist && tsc -p ./tsconfig.build.json",
+    "version": "node ./scripts/version.js",
     "postversion": "npm install --package-lock-only --ignore-scripts --silent",
+    "prepublishOnly": "node ./scripts/prepublishOnly.js",
     "ts-node": "ts-node",
     "test": "jest",
     "lint": "eslint '{src,tests,scripts,benches}/**/*.{js,ts}'",
@@ -41,8 +42,10 @@
     "@matrixai/table": "^1.2.0",
     "@matrixai/timer": "^1.1.1",
     "canonicalize": "^2.0.0",
-    "ip-num": "^1.5.1",
-    "node-gyp-build": "^4.6.0"
+    "ip-num": "^1.5.1"
+  },
+  "optionalDependencies": {
+    "@matrixai/mdns-linux-x64": "1.0.0"
   },
   "devDependencies": {
     "@fast-check/jest": "^1.6.2",

package.json

@@ -36,16 +36,17 @@ async function main(argv = process.argv) {
   while (argv.length > 0) {
     const option = argv.shift();
     let match;
-    if ((match = option.match(/--nodedir(?:=(.+)|$)/))) {
-      nodedir = match[1] ?? argv.shift();
-    } else if ((match = option.match(/--devdir(?:=(.+)|$)/))) {
-      devdir = match[1] ?? argv.shift();
-    } else if ((match = option.match(/--arch(?:=(.+)|$)/))) {
+    if ((match = option.match(/--arch(?:=(.+)|$)/))) {
       arch = match[1] ?? argv.shift();
+    } else if ((match = option.match(/--production$/))) {
+      production = true;
     } else {
       restArgs.push(option);
     }
   }
+  if (arch == null) {
+    arch = process.env.npm_config_arch ?? os.arch();
+  }
 
   if (nodedir == null) {
     nodedir = process.env.npm_config_nodedir;
@@ -60,7 +61,7 @@ async function main(argv = process.argv) {
   }
 
   // If `nodedir` is specified, this means the headers are already part of the node source code
-  // When using `nix`, alwys specify the `nodedir` to avoid downloading from the internet in the middle of `nix-build`
+  // When using `nix`, always specify the `nodedir` to avoid downloading from the internet in the middle of `nix-build`
   if (nodedir == null) {
     // If `devdir` is not specified, node-gyp will place headers into default cache
     // Linux: `$XDG_CACHE_HOME/node-gyp` or `$HOME/.cache/node-gyp`
@@ -129,24 +130,19 @@ async function main(argv = process.argv) {
 
   const projectRoot = path.join(__dirname, '..');
   const buildsPath = path.join(projectRoot, 'build', 'Release');
-  const prebuildsPath = path.join(projectRoot, 'prebuilds');
+  const prebuildsPath = path.join(projectRoot, 'prebuild');
 
   const buildNames = await fs.promises.readdir(buildsPath);
   const buildName = buildNames.find((filename) => /\.node$/.test(filename));
   const buildPath = path.join(buildsPath, buildName);
 
-  const prebuildTuple = `${platform}-${arch}`;
-  // Tags are dot separated `<runtime>.<abi>.<othertag>`
-  // <runtime>: node | electron | node-webkit
-  // <abi>: napi | abi\d+
-  // Other tags depends on node-gyp-build parser
-  const prebuildTags = ['node', 'napi'].join('.');
+  const prebuildName = `mdns-${platform}-${arch}`;
   // The path must end with `.node`
   const prebuildPath =
-    path.join(prebuildsPath, prebuildTuple, prebuildTags) + '.node';
+    path.join(prebuildsPath, prebuildName) + '.node';
 
-  await fs.promises.mkdir(path.join(prebuildsPath, prebuildTuple), {
-    recursive: true,
+  await fs.promises.mkdir(prebuildsPath, {
+    recursive: true
   });
 
   console.error(`Copying ${buildPath} to ${prebuildPath}`);

scripts/prebuild.js

@@ -0,0 +1,133 @@
+#!/usr/bin/env node
+
+/**
+ * This runs before `npm publish` command.
+ * This will take the native objects in `prebuild/`
+ * and create native packages under `prepublishOnly/`.
+ *
+ * For example:
+ *
+ * /prepublishOnly
+ *   /@org
+ *     /name-linux-x64
+ *       /package.json
+ *       /node.napi.node
+ *       /README.md
+ */
+
+const os = require('os');
+const fs = require('fs');
+const path = require('path');
+const process = require('process');
+const childProcess = require('child_process');
+const packageJSON = require('../package.json');
+
+const platform = os.platform();
+
+/* eslint-disable no-console */
+async function main(argv = process.argv) {
+  argv = argv.slice(2);
+  let tag;
+  let dryRun = false;
+  const restArgs = [];
+  while (argv.length > 0) {
+    const option = argv.shift();
+    let match;
+    if ((match = option.match(/--tag(?:=(.+)|$)/))) {
+      tag = match[1] ?? argv.shift();
+    } else if ((match = option.match(/--dry-run$/))) {
+      dryRun = true;
+    } else {
+      restArgs.push(option);
+    }
+  }
+  if (tag == null) {
+    tag = process.env.npm_config_tag;
+  }
+  const projectRoot = path.join(__dirname, '..');
+  const prebuildPath = path.join(projectRoot, 'prebuild');
+  const prepublishOnlyPath = path.join(projectRoot, 'prepublishOnly');
+  const buildNames = (await fs.promises.readdir(prebuildPath)).filter(
+    (filename) => /^(?:[^-]+)-(?:[^-]+)-(?:[^-]+)$/.test(filename),
+  );
+  if (buildNames.length < 1) {
+    console.error(
+      'You must prebuild at least 1 native object with the filename of `name-platform-arch` before prepublish',
+    );
+    process.exitCode = 1;
+    return process.exitCode;
+  }
+  // Extract out the org name, this may be undefined
+  const orgName = packageJSON.name.match(/^@[^/]+/)?.[0];
+  for (const buildName of buildNames) {
+    // This is `name-platform-arch`
+    const name = path.basename(buildName, '.node');
+    // This is `@org/name-platform-arch`, uses `posix` to force usage of `/`
+    const packageName = path.posix.join(orgName ?? '', name);
+    const constraints = name.match(
+      /^(?:[^-]+)-(?<platform>[^-]+)-(?<arch>[^-]+)$/,
+    );
+    // This will be `prebuild/name-platform-arch.node`
+    const buildPath = path.join(prebuildPath, buildName);
+    // This will be `prepublishOnly/@org/name-platform-arch`
+    const packagePath = path.join(prepublishOnlyPath, packageName);
+    console.error('Packaging:', packagePath);
+    try {
+      await fs.promises.rm(packagePath, {
+        recursive: true,
+      });
+    } catch (e) {
+      if (e.code !== 'ENOENT') throw e;
+    }
+    await fs.promises.mkdir(packagePath, { recursive: true });
+    const nativePackageJSON = {
+      name: packageName,
+      version: packageJSON.version,
+      homepage: packageJSON.homepage,
+      author: packageJSON.author,
+      contributors: packageJSON.contributors,
+      description: packageJSON.description,
+      keywords: packageJSON.keywords,
+      license: packageJSON.license,
+      repository: packageJSON.repository,
+      main: 'node.napi.node',
+      os: [constraints.groups.platform],
+      cpu: [...constraints.groups.arch.split('+')],
+    };
+    const packageJSONPath = path.join(packagePath, 'package.json');
+    console.error(`Writing ${packageJSONPath}`);
+    const packageJSONString = JSON.stringify(nativePackageJSON, null, 2);
+    console.error(packageJSONString);
+    await fs.promises.writeFile(packageJSONPath, packageJSONString, {
+      encoding: 'utf-8',
+    });
+    const packageReadmePath = path.join(packagePath, 'README.md');
+    console.error(`Writing ${packageReadmePath}`);
+    const packageReadme = `# ${packageName}\n`;
+    console.error(packageReadme);
+    await fs.promises.writeFile(packageReadmePath, packageReadme, {
+      encoding: 'utf-8',
+    });
+    const packageBuildPath = path.join(packagePath, 'node.napi.node');
+    console.error(`Copying ${buildPath} to ${packageBuildPath}`);
+    await fs.promises.copyFile(buildPath, packageBuildPath);
+    const publishArgs = [
+      'publish',
+      packagePath,
+      ...(tag != null ? [`--tag=${tag}`] : []),
+      '--access=public',
+      ...(dryRun ? ['--dry-run'] : []),
+    ];
+    console.error('Running npm publish:');
+    console.error(['npm', ...publishArgs].join(' '));
+    childProcess.execFileSync('npm', publishArgs, {
+      stdio: ['inherit', 'inherit', 'inherit'],
+      windowsHide: true,
+      encoding: 'utf-8',
+      shell: platform === 'win32' ? true : false,
+    });
+  }
+}
+/* eslint-enable no-console */
+
+void main();