Merge remote-tracking branch 'refs/remotes/origin/feat-console-flow' into feat-pull-project-settings

Author: byawitz

src/SDK/Language.php

@@ -84,6 +84,15 @@ public function getFilters(): array
         return [];
     }
 
+    /**
+     * Language specific functions.
+     * @return array
+     */
+    public function getFunctions(): array
+    {
+        return [];
+    }
+
     protected function toPascalCase(string $value): string
     {
         return \ucfirst($this->toCamelCase($value));

src/SDK/Language/CLI.php

@@ -2,8 +2,66 @@
 
 namespace Appwrite\SDK\Language;
 
+use Twig\TwigFunction;
+
 class CLI extends Node
 {
+    /**
+     * List of functions to ignore for console preview.
+     * @var array
+     */
+    private $consoleIgnoreFunctions = [
+        'listidentities',
+        'listmfafactors',
+        'getprefs',
+        'getsession',
+        'getattribute',
+        'listdocumentlogs',
+        'getindex',
+        'listcollectionlogs',
+        'getcollectionusage',
+        'listlogs',
+        'listruntimes',
+        'getusage',
+        'getusage',
+        'listvariables',
+        'getvariable',
+        'listproviderlogs',
+        'listsubscriberlogs',
+        'getsubscriber',
+        'listtopiclogs',
+        'getemailtemplate',
+        'getsmstemplate',
+        'getfiledownload',
+        'getfilepreview',
+        'getfileview',
+        'getusage',
+        'listlogs',
+        'getprefs',
+        'getusage',
+        'listlogs',
+        'getmembership',
+        'listmemberships',
+        'listmfafactors',
+        'getmfarecoverycodes',
+        'getprefs',
+        'listtargets',
+        'gettarget',
+    ];
+
+    /**
+     * List of SDK services to ignore for console preview.
+     * @var array
+     */
+    private $consoleIgnoreServices = [
+        'health',
+        'migrations',
+        'locale',
+        'avatars',
+        'project',
+        'proxy',
+        'vcs'
+    ];
     /**
      * @var array
      */
@@ -290,4 +348,18 @@ public function getParamExample(array $param): string
 
         return $output;
     }
+
+    /**
+     * Language specific filters.
+     * @return array
+     */
+    public function getFunctions(): array
+    {
+        return [
+            /** Return true if the entered service->method is enabled for a console preview link */
+            new TwigFunction('methodHaveConsolePreview', fn($method, $service) => preg_match('/^([Gg]et|[Ll]ist)/', $method)
+                && !in_array(strtolower($method), $this->consoleIgnoreFunctions)
+                && !in_array($service, $this->consoleIgnoreServices)),
+        ];
+    }
 }

src/SDK/SDK.php

@@ -85,6 +85,13 @@ public function __construct(Language $language, Spec $spec)
             'debug' => true
         ]);
 
+        /**
+         * Add language-specific functions
+         */
+        foreach ($this->language->getFunctions() as $function) {
+            $this->twig->addFunction($function);
+        }
+
         /**
          * Add language specific filters
          */

templates/cli/base/requests/api.twig

@@ -17,8 +17,19 @@
     fs.writeFileSync(destination, response);
     {%~ endif %}
     if (parseOutput) {
+    {%~ if methodHaveConsolePreview(method.name,service.name) %}
+        if(console) {
+            showConsoleLink('{{service.name}}', '{{ method.name }}',open
+        {%- for parameter in method.parameters.path -%}{%- set param = (parameter.name | caseCamel | escapeKeyword)  -%}{%- if param  ends with 'Id' -%}, {{ param }} {%- endif -%}{%- endfor -%}
+            );
+         } else {
+            parse(response)
+            success()
+        }
+    {%~ else %}
         parse(response)
         success()
+    {%~ endif %}
     }
 
     return response;

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

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -70,6 +70,7 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
         {%- if 'multipart/form-data' in method.consumes -%},onProgress = () => {}{%- endif -%}
 
         {%- if method.type == 'location' -%}, destination{%- endif -%}
