Merge pull request #839 from appwrite/feat-adding-messaging

feat(cli): Adding messaging push and pull

Author: christyjacob4

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

@@ -3,6 +3,7 @@ const path = require("path");
 const childProcess = require('child_process');
 const { Command } = require("commander");
 const inquirer = require("inquirer");
+const { messagingCreateTopic, messagingListTopics } = require("./messaging");
 const { teamsCreate, teamsList } = require("./teams");
 const { projectsCreate } = require("./projects");
 const { functionsCreate } = require("./functions");
@@ -237,6 +238,19 @@ const pullTeam = async () => {
     success();
 }
 
+const pullMessagingTopic = async () => {
+    const { topics } = await paginate(messagingListTopics, { parseOutput: false }, 100, 'topics');
+
+    log(`Found ${topics.length} topics`);
+
+    topics.forEach(async topic => {
+        log(`Pulling ${topic.name} ...`);
+        localConfig.addMessagingTopic(topic);
+    });
+
+    success();
+}
+
 pull
     .command("project")
     .description("Pulling your {{ spec.title|caseUcfirst }} project")
@@ -264,6 +278,11 @@ pull
     .description("Pulling your Appwrite teams")
     .action(actionRunner(pullTeam))
 
+pull
+    .command("topic")
+    .description("Initialise your Appwrite messaging topics")
+    .action(actionRunner(pullMessagingTopic))
+
 module.exports = {
     pull,
 };

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

@@ -3,7 +3,7 @@ const JSONbig = require("json-bigint")({ storeAsString: false });
 const { Command } = require("commander");
 const { localConfig } = require("../config");
 const { paginate } = require('../paginate');
