@spinnaker/kayenta 0.0.0-2025.1-0

package/src/kayenta/utils/duration.spec.ts

@@ -0,0 +1,69 @@
+import {
+  defaultDurationObject,
+  defaultDurationString,
+  getDurationString,
+  IDuration,
+  parseDurationString,
+} from './duration';
+
+interface IDurationTest {
+  str: string;
+  obj: IDuration;
+}
+
+describe('Duration utils', () => {
+  let validDurationStringsToObjects: IDurationTest[];
+  let invalidDurationStrings: any[];
+  let invalidDurationObjects: any[];
+
+  beforeEach(() => {
+    validDurationStringsToObjects = [
+      {
+        str: 'PT1H0M',
+        obj: { hours: 1, minutes: 0 },
+      },
+      {
+        str: 'PT0H10M',
+        obj: { hours: 0, minutes: 10 },
+      },
+      {
+        str: 'PT0H0M',
+        obj: { hours: 0, minutes: 0 },
+      },
+      {
+        str: 'PT20H6M',
+        obj: { hours: 20, minutes: 6 },
+      },
+    ];
+
+    invalidDurationStrings = ['invalid', { k: 'not_a_string' }, null];
+
+    invalidDurationObjects = [null, 'not_an_object', { hours: 'not_an_int', minutes: -1 }];
+  });
+
+  describe('parseDurationString', () => {
+    it('converts duration string to object', () => {
+      validDurationStringsToObjects.forEach(({ str, obj }) => {
+        expect(parseDurationString(str)).toEqual(obj);
+      });
+    });
+    it('handles invalid input', () => {
+      invalidDurationStrings.forEach((durationString) => {
+        expect(parseDurationString(durationString)).toEqual(defaultDurationObject);
+      });
+    });
+  });
+
+  describe('getDurationString', () => {
+    it('converts duration object to string', () => {
+      validDurationStringsToObjects.forEach(({ str, obj }) => {
+        expect(getDurationString(obj)).toEqual(str);
+      });
+    });
+    it('handles invalid input', () => {
+      invalidDurationObjects.forEach((durationObject) => {
+        expect(getDurationString(durationObject)).toEqual(defaultDurationString);
+      });
+    });
+  });
+});

package/src/kayenta/utils/duration.ts

@@ -0,0 +1,48 @@
+import { isEmpty, isInteger, isString } from 'lodash';
+
+export interface IDuration {
+  hours: number;
+  minutes: number;
+}
+
+export const defaultDurationObject = {
+  hours: 0,
+  minutes: 0,
+};
+
+export const defaultDurationString = 'PT0H0M';
+
+export function parseDurationString(duration: string): IDuration {
+  const defaultDurationObjectCopy = { ...defaultDurationObject };
+  if (!isString(duration)) {
+    return defaultDurationObjectCopy;
+  }
+  const durationComponents = duration.match(/PT(\d+)H(?:(\d+)M)?/i);
+  if (isEmpty(durationComponents)) {
+    return defaultDurationObjectCopy;
+  }
+  let hours = parseInt(durationComponents[1], 10);
+  if (!isInteger(hours) || hours < 0) {
+    hours = 0;
+  }
+  let minutes = parseInt(durationComponents[2], 10);
+  if (!isInteger(minutes) || minutes < 0) {
+    minutes = 0;
+  }
+  return { hours, minutes };
+}
+// Returns string parsable by Java.time.Duration.parse
+// https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java.lang.CharSequence
+export function getDurationString(duration: IDuration): string {
+  if (!duration) {
+    return defaultDurationString;
+  }
+  let { hours, minutes } = duration;
+  if (!isInteger(hours) || hours < 0) {
+    hours = 0;
+  }
+  if (!isInteger(minutes) || minutes < 0) {
+    minutes = 0;
+  }
+  return `PT${hours}H${minutes}M`;
+}

package/src/lazy.ts

