Merge pull request #852 from appwrite/feat-report-error

feat(cli): Adding report flag

Author: christyjacob4

templates/cli/index.js.twig

@@ -29,12 +29,17 @@ program
   .version(version, "-v, --version")
   .option("--verbose", "Show complete error log")
   .option("--json", "Output in JSON format")
+  .option("--report", "Enable reporting in case of CLI errors")
   .on("option:json", () => {
     cliConfig.json = true;
   })
   .on("option:verbose", () => {
     cliConfig.verbose = true;
   })
+  .on("option:report", function() {
+    cliConfig.report = true;
+    cliConfig.reportData = { data: this };
+  })
   .showSuggestionAfterError()
 {% if sdk.test != "true" %}
   .addCommand(whoami)

templates/cli/lib/parser.js.twig

@@ -2,10 +2,15 @@ const chalk = require('chalk');
 const commander = require('commander');
 const Table = require('cli-table3');
 const { description } = require('../package.json');
+const { globalConfig } = require("./config.js");
+const os = require('os');
+const Client = require("./client");
 
 const cliConfig = {
-  verbose: false,
-  json: false
+    verbose: false,
+    json: false,
+    report: false,
+    reportData: {}
 };
 
 const parse = (data) => {
@@ -110,13 +115,49 @@ const drawJSON = (data) => {
 }
 
 const parseError = (err) => {
-    if(cliConfig.verbose) {
-        console.error(err);
-    }
+    if (cliConfig.report) {
+        (async () => {
+            let appwriteVersion = 'unknown';
+            const endpoint = globalConfig.getEndpoint();
+            const isCloud = endpoint.includes('cloud.appwrite.io') ? 'Yes' : 'No';
+
+            try {
+                const client = new Client().setEndpoint(endpoint);
+                const res = await client.call('get', '/health/version');
+                appwriteVersion = res.version;
+            } catch {
+            }
+
+            const version = '{{ sdk.version }}';
+            const stepsToReproduce = `Running \`appwrite ${cliConfig.reportData.data.args}\``;
+            const yourEnvironment = `CLI version: ${version}\nOperation System: ${os.type()}\nAppwrite version: ${appwriteVersion}\nIs Cloud: ${isCloud}`;
+
+            const stack = '```\n' + err.stack + '\n```';
+
+            const githubIssueUrl = new URL('https://github.com/appwrite/appwrite/issues/new');
+            githubIssueUrl.searchParams.append('labels', 'bug');
+            githubIssueUrl.searchParams.append('template', 'bug.yaml');
+            githubIssueUrl.searchParams.append('title', `🐛 Bug Report: ${err.message}`);
+            githubIssueUrl.searchParams.append('actual-behavior', `CLI Error:\n${stack}`);
+            githubIssueUrl.searchParams.append('steps-to-reproduce', stepsToReproduce);
+            githubIssueUrl.searchParams.append('environment', yourEnvironment);
 
-    error(err.message);
+            log(`To report this error you can:\n - Create a support ticket in our Discord server https://appwrite.io/discord \n - Create an issue in our Github\n   ${githubIssueUrl.href}\n`);
+
+
+            error('\n Stack Trace: \n');
+            console.error(err);
+            process.exit(1);
+        })()
+    } else {
+        if (cliConfig.verbose) {
+            console.error(err);
+        } else {
+            error(err.message);
+        }
+        process.exit(1);
+    }
 
-    process.exit(1)
 }
 
 const actionRunner = (fn) => {