mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Turn on strict mode in tsconfig.json, some helpful lints, and required cleanup where strictness necessitates it (#5195)
* Turn on strict mode in tsconfig.json - Add route, clusterRoute, and payloadValidatedClusterRoute helper functions to improve types with backend routes - Turn on the following new lints: - react/jsx-first-prop-new-line - react/jsx-wrap-multilines - react/jsx-one-expression-per-line - react/jsx-max-props-per-line - react/jsx-indent - react/jsx-indent-props Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix build Signed-off-by: Sebastian Malton <sebastian@malton.name> * Replace KubeObject scope strings with enum Signed-off-by: Sebastian Malton <sebastian@malton.name> * Revert package.json version changes Signed-off-by: Sebastian Malton <sebastian@malton.name> * revert move hostedCluster(Id) Signed-off-by: Sebastian Malton <sebastian@malton.name> * change some type param names to be not single letters Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove copy-extension-themes Signed-off-by: Sebastian Malton <sebastian@malton.name> * add new make clean action Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix build to not use webpack for generating types Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube-object-menu.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix select.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * revert move fileNameMigration to index Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix ref logic error Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix log-resource-selector.test.tsx tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-store.test.ts test by overriding createStorage to not touch file system Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cluster.test.ts tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube=api.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fixed hotbar-store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kubeconfig-manager.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cluster-role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix pods.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix delete-cluster-dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix daemonset.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix replicaset.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix statefulsets/dialog/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix replicasets/scale-dialog/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix deployments.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix deployments/scale/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cronjob.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix stateful-set.api.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix deployment.api.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix api-manager.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix statefulset.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix job.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix pods.store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix scroll-spy.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix hotbar-remove-command.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog-entity-registry.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix welcome.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix verify-that-all-routes-have-route-component.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix pod-tolerations.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * better fix for previous 3 fixes, plus also select.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube-object-menu.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix app-paths.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-tabs.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix isReactNode typing Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix sub-title.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix drawer.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix list-layout.tsx and header.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix error-boundary.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix upgrade-chart/store.ts and dock-tab.store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix install-chart/store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix edit-resource/store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix create-resource/store.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix namespace-select.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix namespace-select-filter.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix crd-list.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix wrong types for extensions Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix circular dependency Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix circular dependency on catalogCategoryRegistry Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix api-kube Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix type errors, most <Select /> errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * fixing more type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * some more fixing type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * convert all KubeApis to injectable with legacy global backups Signed-off-by: Sebastian Malton <sebastian@malton.name> * factor out into a common file all the exports Signed-off-by: Sebastian Malton <sebastian@malton.name> * convert all KubeObjectStores to injectable with legacy global backups Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix lint Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove unused legacy KubeApi globals Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix bad previous commit Signed-off-by: Sebastian Malton <sebastian@malton.name> * more crash fixing Signed-off-by: Sebastian Malton <sebastian@malton.name> * try and fix behavioural tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix sidebar-and-tab-navigation-for-core.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix sidebar-and-tab-navigation-for-extensions.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-using-application-menu.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make ThemeStore non-singleton and fix navigation-to-terminal-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * extensions.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix catalog-entity-registry.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-using-application-menu.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix log-resource-selector.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-tabs.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix delete-cluster-dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-kubernetes-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-editor-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-proxy-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-using-application-menu.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-application-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix dock-store.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix select.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix hotbar-remove-command.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix cluster-role-bindings/__tests__/dialog.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-extension-specific-preferences.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-telemetry-preferences.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix closing-preferences.test.tsx Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-editor-preferences.test.ts Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix navigation-to-proxy-preferences.test.ts - Fix other type errors too Signed-off-by: Sebastian Malton <sebastian@malton.name> * final tweaks Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add more tsconfig files, fix bug in <Catalog> - Make all of history, navigation injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix type errors Signed-off-by: Sebastian Malton <sebastian@malton.name> * Convert all of kube-details-params/ and navigate/ to injectable - This fixes a runtime error that was encountered during testing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix runtime errors on renderer - remove all static uses of `createPageParam` (and then removed the legacy global) - Made LensRendererExtension and LensMainExtension just used dependencies and not the getLegacyDi - Fixed circular dep in extension-loader Signed-off-by: Sebastian Malton <sebastian@malton.name> * Move registerStore calls to after injectMany Signed-off-by: Sebastian Malton <sebastian@malton.name> * replace all the rest of the legacy uses of apiManager Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix stack overflow and cycles in DI Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix NamespaceSelectFilter not opening Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix WizardStep and AddNamespaceDialog Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix KubeApi's not being registered Signed-off-by: Sebastian Malton <sebastian@malton.name> * cleanup WindowManager Signed-off-by: Sebastian Malton <sebastian@malton.name> * Proper fix for Wizard, fix NamespaceStore.subscribe Signed-off-by: Sebastian Malton <sebastian@malton.name> * Rewrite withTooltip to be more type correct - Fixes mobx related "too many recursive actions" error - Change all the uses of withTooltips to be functional components Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add e2e test to cover kube api registration Signed-off-by: Sebastian Malton <sebastian@malton.name> * cleanup internal-commands Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove cast in <Animate> Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix command-palette e2e test Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix type error after rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix test name Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix lint Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix code to help CodeQL scanner Signed-off-by: Sebastian Malton <sebastian@malton.name> * update intree extension lock files Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix build-extensions picking wrong @types/react Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix tests from rebase Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix type error Signed-off-by: Sebastian Malton <sebastian@malton.name> * Make KubeconfigSyncManager more injectable Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix crash in test mode for Dialog Signed-off-by: Sebastian Malton <sebastian@malton.name> * make Select snapshots deterministic Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix new type error Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix kube-object.store.test.ts typing Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix merge build issues Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix snapshots after merge Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix lint after merge Signed-off-by: Sebastian Malton <sebastian@malton.name> * reexport BaseKubeJsonApiObjectMetadata Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix typo in terminalSpawningPool Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove duplicate license header Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix typo to waitUntilDefined Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove iter use from getLegacyGlobalDiForExtensionApi Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove complex createStorage override Signed-off-by: Sebastian Malton <sebastian@malton.name> * override logger with mocks only when needed for tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove specialized overrideStore flags for getDiForUnitTesting Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove unnecessary | undefined types from the exactOptionalFieldTypes experiment Signed-off-by: Sebastian Malton <sebastian@malton.name> * use more descriptive name for local test mocks Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove unnecessary addition to 'make clean' target Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove oddity of KubeObjectStore.getById(undefined) being allowed Signed-off-by: Sebastian Malton <sebastian@malton.name> * rename KubeObject.getDescriptor in favour of name without fundemental JS meaning Signed-off-by: Sebastian Malton <sebastian@malton.name> * Simplify legacyRegisterApi when working in behaviour unit tests - Don't emit within main environment as there should be no auto registering there Signed-off-by: Sebastian Malton <sebastian@malton.name> * change confusing variable name in ReactiveDuration Signed-off-by: Sebastian Malton <sebastian@malton.name> * make visitor pattern more explicit for Entity contextMenuOpen Signed-off-by: Sebastian Malton <sebastian@malton.name> * toggleDetails -> toggleKubeDetailsPane is more specific Signed-off-by: Sebastian Malton <sebastian@malton.name> * remove outdated comment Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix bug where LensExtension dependencies are not set Signed-off-by: Sebastian Malton <sebastian@malton.name> * Fix tests from the revert of react 18 Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix more tests from merge Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix typings with new is-compatible-extension tests Signed-off-by: Sebastian Malton <sebastian@malton.name> * more type fixing Signed-off-by: Sebastian Malton <sebastian@malton.name> * Revert in-tree extension versions Signed-off-by: Sebastian Malton <sebastian@malton.name> * Improve name of guarding injectable for stores and apis - New name better implies that it is just a guard state and does not do anything Signed-off-by: Sebastian Malton <sebastian@malton.name> * Add helper for <Select>.isMulti for storing in a Set<Value> Signed-off-by: Sebastian Malton <sebastian@malton.name> * fix is-compatible-extension.test.ts types Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
1 parent
381d77c633
commit
dfcb7c3330
1062 files changed
+26512
-28689
No files matched your search
@@ -6,53 +6,209 @@
|
||||
// Base class for all kubernetes objects
|
||||
|
||||
import moment from "moment";
|
||||
import type { KubeJsonApiData, KubeJsonApiDataList, KubeJsonApiListMetadata, KubeJsonApiMetadata } from "./kube-json-api";
|
||||
import { autoBind, formatDuration } from "../utils";
|
||||
import type { KubeJsonApiData, KubeJsonApiDataList, KubeJsonApiListMetadata } from "./kube-json-api";
|
||||
import { autoBind, formatDuration, hasOptionalTypedProperty, hasTypedProperty, isObject, isString, isNumber, bindPredicate, isTypedArray, isRecord, json } from "../utils";
|
||||
import type { ItemObject } from "../item.store";
|
||||
import { apiKube } from "./index";
|
||||
import type { JsonApiParams } from "./json-api";
|
||||
import * as resourceApplierApi from "./endpoints/resource-applier.api";
|
||||
import { hasOptionalProperty, hasTypedProperty, isObject, isString, bindPredicate, isTypedArray, isRecord } from "../../common/utils/type-narrowing";
|
||||
import type { Patch } from "rfc6902";
|
||||
import assert from "assert";
|
||||
import type { JsonObject } from "type-fest";
|
||||
|
||||
export type KubeObjectConstructor<K extends KubeObject> = (new (data: KubeJsonApiData | any) => K) & {
|
||||
kind?: string;
|
||||
namespaced?: boolean;
|
||||
apiBase?: string;
|
||||
export type KubeJsonApiDataFor<K> = K extends KubeObject<infer Status, infer Spec, infer Scope>
|
||||
? KubeJsonApiData<KubeObjectMetadata<Scope>, Status, Spec>
|
||||
: never;
|
||||
|
||||
export interface KubeObjectConstructorData {
|
||||
readonly kind?: string;
|
||||
readonly namespaced?: boolean;
|
||||
readonly apiBase?: string;
|
||||
}
|
||||
|
||||
export type KubeObjectConstructor<K extends KubeObject<any, any, KubeObjectScope>, Data> = (new (data: Data) => K) & KubeObjectConstructorData;
|
||||
|
||||
export interface OwnerReference {
|
||||
apiVersion: string;
|
||||
kind: string;
|
||||
name: string;
|
||||
uid: string;
|
||||
controller?: boolean;
|
||||
blockOwnerDeletion?: boolean;
|
||||
}
|
||||
|
||||
export type KubeTemplateObjectMetadata<Namespaced extends KubeObjectScope> = Pick<KubeJsonApiObjectMetadata<KubeObjectScope>, "annotations" | "finalizers" | "generateName" | "labels" | "ownerReferences"> & {
|
||||
name?: string;
|
||||
namespace?: ScopedNamespace<Namespaced>;
|
||||
};
|
||||
|
||||
/**
|
||||
* A reference to an object in the same namespace
|
||||
*/
|
||||
export interface LocalObjectReference {
|
||||
name: string;
|
||||
export interface BaseKubeJsonApiObjectMetadata<Namespaced extends KubeObjectScope> {
|
||||
/**
|
||||
* Annotations is an unstructured key value map stored with a resource that may be set by
|
||||
* external tools to store and retrieve arbitrary metadata. They are not queryable and should be
|
||||
* preserved when modifying objects.
|
||||
*
|
||||
* More info: http://kubernetes.io/docs/user-guide/annotations
|
||||
*/
|
||||
annotations?: Partial<Record<string, string>>;
|
||||
|
||||
/**
|
||||
* The name of the cluster which the object belongs to. This is used to distinguish resources
|
||||
* with same name and namespace in different clusters. This field is not set anywhere right now
|
||||
* and apiserver is going to ignore it if set in create or update request.
|
||||
*/
|
||||
clusterName?: string;
|
||||
|
||||
/**
|
||||
* CreationTimestamp is a timestamp representing the server time when this object was created. It
|
||||
* is not guaranteed to be set in happens-before order across separate operations. Clients may
|
||||
* not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system.
|
||||
*
|
||||
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
*/
|
||||
readonly creationTimestamp?: string;
|
||||
|
||||
/**
|
||||
* Number of seconds allowed for this object to gracefully terminate before it will be removed
|
||||
* from the system. Only set when deletionTimestamp is also set. May only be shortened.
|
||||
*/
|
||||
readonly deletionGracePeriodSeconds?: number;
|
||||
|
||||
/**
|
||||
* DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field
|
||||
* is set by the server when a graceful deletion is requested by the user, and is not directly
|
||||
* settable by a client. The resource is expected to be deleted (no longer visible from resource
|
||||
* lists, and not reachable by name) after the time in this field, once the finalizers list is
|
||||
* empty. As long as the finalizers list contains items, deletion is blocked. Once the
|
||||
* `deletionTimestamp` is set, this value may not be unset or be set further into the future,
|
||||
* although it may be shortened or the resource may be deleted prior to this time. For example,
|
||||
* a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a
|
||||
* graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
* will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the
|
||||
* pod from the API. In the presence of network partitions, this object may still exist after
|
||||
* this timestamp, until an administrator or automated process can determine the resource is
|
||||
* fully terminated. If not set, graceful deletion of the object has not been requested.
|
||||
* Populated by the system when a graceful deletion is requested.
|
||||
*
|
||||
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
*/
|
||||
readonly deletionTimestamp?: string;
|
||||
|
||||
/**
|
||||
* Must be empty before the object is deleted from the registry. Each entry is an identifier for
|
||||
* the responsible component that will remove the entry from the list. If the deletionTimestamp
|
||||
* of the object is non-nil, entries in this list can only be removed. Finalizers may be
|
||||
* processed and removed in any order. Order is NOT enforced because it introduces significant
|
||||
* risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder
|
||||
* it. If the finalizer list is processed in order, then this can lead to a situation in which
|
||||
* the component responsible for the first finalizer in the list is waiting for a signal (field
|
||||
* value, external system, or other) produced by a component responsible for a finalizer later in
|
||||
* the list, resulting in a deadlock. Without enforced ordering finalizers are free to order
|
||||
* amongst themselves and are not vulnerable to ordering changes in the list.
|
||||
*/
|
||||
finalizers?: string[];
|
||||
|
||||
/**
|
||||
* GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the
|
||||
* Name field has not been provided. If this field is used, the name returned to the client will
|
||||
* be different than the name passed. This value will also be combined with a unique suffix. The
|
||||
* provided value has the same validation rules as the Name field, and may be truncated by the
|
||||
* length of the suffix required to make the value unique on the server. If this field is
|
||||
* specified and the generated name exists, the server will NOT return a 409 - instead, it will
|
||||
* either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not
|
||||
* be found in the time allotted, and the client should retry (optionally after the time indicated
|
||||
* in the Retry-After header). Applied only if Name is not specified.
|
||||
*
|
||||
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
|
||||
*/
|
||||
generateName?: string;
|
||||
|
||||
/**
|
||||
* A sequence number representing a specific generation of the desired state. Populated by the
|
||||
* system.
|
||||
*/
|
||||
readonly generation?: number;
|
||||
|
||||
/**
|
||||
* Map of string keys and values that can be used to organize and categorize (scope and select)
|
||||
* objects. May match selectors of replication controllers and services.
|
||||
*
|
||||
* More info: http://kubernetes.io/docs/user-guide/labels
|
||||
*/
|
||||
labels?: Partial<Record<string, string>>;
|
||||
|
||||
/**
|
||||
* ManagedFields maps workflow-id and version to the set of fields that are managed by that
|
||||
* workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set
|
||||
* or understand this field. A workflow can be the user's name, a controller's name, or the name
|
||||
* of a specific apply path like "ci-cd". The set of fields is always in the version that the
|
||||
* workflow used when modifying the object.
|
||||
*/
|
||||
managedFields?: unknown[];
|
||||
|
||||
/**
|
||||
* Name must be unique within a namespace. Is required when creating resources, although some
|
||||
* resources may allow a client to request the generation of an appropriate name automatically.
|
||||
* Name is primarily intended for creation idempotence and configuration definition.
|
||||
*
|
||||
* More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
*/
|
||||
readonly name: string;
|
||||
|
||||
/**
|
||||
* Namespace defines the space within which each name must be unique. An empty namespace is
|
||||
* equivalent to the "default" namespace, but "default" is the canonical representation. Not all
|
||||
* objects are required to be scoped to a namespace - the value of this field for those objects
|
||||
* will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
|
||||
*/
|
||||
readonly namespace?: ScopedNamespace<Namespaced>;
|
||||
|
||||
/**
|
||||
* List of objects depended by this object. If ALL objects in the list have been deleted, this
|
||||
* object will be garbage collected. If this object is managed by a controller, then an entry in
|
||||
* this list will point to this controller, with the controller field set to true. There cannot
|
||||
* be more than one managing controller.
|
||||
*/
|
||||
ownerReferences?: OwnerReference[];
|
||||
|
||||
/**
|
||||
* An opaque value that represents the internal version of this object that can be used by
|
||||
* clients to determine when objects have changed. May be used for optimistic concurrency, change
|
||||
* detection, and the watch operation on a resource or set of resources. Clients must treat these
|
||||
* values as opaque and passed unmodified back to the server. They may only be valid for a
|
||||
* particular resource or set of resources. Populated by the system. Value must be treated as
|
||||
* opaque by clients.
|
||||
*
|
||||
* More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
|
||||
*/
|
||||
readonly resourceVersion?: string;
|
||||
|
||||
/**
|
||||
* SelfLink is a URL representing this object. Populated by the system.
|
||||
*/
|
||||
readonly selfLink?: string;
|
||||
|
||||
/**
|
||||
* UID is the unique in time and space value for this object. It is typically generated by the
|
||||
* server on successful creation of a resource and is not allowed to change on PUT operations.
|
||||
* Populated by the system.
|
||||
*
|
||||
* More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
*/
|
||||
readonly uid?: string;
|
||||
|
||||
[key: string]: unknown;
|
||||
}
|
||||
|
||||
export interface KubeObjectMetadata {
|
||||
uid: string;
|
||||
name: string;
|
||||
namespace?: string;
|
||||
creationTimestamp: string;
|
||||
resourceVersion: string;
|
||||
selfLink: string;
|
||||
deletionTimestamp?: string;
|
||||
finalizers?: string[];
|
||||
continue?: string; // provided when used "?limit=" query param to fetch objects list
|
||||
labels?: {
|
||||
[label: string]: string;
|
||||
};
|
||||
annotations?: {
|
||||
[annotation: string]: string;
|
||||
};
|
||||
ownerReferences?: {
|
||||
apiVersion: string;
|
||||
kind: string;
|
||||
name: string;
|
||||
uid: string;
|
||||
controller: boolean;
|
||||
blockOwnerDeletion: boolean;
|
||||
}[];
|
||||
}
|
||||
export type KubeJsonApiObjectMetadata<Namespaced extends KubeObjectScope = KubeObjectScope> = Namespaced extends KubeObjectScope.Namespace
|
||||
? BaseKubeJsonApiObjectMetadata<KubeObjectScope.Namespace> & { readonly namespace: string }
|
||||
: BaseKubeJsonApiObjectMetadata<Namespaced>;
|
||||
|
||||
export type KubeObjectMetadata<Namespaced extends KubeObjectScope = KubeObjectScope> = KubeJsonApiObjectMetadata<Namespaced> & {
|
||||
readonly selfLink: string;
|
||||
readonly uid: string;
|
||||
readonly name: string;
|
||||
readonly resourceVersion: string;
|
||||
};
|
||||
|
||||
export interface KubeStatusData {
|
||||
kind: string;
|
||||
@@ -62,6 +218,16 @@ export interface KubeStatusData {
|
||||
reason?: string;
|
||||
}
|
||||
|
||||
export function isKubeStatusData(object: unknown): object is KubeStatusData {
|
||||
return isObject(object)
|
||||
&& hasTypedProperty(object, "kind", isString)
|
||||
&& hasTypedProperty(object, "apiVersion", isString)
|
||||
&& hasTypedProperty(object, "code", isNumber)
|
||||
&& hasOptionalTypedProperty(object, "message", isString)
|
||||
&& hasOptionalTypedProperty(object, "reason", isString)
|
||||
&& object.kind === "Status";
|
||||
}
|
||||
|
||||
export class KubeStatus {
|
||||
public readonly kind = "Status";
|
||||
public readonly apiVersion: string;
|
||||
@@ -77,17 +243,36 @@ export class KubeStatus {
|
||||
}
|
||||
}
|
||||
|
||||
export interface KubeObjectStatus {
|
||||
conditions?: {
|
||||
lastTransitionTime: string;
|
||||
message: string;
|
||||
reason: string;
|
||||
status: string;
|
||||
type?: string;
|
||||
}[];
|
||||
export interface BaseKubeObjectCondition {
|
||||
/**
|
||||
* Last time the condition transit from one status to another.
|
||||
*
|
||||
* @type Date
|
||||
*/
|
||||
lastTransitionTime?: string;
|
||||
/**
|
||||
* A human readable message indicating details about last transition.
|
||||
*/
|
||||
message?: string;
|
||||
/**
|
||||
* brief (usually one word) readon for the condition's last transition.
|
||||
*/
|
||||
reason?: string;
|
||||
/**
|
||||
* Status of the condition
|
||||
*/
|
||||
status: "True" | "False" | "Unknown";
|
||||
/**
|
||||
* Type of the condition
|
||||
*/
|
||||
type: string;
|
||||
}
|
||||
|
||||
export type KubeMetaField = keyof KubeObjectMetadata;
|
||||
export interface KubeObjectStatus {
|
||||
conditions?: BaseKubeObjectCondition[];
|
||||
}
|
||||
|
||||
export type KubeMetaField = keyof KubeJsonApiObjectMetadata;
|
||||
|
||||
export class KubeCreationError extends Error {
|
||||
constructor(message: string, public data: any) {
|
||||
@@ -118,35 +303,98 @@ export type LabelMatchExpression = {
|
||||
}
|
||||
);
|
||||
|
||||
export interface Toleration {
|
||||
key?: string;
|
||||
operator?: string;
|
||||
effect?: string;
|
||||
value?: string;
|
||||
tolerationSeconds?: number;
|
||||
}
|
||||
|
||||
export interface ObjectReference {
|
||||
apiVersion?: string;
|
||||
fieldPath?: string;
|
||||
kind?: string;
|
||||
name: string;
|
||||
namespace?: string;
|
||||
resourceVersion?: string;
|
||||
uid?: string;
|
||||
}
|
||||
|
||||
export interface LocalObjectReference {
|
||||
name: string;
|
||||
}
|
||||
|
||||
export interface TypedLocalObjectReference {
|
||||
apiGroup?: string;
|
||||
kind: string;
|
||||
name: string;
|
||||
}
|
||||
|
||||
export interface NodeAffinity {
|
||||
nodeSelectorTerms?: LabelSelector[];
|
||||
weight: number;
|
||||
preference: LabelSelector;
|
||||
}
|
||||
|
||||
export interface PodAffinity {
|
||||
labelSelector: LabelSelector;
|
||||
topologyKey: string;
|
||||
}
|
||||
|
||||
export interface SpecificAffinity<T> {
|
||||
requiredDuringSchedulingIgnoredDuringExecution?: T[];
|
||||
preferredDuringSchedulingIgnoredDuringExecution?: T[];
|
||||
}
|
||||
|
||||
export interface Affinity {
|
||||
nodeAffinity?: SpecificAffinity<NodeAffinity>;
|
||||
podAffinity?: SpecificAffinity<PodAffinity>;
|
||||
podAntiAffinity?: SpecificAffinity<PodAffinity>;
|
||||
}
|
||||
|
||||
export interface LabelSelector {
|
||||
matchLabels?: Record<string, string | undefined>;
|
||||
matchLabels?: Partial<Record<string, string>>;
|
||||
matchExpressions?: LabelMatchExpression[];
|
||||
}
|
||||
|
||||
export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata, Status = any, Spec = any> implements ItemObject {
|
||||
export enum KubeObjectScope {
|
||||
Namespace,
|
||||
Cluster,
|
||||
}
|
||||
export type ScopedNamespace<Namespaced extends KubeObjectScope> = (
|
||||
Namespaced extends KubeObjectScope.Namespace
|
||||
? string
|
||||
: Namespaced extends KubeObjectScope.Cluster
|
||||
? undefined
|
||||
: string | undefined
|
||||
);
|
||||
|
||||
export class KubeObject<
|
||||
Status = unknown,
|
||||
Spec = unknown,
|
||||
Namespaced extends KubeObjectScope = KubeObjectScope,
|
||||
> implements ItemObject {
|
||||
static readonly kind?: string;
|
||||
static readonly namespaced?: boolean;
|
||||
static readonly apiBase?: string;
|
||||
|
||||
apiVersion: string;
|
||||
kind: string;
|
||||
metadata: Metadata;
|
||||
apiVersion!: string;
|
||||
kind!: string;
|
||||
metadata!: KubeObjectMetadata<Namespaced>;
|
||||
status?: Status;
|
||||
spec?: Spec;
|
||||
managedFields?: any;
|
||||
spec!: Spec;
|
||||
|
||||
static create(data: KubeJsonApiData) {
|
||||
static create<
|
||||
Metadata extends KubeObjectMetadata = KubeObjectMetadata,
|
||||
Status = unknown,
|
||||
Spec = unknown,
|
||||
>(data: KubeJsonApiData<Metadata, Status, Spec>) {
|
||||
return new KubeObject(data);
|
||||
}
|
||||
|
||||
static isNonSystem(item: KubeJsonApiData | KubeObject) {
|
||||
return !item.metadata.name.startsWith("system:");
|
||||
static isNonSystem(item: KubeJsonApiData | KubeObject<unknown, unknown, KubeObjectScope>) {
|
||||
return !item.metadata.name?.startsWith("system:");
|
||||
}
|
||||
|
||||
static isJsonApiData(object: unknown): object is KubeJsonApiData {
|
||||
@@ -161,49 +409,49 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
static isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata {
|
||||
return (
|
||||
isObject(object)
|
||||
&& hasOptionalProperty(object, "resourceVersion", isString)
|
||||
&& hasOptionalProperty(object, "selfLink", isString)
|
||||
&& hasOptionalTypedProperty(object, "resourceVersion", isString)
|
||||
&& hasOptionalTypedProperty(object, "selfLink", isString)
|
||||
);
|
||||
}
|
||||
|
||||
static isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata {
|
||||
static isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiObjectMetadata {
|
||||
return (
|
||||
isObject(object)
|
||||
&& hasTypedProperty(object, "uid", isString)
|
||||
&& hasTypedProperty(object, "name", isString)
|
||||
&& hasTypedProperty(object, "resourceVersion", isString)
|
||||
&& hasOptionalProperty(object, "selfLink", isString)
|
||||
&& hasOptionalProperty(object, "namespace", isString)
|
||||
&& hasOptionalProperty(object, "creationTimestamp", isString)
|
||||
&& hasOptionalProperty(object, "continue", isString)
|
||||
&& hasOptionalProperty(object, "finalizers", bindPredicate(isTypedArray, isString))
|
||||
&& hasOptionalProperty(object, "labels", bindPredicate(isRecord, isString, isString))
|
||||
&& hasOptionalProperty(object, "annotations", bindPredicate(isRecord, isString, isString))
|
||||
&& hasOptionalTypedProperty(object, "selfLink", isString)
|
||||
&& hasOptionalTypedProperty(object, "namespace", isString)
|
||||
&& hasOptionalTypedProperty(object, "creationTimestamp", isString)
|
||||
&& hasOptionalTypedProperty(object, "continue", isString)
|
||||
&& hasOptionalTypedProperty(object, "finalizers", bindPredicate(isTypedArray, isString))
|
||||
&& hasOptionalTypedProperty(object, "labels", bindPredicate(isRecord, isString, isString))
|
||||
&& hasOptionalTypedProperty(object, "annotations", bindPredicate(isRecord, isString, isString))
|
||||
);
|
||||
}
|
||||
|
||||
static isPartialJsonApiMetadata(object: unknown): object is Partial<KubeJsonApiMetadata> {
|
||||
static isPartialJsonApiMetadata(object: unknown): object is Partial<KubeJsonApiObjectMetadata> {
|
||||
return (
|
||||
isObject(object)
|
||||
&& hasOptionalProperty(object, "uid", isString)
|
||||
&& hasOptionalProperty(object, "name", isString)
|
||||
&& hasOptionalProperty(object, "resourceVersion", isString)
|
||||
&& hasOptionalProperty(object, "selfLink", isString)
|
||||
&& hasOptionalProperty(object, "namespace", isString)
|
||||
&& hasOptionalProperty(object, "creationTimestamp", isString)
|
||||
&& hasOptionalProperty(object, "continue", isString)
|
||||
&& hasOptionalProperty(object, "finalizers", bindPredicate(isTypedArray, isString))
|
||||
&& hasOptionalProperty(object, "labels", bindPredicate(isRecord, isString, isString))
|
||||
&& hasOptionalProperty(object, "annotations", bindPredicate(isRecord, isString, isString))
|
||||
&& hasOptionalTypedProperty(object, "uid", isString)
|
||||
&& hasOptionalTypedProperty(object, "name", isString)
|
||||
&& hasOptionalTypedProperty(object, "resourceVersion", isString)
|
||||
&& hasOptionalTypedProperty(object, "selfLink", isString)
|
||||
&& hasOptionalTypedProperty(object, "namespace", isString)
|
||||
&& hasOptionalTypedProperty(object, "creationTimestamp", isString)
|
||||
&& hasOptionalTypedProperty(object, "continue", isString)
|
||||
&& hasOptionalTypedProperty(object, "finalizers", bindPredicate(isTypedArray, isString))
|
||||
&& hasOptionalTypedProperty(object, "labels", bindPredicate(isRecord, isString, isString))
|
||||
&& hasOptionalTypedProperty(object, "annotations", bindPredicate(isRecord, isString, isString))
|
||||
);
|
||||
}
|
||||
|
||||
static isPartialJsonApiData(object: unknown): object is Partial<KubeJsonApiData> {
|
||||
return (
|
||||
isObject(object)
|
||||
&& hasOptionalProperty(object, "kind", isString)
|
||||
&& hasOptionalProperty(object, "apiVersion", isString)
|
||||
&& hasOptionalProperty(object, "metadata", KubeObject.isPartialJsonApiMetadata)
|
||||
&& hasOptionalTypedProperty(object, "kind", isString)
|
||||
&& hasOptionalTypedProperty(object, "apiVersion", isString)
|
||||
&& hasOptionalTypedProperty(object, "metadata", KubeObject.isPartialJsonApiMetadata)
|
||||
);
|
||||
}
|
||||
|
||||
@@ -217,7 +465,7 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
);
|
||||
}
|
||||
|
||||
static stringifyLabels(labels?: { [name: string]: string }): string[] {
|
||||
static stringifyLabels(labels?: Partial<Record<string, string>>): string[] {
|
||||
if (!labels) return [];
|
||||
|
||||
return Object.entries(labels).map(([name, value]) => `${name}=${value}`);
|
||||
@@ -240,7 +488,7 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
...KubeObject.nonEditablePathPrefixes,
|
||||
]);
|
||||
|
||||
constructor(data: KubeJsonApiData) {
|
||||
constructor(data: KubeJsonApiData<KubeObjectMetadata<Namespaced>, Status, Spec>) {
|
||||
if (typeof data !== "object") {
|
||||
throw new TypeError(`Cannot create a KubeObject from ${typeof data}`);
|
||||
}
|
||||
@@ -265,13 +513,20 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
return this.metadata.resourceVersion;
|
||||
}
|
||||
|
||||
getScopedName() {
|
||||
const ns = this.getNs();
|
||||
const res = ns ? `${ns}/` : "";
|
||||
|
||||
return res + this.getName();
|
||||
}
|
||||
|
||||
getName() {
|
||||
return this.metadata.name;
|
||||
}
|
||||
|
||||
getNs() {
|
||||
getNs(): ScopedNamespace<Namespaced> {
|
||||
// avoid "null" serialization via JSON.stringify when post data
|
||||
return this.metadata.namespace || undefined;
|
||||
return (this.metadata.namespace || undefined) as never;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -279,6 +534,10 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
* creation timestamp of this object.
|
||||
*/
|
||||
getCreationTimestamp() {
|
||||
if (!this.metadata.creationTimestamp) {
|
||||
return Date.now();
|
||||
}
|
||||
|
||||
return new Date(this.metadata.creationTimestamp).getTime();
|
||||
}
|
||||
|
||||
@@ -288,6 +547,10 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
* NOTE: Generally you can use `getCreationTimestamp` instead.
|
||||
*/
|
||||
getTimeDiffFromNow(): number {
|
||||
if (!this.metadata.creationTimestamp) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
return Date.now() - new Date(this.metadata.creationTimestamp).getTime();
|
||||
}
|
||||
|
||||
@@ -346,8 +609,8 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
];
|
||||
}
|
||||
|
||||
toPlainObject(): object {
|
||||
return JSON.parse(JSON.stringify(this));
|
||||
toPlainObject() {
|
||||
return json.parse(JSON.stringify(this)) as JsonObject;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -389,7 +652,9 @@ export class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata
|
||||
/**
|
||||
* @deprecated use KubeApi.delete instead
|
||||
*/
|
||||
delete(params?: JsonApiParams) {
|
||||
delete(params?: object) {
|
||||
assert(this.selfLink, "selfLink must be present to delete self");
|
||||
|
||||
return apiKube.del(this.selfLink, params);
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user