@hashgraph/solo/src/integration/kube/k8-client/k8-client-base.ts

An opinionated CLI tool to deploy and manage private Hedera Networks.

// SPDX-License-Identifier: Apache-2.0

import {IllegalArgumentError} from '../../../core/errors/illegal-argument-error.js';
import {MissingArgumentError} from '../../../core/errors/missing-argument-error.js';
import {SoloError} from '../../../core/errors/solo-error.js';
import {type V1ObjectMeta} from '@kubernetes/client-node';
import {type ObjectMeta} from '../resources/object-meta.js';
import {K8ClientObjectMeta} from './resources/k8-client-object-meta.js';
import {NamespaceName} from '../../../types/namespace/namespace-name.js';

/**
 * The abstract K8 Client Filter adds the `filterItem` method to the class that extends it.
 */
export abstract class K8ClientBase {
  /**
   * Apply filters to metadata
   * @param items - list of items
   * @param [filters] - an object with metadata fields and value
   * @returns a list of items that match the filters
   * @throws MissingArgumentError - filters are required
   */
  private applyMetadataFilter(items: (object | any)[], filters: Record<string, string> = {}): any[] {
    if (!filters) {
      throw new MissingArgumentError('filters are required');
    }

    const matched: any[] = [];
    const filterMap: Map<any, any> = new Map(Object.entries(filters));
    for (const item of items) {
      // match all filters
      let foundMatch: boolean = true;
      for (const entry of filterMap.entries()) {
        const field: any = entry[0];
        const value: any = entry[1];

        if (item.metadata[field] !== value) {
          foundMatch = false;
          break;
        }
      }

      if (foundMatch) {
        matched.push(item);
      }
    }

    return matched;
  }

  /**
   * Filter a single item using metadata filter
   * @param items - list of items
   * @param [filters] - an object with metadata fields and value
   * @throws SoloError - multiple items found with filters
   * @throws MissingArgumentError - filters are required
   */
  protected filterItem(items: (object | any)[], filters: Record<string, string> = {}): any {
    const filtered: any[] = this.applyMetadataFilter(items, filters);
    if (filtered.length > 1) {
      throw new SoloError('multiple items found with filters', {filters});
    }
    return filtered[0];
  }

  /**
   * Wraps the V1ObjectMeta object instance into a ObjectMeta instance.
   *
   * @param v1meta - the V1ObjectMeta object from the K8S API client.
   */
  protected wrapObjectMeta(v1meta: V1ObjectMeta): ObjectMeta {
    if (!v1meta) {
      throw new IllegalArgumentError('metadata is required');
    }

    return new K8ClientObjectMeta(
      NamespaceName.of(v1meta!.name),
      v1meta?.name,
      v1meta?.labels,
      v1meta?.annotations,
      v1meta?.uid,
    );
  }
}