Merge pull request #927 from appwrite/feat-cli-qa-round

Feat cli qa round

Author: christyjacob4

templates/cli/base/requests/api.twig

@@ -24,11 +24,9 @@
             );
          } else {
             parse(response)
-            success()
         }
     {%~ else %}
         parse(response)
-        success()
     {%~ endif %}
     }
 

templates/cli/base/requests/file.twig

@@ -107,7 +107,6 @@
 
     if (parseOutput) {
         parse(response)
-        success()
     }
 
     return response;

templates/cli/index.js.twig

@@ -30,15 +30,16 @@ program
   .description(commandDescriptions['main'])
   .configureHelp({
     helpWidth: process.stdout.columns || 80,
-    sortSubcommands: true
+    sortSubcommands: true,
   })
-  .version(version, "-v, --version")
+  .helpOption('-h, --help', "Display help for command")
+  .version(version, "-v, --version", "Output the version number")
   .option("-V, --verbose", "Show complete error log")
   .option("-j, --json", "Output in JSON format")
   .hook('preAction', migrate)
   .option("-f,--force", "Flag to confirm all warnings")
   .option("-a,--all", "Flag to push all resources")
-  .option("--id [id...]", "Flag to pass list of ids for a giving action")
+  .option("--id [id...]", "Flag to pass a list of ids for a given action")
   .option("--report", "Enable reporting in case of CLI errors")
   .on("option:json", () => {
     cliConfig.json = true;

templates/cli/lib/commands/command.js.twig

@@ -35,7 +35,7 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower }}").description(commandDescriptions['{{ service.name | caseLower }}']).configureHelp({
+const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower }}").description(commandDescriptions['{{ service.name | caseLower }}'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 

templates/cli/lib/commands/generic.js.twig

@@ -7,25 +7,25 @@ const { actionRunner, success, parseBool, commandDescriptions, error, parse, hin
 const ID = require("../id");
 {% if sdk.test != "true" %}
 const { questionsLogin, questionsLogout, questionsListFactors, questionsMfaChallenge } = require("../questions");
-const {  accountUpdateMfaChallenge, accountCreateMfaChallenge, accountGet, accountCreateEmailPasswordSession, accountDeleteSession } = require("./account");
+const { accountUpdateMfaChallenge, accountCreateMfaChallenge, accountGet, accountCreateEmailPasswordSession, accountDeleteSession } = require("./account");
 
 const DEFAULT_ENDPOINT = 'https://cloud.appwrite.io/v1';
 
 const loginCommand = async ({ email, password, endpoint, mfa, code }) => {
     const oldCurrent = globalConfig.getCurrentSession();
     let configEndpoint = endpoint ?? DEFAULT_ENDPOINT;
 
-    if(globalConfig.getCurrentSession() !== '') {
+    if (globalConfig.getCurrentSession() !== '') {
         log('You are currently signed in as ' + globalConfig.getEmail());
 
-        if(globalConfig.getSessions().length === 1) {
+        if (globalConfig.getSessions().length === 1) {
             hint('You can sign in and manage multiple accounts with Appwrite CLI');
         }
     }
 
     const answers = email && password ? { email, password } : await inquirer.prompt(questionsLogin);
 
-    if(!answers.method) {
+    if (!answers.method) {
         answers.method = 'login';
     }
 
@@ -93,7 +93,7 @@ const loginCommand = async ({ email, password, endpoint, mfa, code }) => {
         } else {
             globalConfig.removeSession(id);
             globalConfig.setCurrentSession(oldCurrent);
-            if(endpoint !== DEFAULT_ENDPOINT && error.response === 'user_invalid_credentials'){
+            if (endpoint !== DEFAULT_ENDPOINT && error.response === 'user_invalid_credentials') {
                 log('Use the --endpoint option for self-hosted instances')
             }
             throw error;
@@ -136,7 +136,7 @@ const whoami = new Command("whoami")
             }
         ];
 
-        if(cliConfig.json) {
+        if (cliConfig.json) {
             console.log(data);
             return;
         }
@@ -194,7 +194,7 @@ const logout = new Command("logout")
         }
         if (sessions.length === 1) {
             await deleteSession(current);
-            success();
+            success("Logging out");
 
             return;
         }
@@ -208,16 +208,16 @@ const logout = new Command("logout")
             }
         }
 
-        const remainingSessions  = globalConfig.getSessions();
+        const remainingSessions = globalConfig.getSessions();
 
-        if (remainingSessions .length > 0 && remainingSessions .filter(session => session.id === current).length !== 1) {
+        if (remainingSessions.length > 0 && remainingSessions.filter(session => session.id === current).length !== 1) {
             const accountId = remainingSessions [0].id;
             globalConfig.setCurrentSession(accountId);
 
             success(`Current account is ${accountId}`);
         }
 
-        success();
+        success("Logging out");
     }));
 {% endif %}
 
@@ -294,7 +294,7 @@ const client = new Command("client")
             }
         }
 
-        success()
+        success("Setting client")
     }));
 
 const migrate = async () => {

templates/cli/lib/commands/init.js.twig

@@ -129,7 +129,7 @@ const initBucket = async () => {
         fileSecurity: answers.fileSecurity.toLowerCase() === 'yes',
         enabled: true,
     });
-    success();
+    success("Initialing bucket");
     log("Next you can use 'appwrite push bucket' to deploy the changes.");
 };
 
@@ -141,7 +141,7 @@ const initTeam = async () => {
         name: answers.bucket,
     });
 
-    success();
+    success("Initialing team");
     log("Next you can use 'appwrite push team' to deploy the changes.");
 };
 
