Merge pull request #562 from appwrite/feat-cli-buckets

Feat: CLI buckets init&deploy

Author: lohanidamodar

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

@@ -2,7 +2,7 @@ const inquirer = require("inquirer");
 const JSONbig = require("json-bigint")({ storeAsString: false });
 const { Command } = require("commander");
 const { localConfig } = require("../config");
-const { questionsDeployTeams, questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections, questionsConfirmDeployCollections } = require("../questions");
+const { questionsDeployBuckets, questionsDeployTeams, questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections, questionsConfirmDeployCollections } = require("../questions");
 const { actionRunner, success, log, error, commandDescriptions } = require("../parser");
 const { functionsGet, functionsCreate, functionsUpdate, functionsCreateDeployment, functionsUpdateDeployment, functionsListVariables, functionsDeleteVariable, functionsCreateVariable } = require('./functions');
 const {
@@ -26,6 +26,9 @@ const {
     databasesDeleteIndex,
     databasesUpdateCollection
 } = require("./databases");
+const {
+    storageGetBucket, storageUpdateBucket, storageCreateBucket
+} = require("./storage");
 const {
     teamsGet,
     teamsUpdate,
@@ -624,6 +627,93 @@ const deployCollection = async ({ all, yes } = {}) => {
     }
 }
 
+const deployBucket = async ({ all, yes } = {}) => {
+    let response = {};
+
+    let bucketIds = [];
+    const configBuckets = localConfig.getBuckets();
+
+    if(all) {
+        if (configBuckets.length === 0) {
+            throw new Error("No buckets found in the current directory. Run `appwrite init bucket` to fetch all your buckets.");
+        }
+        bucketIds.push(...configBuckets.map((b) => b.$id));
+    }
+
+    if(bucketIds.length === 0) {
+        let answers = await inquirer.prompt(questionsDeployBuckets[0])
+        bucketIds.push(...answers.buckets);
+    }
+
+    let buckets = [];
+
+    for(const bucketId of bucketIds) {
+        const idBuckets = configBuckets.filter((b) => b.$id === bucketId);
+        buckets.push(...idBuckets);
+    }
+
+    for (let bucket of buckets) {
+        log(`Deploying bucket ${bucket.name} ( ${bucket['$id']} )`)
+
+        try {
+            response = await storageGetBucket({
+                bucketId: bucket['$id'],
+                parseOutput: false,
+            })
+            log(`Bucket ${bucket.name} ( ${bucket['$id']} ) already exists.`);
+
+            if(!yes) {
+                answers = await inquirer.prompt(questionsDeployBuckets[1])
+                if (answers.override !== "YES") {
+                    log(`Received "${answers.override}". Skipping ${bucket.name} ( ${bucket['$id']} )`);
+                    continue;
+                }
+            }
+
+            log(`Updating bucket ...`)
+
+            await storageUpdateBucket({
+                bucketId: bucket['$id'],
+                name: bucket.name,
+                permissions: bucket['$permissions'],
+                fileSecurity: bucket.fileSecurity,
+                enabled: bucket.enabled,
+                maximumFileSize: bucket.maximumFileSize,
+                allowedFileExtensions: bucket.allowedFileExtensions,
+                compression: bucket.compression,
+                encryption: bucket.encryption,
+                antivirus: bucket.antivirus,
+                compression: bucket.compression,
+                parseOutput: false
+            });
+
+            success(`Deployed ${bucket.name} ( ${bucket['$id']} )`);
+        } catch (e) {
+            if (e.code == 404) {
+                log(`Bucket ${bucket.name} does not exist in the project. Creating ... `);
+
+                response = await storageCreateBucket({
+                    bucketId: bucket['$id'],
+                    name: bucket.name,
+                    permissions: bucket['$permissions'],
+                    fileSecurity: bucket.fileSecurity,
+                    enabled: bucket.enabled,
+                    maximumFileSize: bucket.maximumFileSize,
+                    allowedFileExtensions: bucket.allowedFileExtensions,
+                    compression: bucket.compression,
+                    encryption: bucket.encryption,
+                    antivirus: bucket.antivirus,
+                    parseOutput: false
+                })
+
+                success(`Deployed ${bucket.name} ( ${bucket['$id']} )`);
+            } else {
+                throw e;
+            }
+        }
+    }
+}
+
 const deployTeam = async ({ all, yes } = {}) => {
     let response = {};
 
@@ -709,6 +799,13 @@ deploy
     .option(`--yes`, `Flag to confirm all warnings`)
     .action(actionRunner(deployCollection));
 
+deploy
+    .command("bucket")
+    .description("Deploy buckets in the current project.")
+    .option(`--all`, `Flag to deploy all buckets`)
+    .option(`--yes`, `Flag to confirm all warnings`)
+    .action(actionRunner(deployBucket));
+
 deploy
     .command("team")
     .description("Deploy teams in the current project.")

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

@@ -7,6 +7,7 @@ const { teamsCreate, teamsList } = require("./teams");
 const { projectsCreate } = require("./projects");
 const { functionsCreate } = require("./functions");
 const { databasesListCollections, databasesList } = require("./databases");
+const { storageListBuckets } = require("./storage");
 const { sdkForConsole } = require("../sdks");
 const { localConfig } = require("../config");
 const { questionsInitProject, questionsInitFunction, questionsInitCollection } = require("../questions");
@@ -200,6 +201,24 @@ const initCollection = async ({ all, databaseId } = {}) => {
   success();
 }
 
+const initBucket = async () => {
+  // TODO: Pagination?
+  let response = await storageListBuckets({
+    queries: [ 'limit(100)' ],
+    parseOutput: false
+  })
+
+  let buckets = response.buckets;
+  log(`Found ${buckets.length} buckets`);
+
+  buckets.forEach(async bucket => {
+    log(`Fetching ${bucket.name} ...`);
+    localConfig.addBucket(bucket);
+  });
+
+  success();
+}
+
 const initTeam = async () => {
   // TODO: Pagination?
   let response = await teamsList({
@@ -240,6 +259,11 @@ init
   .option(`--all`, `Flag to initialize all databases`)
   .action(actionRunner(initCollection))
 
+init
+  .command("bucket")
+  .description("Initialise your Appwrite buckets")
+  .action(actionRunner(initBucket))
+
 init
   .command("team")
   .description("Initialise your Appwrite teams")

templates/cli/lib/config.js.twig

@@ -166,6 +166,45 @@ class Local extends Config {
         this.set("collections", collections);
     }
 
+    getBuckets() {
+        if (!this.has("buckets")) {
+            return [];
+        }
+        return this.get("buckets");
+    }
+
+    getBucket($id) {
+        if (!this.has("buckets")) {
+            return {};
+        }
+
+        let buckets = this.get("buckets");
+        for (let i = 0; i < buckets.length; i++) {
+            if (buckets[i]['$id'] == $id) {
+                return buckets[i];
+            }
+        }
+
+        return {};
+    }
+
+    addBucket(props) {
+        if (!this.has("buckets")) {
+            this.set("buckets", []);
+        }
+
+        let buckets = this.get("buckets");
+        for (let i = 0; i < buckets.length; i++) {
+            if (buckets[i]['$id'] == props['$id']) {
+                buckets[i] = props;
+                this.set("buckets", buckets);
+                return;
+            }
+        }
+        buckets.push(props);
+        this.set("buckets", buckets);
+    }
+
     getDatabases() {
         if (!this.has("databases")) {
             return [];

templates/cli/lib/questions.js.twig

@@ -285,6 +285,32 @@ const questionsDeployCollections = [
   },
 ]
 
+const questionsDeployBuckets = [
+  {
+    type: "checkbox",
+    name: "buckets",
+    message: "Which buckets would you like to deploy?",
+    choices: () => {
+      let buckets = localConfig.getBuckets();
+      if (buckets.length === 0) {
+        throw new Error("No buckets found in the current directory. Run `appwrite init bucket` to fetch all your buckets.");
+      }
+      let choices = buckets.map((bucket, idx) => {
+        return {
+          name: `${bucket.name} (${bucket['$id']})`,
+          value: bucket.$id
+        }
+      })
+      return choices;
+    }
+  },
+  {
+    type: "input",
+    name: "override",
+    message: 'Are you sure you want to override this bucket? This can lead to loss of data! Type "YES" to confirm.'
+  },
+]
+
 const questionsGetEntrypoint = [
   {
     type: "input",
@@ -333,6 +359,7 @@ module.exports = {
   questionsInitCollection,
   questionsDeployFunctions,
   questionsDeployCollections,
+  questionsDeployBuckets,
   questionsDeployTeams,
   questionsGetEntrypoint
 };