+        {% if methodHaveConsolePreview(method.name,service.name) %}, console, open{%- endif -%}
 }) => {
 {%~ endblock %}
     let client = !sdk ? await {% if service.name == "projects" %}sdkForConsole(){% else %}sdkForProject(){% endif %} :
@@ -94,6 +95,10 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
 {% if method.type == 'location' %}
     .requiredOption(`--destination <path>`, `output file path.`)
 {% endif %}
+{% if methodHaveConsolePreview(method.name,service.name) %}
+    .option(`--console`, `Get the resource console url`)
+    .option(`--open`, `Use with '--console' to open the using default browser`)
+{% endif %}
 {% endautoescape %}
     .action(actionRunner({{ service.name | caseLower }}{{ method.name | caseUcfirst }}))
 

templates/cli/lib/utils.js.twig

@@ -1,9 +1,13 @@
 const fs = require("fs");
 const path = require("path");
+const { localConfig, globalConfig } = require("./config");
+const { success, log } = require('./parser')
+const readline = require('readline');
+const cp = require('child_process');
 
 function getAllFiles(folder) {
     const files = [];
-    for(const pathDir of fs.readdirSync(folder)) {
+    for (const pathDir of fs.readdirSync(folder)) {
         const pathAbsolute = path.join(folder, pathDir);
         if (fs.statSync(pathAbsolute).isDirectory()) {
             files.push(...getAllFiles(pathAbsolute));
@@ -20,7 +24,210 @@ const checkDeployConditions = (localConfig) => {
     }
 }
 
+function showConsoleLink(serviceName, action, open, ...ids) {
+    const projectId = localConfig.getProject().projectId;
+
+    const url = new URL(globalConfig.getEndpoint().replace('/v1', '/console'));
+    url.pathname += `/project-${projectId}`;
+    action = action.toLowerCase();
+
+    switch (serviceName) {
+        case "account":
+            url.pathname = url.pathname.replace(`/project-${projectId}`, '');
+            url.pathname += getAccountPath(action);
+            break;
+        case "databases":
+            url.pathname += getDatabasePath(action, ids);
+            break;
+        case "functions":
+            url.pathname += getFunctionsPath(action, ids);
+            break;
+        case "messaging":
+            url.pathname += getMessagingPath(action, ids);
+            break;
+        case "projects":
+            url.pathname = url.pathname.replace(`/project-${projectId}`, '');
+            url.pathname += getProjectsPath(action, ids);
+            break;
+        case "storage":
+            url.pathname += getBucketsPath(action, ids);
+            break;
+        case "teams":
+            url.pathname += getTeamsPath(action, ids);
+            break;
+        case "users":
+            url.pathname += getUsersPath(action, ids);
+            break;
+        default:
+            return;
+    }
+
+
+    success(url);
+
+    if (open) {
+        const start = (process.platform == 'darwin' ? 'open' : process.platform == 'win32' ? 'start' : 'xdg-open');
+        cp.exec(`${start} ${url}`);
+    }
+}
+
+function getAccountPath(action) {
+    let path = '/account';
+
+    if (action === 'listsessions') {
+        path += '/sessions';
+    }
+
+    return path;
+}
+
+function getDatabasePath(action, ids) {
+    let path = '/databases';
+
+
+    if (['get', 'listcollections', 'getcollection', 'listattributes', 'listdocuments', 'getdocument', 'listindexes', 'getdatabaseusage'].includes(action)) {
+        path += `/database-${ids[0]}`;
+    }
+
+    if (action === 'getdatabaseusage') {
+        path += `/usage`;
+    }
+
+    if (['getcollection', 'listattributes', 'listdocuments', 'getdocument', 'listindexes'].includes(action)) {
+        path += `/collection-${ids[1]}`;
+    }
+
+    if (action === 'listattributes') {
+        path += '/attributes';
+    }
+    if (action === 'listindexes') {
+        path += '/indexes';
+    }
+    if (action === 'getdocument') {
+        path += `/document-${ids[2]}`;
+    }
+
+
+    return path;
+}
+
+function getFunctionsPath(action, ids) {
+    let path = '/functions';
+
+    if (action !== 'list') {
+        path += `/function-${ids[0]}`;
+    }
+
+    if (action === 'getdeployment') {
+        path += `/deployment-${ids[1]}`
+    }
+
+    if (action === 'getexecution' || action === 'listexecution') {
+        path += `/executions`
+    }
+    if (action === 'getfunctionusage') {
+        path += `/usage`
+    }
+
+    return path;
+}
+
+function getMessagingPath(action, ids) {
+    let path = '/messaging';
+
+    if (['getmessage', 'listmessagelogs'].includes(action)) {
+        path += `/message-${ids[0]}`;
+    }
+
+    if (['listproviders', 'getprovider'].includes(action)) {
+        path += `/providers`;
+    }
+
+    if (action === 'getprovider') {
+        path += `/provider-${ids[0]}`;
+    }
+
+    if (['listtopics', 'gettopic'].includes(action)) {
+        path += `/topics`;
+    }
+
+    if (action === 'gettopic') {
+        path += `/topic-${ids[0]}`;
+    }
+
+    return path;
+}
+
+function getProjectsPath(action, ids) {
+    let path = '';
+
+    if (action !== 'list') {
+        path += `/project-${ids[0]}`;
+    }
+
+    if (['listkeys', 'getkey'].includes(action)) {
+        path += '/overview/keys'
+    }
+
+    if (['listplatforms', 'getplatform'].includes(action)) {
+        path += '/overview/platforms'
+    }
+
+    if (['listwebhooks', 'getwebhook'].includes(action)) {
+        path += '/settings/webhooks'
+    }
+
+    if (['getplatform', 'getkey', 'getwebhook'].includes(action)) {
+        path += `/${ids[1]}`;
+    }
+
+    return path;
+}
+
+function getBucketsPath(action, ids) {
+    let path = '/storage';
+
+    if (action !== 'listbuckets') {
+        path += `/bucket-${ids[0]}`;
+    }
+
+    if (action === 'getbucketusage') {
+        path += `/usage`
+    }
+
+    if (action === 'getfile') {
+        path += `/file-${ids[1]}`
+    }
+
+    return path;
+}
+
+function getTeamsPath(action, ids) {
+    let path = '/auth/teams';
+
+    if (action !== 'list') {
+        path += `/team-${ids[0]}`;
+    }
+
+    return path;
+}
+
+function getUsersPath(action, ids) {
+    let path = '/auth';
+
+    if (action !== 'list') {
+        path += `/user-${ids[0]}`;
+    }
+
+    if (action === 'listsessions') {
+        path += 'sessions';
+    }
+
+    return path;
+}
+
 module.exports = {
     getAllFiles,
-    checkDeployConditions
+    checkDeployConditions,
+    showConsoleLink
 };