@grafana/sign-plugin 2.0.0 → 2.0.2-canary.481.f400697.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v2.0.1 (Tue Oct 03 2023)
+
+#### 🐛 Bug Fix
+
+- Allows to sign behind an https proxy [#436](https://github.com/grafana/plugin-tools/pull/436) ([@academo](https://github.com/academo))
+
+#### Authors: 1
+
+- Esteban Beltran ([@academo](https://github.com/academo))
+
+---
+
 # v2.0.0 (Mon Oct 02 2023)
 
 #### 🐛 Bug Fix

package/README.md

@@ -22,7 +22,7 @@ Signing a plugin allows Grafana to verify the authenticity of the plugin with si
 
 All plugins require a signature since Grafana 7.0.
 
-Please refer to [Signing plugins documentation](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/) to understand how to sign a Grafana plugin. The following commands are mentioned here for development purposes.
+Please refer to [Signing plugins documentation](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin) to understand how to sign a Grafana plugin. The following commands are mentioned here for development purposes.
 
 ### Sign a public plugin
 

package/dist/bin/run.js

@@ -3,14 +3,14 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var minimist_1 = __importDefault(require("minimist"));
 var commands_1 = require("../commands");
 var args = process.argv.slice(2);
-var argv = (0, minimist_1["default"])(args);
+var argv = (0, minimist_1.default)(args);
 var commands = {
     sign: commands_1.sign,
-    version: commands_1.version
+    version: commands_1.version,
 };
 var command = commands[argv._[0]] || commands.sign;
 command(argv);

package/dist/commands/index.js

@@ -13,6 +13,6 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./sign.command"), exports);
 __exportStar(require("./version.command"), exports);

package/dist/commands/sign.command.js

@@ -38,7 +38,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.sign = void 0;
 var path_1 = __importDefault(require("path"));
 var fs_1 = require("fs");
@@ -52,7 +52,7 @@ var sign = function (argv) { return __awaiter(void 0, void 0, void 0, function (
         switch (_d.label) {
             case 0:
                 distDir = (_a = argv.distDir) !== null && _a !== void 0 ? _a : 'dist';
-                pluginDistDir = path_1["default"].resolve(distDir);
+                pluginDistDir = path_1.default.resolve(distDir);
                 signatureType = argv.signatureType;
                 rootUrls = (_c = (_b = argv.rootUrls) === null || _b === void 0 ? void 0 : _b.split(',')) !== null && _c !== void 0 ? _c : [];
                 if (!(0, fs_1.existsSync)(pluginDistDir)) {

package/dist/commands/version.command.js

@@ -35,7 +35,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 var getVersion_1 = require("../utils/getVersion");
 var version = function () { return __awaiter(void 0, void 0, void 0, function () {

package/dist/utils/getVersion.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVersion = void 0;
 var fs_1 = require("fs");
 var path_1 = require("path");

package/dist/utils/manifest.js

@@ -46,7 +46,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
 var __asyncDelegator = (this && this.__asyncDelegator) || function (o) {
     var i, p;
     return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
-    function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; }
+    function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }
 };
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
@@ -73,7 +73,7 @@ var __values = (this && this.__values) || function(o) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.saveManifest = exports.signManifest = exports.buildManifest = void 0;
 var crypto_1 = __importDefault(require("crypto"));
 var promises_1 = __importDefault(require("fs/promises"));
@@ -88,76 +88,71 @@ function walk(dir, baseDir) {
         return __generator(this, function (_g) {
             switch (_g.label) {
                 case 0:
-                    _g.trys.push([0, 20, 21, 26]);
+                    _g.trys.push([0, 17, 18, 23]);
                     _a = true;
-                    return [4, __await(promises_1["default"].opendir(dir))];
+                    return [4, __await(promises_1.default.opendir(dir))];
                 case 1:
                     _b = __asyncValues.apply(void 0, [_g.sent()]);
                     _g.label = 2;
                 case 2: return [4, __await(_b.next())];
                 case 3:
-                    if (!(_c = _g.sent(), _d = _c.done, !_d)) return [3, 19];
+                    if (!(_c = _g.sent(), _d = _c.done, !_d)) return [3, 16];
                     _f = _c.value;
                     _a = false;
-                    _g.label = 4;
-                case 4:
-                    _g.trys.push([4, , 17, 18]);
                     d = _f;
-                    entry = path_1["default"].join(dir, d.name);
-                    if (!d.isDirectory()) return [3, 8];
+                    entry = path_1.default.join(dir, d.name);
+                    if (!d.isDirectory()) return [3, 7];
                     return [4, __await(walk(entry, baseDir))];
-                case 5: return [5, __values(__asyncDelegator.apply(void 0, [__asyncValues.apply(void 0, [_g.sent()])]))];
-                case 6: return [4, __await.apply(void 0, [_g.sent()])];
+                case 4: return [5, __values(__asyncDelegator.apply(void 0, [__asyncValues.apply(void 0, [_g.sent()])]))];
+                case 5: return [4, __await.apply(void 0, [_g.sent()])];
+                case 6:
+                    _g.sent();
+                    return [3, 15];
                 case 7:
+                    if (!d.isFile()) return [3, 10];
+                    return [4, __await(path_1.default.relative(baseDir, entry))];
+                case 8: return [4, _g.sent()];
+                case 9:
                     _g.sent();
-                    return [3, 16];
-                case 8:
-                    if (!d.isFile()) return [3, 11];
-                    return [4, __await(path_1["default"].relative(baseDir, entry))];
-                case 9: return [4, _g.sent()];
+                    return [3, 15];
                 case 10:
-                    _g.sent();
-                    return [3, 16];
+                    if (!d.isSymbolicLink()) return [3, 15];
+                    return [4, __await(promises_1.default.realpath(entry))];
                 case 11:
-                    if (!d.isSymbolicLink()) return [3, 16];
-                    return [4, __await(promises_1["default"].realpath(entry))];
-                case 12:
                     realPath = _g.sent();
                     if (!realPath.startsWith(baseDir)) {
-                        throw new Error("symbolic link ".concat(path_1["default"].relative(baseDir, entry), " targets a file outside of the base directory: ").concat(baseDir));
+                        throw new Error("symbolic link ".concat(path_1.default.relative(baseDir, entry), " targets a file outside of the base directory: ").concat(baseDir));
                     }
-                    return [4, __await(promises_1["default"].stat(realPath))];
-                case 13:
+                    return [4, __await(promises_1.default.stat(realPath))];
+                case 12:
                     stats = _g.sent();
-                    if (!stats.isFile()) return [3, 16];
-                    return [4, __await(path_1["default"].relative(baseDir, entry))];
-                case 14: return [4, _g.sent()];
-                case 15:
+                    if (!stats.isFile()) return [3, 15];
+                    return [4, __await(path_1.default.relative(baseDir, entry))];
+                case 13: return [4, _g.sent()];
+                case 14:
                     _g.sent();
-                    _g.label = 16;
-                case 16: return [3, 18];
-                case 17:
+                    _g.label = 15;
+                case 15:
                     _a = true;
-                    return [7];
-                case 18: return [3, 2];
-                case 19: return [3, 26];
-                case 20:
+                    return [3, 2];
+                case 16: return [3, 23];
+                case 17:
                     e_1_1 = _g.sent();
                     e_1 = { error: e_1_1 };
-                    return [3, 26];
-                case 21:
-                    _g.trys.push([21, , 24, 25]);
-                    if (!(!_a && !_d && (_e = _b["return"]))) return [3, 23];
+                    return [3, 23];
+                case 18:
+                    _g.trys.push([18, , 21, 22]);
+                    if (!(!_a && !_d && (_e = _b.return))) return [3, 20];
                     return [4, __await(_e.call(_b))];
-                case 22:
+                case 19:
                     _g.sent();
-                    _g.label = 23;
-                case 23: return [3, 25];
-                case 24:
+                    _g.label = 20;
+                case 20: return [3, 22];
+                case 21:
                     if (e_1) throw e_1.error;
                     return [7];
-                case 25: return [7];
-                case 26: return [2];
+                case 22: return [7];
+                case 23: return [2];
             }
         });
     });
@@ -169,11 +164,11 @@ function buildManifest(dir) {
         return __generator(this, function (_g) {
             switch (_g.label) {
                 case 0:
-                    pluginJson = JSON.parse((0, fs_1.readFileSync)(path_1["default"].join(dir, 'plugin.json'), { encoding: 'utf8' }));
+                    pluginJson = JSON.parse((0, fs_1.readFileSync)(path_1.default.join(dir, 'plugin.json'), { encoding: 'utf8' }));
                     manifest = {
                         plugin: pluginJson.id,
                         version: pluginJson.info.version,
-                        files: {}
+                        files: {},
                     };
                     _g.label = 1;
                 case 1:
@@ -188,22 +183,19 @@ function buildManifest(dir) {
                     if (!(_f = _g.sent(), _a = _f.done, !_a)) return [3, 6];
                     _c = _f.value;
                     _d = false;
-                    try {
-                        filePath = _c;
-                        if (filePath === MANIFEST_FILE) {
-                            return [3, 5];
-                        }
-                        sanitisedFilePath = filePath.split(path_1["default"].sep).join(path_1["default"].posix.sep);
-                        manifest.files[sanitisedFilePath] = crypto_1["default"]
-                            .createHash('sha256')
-                            .update((0, fs_1.readFileSync)(path_1["default"].join(dir, filePath)))
-                            .digest('hex');
-                    }
-                    finally {
-                        _d = true;
+                    filePath = _c;
+                    if (filePath === MANIFEST_FILE) {
+                        return [3, 5];
                     }
+                    sanitisedFilePath = filePath.split(path_1.default.sep).join(path_1.default.posix.sep);
+                    manifest.files[sanitisedFilePath] = crypto_1.default
+                        .createHash('sha256')
+                        .update((0, fs_1.readFileSync)(path_1.default.join(dir, filePath)))
+                        .digest('hex');
                     _g.label = 5;
-                case 5: return [3, 3];
+                case 5:
+                    _d = true;
+                    return [3, 3];
                 case 6: return [3, 13];
                 case 7:
                     e_2_1 = _g.sent();
@@ -211,7 +203,7 @@ function buildManifest(dir) {
                     return [3, 13];
                 case 8:
                     _g.trys.push([8, , 11, 12]);
-                    if (!(!_d && !_a && (_b = _e["return"]))) return [3, 10];
+                    if (!(!_d && !_a && (_b = _e.return))) return [3, 10];
                     return [4, _b.call(_e)];
                 case 9:
                     _g.sent();
@@ -237,10 +229,10 @@ function signManifest(manifest) {
                     GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
                     GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
                     if (!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
-                        throw new Error('You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-a-token for instructions.');
+                        throw new Error('You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token for instructions.');
                     }
                     if (GRAFANA_API_KEY) {
-                        console.warn("\u001B[33m%s\u001B[0m", 'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/sign-a-plugin');
+                        console.warn("\u001B[33m%s\u001B[0m", 'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin');
                     }
                     GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || 'https://grafana.com/api';
                     url = GRAFANA_COM_URL + '/plugins/ci/sign';
@@ -249,7 +241,7 @@ function signManifest(manifest) {
                 case 1:
                     _c.trys.push([1, 3, , 4]);
                     return [4, (0, request_1.postData)(url, manifest, {
-                            Authorization: 'Bearer ' + token
+                            Authorization: 'Bearer ' + token,
                         })];
                 case 2:
                     info = _c.sent();
@@ -272,7 +264,7 @@ function signManifest(manifest) {
 exports.signManifest = signManifest;
 function saveManifest(dir, signedManifest) {
     try {
-        (0, fs_1.writeFileSync)(path_1["default"].join(dir, MANIFEST_FILE), signedManifest);
+        (0, fs_1.writeFileSync)(path_1.default.join(dir, MANIFEST_FILE), signedManifest);
         return true;
     }
     catch (error) {

package/dist/utils/pluginValidation.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertRootUrlIsValid = exports.getPluginJson = exports.validatePluginJson = void 0;
 var validatePluginJson = function (pluginJson) {
     if (!pluginJson.id) {

package/dist/utils/pluginValidation.test.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 var pluginValidation_1 = require("./pluginValidation");
 describe('pluginValidation', function () {
     describe('plugin.json', function () {

package/dist/utils/request.js

@@ -49,10 +49,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.postData = void 0;
 var https_1 = __importDefault(require("https"));
+var proxy_agent_1 = require("proxy-agent");
 var url_1 = require("url");
+var agent = new proxy_agent_1.ProxyAgent();
 function postData(urlString, data, headers) {
     return __awaiter(this, void 0, void 0, function () {
         return __generator(this, function (_a) {
@@ -64,9 +66,10 @@ function postData(urlString, data, headers) {
                         port: url.port || 443,
                         path: url.pathname,
                         method: 'POST',
-                        headers: __assign(__assign({}, headers), { 'Content-Type': 'application/json' })
+                        headers: __assign(__assign({}, headers), { 'Content-Type': 'application/json' }),
+                        agent: agent,
                     };
-                    var req = https_1["default"].request(options, function (res) {
+                    var req = https_1.default.request(options, function (res) {
                         var chunks = [];
                         res.on('data', function (chunk) { return chunks.push(chunk); });
                         res.on('end', function () {
@@ -74,7 +77,7 @@ function postData(urlString, data, headers) {
                             var results = Buffer.concat(chunks);
                             resolve({
                                 data: results.toString(),
-                                status: (_a = res.statusCode) !== null && _a !== void 0 ? _a : 200
+                                status: (_a = res.statusCode) !== null && _a !== void 0 ? _a : 200,
                             });
                         });
                         res.on('error', reject);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/sign-plugin",
-  "version": "2.0.0",
+  "version": "2.0.2-canary.481.f400697.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/sign-plugin",
@@ -23,7 +23,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "minimist": "^1.2.2"
+    "minimist": "^1.2.2",
+    "proxy-agent": "6.3.1"
   },
   "devDependencies": {
     "@types/minimist": "^1.2.2"
@@ -40,5 +41,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "d61bc5effe7e3c9bd444ebe05c6840c48f15ecef"
+  "gitHead": "f40069751aa92d8136651fefac2bf57b1cd15c4d"
 }

package/src/utils/manifest.ts

@@ -80,11 +80,11 @@ export async function signManifest(manifest: ManifestInfo): Promise<string> {
 
   if(!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
     throw new Error(
-      'You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-a-token for instructions.'
+      'You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token for instructions.'
     );
   }
   if (GRAFANA_API_KEY) {
-    console.warn(`\x1b[33m%s\x1b[0m`,'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/sign-a-plugin')
+    console.warn(`\x1b[33m%s\x1b[0m`,'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin')
   }
 
   const GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || 'https://grafana.com/api';

package/src/utils/request.ts

@@ -1,4 +1,6 @@
 import https, { RequestOptions } from 'https';
+import { ProxyAgent } from 'proxy-agent';
+
 import { URL } from 'url';
 
 interface Headers {
@@ -11,6 +13,8 @@ interface Response<R> {
   status: number;
 }
 
+const agent = new ProxyAgent();
+
 export async function postData(urlString: string, data: unknown, headers: Headers): Promise<Response<string>> {
   return new Promise<Response<string>>((resolve, reject) => {
     const url = new URL(urlString);
@@ -25,6 +29,7 @@ export async function postData(urlString: string, data: unknown, headers: Header
         ...headers,
         'Content-Type': 'application/json',
       },
+      agent,
     };
 
     const req = https.request(options, (res) => {