feat: Hook to fetch & filter Failover History of a domain (#1075)

Add hook for fetching and filtering failover history
Add helper function to check if a ClusterFailover matches a given cluster attribute
Add some types/constants for domain page failovers

Signed-off-by: Adhitya Mamallan <[email protected]>

Author: adhityamamallan

src/route-handlers/list-failover-history/list-failover-history.types.ts

@@ -1,5 +1,6 @@
 import { type z } from 'zod';
 
+import { type FailoverEvent as FailoverEventProto } from '@/__generated__/proto-ts/uber/cadence/api/v1/FailoverEvent';
 import { type ListFailoverHistoryResponse as ListFailoverHistoryResponseProto } from '@/__generated__/proto-ts/uber/cadence/api/v1/ListFailoverHistoryResponse';
 import { type DefaultMiddlewaresContext } from '@/utils/route-handlers-middleware';
 
@@ -20,4 +21,6 @@ export type ListFailoverHistoryRequestQueryParams = z.input<
 
 export type ListFailoverHistoryResponse = ListFailoverHistoryResponseProto;
 
+export type FailoverEvent = FailoverEventProto;
+
 export type Context = DefaultMiddlewaresContext;

src/views/domain-page/domain-page-failovers/domain-page-failovers.constants.ts

@@ -0,0 +1,12 @@
+import { type FailoverEvent } from '@/route-handlers/list-failover-history/list-failover-history.types';
+
+export const PRIMARY_CLUSTER_SCOPE = 'primary';
+
+export const FAILOVER_TYPE_LABEL_MAP: Record<
+  FailoverEvent['failoverType'],
+  string
+> = {
+  FAILOVER_TYPE_INVALID: 'Invalid',
+  FAILOVER_TYPE_FORCE: 'Force',
+  FAILOVER_TYPE_GRACEFUL: 'Graceful',
+};

src/views/domain-page/domain-page-failovers/domain-page-failovers.types.ts

@@ -0,0 +1,3 @@
+import { type FailoverEvent } from '@/route-handlers/list-failover-history/list-failover-history.types';
+
+export type ClusterFailover = FailoverEvent['clusterFailovers'][number];

src/views/domain-page/helpers/__tests__/cluster-failover-matches-attribute.test.ts

@@ -0,0 +1,189 @@
+import { PRIMARY_CLUSTER_SCOPE } from '../../domain-page-failovers/domain-page-failovers.constants';
+import { type ClusterFailover } from '../../domain-page-failovers/domain-page-failovers.types';
+import clusterFailoverMatchesAttribute from '../cluster-failover-matches-attribute';
+
+describe(clusterFailoverMatchesAttribute.name, () => {
+  it('should return true when clusterAttribute is null and scope is PRIMARY_CLUSTER_SCOPE', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: null,
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(clusterFailover, PRIMARY_CLUSTER_SCOPE)
+    ).toBe(true);
+  });
+
+  it('should return false when clusterAttribute is null and scope is not PRIMARY_CLUSTER_SCOPE', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: null,
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(clusterFailover, 'other-scope')
+    ).toBe(false);
+  });
+
+  it('should return false when clusterAttribute is null and scope is undefined', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: null,
+    };
+
+    expect(clusterFailoverMatchesAttribute(clusterFailover)).toBe(false);
+  });
+
+  it('should return true when clusterAttribute scope matches and no value is provided', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: {
+        scope: 'city',
+        name: 'new_york',
+      },
+    };
+
+    expect(clusterFailoverMatchesAttribute(clusterFailover, 'city')).toBe(true);
+  });
+
+  it('should return false when clusterAttribute scope does not match and no value is provided', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: {
+        scope: 'city',
+        name: 'new_york',
+      },
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(clusterFailover, 'other-scope')
+    ).toBe(false);
+  });
+
+  it('should return true when clusterAttribute scope and name both match', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: {
+        scope: 'city',
+        name: 'new_york',
+      },
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(clusterFailover, 'city', 'new_york')
+    ).toBe(true);
+  });
+
+  it('should return false when clusterAttribute scope matches but name does not match', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: {
+        scope: 'city',
+        name: 'new_york',
+      },
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(clusterFailover, 'city', 'san_francisco')
+    ).toBe(false);
+  });
+
+  it('should return false when clusterAttribute scope does not match even if name matches', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: {
+        scope: 'city',
+        name: 'new_york',
+      },
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(
+        clusterFailover,
+        'other-scope',
+        'new_york'
+      )
+    ).toBe(false);
+  });
+
+  it('should return false when clusterAttribute scope does not match and value is provided', () => {
+    const clusterFailover: ClusterFailover = {
+      fromCluster: {
+        activeClusterName: 'cluster1',
+        failoverVersion: '1',
+      },
+      toCluster: {
+        activeClusterName: 'cluster2',
+        failoverVersion: '2',
+      },
+      clusterAttribute: {
+        scope: 'city',
+        name: 'new_york',
+      },
+    };
+
+    expect(
+      clusterFailoverMatchesAttribute(
+        clusterFailover,
+        'other-scope',
+        'san_francisco'
+      )
+    ).toBe(false);
+  });
+});

src/views/domain-page/helpers/cluster-failover-matches-attribute.ts

@@ -0,0 +1,16 @@
+import { PRIMARY_CLUSTER_SCOPE } from '../domain-page-failovers/domain-page-failovers.constants';
+import { type ClusterFailover } from '../domain-page-failovers/domain-page-failovers.types';
+
+export default function clusterFailoverMatchesAttribute(
+  clusterFailover: ClusterFailover,
+  scope?: string,
+  value?: string
+) {
+  const attribute = clusterFailover.clusterAttribute;
+  if (attribute === null) return scope === PRIMARY_CLUSTER_SCOPE;
+
+  const scopeMatches = attribute.scope === scope;
+  if (!value) return scopeMatches;
+
+  return scopeMatches && attribute.name === value;
+}