feat(cli): Pulling function code and definition

Author: byawitz

templates/cli/base/params.twig

@@ -11,7 +11,7 @@
     if (!fs.lstatSync(folderPath).isDirectory()) {
         throw new Error('The path is not a directory.');
     }
-    
+
     const ignorer = ignore();
 
     const func = localConfig.getFunction(functionId);
@@ -23,7 +23,7 @@
         ignorer.add(fs.readFileSync(pathLib.join({{ parameter.name | caseCamel | escapeKeyword }}, '.gitignore')).toString());
         log('Ignoring files in .gitignore');
     }
-    
+
     const files = getAllFiles({{ parameter.name | caseCamel | escapeKeyword }}).map((file) => pathLib.relative({{ parameter.name | caseCamel | escapeKeyword }}, file)).filter((file) => !ignorer.ignores(file));
 
     await tar
@@ -77,8 +77,10 @@
 {% endif %}
 {% endfor %}
 {% if method.type == 'location' %}
-    payload['project'] = localConfig.getProject().projectId
-    payload['key'] = globalConfig.getKey();
-    const queryParams = new URLSearchParams(payload);
-    apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
-{% endif %}
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
+{% endif %}

templates/cli/base/requests/api.twig

@@ -10,12 +10,16 @@
     }, payload{% if method.type == 'location' %}, 'arraybuffer'{% endif %});
 
 {% if method.type == 'location' %}
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
+
     fs.writeFileSync(destination, response);
 
 {% endif %}
     if (parseOutput) {
         parse(response)
         success()
     }
-    
-    return response;
+
+    return response;

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

@@ -45,6 +45,7 @@ const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower
 {% for parameter in method.parameters.all %}
  * @property {{ "{" }}{{ parameter | typeName }}{{ "}" }} {{ parameter.name | caseCamel | escapeKeyword }} {{ parameter.description | replace({'`':'\''}) | replace({'\n':' '}) | replace({'\n \n':' '}) }}
 {% endfor %}
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
 {% if 'multipart/form-data' in method.consumes %}
@@ -58,7 +59,7 @@ const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower
 /**
  * @param {{ "{" }}{{ service.name | caseUcfirst }}{{ method.name | caseUcfirst }}RequestParams{{ "}" }} params
  */
