@spinnaker/kayenta 2025.0.6 → 2025.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spinnaker/kayenta",
-  "version": "2025.0.6",
+  "version": "2025.1.1",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -9,8 +9,8 @@
   "module": "build/dist/index.js",
   "typings": "build/dist/index.d.ts",
   "engines": {
-    "node": ">=12.14.1",
-    "npm": ">=6.13.4",
+    "node": ">=20.19.4",
+    "npm": ">=10.8.2",
     "yarn": ">=1.21.1"
   },
   "scripts": {
@@ -158,7 +158,7 @@
     "utf-8-validate": "5.0.3"
   },
   "optionalDependencies": {
-    "fsevents": "1.2.11"
+    "fsevents": "2.3.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"

package/src/kayenta/actions/creators.ts

@@ -40,9 +40,15 @@ export const updateMetricDirection = createAction<{ id: string; direction: strin
 export const updateMetricNanStrategy = createAction<{ id: string; strategy: string }>(
   Actions.UPDATE_METRIC_NAN_STRATEGY,
 );
+export const updateMetricOutlierStrategy = createAction<{ id: string; strategy: string }>(
+  Actions.UPDATE_METRIC_OUTLIER_STRATEGY,
+);
 export const updateMetricCriticality = createAction<{ id: string; critical: boolean }>(
   Actions.UPDATE_METRIC_CRITICALITY,
 );
+export const updateMetricDataRequired = createAction<{ id: string; mustHaveData: boolean }>(
+  Actions.UPDATE_METRIC_DATA_REQUIRED,
+);
 export const updateEffectSize = createAction<{ id: string; value: ICanaryMetricEffectSizeConfig }>(
   Actions.UPDATE_EFFECT_SIZE,
 );

package/src/kayenta/actions/index.ts

@@ -19,7 +19,9 @@ export const EDIT_METRIC_CONFIRM = 'edit_metric_modal_confirm';
 export const EDIT_METRIC_CANCEL = 'edit_metric_modal_cancel';
 export const UPDATE_METRIC_DIRECTION = 'update_metric_direction';
 export const UPDATE_METRIC_NAN_STRATEGY = 'update_metric_nan_strategy';
+export const UPDATE_METRIC_OUTLIER_STRATEGY = 'update_metric_outlier_strategy';
 export const UPDATE_METRIC_CRITICALITY = 'update_metric_criticality';
+export const UPDATE_METRIC_DATA_REQUIRED = 'update_metric_data_required';
 export const UPDATE_EFFECT_SIZE = 'update_effect_size';
 export const UPDATE_METRIC_GROUP = 'update_metric_group';
 export const UPDATE_METRIC_SCOPE_NAME = 'update_metric_scope_name';

package/src/kayenta/canary.help.ts

@@ -73,6 +73,10 @@ const helpContents: { [key: string]: string } = {
     <p>When there is no value for a metric at a given point in time, it can either be ignored or assumed to be zero. The right choice depends on what is being measured. For example, when measuring successful attempts (like health checks) replacing missing values with zero may be appropriate.</p>
     <p>The default strategy for a given metric will be used if no strategy is selected.</p>
   `,
+  'canary.config.outlierStrategy': `
+    <p>When outliers are present in metric data, you can choose to either remove them or include them in the evaluation. The appropriate strategy depends on the metrics being assessed. For example, when measuring CPU or memory utilization, it might be appropriate to remove outliers that occur during startup times.</p> 
+    <p>If no strategy is chosen, the default strategy for the metric will be implemented.</p>
+  `,
   'canary.config.filterTemplate': `
     <p>Templates allow you to compose and parameterize advanced queries against your telemetry provider.</p>
     <p>Parameterized queries are hydrated by values provided in the canary stage. The <strong>project</strong>, <strong>resourceType</strong>, </string><strong>scope</strong>, and <strong>location</strong> variable bindings are implicitly available.</p>

package/src/kayenta/domain/MetricClassificationLabel.ts

@@ -3,5 +3,6 @@ export enum MetricClassificationLabel {
   High = 'High',
   Low = 'Low',
   Nodata = 'Nodata',
+  NodataFailMetric = 'NodataFailMetric',
   Error = 'Error',
 }

package/src/kayenta/edit/editMetricModal.spec.tsx

@@ -0,0 +1,129 @@
+import { mount } from 'enzyme';
+import { ICanaryMetricConfig } from 'kayenta';
+import * as Creators from 'kayenta/actions/creators';
+import React from 'react';
+import { Provider } from 'react-redux';
+import { createMockStore } from 'redux-test-utils';
+
+import EditMetricModal from './editMetricModal';
+
+describe('EditMetricModal', () => {
+  const mockProps = {
+    metric: {
+      id: '1',
+      name: 'Test Metric',
+      groups: ['Test Group'],
+      type: 'Test Type',
+      analysisConfigurations: {
+        canary: {
+          direction: 'increase',
+          nanStrategy: 'default',
+          critical: false,
+        },
+      },
+    },
+    groups: ['Group 1', 'Group 2'],
+    isTemplateValid: true,
+    useInlineTemplateEditor: false,
+    disableEdit: false,
+    validationErrors: {},
+    rename: jest.fn(),
+    changeGroup: jest.fn(),
+    updateDirection: jest.fn(),
+    updateNanStrategy: jest.fn(),
+    updateCriticality: jest.fn(),
+    updateDataRequired: jest.fn(),
+    confirm: jest.fn(),
+    cancel: jest.fn(),
+  };
+
+  const mockState = {
+    app: {
+      disableConfigEdit: false,
+    },
+    selectedConfig: {
+      editingMetric: {
+        name: 'Test Metric',
+        query: {
+          serviceType: 'prometheus',
+        },
+        groups: ['Group 1'],
+      },
+      editingTemplate: {},
+      group: {
+        list: ['Group 1', 'Group 2'],
+      },
+      metricList: [] as ICanaryMetricConfig[],
+    },
+  };
+
+  const store = createMockStore(mockState);
+  store.dispatch = jest.fn();
+
+  const buildComponent = (props: object) =>
+    mount(
+      <Provider store={store}>
+        <EditMetricModal {...mockProps} {...props} />
+      </Provider>,
+    ).find(EditMetricModal);
+
+  it('renders without crashing', () => {
+    const component = buildComponent({});
+    expect(component.exists()).toBe(true);
+  });
+
+  it('calls cancel when the cancel button is clicked', () => {
+    const component = buildComponent({});
+    const cancelBtn = component
+      .find('button')
+      .filterWhere((btn) => btn.text().trim() === 'Cancel')
+      .at(0);
+    cancelBtn.simulate('click');
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.editMetricCancel());
+  });
+
+  it('calls confirm when the confirm button is clicked', () => {
+    const component = buildComponent({});
+    const confirmBtn = component
+      .find('button')
+      .filterWhere((btn) => btn.text().trim() === 'OK')
+      .at(0);
+    confirmBtn.simulate('click');
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.editMetricConfirm());
+  });
+
+  it('calls updateDirection when a direction radio button is clicked', () => {
+    const component = buildComponent({});
+    const changeDirectionEvent = { target: { value: 'increase', dataset: { id: '1' } } };
+    component.find('input[name="direction"][value="increase"]').simulate('change', changeDirectionEvent);
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.updateMetricDirection({ id: '1', direction: 'increase' }));
+  });
+
+  it('calls updateNanStrategy when the nan strategy is changed', () => {
+    const component = buildComponent({});
+    const changeNanStrategyEvent = { target: { value: 'replace', dataset: { id: '1' } } };
+    component.find('input[name="nanStrategy"][value="replace"]').simulate('change', changeNanStrategyEvent);
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.updateMetricNanStrategy({ id: '1', strategy: 'replace' }));
+  });
+
+  it('calls updateOutlierStrategy when the outlier strategy is changed', () => {
+    const component = buildComponent({});
+    const changeOutlierStrategyEvent = { target: { value: 'remove', dataset: { id: '1' } } };
+    component.find('input[name="outlierStrategy"][value="remove"]').simulate('change', changeOutlierStrategyEvent);
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.updateMetricOutlierStrategy({ id: '1', strategy: 'remove' }));
+  });
+
+  it('calls updateCriticality when the criticality checkbox is changed', () => {
+    const component = buildComponent({});
+    const changeCriticalityEvent = { target: { checked: true, dataset: { id: '1' } } };
+    component.find('input[type="checkbox"][name="criticality"]').simulate('change', changeCriticalityEvent);
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.updateMetricCriticality({ id: '1', critical: true }));
+  });
+
+  it('calls updateDataRequired when the data required checkbox is changed', () => {
+    const component = buildComponent({ disableEdit: true });
+    const changeDataRequiredEvent = { target: { checked: true, dataset: { id: '1' } } };
+    component.find('input[type="checkbox"][name="dataRequired"]').simulate('change', changeDataRequiredEvent);
+    expect(store.dispatch).toHaveBeenCalledWith(Creators.updateMetricDataRequired({ id: '1', mustHaveData: true }));
+  });
+});