-const { questionsPushBuckets, questionsPushTeams, questionsPushFunctions, questionsGetEntrypoint, questionsPushCollections, questionsConfirmPushCollections } = require("../questions");
+const { questionsPushBuckets, questionsPushTeams, questionsPushFunctions, questionsGetEntrypoint, questionsPushCollections, questionsConfirmPushCollections, questionsPushMessagingTopics } = require("../questions");
 const { actionRunner, success, log, error, commandDescriptions } = require("../parser");
 const { functionsGet, functionsCreate, functionsUpdate, functionsCreateDeployment, functionsUpdateDeployment, functionsListVariables, functionsDeleteVariable, functionsCreateVariable } = require('./functions');
 const {
@@ -32,6 +32,9 @@ const {
 const {
     storageGetBucket, storageUpdateBucket, storageCreateBucket
 } = require("./storage");
+const {
+    messagingGetTopic, messagingUpdateTopic, messagingCreateTopic
+} = require("./messaging");
 const {
     teamsGet,
     teamsUpdate,
@@ -227,14 +230,27 @@ const awaitPools = {
     },
 }
 
-const push = new Command("push")
-    .description(commandDescriptions['push'])
-    .configureHelp({
-        helpWidth: process.stdout.columns || 80
-    })
-    .action(actionRunner(async (_options, command) => {
-        command.help()
-    }));
+const pushResources = async ({ all, yes } = {}) => {
+    const actions = {
+        functions: pushFunction,
+        collections: pushCollection,
+        buckets: pushBucket,
+        teams: pushTeam,
+        messages: pushMessagingTopic
+    }
+
+    if (all) {
+        Object.values(actions).forEach(action => action({ all: true, yes }));
+    } else {
+        const answers = await inquirer.prompt(questionsPushResources[0]);
+        answers.resources.forEach((resource) => {
+            const action = actions[resource];
+            if (action !== undefined) {
+                action({ all: true, yes });
+            }
+        })
+    }
+};
 
 const pushFunction = async ({ functionId, all, yes } = {}) => {
     let response = {};
@@ -907,6 +923,89 @@ const pushTeam = async ({ all, yes } = {}) => {
     }
 }
 
+const pushMessagingTopic = async ({ all, yes } = {}) => {
+    let response = {};
+
+    let topicsIds = [];
+    const configTopics = localConfig.getMessagingTopics();
+    let overrideExisting = yes;
+
+    if (all) {
+        if (configTopics.length === 0) {
+            throw new Error("No topics found in the current directory. Run `appwrite pull topics` to pull all your messaging topics.");
+        }
+        topicsIds.push(...configTopics.map((b) => b.$id));
+    }
+
+    if (topicsIds.length === 0) {
+        const answers = await inquirer.prompt(questionsPushMessagingTopics[0])
+        topicsIds.push(...answers.topics);
+    }
+
+    let topics = [];
+
+    for (const topicId of topicsIds) {
+        const idTopic = configTopics.filter((b) => b.$id === topicId);
+        topics.push(...idTopic);
+    }
+
+    if (!yes) {
+        const answers = await inquirer.prompt(questionsPushMessagingTopics[1])
+        if (answers.override.toLowerCase() === "yes") {
+            overrideExisting = true;
+        }
+    }
+
+    for (let topic of topics) {
+        log(`Pushing topic ${topic.name} ( ${topic['$id']} )`)
+
+        try {
+            response = await messagingGetTopic({
+                topicId: topic['$id'],
+                parseOutput: false
+            })
+            log(`Topic ${topic.name} ( ${topic['$id']} ) already exists.`);
+
+            if (!overrideExisting) {
+                log(`Skipping ${topic.name} ( ${topic['$id']} )`);
+                continue;
+            }
+
+            log(`Updating Topic ...`)
+
+            await messagingUpdateTopic({
+                topicId: topic['$id'],
+                name: topic.name,
+                subscribe: topic.subscribe,
+                parseOutput: false
+            });
+
+            success(`Pushed ${topic.name} ( ${topic['$id']} )`);
+        } catch (e) {
+            if (e.code == 404) {
+                log(`Topic ${topic.name} does not exist in the project. Creating ... `);
+
+                response = await messagingCreateTopic({
+                    topicId: topic['$id'],
+                    name: topic.name,
+                    subscribe: topic.subscribe,
+                    parseOutput: false
+                })
+
+                success(`Created ${topic.name} ( ${topic['$id']} )`);
+            } else {
+                throw e;
+            }
+        }
+    }
+}
+
+const push = new Command("push")
+    .description(commandDescriptions['push'])
+    .option(`--all`, `Flag to push all resources`)
+    .option(`--yes`, `Flag to confirm all warnings`)
+    .action(actionRunner(pushResources));
+
 push
     .command("function")
     .description("Push functions in the current directory.")
@@ -936,6 +1035,13 @@ push
     .option(`--yes`, `Flag to confirm all warnings`)
     .action(actionRunner(pushTeam));
 
+push
+    .command("topic")
+    .description("Push messaging topics in the current project.")
+    .option(`--all`, `Flag to deploy all topics`)
+    .option(`--yes`, `Flag to confirm all warnings`)
+    .action(actionRunner(pushMessagingTopic));
+
 module.exports = {
     push
 }

templates/cli/lib/config.js.twig

@@ -204,6 +204,45 @@ class Local extends Config {
         this.set("buckets", buckets);
     }
 
+    getMessagingTopics() {
+        if (!this.has("topics")) {
+            return [];
+        }
+        return this.get("topics");
+    }
+
+    getMessagingTopic($id) {
+        if (!this.has("topics")) {
+            return {};
+        }
+
+        let topic = this.get("topics");
+        for (let i = 0; i < topic.length; i++) {
+            if (topic[i]['$id'] == $id) {
+                return topic[i];
+            }
+        }
+
+        return {};
+    }
+
+    addMessagingTopic(props) {
+        if (!this.has("topics")) {
+            this.set("topics", []);
+        }
+
+        let topics = this.get("topics");
+        for (let i = 0; i < topics.length; i++) {
+            if (topics[i]['$id'] === props['$id']) {
+                topics[i] = props;
+                this.set("topics", topics);
+                return;
+            }
+        }
+        topics.push(props);
+        this.set("topics", topics);
+    }
+
     getDatabases() {
         if (!this.has("databases")) {
             return [];

templates/cli/lib/questions.js.twig

@@ -305,6 +305,21 @@ const questionsLogin = [
     },
 ];
 
+const questionsPushResources = [
+    {
+        type: "checkbox",
+        name: "resources",
+        message: "Which resources would you like to push?",
+        choices: [
+            { name: 'Functions', value: 'functions' },
+            { name: 'Collections', value: 'collections' },
+            { name: 'Buckets', value: 'buckets' },
+            { name: 'Teams', value: 'teams' },
+            { name: 'Topics', value: 'messages' }
+        ]
+    }
+]
+
 const questionsPushFunctions = [
     {
         type: "checkbox",
@@ -384,6 +399,31 @@ const questionsPushBuckets = [
     },
 ]
 
+const questionsPushMessagingTopics = [
+    {
+        type: "checkbox",
+        name: "topics",
+        message: "Which messaging topic would you like to push?",
+        choices: () => {
+            let topics = localConfig.getMessagingTopics();
+            if (topics.length === 0) {
+                throw new Error("No topics found in the current directory. Run `appwrite pull messaging` to fetch all your messaging topics.");
+            }
+            return topics.map(topic => {
+                return {
+                    name: `${topic.name} (${topic['$id']})`,
+                    value: topic.$id
+                }
+            });
+        }
+    },
+    {
+        type: "input",
+        name: "override",
+        message: 'Would you like to override existing topics? This can lead to loss of data! Type "YES" to confirm.'
+    }
+]
+
 const questionsGetEntrypoint = [
     {
         type: "input",
@@ -480,9 +520,11 @@ module.exports = {
     questionsLogin,
     questionsPullFunction,
     questionsPullCollection,
+    questionsPushResources,
     questionsPushFunctions,
     questionsPushCollections,
     questionsPushBuckets,
+    questionsPushMessagingTopics,
     questionsPushTeams,
     questionsGetEntrypoint,
     questionsListFactors,