fix: use missing google proto files in CLI

arduino-ide-extension/scripts/generate-protocol.js

@@ -6,11 +6,10 @@
   const { mkdirSync, promises: fs, rmSync } = require('node:fs');
   const { exec } = require('./utils');
   const { glob } = require('glob');
-  const { SemVer, gte, valid: validSemVer } = require('semver');
+  const { SemVer, gte, valid: validSemVer, gt } = require('semver');
   // Use a node-protoc fork until apple arm32 is supported
   // https://github.com/YePpHa/node-protoc/pull/10
   const protoc = path.dirname(require('@pingghost/protoc/protoc'));
-  const repository = await fs.mkdtemp(path.join(os.tmpdir(), 'arduino-cli-'));
 
   const { owner, repo, commitish } = (() => {
     const pkg = require(path.join(__dirname, '..', 'package.json'));
@@ -57,11 +56,6 @@
     return { owner, repo, commitish };
   })();
 
-  const url = `https://github.com/${owner}/${repo}.git`;
-  console.log(`>>> Cloning repository from '${url}'...`);
-  exec('git', ['clone', url, repository], { logStdout: true });
-  console.log(`<<< Repository cloned.`);
-
   const { platform } = process;
   const resourcesFolder = path.join(
     __dirname,
@@ -87,59 +81,90 @@
   //  - `git-snapshot` for local build executed via `task build`. We do not do this.
   //  - rest, we assume it is a valid semver and has the corresponding tagged code, we use the tag to generate the APIs from the `proto` files.
   /*
-      {
+    {
-        "Application": "arduino-cli",
+      "Application": "arduino-cli",
-        "VersionString": "nightly-20210126",
+      "VersionString": "nightly-20210126",
-        "Commit": "079bb6c6",
+      "Commit": "079bb6c6",
-        "Status": "alpha",
+      "Status": "alpha",
-        "Date": "2021-01-26T01:46:31Z"
+      "Date": "2021-01-26T01:46:31Z"
-      }
-      */
-  const versionObject = JSON.parse(versionJson);
-  let version = versionObject.VersionString;
-  if (validSemVer(version)) {
-    // https://github.com/arduino/arduino-cli/pull/2374
-    if (gte(new SemVer(version, { loose: true }), new SemVer('0.35.0-rc.1'))) {
-      version = `v${version}`;
     }
-    console.log(`>>> Checking out tagged version: '${version}'...`);
+  */
-    exec('git', ['-C', repository, 'fetch', '--all', '--tags'], {
+  const versionObject = JSON.parse(versionJson);
-      logStdout: true,
+  const version = versionObject.VersionString;
-    });
+
-    exec(
+  // Clone the repository and check out the tagged version
-      'git',
+  // Return folder with proto files
-      ['-C', repository, 'checkout', `tags/${version}`, '-b', version],
+  async function getProtoPath(forceCliVersion) {
-      { logStdout: true }
+    const repository = await fs.mkdtemp(path.join(os.tmpdir(), 'arduino-cli-'));
-    );
+
-    console.log(`<<< Checked out tagged version: '${version}'.`);
+    const url = `https://github.com/${owner}/${repo}.git`;
-  } else if (commitish) {
+    console.log(`>>> Cloning repository from '${url}'...`);
-    console.log(
+    exec('git', ['clone', url, repository], { logStdout: true });
-      `>>> Checking out commitish from 'package.json': '${commitish}'...`
+    console.log(`<<< Repository cloned.`);
-    );
+
-    exec('git', ['-C', repository, 'checkout', commitish], { logStdout: true });
+    let cliVersion = forceCliVersion || version;
-    console.log(
+    if (validSemVer(cliVersion)) {
-      `<<< Checked out commitish from 'package.json': '${commitish}'.`
+      // https://github.com/arduino/arduino-cli/pull/2374
-    );
+      if (
-  } else if (versionObject.Commit) {
+        gte(new SemVer(version, { loose: true }), new SemVer('0.35.0-rc.1'))
-    console.log(
+      ) {
-      `>>> Checking out commitish from the CLI: '${versionObject.Commit}'...`
+        cliVersion = `v${cliVersion}`;
-    );
+      }
-    exec('git', ['-C', repository, 'checkout', versionObject.Commit], {
+      console.log(`>>> Checking out tagged version: '${cliVersion}'...`);
-      logStdout: true,
+      exec('git', ['-C', repository, 'fetch', '--all', '--tags'], {
-    });
+        logStdout: true,
-    console.log(
+      });
-      `<<< Checked out commitish from the CLI: '${versionObject.Commit}'.`
+      exec(
-    );
+        'git',
-  } else {
+        ['-C', repository, 'checkout', `tags/${cliVersion}`, '-b', cliVersion],
-    console.log(`WARN: no 'git checkout'. Generating from the HEAD revision.`);
+        { logStdout: true }
+      );
+      console.log(`<<< Checked out tagged version: '${cliVersion}'.`);
+    } else if (forceCliVersion) {
+      console.log(`WARN: invalid semver: '${forceCliVersion}'.`);
+      // If the forced version is invalid, do not proceed with fallbacks.
+      return undefined;
+    } else if (commitish) {
+      console.log(
+        `>>> Checking out commitish from 'package.json': '${commitish}'...`
+      );
+      exec('git', ['-C', repository, 'checkout', commitish], {
+        logStdout: true,
+      });
+      console.log(
+        `<<< Checked out commitish from 'package.json': '${commitish}'.`
+      );
+    } else if (versionObject.Commit) {
+      console.log(
+        `>>> Checking out commitish from the CLI: '${versionObject.Commit}'...`
+      );
+      exec('git', ['-C', repository, 'checkout', versionObject.Commit], {
+        logStdout: true,
+      });
+      console.log(
+        `<<< Checked out commitish from the CLI: '${versionObject.Commit}'.`
+      );
+    } else {
+      console.log(
+        `WARN: no 'git checkout'. Generating from the HEAD revision.`
+      );
+    }
+
+    return path.join(repository, 'rpc');
+  }
+
+  const protoPath = await getProtoPath();
+
+  if (!protoPath) {
+    console.log(`Could not find the proto files folder.`);
+    process.exit(1);
   }
 
   console.log('>>> Generating TS/JS API from:');
-  exec('git', ['-C', repository, 'rev-parse', '--abbrev-ref', 'HEAD'], {
+  exec('git', ['-C', protoPath, 'rev-parse', '--abbrev-ref', 'HEAD'], {
     logStdout: true,
   });
 
-  const rpc = path.join(repository, 'rpc');
   const out = path.join(__dirname, '..', 'src', 'node', 'cli-protocol');
   // Must wipe the gen output folder. Otherwise, dangling service implementation remain in IDE2 code,
   // although it has been removed from the proto file.
@@ -147,16 +172,36 @@
   rmSync(out, { recursive: true, maxRetries: 5, force: true });
   mkdirSync(out, { recursive: true });
 
+  if (gt(new SemVer(version, { loose: true }), new SemVer('1.0.4'))) {
+    // Patch for https://github.com/arduino/arduino-cli/issues/2755
+    // Credit https://github.com/dankeboy36/ardunno-cli-gen/pull/9/commits/64a5ac89aae605249261c8ceff7255655ecfafca
+    // Download the 1.0.4 version and use the missing google/rpc/status.proto file.
+    console.log('<<< Generating missing google proto files');
+    const v104ProtoPath = await getProtoPath('1.0.4');
+    if (!v104ProtoPath) {
+      console.log(`Could not find the proto files folder for version 1.0.4.`);
+      process.exit(1);
+    }
+    await fs.cp(
+      path.join(v104ProtoPath, 'google'),
+      path.join(protoPath, 'google'),
+      {
+        recursive: true,
+      }
+    );
+    console.log(`>>> Generated missing google file`);
+  }
+
   let protos = [];
   try {
-    const matches = await glob('**/*.proto', { cwd: rpc });
+    const matches = await glob('**/*.proto', { cwd: protoPath });
-    protos = matches.map((filename) => path.join(rpc, filename));
+    protos = matches.map((filename) => path.join(protoPath, filename));
   } catch (error) {
     console.log(error.stack ?? error.message);
   }
 
   if (!protos || protos.length === 0) {
-    console.log(`Could not find any .proto files under ${rpc}.`);
+    console.log(`Could not find any .proto files under ${protoPath}.`);
     process.exit(1);
   }
 
@@ -167,7 +212,7 @@
       `--js_out=import_style=commonjs,binary:${out}`,
       `--grpc_out=generate_package_definition:${out}`,
       '-I',
-      rpc,
+      protoPath,
       ...protos,
     ],
     { logStdout: true }
@@ -186,7 +231,7 @@
       )}`,
       `--ts_out=generate_package_definition:${out}`,
       '-I',
-      rpc,
+      protoPath,
       ...protos,
     ],
     { logStdout: true }