feat(cli): Expanding console flow to list and various get commands

Author: byawitz

templates/cli/base/requests/api.twig

@@ -17,10 +17,10 @@
     fs.writeFileSync(destination, response);
     {%~ endif %}
     if (parseOutput) {
-    {%~ if method.name == 'get' and service.name not in ['health','migrations','locale'] %}
+    {%~ if methodHaveConsolePreview(method.name,service.name) %}
         if(console) {
-            showConsoleLink('{{service.name}}', 'get'
-        {%- for parameter in method.parameters.path -%}{%- set param = (parameter.name | caseCamel | escapeKeyword)  -%},open {%- if param  ends with 'Id' -%}, {{ param }} {%- endif -%}{%- endfor -%}
+            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)

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

@@ -70,7 +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 method.name == 'get' -%}, console, open{%- endif -%}
+        {% if methodHaveConsolePreview(method.name,service.name) %}, console, open{%- endif -%}
 }) => {
 {%~ endblock %}
     let client = !sdk ? await {% if service.name == "projects" %}sdkForConsole(){% else %}sdkForProject(){% endif %} :
@@ -95,7 +95,7 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
 {% if method.type == 'location' %}
     .requiredOption(`--destination <path>`, `output file path.`)
 {% endif %}
-{% if method.name == 'get' %}
+{% 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 %}

templates/cli/lib/utils.js.twig

@@ -18,46 +18,45 @@ function getAllFiles(folder) {
     return files;
 }
 
-function showConsoleLink(serviceName, action, open, id = '') {
-    let resource = '';
-    let service = '';
+
+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":
-            service = 'account';
+            url.pathname = url.pathname.replace(`/project-${projectId}`, '');
+            url.pathname += getAccountPath(action);
             break;
         case "databases":
-            resource = 'database';
-            service = 'databases';
+            url.pathname += getDatabasePath(action, ids);
             break;
         case "functions":
-            resource = 'function';
-            service = 'functions';
+            url.pathname += getFunctionsPath(action, ids);
+            break;
+        case "messaging":
+            url.pathname += getMessagingPath(action, ids);
             break;
         case "projects":
-            service = `project-${id}`;
-            id = '';
+            url.pathname = url.pathname.replace(`/project-${projectId}`, '');
+            url.pathname += getProjectsPath(action, ids);
+            break;
+        case "storage":
+            url.pathname += getBucketsPath(action, ids);
             break;
         case "teams":
-            resource = 'team';
-            service = 'auth/teams';
+            url.pathname += getTeamsPath(action, ids);
             break;
-
         case "users":
-            resource = 'user';
-            service = 'auth';
+            url.pathname += getUsersPath(action, ids);
             break;
         default:
             return;
     }
 
-    const baseUrl = globalConfig.getEndpoint().replace('/v1', '');
-
-    const end = action === 'get' ? (id ? `/${resource}-${id}` : `/${resource}`) : '';
-    const projectId = localConfig.getProject().projectId;
-    const middle = resource !== '' ? `/project-${projectId}` : '';
-    const url = `${baseUrl}/console${middle}/${service}${end}`
-
 
     success(url);
 
@@ -67,6 +66,161 @@ function showConsoleLink(serviceName, action, open, id = '') {
     }
 }
 
+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,
     showConsoleLink