package/src/kayenta/edit/editMetricModal.tsx

@@ -30,7 +30,9 @@ interface IEditMetricModalDispatchProps {
   changeGroup: (event: any) => void;
   updateDirection: (event: any) => void;
   updateNanStrategy: (event: any) => void;
+  updateOutlierStrategy: (event: any) => void;
   updateCriticality: (event: any) => void;
+  updateDataRequired: (event: any) => void;
   confirm: () => void;
   cancel: () => void;
 }
@@ -57,7 +59,9 @@ function EditMetricModal({
   isTemplateValid,
   updateDirection,
   updateNanStrategy,
+  updateOutlierStrategy,
   updateCriticality,
+  updateDataRequired,
   useInlineTemplateEditor,
   disableEdit,
   validationErrors,
@@ -68,7 +72,9 @@ function EditMetricModal({
 
   const direction = metric.analysisConfigurations?.canary?.direction ?? 'either';
   const nanStrategy = metric.analysisConfigurations?.canary?.nanStrategy ?? 'default';
+  const outlierStrategy = metric.analysisConfigurations?.canary?.outliers?.strategy ?? 'default';
   const critical = metric.analysisConfigurations?.canary?.critical ?? false;
+  const dataRequired = metric.analysisConfigurations?.canary?.mustHaveData ?? false;
   const isConfirmDisabled =
     !isTemplateValid ||
     disableEdit ||
@@ -147,6 +153,7 @@ function EditMetricModal({
             <label>
               <DisableableInput
                 type="checkbox"
+                name="criticality"
                 checked={critical}
                 onChange={updateCriticality}
                 disabled={CanarySettings.disableConfigEdit}
@@ -155,6 +162,19 @@ function EditMetricModal({
               Fail the canary if this metric fails
             </label>
           </FormRow>
+          <FormRow label="Data Required" checkbox={true}>
+            <label>
+              <DisableableInput
+                type="checkbox"
+                name="dataRequired"
+                checked={dataRequired}
+                onChange={updateDataRequired}
+                disabled={CanarySettings.disableConfigEdit}
+                disabledStateKeys={[DISABLE_EDIT_CONFIG]}
+              />
+              Fail the metric if data is missing
+            </label>
+          </FormRow>
           <FormRow label="NaN Strategy" helpId="canary.config.nanStrategy">
             <RadioChoice
               value="default"
@@ -178,6 +198,29 @@ function EditMetricModal({
               action={updateNanStrategy}
             />
           </FormRow>
+          <FormRow label="Outlier Strategy" helpId="canary.config.outlierStrategy">
+            <RadioChoice
+              value="default"
+              label="Default (keep)"
+              name="outlierStrategy"
+              current={outlierStrategy}
+              action={updateOutlierStrategy}
+            />
+            <RadioChoice
+              value="remove"
+              label="Remove"
+              name="outlierStrategy"
+              current={outlierStrategy}
+              action={updateOutlierStrategy}
+            />
+            <RadioChoice
+              value="keep"
+              label="Keep"
+              name="outlierStrategy"
+              current={outlierStrategy}
+              action={updateOutlierStrategy}
+            />
+          </FormRow>
           <EditMetricEffectSizes />
           <MetricConfigurerDelegator />
           {templatesEnabled && !useInlineTemplateEditor && <FilterTemplateSelector />}
@@ -224,9 +267,15 @@ function mapDispatchToProps(dispatch: any): IEditMetricModalDispatchProps {
     updateNanStrategy: ({ target }: React.ChangeEvent<HTMLInputElement>) => {
       dispatch(Creators.updateMetricNanStrategy({ id: target.dataset.id, strategy: target.value }));
     },
+    updateOutlierStrategy: ({ target }: React.ChangeEvent<HTMLInputElement>) => {
+      dispatch(Creators.updateMetricOutlierStrategy({ id: target.dataset.id, strategy: target.value }));
+    },
     updateCriticality: ({ target }: React.ChangeEvent<HTMLInputElement>) => {
       dispatch(Creators.updateMetricCriticality({ id: target.dataset.id, critical: Boolean(target.checked) }));
     },
+    updateDataRequired: ({ target }: React.ChangeEvent<HTMLInputElement>) => {
+      dispatch(Creators.updateMetricDataRequired({ id: target.dataset.id, mustHaveData: Boolean(target.checked) }));
+    },
   };
 }
 

package/src/kayenta/metricStore/datadog/index.ts

@@ -5,4 +5,5 @@ metricStoreConfigStore.register({
   name: 'datadog',
   metricConfigurer: DatadogMetricConfigurer,
   queryFinder,
+  useTemplates: true,
 });

package/src/kayenta/reducers/selectedConfig.ts

@@ -148,6 +148,15 @@ const editingMetric = handleActions(
 
       return newState;
     },
+    [Actions.UPDATE_METRIC_OUTLIER_STRATEGY]: (state: ICanaryMetricConfig, { payload }: Action & any) => {
+      const newState = cloneDeep(state);
+
+      payload.strategy === 'default'
+        ? unset(newState, ['analysisConfigurations', 'canary', 'outliers', 'strategy'])
+        : set(newState, ['analysisConfigurations', 'canary', 'outliers', 'strategy'], payload.strategy);
+
+      return newState;
+    },
     [Actions.UPDATE_METRIC_CRITICALITY]: (state: ICanaryMetricConfig, { payload }: Action & any) => {
       const newState = cloneDeep(state);
 
@@ -157,6 +166,14 @@ const editingMetric = handleActions(
 
       return newState;
     },
+    [Actions.UPDATE_METRIC_DATA_REQUIRED]: (state: ICanaryMetricConfig, { payload }: Action & any) => {
+      const newState = cloneDeep(state);
+      payload.mustHaveData
+        ? set(newState, ['analysisConfigurations', 'canary', 'mustHaveData'], payload.mustHaveData)
+        : unset(newState, ['analysisConfigurations', 'canary', 'mustHaveData']);
+
+      return newState;
+    },
     [Actions.UPDATE_EFFECT_SIZE]: (state: ICanaryMetricConfig, { payload }: Action & any) => {
       const newState = cloneDeep(state);
       Object.keys(payload.value).length

package/src/kayenta/report/detail/colors.ts

@@ -18,6 +18,7 @@ export const mapMetricClassificationToColor = (classification: MetricClassificat
     [MetricClassificationLabel.Low]: RED,
     [MetricClassificationLabel.Error]: YELLOW,
     [MetricClassificationLabel.Nodata]: GREY,
+    [MetricClassificationLabel.NodataFailMetric]: RED,
     [MetricClassificationLabel.Pass]: GREEN,
   }[classification]);