@@ -0,0 +1,29 @@
+import { UIRouter } from '@uirouter/core';
+import 'kayenta/metricStore/index';
+import 'kayenta/report/detail/graph/semiotic';
+
+import { ApplicationStateProvider } from '@spinnaker/core';
+
+// This import has a side effect of instantiating the canary redux store
+import { bridgeKayentaDataSourceToReduxStore } from './kayenta/canary.dataSource.bridge';
+import { registerStates, registerTransitionHooks } from './kayenta/navigation/canary.states';
+
+export function lazyInitializeKayenta(applicationState: ApplicationStateProvider, uiRouter: UIRouter) {
+  const { stateRegistry } = uiRouter;
+
+  // deregister the stub states, starting with the deepest children first
+  stateRegistry
+    .get()
+    .filter((state) => state.name.match(/home.(project|applications).application.canary/))
+    .sort((a, b) => b.name.length - a.name.length)
+    .forEach((stub) => stateRegistry.deregister(stub));
+
+  // Now register the full states
+  registerStates(uiRouter, applicationState);
+  registerTransitionHooks(uiRouter);
+
+  // Patch the data source so data flows into the redux store
+  bridgeKayentaDataSourceToReduxStore();
+
+  return {};
+}

package/src/stub.ts

@@ -0,0 +1,60 @@
+import { UIRouter } from '@uirouter/core';
+import { module } from 'angular';
+import { registerKayentaDataSourceStubs } from 'kayenta/canary.dataSource.stub';
+import 'kayenta/canary.help';
+import { CanarySettings } from 'kayenta/canary.settings';
+import { registerKayentaStateStubs } from 'kayenta/navigation/canary.states.stub';
+
+import { ApplicationStateProvider, Registry } from '@spinnaker/core';
+
+import { CANARY_SCORE_COMPONENT } from './kayenta/components/canaryScore.component';
+import { CANARY_SCORES_CONFIG_COMPONENT } from './kayenta/components/canaryScores.component';
+import { KAYENTA_ANALYSIS_TYPE_COMPONENT } from './kayenta/stages/kayentaStage/analysisType.component';
+import { FOR_ANALYSIS_TYPE_COMPONENT } from './kayenta/stages/kayentaStage/forAnalysisType.component';
+import { kayentaCanaryStage } from './kayenta/stages/kayentaStage/kayentaStage';
+import { KayentaStageController } from './kayenta/stages/kayentaStage/kayentaStage.controller';
+import { KayentaStageTransformer } from './kayenta/stages/kayentaStage/kayentaStage.transformer';
+import { KAYENTA_STAGE_CONFIG_SECTION } from './kayenta/stages/kayentaStage/kayentaStageConfigSection.component';
+import { KAYENTA_STAGE_EXECUTION_DETAILS_CONTROLLER } from './kayenta/stages/kayentaStage/kayentaStageExecutionDetails.controller';
+
+/**
+ * This is the stub for Kayenta in deck
+ *
+ * - Registers all AngularJS components and controllers
+ * - Registers the full Kayenta Stage with Deck
+ * - Registers STUB routes for canary configs and canary reports (see: registerKayentaStateStubs)
+ *    - These stub routes are names and URLs only
+ *    - A lazyLoad router hook runs when the user navigates to a stub route and loads the remainder of Kayenta
+ * - Registers a DataSource that fetches kayenta canary/report data (and provides the nav items)
+ *
+ * See: lazy.ts for what happens next
+ */
+
+export const KAYENTA_MODULE = 'spinnaker.kayenta';
+
+if (CanarySettings.featureDisabled) {
+  module(KAYENTA_MODULE, []);
+} else {
+  module(KAYENTA_MODULE, [
+    'ui.router',
+    CANARY_SCORES_CONFIG_COMPONENT,
+    CANARY_SCORE_COMPONENT,
+    FOR_ANALYSIS_TYPE_COMPONENT,
+    KAYENTA_ANALYSIS_TYPE_COMPONENT,
+    KAYENTA_STAGE_CONFIG_SECTION,
+    KAYENTA_STAGE_EXECUTION_DETAILS_CONTROLLER,
+  ])
+    .controller('KayentaCanaryStageCtrl', KayentaStageController)
+    .run([
+      '$uiRouter',
+      'applicationState',
+      function ($uiRouter: UIRouter, applicationState: ApplicationStateProvider) {
+        registerKayentaDataSourceStubs();
+        registerKayentaStateStubs(applicationState, $uiRouter);
+        if (CanarySettings.stagesEnabled !== false) {
+          Registry.pipeline.registerStage(kayentaCanaryStage);
+          Registry.pipeline.registerTransformer(new KayentaStageTransformer());
+        }
+      },
+    ]);
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@spinnaker/pluginsdk/pluginconfig/tsconfig.json",
+  "compilerOptions": {
+    "paths": {
+      "kayenta": ["kayenta"]
+    },
+    "baseUrl": "src",
+    "outDir": "build/dist",
+    "rootDir": "src"
+  }
+}