From d4469430c23a25312b2e06f20d50d7e945c05634 Mon Sep 17 00:00:00 2001 From: Giacomo Cusinato <7659518+giacomocusinato@users.noreply.github.com> Date: Tue, 19 Nov 2024 17:47:24 +0100 Subject: [PATCH] fix: use missing `google` proto files in CLI --- .../scripts/generate-protocol.js | 164 +++++++++++------- 1 file changed, 106 insertions(+), 58 deletions(-) diff --git a/arduino-ide-extension/scripts/generate-protocol.js b/arduino-ide-extension/scripts/generate-protocol.js index f2b1ce8e8..01cf7d5a1 100644 --- a/arduino-ide-extension/scripts/generate-protocol.js +++ b/arduino-ide-extension/scripts/generate-protocol.js @@ -1,16 +1,17 @@ // @ts-check +const { exit } = require('node:process'); + (async () => { const os = require('node:os'); const path = require('node:path'); 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 +58,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 +83,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", - "VersionString": "nightly-20210126", - "Commit": "079bb6c6", - "Status": "alpha", - "Date": "2021-01-26T01:46:31Z" - } - */ + { + "Application": "arduino-cli", + "VersionString": "nightly-20210126", + "Commit": "079bb6c6", + "Status": "alpha", + "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}`; + const version = versionObject.VersionString; + + // Clone the repository and check out the tagged version + // Return folder with proto files + async function getProtoPath(forceCliVersion) { + const repository = await fs.mkdtemp(path.join(os.tmpdir(), 'arduino-cli-')); + + 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.`); + + let cliVersion = forceCliVersion || version; + if (validSemVer(cliVersion)) { + // https://github.com/arduino/arduino-cli/pull/2374 + if ( + gte(new SemVer(version, { loose: true }), new SemVer('0.35.0-rc.1')) + ) { + cliVersion = `v${cliVersion}`; + } + console.log(`>>> Checking out tagged version: '${cliVersion}'...`); + exec('git', ['-C', repository, 'fetch', '--all', '--tags'], { + logStdout: true, + }); + exec( + 'git', + ['-C', repository, 'checkout', `tags/${cliVersion}`, '-b', cliVersion], + { 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.` + ); } - console.log(`>>> Checking out tagged version: '${version}'...`); - exec('git', ['-C', repository, 'fetch', '--all', '--tags'], { - logStdout: true, - }); - exec( - 'git', - ['-C', repository, 'checkout', `tags/${version}`, '-b', version], - { logStdout: true } - ); - console.log(`<<< Checked out tagged version: '${version}'.`); - } 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.`); + 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,19 +174,40 @@ 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.`); + exit(1); + } + await fs.cp( + path.join(v104ProtoPath, 'google'), + path.join(protoPath, 'google'), + { + recursive: true, + } + ); + console.log(`>>> Generated missing google file`); + } + const protos = await new Promise((resolve) => - glob('**/*.proto', { cwd: rpc }, (error, matches) => { + glob('**/*.proto', { cwd: protoPath }, (error, matches) => { if (error) { console.log(error.stack ?? error.message); resolve([]); return; } - resolve(matches.map((filename) => path.join(rpc, filename))); + resolve(matches.map((filename) => path.join(protoPath, filename))); }) ); + if (!protos || protos.length === 0) { - console.log(`Could not find any .proto files under ${rpc}.`); - process.exit(1); + console.log(`Could not find any .proto files under ${protoPath}.`); + exit(1); } // Generate JS code from the `.proto` files. @@ -169,7 +217,7 @@ `--js_out=import_style=commonjs,binary:${out}`, `--grpc_out=generate_package_definition:${out}`, '-I', - rpc, + protoPath, ...protos, ], { logStdout: true } @@ -188,7 +236,7 @@ )}`, `--ts_out=generate_package_definition:${out}`, '-I', - rpc, + protoPath, ...protos, ], { logStdout: true }