@@ -174,7 +174,7 @@ const initCollection = async () => {
         enabled: true,
     });
 
-    success();
+    success("Initialing collection");
     log("Next you can use 'appwrite push collection' to deploy the changes.");
 };
 
@@ -187,7 +187,7 @@ const initTopic = async () => {
 
     });
 
-    success();
+    success("Initialing topic");
     log("Next you can use 'appwrite push topic' to deploy the changes.");
 };
 
@@ -223,21 +223,7 @@ const initFunction = async () => {
     fs.mkdirSync(templatesDir, "777");
     const repo = "https://github.com/{{ sdk.gitUserName }}/templates";
     const api = `https://api.github.com/repos/{{ sdk.gitUserName }}/templates/contents/${answers.runtime.name}`
-    let selected = undefined;
-
-    if(answers.template === 'starter') {
-        selected = { template: 'starter' };
-    } else {
-        try {
-            const res = await fetch(api);
-            const templates = [];
-            templates.push(...(await res.json()).map((template) => template.name));
-            selected = await inquirer.prompt(questionsCreateFunctionSelectTemplate(templates));
-        } catch {
-            // Not a problem will go with directory pulling
-            log('Loading templates...');
-        }
-    }
+    let selected = { template: 'starter' };
 
     const sparse = (selected ? `${answers.runtime.name}/${selected.template}` : answers.runtime.name).toLowerCase();
 
@@ -312,6 +298,7 @@ const initFunction = async () => {
         runtime: answers.runtime.id,
         execute: [],
         events: [],
+        scopes: [],
         schedule: "",
         timeout: 15,
         enabled: true,
@@ -323,7 +310,7 @@ const initFunction = async () => {
     };
 
     localConfig.addFunction(data);
-    success();
+    success("Initialing function");
     log("Next you can use 'appwrite run function' to develop a function locally. To deploy the function, use 'appwrite push function'");
 }
 

templates/cli/lib/commands/pull.js.twig

@@ -56,7 +56,7 @@ const pullSettings = async () => {
     }
 }
 
-const pullFunctions = async ({ code }) => {
+const pullFunctions = async ({ code, withVariables }) => {
     log("Fetching functions ...");
     let total = 0;
 
@@ -83,27 +83,29 @@ const pullFunctions = async ({ code }) => {
         const localFunction = localConfig.getFunction(func.$id);
 
         func['path'] = localFunction['path'];
-        if(!localFunction['path']) {
+        if (!localFunction['path']) {
             func['path'] = `functions/${func.$id}`;
         }
-
+        if (!withVariables) {
+            delete func['vars'];
+        }
         localConfig.addFunction(func);
 
         if (!fs.existsSync(func['path'])) {
             fs.mkdirSync(func['path'], { recursive: true });
         }
 
-        if(code === false) {
+        if (code === false) {
             warn("Source code download skipped.");
-        } else if(!func['deployment']) {
+        } else if (!func['deployment']) {
             warn("Source code download skipped because function doesn't have active deployment.");
         } else {
-            if(allowCodePull === null) {
+            if (allowCodePull === null) {
                 const codeAnswer = await inquirer.prompt(questionsPullFunctionsCode);
                 allowCodePull = codeAnswer.override;
             }
 
-            if(allowCodePull) {
+            if (allowCodePull) {
                 log("Pulling active deployment's code ...");
 
                 const compressedFileName = `${func['$id']}-${+new Date()}.tar.gz`
@@ -123,6 +125,16 @@ const pullFunctions = async ({ code }) => {
                 });
 
                 fs.rmSync(compressedFileName);
+
+                if (withVariables) {
+                    const envFileLocation = `${func['path']}/.env`
+                    try {
+                        fs.rmSync(envFileLocation);
+                    } catch {
+                    }
+
+                    fs.writeFileSync(envFileLocation, func['vars'].map(r => `${r.key}=${r.value}\n`).join(''))
+                }
             }
         }
     }
@@ -170,7 +182,7 @@ const pullCollection = async () => {
             parseOutput: false
         }, 100, 'collections');
 
-        for(const collection of collections) {
+        for (const collection of collections) {
             localConfig.addCollection({
                 ...collection,
                 '$createdAt': undefined,
@@ -198,7 +210,7 @@ const pullBucket = async () => {
 
     const { buckets } = await paginate(storageListBuckets, { parseOutput: false }, 100, 'buckets');
 
-    for(const bucket of buckets) {
+    for (const bucket of buckets) {
         total++;
         log(`Pulling bucket ${chalk.bold(bucket['name'])} ...`);
         localConfig.addBucket(bucket);
@@ -223,7 +235,7 @@ const pullTeam = async () => {
 
     const { teams } = await paginate(teamsList, { parseOutput: false }, 100, 'teams');
 
-    for(const team of teams) {
+    for (const team of teams) {
         total++;
         log(`Pulling team ${chalk.bold(team['name'])} ...`);
         localConfig.addTeam(team);
@@ -248,7 +260,7 @@ const pullMessagingTopic = async () => {
 
     const { topics } = await paginate(messagingListTopics, { parseOutput: false }, 100, 'topics');
 
-    for(const topic of topics) {
+    for (const topic of topics) {
         total++;
         log(`Pulling topic ${chalk.bold(topic['name'])} ...`);
         localConfig.addMessagingTopic(topic);
@@ -279,6 +291,7 @@ pull
     .alias("functions")
     .description("Pulling your {{ spec.title|caseUcfirst }} cloud function")
     .option("--no-code", "Don't pull the function's code")
+    .option("--with-variables", `Pull function variables. ${chalk.red('recommend for testing purposes only')}`)
     .action(actionRunner(pullFunctions))
 
 pull