[Fix][WRS-2026]: Prevent changing (update/delete) of "Hub-Based" connectors via CLI

src/connector-cli/resources/schemas/authentication-types/chili-token.json

@@ -6,6 +6,5 @@
       "type": "string"
     }
   },
-  "required": ["name"],
   "additionalProperties": false
 }

src/connector-cli/resources/schemas/authentication-types/oauth2-authorization-code.json

@@ -60,11 +60,6 @@
       "$ref": "#/$defs/SpecCustomization"
     }
   },
-  "required": [
-    "name",
-    "clientId",
-    "clientSecret",
-    "authorizationServerMetadata"
-  ],
+  "required": ["clientId", "clientSecret", "authorizationServerMetadata"],
   "additionalProperties": false
 }

src/connector-cli/resources/schemas/authentication-types/oauth2-client-credentials.json

@@ -18,6 +18,6 @@
       "type": "string"
     }
   },
-  "required": ["name", "clientId", "clientSecret", "tokenEndpoint"],
+  "required": ["clientId", "clientSecret", "tokenEndpoint"],
   "additionalProperties": false
 }

src/connector-cli/resources/schemas/authentication-types/oauth2-resource-owner-password.json

@@ -30,7 +30,6 @@
     }
   },
   "required": [
-    "name",
     "clientId",
     "clientSecret",
     "tokenEndpoint",

src/connector-cli/resources/schemas/authentication-types/static-key.json

@@ -12,6 +12,6 @@
       "type": "string"
     }
   },
-  "required": ["name", "key", "value"],
+  "required": ["key", "value"],
   "additionalProperties": false
 }

src/connector-cli/src/commands/delete/steps/remove-connector.ts

@@ -1,13 +1,20 @@
-import { selectAvailableConnector } from '../../../common/select-available-connector';
-import { httpErrorHandler, info, success, verbose, warn } from '../../../core';
+import { getConnectorById } from '../../../common/get-connector';
+import { httpErrorHandler, info, success, verbose } from '../../../core';
 
 export async function removeConnector(
   connectorEndpointBaseUrl: string,
   connectorId: string,
   token: string
 ): Promise<void> {
+  info('Retrieving connector to remove...');
+  const { id, name } = await getConnectorById({
+    baseUrl: connectorEndpointBaseUrl,
+    connectorId,
+    token,
+  });
+
   info('Removing connector...');
-  const deleteConnectorEnpdoint = `${connectorEndpointBaseUrl}/${connectorId}`;
+  const deleteConnectorEnpdoint = `${connectorEndpointBaseUrl}/${id}`;
 
   verbose('Removing connector via -> ' + deleteConnectorEnpdoint);
 
@@ -19,15 +26,9 @@ export async function removeConnector(
     },
   });
 
-  if (!res.ok && res.status === 404) {
-    warn(
-      `Connector with id ${connectorId} doesn't exist or you don't have permission to remove it`
-    );
-    const id = await selectAvailableConnector(connectorEndpointBaseUrl, token);
-    return removeConnector(connectorEndpointBaseUrl, id, token);
-  } else if (!res.ok) {
+  if (!res.ok) {
     await httpErrorHandler(res);
   }
 
-  success(`Connector "${connectorId}" is removed`);
+  success(`Connector "${name}" is removed`, { id, name });
 }

src/connector-cli/src/commands/init/templates.ts

