@trayio/cdk-cli 3.1.1-unstable → 3.3.0

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @trayio/cdk-cli
 $ tray-cdk COMMAND
 running command...
 $ tray-cdk (--version|-v)
-@trayio/cdk-cli/3.1.1-unstable linux-x64 node-v18.19.0
+@trayio/cdk-cli/3.3.0 linux-x64 node-v18.19.0
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND
@@ -38,7 +38,7 @@ USAGE
 * [`tray-cdk connector init [CONNECTORNAME]`](#tray-cdk-connector-init-connectorname)
 * [`tray-cdk connector test [OPERATIONNAME]`](#tray-cdk-connector-test-operationname)
 * [`tray-cdk deployment create`](#tray-cdk-deployment-create)
-* [`tray-cdk deployment get CONNECTORNAME CONNECTORVERSION UUID`](#tray-cdk-deployment-get-connectorname-connectorversion-uuid)
+* [`tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]`](#tray-cdk-deployment-get-connectorname-connectorversion-uuid)
 * [`tray-cdk help [COMMANDS]`](#tray-cdk-help-commands)
 * [`tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-add-connectorname-connectorversion)
 * [`tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-list-connectorname-connectorversion)
@@ -174,21 +174,43 @@ DESCRIPTION
   Creates a new deployment for a connector project
 ```
 
-## `tray-cdk deployment get CONNECTORNAME CONNECTORVERSION UUID`
+## `tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]`
 
 Retrieves the status of a connector deployment
 
 ```
 USAGE
-  $ tray-cdk deployment get CONNECTORNAME CONNECTORVERSION UUID
+  $ tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID] [-t]
 
 ARGUMENTS
   CONNECTORNAME     The name of the connector
   CONNECTORVERSION  The version of the connector
   UUID              The UUID of the deployment, this is included in the tray-cdk deploy output
 
+FLAGS
+  -t, --tail  Enables the command to run until the deployment is complete with either a success or failure.
+
 DESCRIPTION
   Retrieves the status of a connector deployment
+
+EXAMPLES
+  $ tray-cdk deployment get
+
+  $ tray-cdk deployment get --tail
+
+  $ tray-cdk deployment get -t
+
+  $ tray-cdk deployment get my-connector 1.0
+
+  $ tray-cdk deployment get my-connector 1.0 --tail
+
+  $ tray-cdk deployment get my-connector 1.0 -t
+
+  $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3
+
+  $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 --tail
+
+  $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 -t
 ```
 
 ## `tray-cdk help [COMMANDS]`

package/dist/commands/deployment/get.d.ts

@@ -2,11 +2,18 @@ import { Command } from '@oclif/core';
 export default class Get extends Command {
     static description: string;
     static args: {
-        connectorName: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
-        connectorVersion: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
-        uuid: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+        connectorName: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+        connectorVersion: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+        uuid: import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };
+    static flags: {
+        tail: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static examples: string[];
     private connectorDeployment;
+    private generateConnectorDeploymentId;
+    private pollConnectorDeploymentStatus;
+    private getLocalConnectorInfo;
     run(): Promise<void>;
 }
 //# sourceMappingURL=get.d.ts.map

package/dist/commands/deployment/get.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/commands/deployment/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAY,MAAM,aAAa,CAAC;AAOhD,MAAM,CAAC,OAAO,OAAO,GAAI,SAAQ,OAAO;IACvC,MAAM,CAAC,WAAW,SAAoD;IAEtE,MAAM,CAAC,IAAI;;;;MAiBT;IAEF,OAAO,CAAC,mBAAmB,CAKzB;IAEI,GAAG;CAyDT"}
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../../src/commands/deployment/get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAmB,MAAM,aAAa,CAAC;AAcvD,MAAM,CAAC,OAAO,OAAO,GAAI,SAAQ,OAAO;IACvC,MAAM,CAAC,WAAW,SAAoD;IAEtE,MAAM,CAAC,IAAI;;;;MAiBT;IAEF,MAAM,CAAC,KAAK;;MAMV;IAEF,MAAM,CAAC,QAAQ,WAUb;IAEF,OAAO,CAAC,mBAAmB,CAKzB;IAEF,OAAO,CAAC,6BAA6B,CAGmC;IAExE,OAAO,CAAC,6BAA6B,CA8BnC;IAEF,OAAO,CAAC,qBAAqB,CAe3B;IAEI,GAAG;CAsFT"}

package/dist/commands/deployment/get.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -10,9 +33,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
+const pathLib = __importStar(require("path"));
+const fse = __importStar(require("fs-extra"));
 const AxiosHttpClient_1 = require("@trayio/axios/http/AxiosHttpClient");
 const ConnectorDeploymentHttpClient_1 = require("@trayio/tray-client/connector/deployment/ConnectorDeploymentHttpClient");
 const ConnectorDeploymentApi_1 = require("@trayio/tray-api/connector/deployment/ConnectorDeploymentApi");
+const uuid_1 = require("uuid");
 const colorizeString_1 = require("../../utils/colorizeString");
 const check_env_1 = require("../../utils/check-env");
 class Get extends core_1.Command {
@@ -21,20 +47,67 @@ class Get extends core_1.Command {
         this.connectorDeployment = new ConnectorDeploymentHttpClient_1.ConnectorDeploymentHttpClient({
             baseUrl: process.env.TRAY_API_URL,
         }, new AxiosHttpClient_1.AxiosHttpClient());
+        this.generateConnectorDeploymentId = (connectorName, connectorVersion) => (0, uuid_1.v5)(`${connectorName}-${connectorVersion}`, uuid_1.v5.URL);
+        this.pollConnectorDeploymentStatus = (connectorName, connectorVersion, id, token) => __awaiter(this, void 0, void 0, function* () {
+            const input = {
+                connectorName,
+                connectorVersion,
+                id,
+                token,
+            };
+            const response = yield this.connectorDeployment.get(input);
+            if (response.isSuccess &&
+                response.value.deploymentStatus === ConnectorDeploymentApi_1.ConnectorDeploymentStatus.Deploying) {
+                yield new Promise((resolve) => {
+                    setTimeout(resolve, 5000);
+                });
+                return this.pollConnectorDeploymentStatus(connectorName, connectorVersion, id, token);
+            }
+            return response;
+        });
+        this.getLocalConnectorInfo = () => {
+            const currentDirectory = process.cwd();
+            const connectorJsonPath = pathLib.join(currentDirectory, 'connector.json');
+            try {
+                const connectorJson = fse.readJsonSync(connectorJsonPath);
+                return {
+                    name: connectorJson.name,
+                    version: connectorJson.version,
+                };
+            }
+            catch (e) {
+                throw new Error(`Connector JSON file not found in the current directory. Please provide the connector name and version as arguments`);
+            }
+        };
     }
     run() {
         return __awaiter(this, void 0, void 0, function* () {
             (0, check_env_1.checkEnv)();
-            const { args } = yield this.parse(Get);
+            const { args, flags } = yield this.parse(Get);
             const TRAY_API_TOKEN = process.env.TRAY_API_TOKEN;
+            if (!args.connectorName || !args.connectorVersion) {
+                core_1.ux.action.start('No arguments provided, attempting to use local connector');
+                const { name, version } = this.getLocalConnectorInfo();
+                args.connectorName = name;
+                args.connectorVersion = version;
+                core_1.ux.action.stop(`Local connector found. Name: ${name}, Version: ${version}`);
+            }
             const input = {
                 connectorName: args.connectorName,
                 connectorVersion: args.connectorVersion,
-                id: args.uuid,
+                id: args.uuid ||
+                    this.generateConnectorDeploymentId(args.connectorName, args.connectorVersion),
                 token: TRAY_API_TOKEN,
             };
-            core_1.ux.action.start(`Checking the connector deployment status`);
-            const response = yield this.connectorDeployment.get(input);
+            let response;
+            if (flags.tail) {
+                core_1.ux.action.start(`Checking the connector deployment status with tailing`);
+                response = yield this.pollConnectorDeploymentStatus(input.connectorName, input.connectorVersion, input.id, input.token);
+            }
+            else {
+                core_1.ux.action.start(`Checking the connector deployment status`);
+                response = yield this.connectorDeployment.get(input);
+            }
             core_1.ux.action.stop();
             if (response.isSuccess) {
                 switch (response.value.deploymentStatus) {
@@ -63,18 +136,35 @@ Get.description = 'Retrieves the status of a connector deployment';
 Get.args = {
     connectorName: core_1.Args.string({
         name: 'Connector Name',
-        required: true,
+        required: false,
         description: 'The name of the connector',
     }),
     connectorVersion: core_1.Args.string({
         name: 'Connector Version',
-        required: true,
+        required: false,
         description: 'The version of the connector',
     }),
     uuid: core_1.Args.string({
         name: 'Deployment UUID',
-        required: true,
+        required: false,
         description: 'The UUID of the deployment, this is included in the tray-cdk deploy output',
     }),
 };
+Get.flags = {
+    tail: core_1.Flags.boolean({
+        char: 't',
+        description: 'Enables the command to run until the deployment is complete with either a success or failure.',
+    }),
+};
+Get.examples = [
+    `<%= config.bin %> <%= command.id %>`,
+    `<%= config.bin %> <%= command.id %> --tail`,
+    `<%= config.bin %> <%= command.id %> -t`,
+    `<%= config.bin %> <%= command.id %> my-connector 1.0`,
+    `<%= config.bin %> <%= command.id %> my-connector 1.0 --tail`,
+    `<%= config.bin %> <%= command.id %> my-connector 1.0 -t`,
+    `<%= config.bin %> <%= command.id %> my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3`,
+    `<%= config.bin %> <%= command.id %> my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 --tail`,
+    `<%= config.bin %> <%= command.id %> my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 -t`,
+];
 exports.default = Get;

package/dist/commands/deployment/get.unit.test.js

@@ -12,6 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
 const stdout_stderr_1 = require("stdout-stderr");
 const ConnectorDeploymentApi_1 = require("@trayio/tray-api/connector/deployment/ConnectorDeploymentApi");
 const ConnectorDeploymentHttpClient_1 = require("@trayio/tray-client/connector/deployment/ConnectorDeploymentHttpClient");
@@ -33,6 +34,8 @@ describe('GetDeploymentStatus', () => {
     const connectorVersion = '1.0';
     const uuid = 'test-uuid';
     beforeEach(() => {
+        success = true;
+        failure = false;
         ConnectorDeploymentHttpClient_1.ConnectorDeploymentHttpClient.mockImplementation(() => ({
             get: jest.fn().mockReturnValue(Object.assign(Object.assign(Object.assign({ isSuccess: success }, (success && {
                 value: {
@@ -50,9 +53,11 @@ describe('GetDeploymentStatus', () => {
     });
     it('should log success message when connector is deployed', () => __awaiter(void 0, void 0, void 0, function* () {
         status = ConnectorDeploymentApi_1.ConnectorDeploymentStatus.Deployed;
+        const uxStartSpy = jest.spyOn(core_1.ux.action, 'start');
         stdout_stderr_1.stdout.start();
         yield get_1.default.run([connectorName, connectorVersion, uuid]);
         stdout_stderr_1.stdout.stop();
+        expect(uxStartSpy).toHaveBeenCalledWith(`Checking the connector deployment status`);
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector Deployed Successfully!'));
     }));
     it('should log failed message when connector failed to deploy', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -79,4 +84,31 @@ describe('GetDeploymentStatus', () => {
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector Deploy Failed, please try again or contact support'));
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('There was an error fetching deployment status'));
     }));
+    it('should run the polling function when tail flag is set', () => __awaiter(void 0, void 0, void 0, function* () {
+        status = ConnectorDeploymentApi_1.ConnectorDeploymentStatus.Deployed;
+        const uxStartSpy = jest.spyOn(core_1.ux.action, 'start');
+        stdout_stderr_1.stdout.start();
+        yield get_1.default.run([connectorName, connectorVersion, uuid, '-t']);
+        stdout_stderr_1.stdout.stop();
+        expect(uxStartSpy).toHaveBeenCalledWith(`Checking the connector deployment status with tailing`);
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector Deployed Successfully!'));
+    }));
+    it('should run the get status command when a uuid is not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+        status = ConnectorDeploymentApi_1.ConnectorDeploymentStatus.Deployed;
+        stdout_stderr_1.stdout.start();
+        yield get_1.default.run([connectorName, connectorVersion]);
+        stdout_stderr_1.stdout.stop();
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector Deployed Successfully!'));
+    }));
+    it('should use local connector when no args are provided', () => __awaiter(void 0, void 0, void 0, function* () {
+        status = ConnectorDeploymentApi_1.ConnectorDeploymentStatus.Deployed;
+        stdout_stderr_1.stdout.start();
+        yield get_1.default.run([]);
+        stdout_stderr_1.stdout.stop();
+        const uxStartSpy = jest.spyOn(core_1.ux.action, 'start');
+        expect(uxStartSpy).toHaveBeenCalledTimes(2);
+        expect(uxStartSpy.mock.calls[0][0]).toEqual('No arguments provided, attempting to use local connector');
+        expect(uxStartSpy.mock.calls[1][0]).toEqual('Checking the connector deployment status');
+        expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector Deployed Successfully!'));
+    }));
 });

package/oclif.manifest.json

@@ -203,21 +203,40 @@
         "connectorName": {
           "description": "The name of the connector",
           "name": "connectorName",
-          "required": true
+          "required": false
         },
         "connectorVersion": {
           "description": "The version of the connector",
           "name": "connectorVersion",
-          "required": true
+          "required": false
         },
         "uuid": {
           "description": "The UUID of the deployment, this is included in the tray-cdk deploy output",
           "name": "uuid",
-          "required": true
+          "required": false
         }
       },
       "description": "Retrieves the status of a connector deployment",
-      "flags": {},
+      "examples": [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --tail",
+        "<%= config.bin %> <%= command.id %> -t",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 --tail",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 -t",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 --tail",
+        "<%= config.bin %> <%= command.id %> my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 -t"
+      ],
+      "flags": {
+        "tail": {
+          "char": "t",
+          "description": "Enables the command to run until the deployment is complete with either a success or failure.",
+          "name": "tail",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "deployment:get",
@@ -324,5 +343,5 @@
       ]
     }
   },
-  "version": "3.1.1-unstable"
+  "version": "3.3.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "3.1.1-unstable",
+  "version": "3.3.0",
   "description": "A CLI for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -19,12 +19,12 @@
     "@oclif/plugin-help": "6.0.12",
     "@oclif/plugin-version": "2.0.11",
     "@oclif/test": "3.1.12",
-    "@trayio/axios": "3.1.1-unstable",
-    "@trayio/cdk-build": "3.1.1-unstable",
-    "@trayio/commons": "3.1.1-unstable",
-    "@trayio/generator": "3.1.1-unstable",
-    "@trayio/tray-client": "3.1.1-unstable",
-    "@trayio/tray-openapi": "3.1.1-unstable",
+    "@trayio/axios": "3.3.0",
+    "@trayio/cdk-build": "3.3.0",
+    "@trayio/commons": "3.3.0",
+    "@trayio/generator": "3.3.0",
+    "@trayio/tray-client": "3.3.0",
+    "@trayio/tray-openapi": "3.3.0",
     "@types/inquirer": "8.2.6",
     "chalk": "4.1.2",
     "inquirer": "8.2.5"