dashboard/shell/components/google/util/gcp.ts

import { addParams, QueryParams } from '@shell/utils/url';
import {
  getGKEMachineTypesResponse,
  getGKEClustersResponse,
  getGKENetworksResponse,
  getGKESharedSubnetworksResponse,
  getGKESubnetworksResponse,
  getGKEVersionsResponse,
  GKEZone,
  getGKEZonesResponse,
  getGKEServiceAccountsResponse,
  getGKEImageFamiliesResponse
} from 'types/gcp';
import { Store } from 'vuex';

// If any of these defaults are not available in the actual list from gcp, the ui will default to the first option in the (sorted) list
export const DEFAULT_GCP_ZONE = 'us-central1-c';
export const DEFAULT_GCP_REGION = 'us-central1';

export const DEFAULT_GCP_SERVICE_ACCOUNT = 'Compute Engine default service account';
/**
 * @param resource gcp resource to fetch eg gkeZones
 * @param store vuex store used to dispatch management/request
 * @param cloudCredentialId gcp credential id - will be in the form cattle-global-data:<random string>
 * @param projectId gcp project in which to make the request
 * @param location object containing either gcp region or zone in which to make the request - defaults to DEFAULT_GCP_ZONE if both zone and region are undefined. region preempts zone
 * @param extraParams any additional parameters required by requests
 * @returns
 */
function getGKEOptions(resource: string, store: any, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}, clusterId?:string, extraParams?: object ) {
  if (!cloudCredentialId || !projectId) {
    return;
  }
  if (!location.zone && !location.region) {
    location.zone = DEFAULT_GCP_ZONE;
  }
  let params: QueryParams = {};

  if (location.region) {
    params = {
      cloudCredentialId, projectId, region: location.region
    };
  } else if (location.zone) {
    params = {
      cloudCredentialId, projectId, zone: location.zone

    };
  }
  if (clusterId) {
    params.clusterId = clusterId;
  }
  if (extraParams) {
    params = { ...params, ...extraParams };
  }

  const url = addParams(`/meta/${ resource }`, params);

  return store.dispatch('management/request', {
    url,
    method:               'POST',
    redirectUnauthorized: false,
  });
}

export function getGKEZones(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKEZonesResponse> {
  return getGKEOptions('gkeZones', store, cloudCredentialId, projectId, location);
}

export async function getGKEVersions(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKEVersionsResponse> {
  return await getGKEOptions('gkeVersions', store, cloudCredentialId, projectId, location);
}

export function getGKEMachineTypes(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKEMachineTypesResponse> {
  return getGKEOptions('gkeMachineTypes', store, cloudCredentialId, projectId, { zone: location.zone });
}

export function getGKENetworks(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKENetworksResponse> {
  return getGKEOptions('gkeNetworks', store, cloudCredentialId, projectId, location);
}

export function getGKESubnetworks(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKESubnetworksResponse> {
  return getGKEOptions('gkeSubnetworks', store, cloudCredentialId, projectId, location);
}

export function getGKESharedSubnetworks(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKESharedSubnetworksResponse> {
  return getGKEOptions('gkeSharedSubnets', store, cloudCredentialId, projectId, location);
}

export function getGKEClusters(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKEClustersResponse> {
  return getGKEOptions('gkeClusters', store, cloudCredentialId, projectId, location);
}

export function getGKEServiceAccounts(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKEServiceAccountsResponse> {
  return getGKEOptions('gkeServiceAccounts', store, cloudCredentialId, projectId, location);
}
/**
 * we fetch GKE zones and etrapolate available regions from that list. Zones include a url to the region they are in.
 * @param zone
 * @returns region the zone is contained in
 */
export function getGKERegionFromZone(zone: GKEZone): string|undefined {
  const regionUrl = zone.region || '';

  return regionUrl.split('/').pop();
}

export function getGKEFamiliesFromProject(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}, imageProjects: string, showDeprecated = false): Promise<getGKEServiceAccountsResponse> {
  const extraParams = { imageProjects, showDeprecated };

  return getGKEOptions('gkeFamiliesFromProject', store, cloudCredentialId, projectId, location, '', extraParams);
}

export function getGKEImageFamilies(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}, imageFamilies: string, imageProject: string, showDeprecated = false): Promise<getGKEImageFamiliesResponse> {
  const extraParams = {
    imageFamilies, imageProject, showDeprecated
  };

  return getGKEOptions('gkeImageFamilies', store, cloudCredentialId, projectId, location, '', extraParams);
}
export function getGKEDiskTypes(store: Store<any>, cloudCredentialId: string, projectId: string, location: {zone?: string, region?: string}): Promise<getGKEServiceAccountsResponse> {
  return getGKEOptions('gkeDiskTypes', store, cloudCredentialId, projectId, location);
}

/** The Ember logic around image types is more complicated; it includes docker variants and windows SAC, with version-dependent availability
 * the gke versions supporting those options are well outside the versions that will be supported in rancher 2.9
 * No windows SAC since 2022 https://cloud.google.com/kubernetes-engine/docs/deprecations/windows-server-sac
 * No more docker (non _containerd) since gke 1.24 https://cloud.google.com/kubernetes-engine/docs/concepts/node-images
 * We will simply exclude those options from the UI and display a warning if the user is editing a cluster with one of them already configured
 */
export const GKEImageTypes = [
  'COS_CONTAINERD',
  'WINDOWS_LTSC_CONTAINERD',
  'UBUNTU_CONTAINERD',
];