@@ -18,6 +18,7 @@ export const getPackageJson = (projectName: string, type: Type) => ({
     type: type,
     options: {},
     mappings: {},
+    supportedAuth: [],
   },
   license: 'MIT',
   main: `${outputDirectory}/${outputFilename}`,

src/connector-cli/src/commands/publish/steps/update-connector.ts

@@ -1,5 +1,5 @@
-import { selectAvailableConnector } from '../../../common/select-available-connector';
-import { httpErrorHandler, info, success, verbose, warn } from '../../../core';
+import { getConnectorById } from '../../../common/get-connector';
+import { httpErrorHandler, info, success, verbose } from '../../../core';
 import { UpdateConnectorPayload } from '../types';
 
 export async function updateExistingConnector(
@@ -8,38 +8,19 @@ export async function updateExistingConnector(
   token: string,
   payload: UpdateConnectorPayload
 ): Promise<void> {
-  info('Updating connector...');
-  const getConnectorEnpdoint = `${connectorEndpointBaseUrl}/${connectorId}`;
-
-  verbose(
-    `Checking connector's existing with id ${connectorId} -> ${getConnectorEnpdoint}`
-  );
-  const existingConnectorRes = await fetch(getConnectorEnpdoint, {
-    headers: {
-      Authorization: token,
-    },
+  info('Retrieving connector to remove...');
+  const existingConnector = await getConnectorById({
+    baseUrl: connectorEndpointBaseUrl,
+    connectorId,
+    token,
   });
-  if (existingConnectorRes.status !== 200) {
-    warn(
-      `Connector with id ${connectorId} doesn't exist or you don't have permission to update it`
-    );
-    // When connector is not available we request the list and ask user to select connector for update
-    const id = await selectAvailableConnector(connectorEndpointBaseUrl, token);
-    return updateExistingConnector(
-      connectorEndpointBaseUrl,
-      id,
-      token,
-      payload
-    );
-  }
-
-  const existingConnector = await existingConnectorRes.json();
   const updatePayload = {
     ...existingConnector,
     ...payload,
   };
 
-  const updateConnectorEnpdoint = getConnectorEnpdoint;
+  info('Updating connector...');
+  const updateConnectorEnpdoint = `${connectorEndpointBaseUrl}/${existingConnector.id}`;
 
   verbose(
     `Deploying connector with a payload\n ${JSON.stringify(

src/connector-cli/src/commands/publish/types.ts

@@ -11,6 +11,7 @@ interface ConnectorPayload {
   iconUrl?: string;
   script: string;
   apiVersion: string;
+  options?: Record<string, unknown>;
   allowedDomains: Array<string>;
   proxyOptions: {
     forwardedHeaders: boolean;

src/connector-cli/src/commands/set-auth/index.ts

@@ -1,3 +1,5 @@
+import { buildRequestUrl } from '../../common/build-request-url';
+import { getConnectorById } from '../../common/get-connector';
 import { info, readConnectorConfig, startCommand, success } from '../../core';
 import { readAccessToken } from '../../core/read-access-token';
 import {
@@ -40,9 +42,9 @@ export async function runSetAuth(
 
   const connectorConfig = readConnectorConfig(packageJson);
 
-  if (!connectorConfig.supportedAuth) {
+  if (connectorConfig.supportedAuth.length === 0) {
     throw new ExecutionError(
-      'There is no information about supported authentication for this connector. Specify "config.supportedAuth" in connecotr\'s package.json'
+      'There is no information about supported authentication for this connector. Specify "config.supportedAuth" in connector\'s package.json'
     );
   }
 
@@ -56,8 +58,19 @@ export async function runSetAuth(
     connectorConfig.supportedAuth
   );
 
+  info('Retrieving connector to update...');
+  const { id, name } = await getConnectorById({
+    baseUrl: buildRequestUrl(baseUrl, environment),
+    connectorId,
+    token: accessToken,
+  });
+
+  if (!authData.name) {
+    authData.name = `${id}-${usage}-${type}`;
+  }
+
   info('Build full request URL...');
-  const requestUrl = getRequestUrl(baseUrl, environment, connectorId, type);
+  const requestUrl = getRequestUrl(baseUrl, environment, id, type);
 
   info('Set authentication...');
   await setAuthentication(
@@ -69,5 +82,9 @@ export async function runSetAuth(
     accessToken
   );
 
-  success(`"${type}" authentication is applied.`, { id: connectorId });
+  success(`"${type}" authentication is applied for "${name}" connector`, {
+    id,
+    name,
+    type,
+  });
 }

src/connector-cli/src/common/get-connector.ts

@@ -0,0 +1,52 @@
+import { httpErrorHandler, verbose, warn } from '../core';
+import { ExecutionError } from '../core/types';
+import { selectAvailableConnector } from './select-available-connector';
+
+interface GetConnectorById {
+  baseUrl: string;
+  connectorId: string;
+  token: string;
+}
+
+interface EnvironmentConnector {
+  id: string;
+  name: string;
+  ownerType: 'grafx';
+  externalSourceId?: string;
+}
+
+export async function getConnectorById(
+  request: GetConnectorById
+): Promise<EnvironmentConnector> {
+  const getConnectorEnpdoint = `${request.baseUrl}/${request.connectorId}`;
+
+  verbose(
+    `Checking connector's existing with id ${request.connectorId} -> ${getConnectorEnpdoint}`
+  );
+  const res = await fetch(getConnectorEnpdoint, {
+    headers: {
+      Authorization: request.token,
+    },
+  });
+
+  if (!res.ok && res.status === 404) {
+    warn(
+      `Connector with id ${request.connectorId} doesn't exist or you don't have permission to view it`
+    );
+    // When particular connector is not available we request the full list and ask user to select one available to make an action
+    const id = await selectAvailableConnector(request.baseUrl, request.token);
+    return getConnectorById({ ...request, connectorId: id });
+  } else if (!res.ok) {
+    await httpErrorHandler(res);
+  }
+
+  const connector: EnvironmentConnector = await res.json();
+
+  verbose('Checking belongings to "Hub-Based" connectors');
+  if (connector.ownerType === 'grafx' && !!connector.externalSourceId) {
+    throw new ExecutionError(
+      `You're trying to change a connector created using Connector Hub. It can not be done via Connector CLI. Consider to use GraFx Platform connectors configuration page instead`
+    );
+  }
+  return connector;
+}

src/connector-cli/src/common/select-available-connector.ts

@@ -30,7 +30,9 @@ export async function selectAvailableConnector(
   while (true) {
     // Use the question method to get the user input
     const index = Number(
-      await rl.question('Select the index of the connector to make an action')
+      await rl.question(
+        'Select the index of the connector to make an action:\xa0'
+      )
     );
     // Use the validation function to check the input
     if (isNaN(index) || !connectors[index]) {

src/connector-cli/src/core/types/gen-types.ts

@@ -13,14 +13,14 @@
 // match the expected interface, even if the JSON is valid.
 
 export interface ChiliToken {
-    name: string;
+    name?: string;
 }
 
 export interface Oauth2AuthorizationCode {
     authorizationServerMetadata: AuthorizationServerMetadata;
     clientId:                    string;
     clientSecret:                string;
-    name:                        string;
+    name?:                       string;
     scope?:                      string;
     specCustomization?:          SpecCustomization;
 }
@@ -49,7 +49,7 @@ export enum RequestContentType {
 export interface Oauth2ClientCredentials {
     clientId:      string;
     clientSecret:  string;
-    name:          string;
+    name?:         string;
     scope?:        string;
     tokenEndpoint: string;
 }
@@ -58,7 +58,7 @@ export interface Oauth2ResourceOwnerPassword {
     bodyFormat?:   RequestContentType;
     clientId:      string;
     clientSecret:  string;
-    name:          string;
+    name?:         string;
     password:      string;
     scope?:        string;
     tokenEndpoint: string;
@@ -67,7 +67,7 @@ export interface Oauth2ResourceOwnerPassword {
 
 export interface StaticKey {
     key:   string;
-    name:  string;
+    name?: string;
     value: string;
 }
 
@@ -298,13 +298,13 @@ function r(name: string) {
 
 const typeMap: any = {
     "ChiliToken": o([
-        { json: "name", js: "name", typ: "" },
+        { json: "name", js: "name", typ: u(undefined, "") },
     ], false),
     "Oauth2AuthorizationCode": o([
         { json: "authorizationServerMetadata", js: "authorizationServerMetadata", typ: r("AuthorizationServerMetadata") },
         { json: "clientId", js: "clientId", typ: "" },
         { json: "clientSecret", js: "clientSecret", typ: "" },
-        { json: "name", js: "name", typ: "" },
+        { json: "name", js: "name", typ: u(undefined, "") },
         { json: "scope", js: "scope", typ: u(undefined, "") },
         { json: "specCustomization", js: "specCustomization", typ: u(undefined, r("SpecCustomization")) },
     ], false),
@@ -320,23 +320,23 @@ const typeMap: any = {
     "Oauth2ClientCredentials": o([
         { json: "clientId", js: "clientId", typ: "" },
         { json: "clientSecret", js: "clientSecret", typ: "" },
-        { json: "name", js: "name", typ: "" },
+        { json: "name", js: "name", typ: u(undefined, "") },
         { json: "scope", js: "scope", typ: u(undefined, "") },
         { json: "tokenEndpoint", js: "tokenEndpoint", typ: "" },
     ], false),
     "Oauth2ResourceOwnerPassword": o([
         { json: "bodyFormat", js: "bodyFormat", typ: u(undefined, r("RequestContentType")) },
         { json: "clientId", js: "clientId", typ: "" },
         { json: "clientSecret", js: "clientSecret", typ: "" },
-        { json: "name", js: "name", typ: "" },
+        { json: "name", js: "name", typ: u(undefined, "") },
         { json: "password", js: "password", typ: "" },
         { json: "scope", js: "scope", typ: u(undefined, "") },
         { json: "tokenEndpoint", js: "tokenEndpoint", typ: "" },
         { json: "username", js: "username", typ: "" },
     ], false),
     "StaticKey": o([
         { json: "key", js: "key", typ: "" },
-        { json: "name", js: "name", typ: "" },
+        { json: "name", js: "name", typ: u(undefined, "") },
         { json: "value", js: "value", typ: "" },
     ], false),
     "ConnectorConfig": o([

src/connector-cli/src/index.ts

@@ -94,7 +94,10 @@ function main() {
         ' You can use "*" to denote dynamic parts of the URL.' +
         ' Example usage: --proxyOption.allowedDomains "main-domain.com", --proxyOption.allowedDomains "*.sub-domain.com"'
     )
-    .option('--proxyOption.forwardedHeaders')
+    .option(
+      '--proxyOption.forwardedHeaders',
+      'If enabled, any request to connector via proxy ednpoint will include X-Forwarded-* headers'
+    )
     .action(withErrorHandlerAction(runPublish));
 
   program