Add postinstall hook for fetching official protoc-gen-js binary

Author: dibenede

MODULE.bazel.lock

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+console.error(
+  'The protoc-gen-js binary could not be found. This is likely because you ' +
+  'installed google-protobuf with the --omit=optional flag.'
+);
+console.error(
+  'To fix this, please reinstall google-protobuf without that flag.'
+);
+process.exit(1);

bin/protoc-gen-js

@@ -0,0 +1,143 @@
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+const isGlobal = process.env.npm_config_global === 'true';
+
+let AdmZip;
+try {
+  AdmZip = require('adm-zip');
+} catch (e) {
+  if (isGlobal) {
+    console.warn(
+      'Skipping protoc-gen-js download due to --omit=optional in global install.'
+    );
+    console.warn(
+      'If you have a system-installed protoc-gen-js, it will be preserved.'
+    );
+    // On global installs, we refuse to overwrite a potentially real binary
+    // with our placeholder. In this case, we must delete our placeholder.
+    const placeholderPath = path.join(__dirname, 'bin', 'protoc-gen-js');
+    if (fs.existsSync(placeholderPath)) {
+      fs.unlinkSync(placeholderPath);
+    }
+  } else {
+    // For local installs, the placeholder script is fine. It's sandboxed
+    // to the project's node_modules/.bin and provides a helpful error.
+    console.warn(
+      'adm-zip not found, skipping binary download. The protoc-gen-js command will show a help message.'
+    );
+  }
+  process.exit(0);
+}
+
+const VERSION = '4.0.0';
+const BIN_DIR = path.join(__dirname, 'bin');
+
+function getPlatform() {
+  const platform = os.platform();
+  if (platform === 'darwin') {
+    return 'osx';
+  }
+  if (platform === 'win32') {
+    return 'windows';
+  }
+  return platform;
+}
+
+function getArch() {
+  const arch = os.arch();
+  if (arch === 'x64') {
+    return 'x86_64';
+  }
+  if (arch === 'arm64') {
+    return 'aarch64';
+  }
+  return arch;
+}
+
+function getDownloadUrl() {
+  const platform = getPlatform();
+  const arch = getArch();
+  const supportedPlatforms = {
+    linux: ['x86_64', 'aarch64'],
+    osx: ['x86_64', 'aarch64'],
+    windows: ['x86_64'],
+  };
+
+  if (
+    !supportedPlatforms[platform] ||
+    !supportedPlatforms[platform].includes(arch)
+  ) {
+    console.error(`Unsupported platform: ${platform}-${arch}`);
+    process.exit(1);
+  }
+
+  return `https://github.com/protocolbuffers/protobuf-javascript/releases/download/v${VERSION}/protobuf-javascript-${VERSION}-${platform}-${arch}.zip`;
+}
+
+function unzip(zipFile, destDir, binaryName) {
+  return new Promise((resolve, reject) => {
+    const binaryPathInZip = `bin/${binaryName}`;
+    const zip = new AdmZip(zipFile);
+    const zipEntries = zip.getEntries();
+    let found = false;
+
+    for (const entry of zipEntries) {
+      const entryFileName = entry.entryName.replace(/\\/g, '/');
+      if (entryFileName.endsWith(binaryPathInZip)) {
+        found = true;
+        fs.writeFile(path.join(destDir, binaryName), entry.getData(), (err) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve();
+          }
+        });
+        break;
+      }
+    }
+
+    if (!found) {
+      reject(new Error(`Binary ${binaryPathInZip} not found in zip file.`));
+    }
+  });
+}
+
+async function main() {
+  try {
+    const downloadUrl = getDownloadUrl();
+    const zipFile = path.join(__dirname, 'google-protobuf.zip');
+    const binaryName =
+      os.platform() === 'win32' ? 'protoc-gen-js.exe' : 'protoc-gen-js';
+
+    await fs.promises.mkdir(BIN_DIR, {recursive: true});
+
+    console.log(`Downloading ${downloadUrl}`);
+    const response = await fetch(downloadUrl);
+    if (!response.ok) {
+      throw new Error(
+        `Failed to download: ${response.status} ${response.statusText}`
+      );
+    }
+    const buffer = await response.arrayBuffer();
+    await fs.promises.writeFile(zipFile, Buffer.from(buffer));
+
+    console.log('Unzipping...');
+    await unzip(zipFile, BIN_DIR, binaryName);
+
+    await fs.promises.unlink(zipFile);
+
+    const binaryPath = path.join(BIN_DIR, binaryName);
+
+    console.log(`Making ${binaryPath} executable...`);
+    await fs.promises.chmod(binaryPath, 0o755);
+
+    console.log('Done!');
+  } catch (err) {
+    console.error(`Failed to download protoc-gen-js: ${err.message}`);
+    process.exit(1);
+  }
+}
+
+main();

download-protoc-gen-js.js

@@ -3,15 +3,23 @@
   "version": "4.0.0",
   "description": "Protocol Buffers for JavaScript",
   "main": "google-protobuf.js",
+  "bin": {
+    "protoc-gen-js": "bin/protoc-gen-js"
+  },
   "files": [
     "google/protobuf/*_pb.js",
     "google/protobuf/compiler/*_pb.js",
     "google-protobuf.js",
     "LICENSE.md",
     "LICENSE-asserts.md",
     "package.json",
-    "README.md"
+    "README.md",
+    "download-protoc-gen-js.js",
+    "bin/protoc-gen-js"
   ],
+  "optionalDependencies": {
+    "adm-zip": "^0.5.16"
+  },
   "devDependencies": {
     "glob": "~7.1.4",
     "google-closure-compiler": "20230802.0.0",
@@ -23,7 +31,8 @@
   "scripts": {
     "build": "node ./node_modules/gulp/bin/gulp.js dist",
     "test": "node ./node_modules/gulp/bin/gulp.js test",
-    "clean": "node ./node_modules/gulp/bin/gulp.js clean"
+    "clean": "node ./node_modules/gulp/bin/gulp.js clean",
+    "postinstall": "node download-protoc-gen-js.js"
   },
   "repository": {
     "type": "git",

package-lock.json

@@ -0,0 +1,13 @@
+
+const { spawn } = require('child_process');
+
+const child = spawn('node', ['download-protoc-gen-js.js'], {
+  stdio: 'inherit'
+});
+
+child.on('close', (code) => {
+  if (code !== 0) {
+    console.error('Failed to download protoc-gen-js');
+    process.exit(1);
+  }
+});

package.json

@@ -14,6 +14,11 @@
   dependencies:
     is-negated-glob "^1.0.0"
 
+adm-zip@^0.5.16:
+  version "0.5.16"
+  resolved "https://registry.npmjs.org/adm-zip/-/adm-zip-0.5.16.tgz"
+  integrity sha512-TGw5yVi4saajsSEgz25grObGHEUaDrniwvA2qwSC060KfqGPdglhvPMA2lPIoxs3PQIItj2iag35fONcQqgUaQ==
+
 ansi-regex@^5.0.1:
   version "5.0.1"
   resolved "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz"