APIGOV-33064 Query Engage for latest version of agent for creating output of install command

Author: kasuvy

src/lib/engage/clients-external/apiserverclient.ts

@@ -10,6 +10,7 @@ import {
 	ApiServerVersions,
 	BasePaths,
 	CommandLineInterface,
+	Component,
 	GenericResource,
 	GenericResourceWithoutName,
 	LanguageTypes,
@@ -894,6 +895,21 @@ export class ApiServerClient {
 		}
 	}
 
+	async getComponentDefinitionsByName(componentName: string, version = ApiServerVersions.v1alpha1): Promise<Component> {
+		const log = logger('ApiServerClient.getComponentDefinitionsByName');
+		log.info('get component definitions');
+		try {
+			const service = await this.initializeDataService();
+			const component: Component = await service.get(`definitions/${version}/components/${componentName}`);
+
+			return component;
+
+		} catch (e: any) {
+			log.error('get specs, error: ', e);
+			throw e;
+		}
+	}
+
 	async bulkCreate(
 		resources: Array<GenericResourceWithoutName | GenericResource>,
 		sortedDefsMap: Map<string, ResourceDefinition>,

src/lib/engage/services/install-service.ts

@@ -89,17 +89,17 @@ const determineRegion = async (region: string | undefined): Promise<string> => {
 	return configurationRegion ? configurationRegion : Regions.US;
 };
 
-async function getAgentVersions(agentInstallFlow: InstallationFlowMethods, installConfig: AgentInstallConfig, account: Account): Promise<void> {
+async function getAgentVersions(agentInstallFlow: InstallationFlowMethods, installConfig: AgentInstallConfig, apiServerClient: ApiServerClient): Promise<void> {
 	if (agentInstallFlow.AgentNameMap && !installConfig.switches.isHostedInstall && installConfig.switches.isDaEnabled) {
 		installConfig.daVersion = await helpers.getLatestAgentVersion(
+			apiServerClient,
 			agentInstallFlow.AgentNameMap[AgentTypes.da] as string,
-			account
 		);
 	}
 	if (agentInstallFlow.AgentNameMap && !installConfig.switches.isHostedInstall && installConfig.switches.isTaEnabled) {
 		installConfig.taVersion = await helpers.getLatestAgentVersion(
+			apiServerClient,
 			agentInstallFlow.AgentNameMap[AgentTypes.ta] as string,
-			account
 		);
 	}
 }
@@ -249,8 +249,8 @@ export async function installAgents(params: InstallAgentsCommandParams): Promise
 		installConfig.switches.isDockerInstall = installConfig.deploymentType === AgentConfigTypes.DOCKERIZED;
 		installConfig.switches.isBinaryInstall = installConfig.deploymentType === AgentConfigTypes.BINARIES;
 
-		// Get the version of the agents from jfrog, not needed in hosted install
-		await getAgentVersions(agentInstallFlow, installConfig, params.account);
+		// Get the version of the agents from Engage, not needed in hosted install
+		await getAgentVersions(agentInstallFlow, installConfig, apiServerClient);
 
 		// if EDGE_GATEWAY or EDGE_GATEWAY_ONLY and isDaEnabled, ask if the organization structure should replicate
 		if (

src/lib/engage/types.ts

@@ -153,6 +153,49 @@ export interface CommandLineInterface {
 	};
 }
 
+export interface Component {
+	group: 'definitions',
+	apiVersion: ApiServerVersions,
+	kind: 'Component',
+	name: string,
+	title: string,
+	metadata: {
+		id: string,
+		audit: {
+			createTimestamp: string,
+			modifyTimestamp: string
+		},
+		accessRights: {
+			canChangeOwner: boolean,
+			canDelete: boolean,
+			canWrite: boolean,
+			canRead: boolean
+		},
+		resourceVersion: string,
+		selfLink: string
+	},
+	spec: {
+		type: ComponentType,
+		latest: ComponentSpecVersionInfo,
+		retracted: string[],
+		supported: ComponentSpecVersionInfo[]
+	}
+
+}
+
+export enum ComponentType {
+	Agent = 'agent',
+	DA = 'DiscoveryAgent',
+	TA = 'TraceabilityAgent',
+	CA = 'ComplianceAgent'
+}
+
+export interface ComponentSpecVersionInfo {
+	version: string;
+	releaseDate: string;
+	endOfSupportDate: string;
+}
+
 export interface AuditMetadata {
 	createTimestamp: string; // '2020-08-04T21:05:32.106Z';
 	createUserId: string; // '07e6b449-3a31-4a96-8920-e87dd504cb87';
@@ -349,7 +392,6 @@ export enum BasePaths {
 	V7Agents = '/artifactory/ampc-public-generic-release/v7-agents',
 	AWSAgents = '/artifactory/ampc-public-generic-release/aws-agents',
 	DockerAgentPublicRepo = '/agent',
-	DockerAgentAPIRepoPath = '/artifactory/api/docker/ampc-public-docker-release/v2/agent',
 }
 
 export interface ValidatedDocs {
@@ -836,8 +878,8 @@ export const GatewayTypeToDataPlane = {
 	[GatewayTypes.WSO2]: DataPlaneNames.WSO2,
 };
 
-export const PublicRepoUrl = 'https://axway.jfrog.io';
-export const PublicDockerRepoBaseUrl = 'axway.jfrog.io/ampc-public-docker-release';
+export const PublicRepoUrl = 'https://repository.axway.com';
+export const PublicDockerRepoBaseUrl = 'repository.axway.com/ampc-public-docker-release';
 
 export class DOSAConfigInfo {
 	clientId: string | null;

src/lib/engage/utils/agents/getters.ts

@@ -1,9 +1,7 @@
 import { ApiServerClient } from '../../clients-external/apiserverclient.js';
-import { ApiServerClientListResult, BasePaths, PublicRepoUrl } from '../../types.js';
-import { dataService } from '../../../request.js';
+import { ApiServerClientListResult } from '../../types.js';
 import { DefinitionsManager } from '../../results/DefinitionsManager.js';
 import logger from '../../../logger.js';
-import { Account } from '../../../../types.js';
 
 const { log, error } = logger('lib: engage: utils: agents: getters');
 
@@ -56,49 +54,17 @@ export const getEnvironmentId = async (
 	return resource.data?.metadata ? resource.data.metadata.id || '' : '';
 };
 
-export const getLatestAgentVersion = async (agent: string, account: Account): Promise<string> => {
+export const getLatestAgentVersion = async (client: ApiServerClient, agentName: string): Promise<string> => {
 	try {
-		const service = await dataService({ account, baseUrl: PublicRepoUrl + BasePaths.DockerAgentAPIRepoPath });
-
-		const response = await service.get(
-			`/${agent}/tags/list`,
-			{
-				// docker api requires auth, even if its just anonymous
-				Authorization: `Basic ${Buffer.from('anonymous:').toString('base64')}`,
-			},
-			true
-		);
-
-		if (response.tags.length === 0) {
-			return 'latest';
+		const componentDef = await client.getComponentDefinitionsByName(agentName);
+		const version = componentDef.spec?.latest?.version;
+		if (version) {
+			log(`Latest Version (${agentName}): ${version}`);
+			return version;
 		}
-		const latestVersion = response.tags.reduce((prev: string, current: string) => {
-			// skip any tags that are latest
-			if (prev === 'latest') {
-				return current;
-			} else if (current === 'latest') {
-				return prev;
-			}
-
-			// find the largest tag
-			const [ pMajor, pMinor, pPatch ] = prev.split('.').map(Number);
-			const [ cMajor, cMinor, cPatch ] = current.split('.').map(Number);
-
-			if (cMajor > pMajor) {
-				return current;
-			}
-			if (cMajor === pMajor && cMinor > pMinor) {
-				return current;
-			}
-			if (cMajor === pMajor && cMinor === pMinor && cPatch > pPatch) {
-				return current;
-			}
-			return prev;
-		});
-		log(`Latest Version (${agent}): ${latestVersion}`);
-		return latestVersion;
+		return 'latest';
 	} catch (e: any) {
-		error('Error hit retrieving latest version of agent, setting tag to latest');
+		error('Error retrieving latest version, setting tag to latest');
 		error(e);
 		return 'latest';
 	}