-const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({ {% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}, {% endfor %}parseOutput = true, sdk = undefined{% if 'multipart/form-data' in method.consumes %}, onProgress = () => {}{% endif %}{% if method.type == 'location' %}, destination{% endif %}}) => {
+const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({ {% for parameter in method.parameters.all %}{{ parameter.name | caseCamel | escapeKeyword }}, {% endfor %}parseOutput = true, overrideForCli = false, sdk = undefined{% if 'multipart/form-data' in method.consumes %}, onProgress = () => {}{% endif %}{% if method.type == 'location' %}, destination{% endif %}}) => {
     let client = !sdk ? await {% if service.name == "projects" %}sdkForConsole(){% else %}sdkForProject(){% endif %} : sdk;
     let apiPath = '{{ method.path }}'{% for parameter in method.parameters.path %}.replace('{{ '{' }}{{ parameter.name | caseCamel }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
 {{ include ('cli/base/params.twig') }}
@@ -90,4 +91,4 @@ module.exports = {
     {{ service.name | caseLower }}{{ method.name | caseUcfirst }}{% if not loop.last %},{% endif %}
 
 {% endfor %}
-};
+};

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

@@ -1,14 +1,17 @@
+const fs = require("fs");
+const tar = require("tar");
 const { Command } = require("commander");
 const inquirer = require("inquirer");
 const { teamsCreate, teamsList } = require("./teams");
 const { projectsCreate } = require("./projects");
+const { functionsList, functionsDownloadDeployment } = require("./functions");
 const { databasesGet, databasesListCollections, databasesList } = require("./databases");
 const { storageListBuckets } = require("./storage");
 const { sdkForConsole } = require("../sdks");
 const { localConfig } = require("../config");
 const ID = require("../id");
 const { paginate } = require("../paginate");
-const { questionsPullProject, questionsPullCollection } = require("../questions");
+const { questionsPullProject, questionsPullCollection, questionsPullFunctions } = require("../questions");
 const { success, log, actionRunner, commandDescriptions } = require("../parser");
 
 const pull = new Command("pull")
@@ -28,6 +31,64 @@ const pullProject = async () => {
     success();
 }
 
+const pullFunctions = async ({ all, yes } = {}) => {
+    let functions = [];
+    let questions = questionsPullFunctions;
+
+    const localFunctions = localConfig.getFunctions();
+
+    if (all) {
+        questions = yes ? [] : questionsPullFunctions[1];
+        functions = (await paginate(functionsList, { parseOutput: false }, 100, 'functions')).functions;
+    }
+
+    const answers = await inquirer.prompt(questions);
+
+    const overridingLocalChanges = yes ?? answers.override.toLowerCase() === "yes";
+    const selectedFunctions = functions.length === 0 ? answers.functions : functions;
+
+    for (let func of selectedFunctions) {
+        const functionExistLocally = localFunctions.find((localFunc) => localFunc['$id'] === func['$id']) !== undefined;
+
+        if (!overridingLocalChanges && functionExistLocally) {
+            log(`Skipping locally found implementation of ${func['name']}`)
+            continue;
+        }
+        if (functionExistLocally) {
+            localConfig.updateFunction(func['$id'], func);
+        } else {
+            func['path'] = `functions/${func['$id']}`;
+            localConfig.addFunction(func);
+        }
+
+        const localFunction = localFunctions.find((localFunc) => localFunc['$id'] === func['$id']);
+
+        if (localFunction['deployment'] === '') {
+            continue
+        }
+
+        const compressedFileName = `${+new Date()}.tar.gz`
+
+        await functionsDownloadDeployment({
+            functionId: func['$id'],
+            deploymentId: func['deployment'],
+            destination: compressedFileName,
+            overrideForCli: true,
+            parseOutput: false
+        })
+
+        tar.extract({
+            sync: true,
+            cwd: localFunction['path'],
+            file: compressedFileName,
+            strict: false,
+        });
+
+        fs.rmSync(compressedFileName);
+        success(`Pulled ${func['name']} code and definition`)
+    }
+}
+
 const pullCollection = async ({ all, databaseId } = {}) => {
     const databaseIds = [];
 
@@ -104,14 +165,21 @@ const pullTeam = async () => {
 
 pull
     .command("project")
-    .description("Pulling your {{ spec.title|caseUcfirst }} project")
+    .description("Pulling your Appwrite project")
     .action(actionRunner(pullProject));
 
+pull
+    .command("function")
+    .description(`Pulling your Appwrite functions`)
+    .option(`--yes`, `Flag to confirm all warnings`)
+    .option(`--all`, `Flag to pull all functions`)
+    .action(actionRunner(pullFunctions));
+
 pull
     .command("collection")
-    .description("Pulling your {{ spec.title|caseUcfirst }} collections")
+    .description("Pulling your Appwrite collections")
     .option(`--databaseId <databaseId>`, `Database ID`)
-    .option(`--all`, `Flag to pullialize all databases`)
+    .option(`--all`, `Flag to pull all databases`)
     .action(actionRunner(pullCollection))
 
 pull

templates/cli/lib/questions.js.twig

@@ -1,12 +1,12 @@
 const { localConfig } = require('./config');
 const { projectsList } = require('./commands/projects');
 const { teamsList } = require('./commands/teams');
-const { functionsListRuntimes } = require('./commands/functions');
+const { functionsListRuntimes, functionsList } = require('./commands/functions');
 const { accountListMfaFactors } = require("./commands/account");
 const { sdkForConsole } = require("./sdks");
 const { validateRequired } = require("./validations");
 const { paginate } = require('./paginate');
-
+const chalk = require('chalk');
 const { databasesList } = require('./commands/databases');
 const JSONbig = require("json-bigint")({ storeAsString: false });
 
@@ -311,6 +311,30 @@ const questionsPullProject = [
     }
 ];
 
+
+const questionsPullFunctions = [
+    {
+        type: "checkbox",
+        name: "functions",
+        message: "Which functions would you like to pull?",
+        choices: async () => {
+            const { functions } = await paginate(functionsList, { parseOutput: false }, 100, 'functions');
+
+            return functions.map(func => {
+                return {
+                    name: `${func.name} (${func.$id})`,
+                    value: func
+                }
+            });
+        }
+    },
+    {
+        type: "input",
+        name: "override",
+        message: `Do you want to override local functions code and definition? ${chalk.red('all local changes will lost!')} Type "YES" to confirm.`
+    }
+];
+
 const questionsPullCollection = [
     {
         type: "checkbox",
@@ -539,6 +563,7 @@ module.exports = {
     questionsCreateCollection,
     questionsCreateMessagingTopic,
     questionsPullProject,
+    questionsPullFunctions,
     questionsLogin,
     questionsPullCollection,
     questionsPushFunctions,