@pagopa/dx-savemoney 0.6.2 → 0.6.3

package/dist/index.d.ts

@@ -19,6 +19,7 @@ import * as azureModule from "./azure/index.js";
 export declare const azure: typeof azureModule;
 export { type Finding, type FindingCategory, findingsFromAnalysisResult, type FindingSource, type Money, type ResourceReport, } from "./finding.js";
 export { AZURE_SOURCE_VALUES } from "./schema.js";
+export { buildSavemoneyInvocationTelemetryAttributes, buildSavemoneyOutcomeTelemetryAttributes, type SavemoneyAzqrReportSource, type SavemoneyCommandInput, type SavemoneySubscriptionsSource, } from "./telemetry/savemoney-command-telemetry.js";
 export * from "./types.js";
 import type { AzureConfig } from "./azure/types.js";
 /**

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,sBAAsB,GACvB,MAAM,4BAA4B,CAAC;AAGpC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAG7E,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,eAAO,MAAM,KAAK,oBAAc,CAAC;AAGjC,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,0BAA0B,EAC1B,KAAK,aAAa,EAClB,KAAK,KAAK,EACV,KAAK,cAAc,GACpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,cAAc,YAAY,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAIpD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAE1E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,sBAAsB,GACvB,MAAM,4BAA4B,CAAC;AAGpC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAG7E,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,eAAO,MAAM,KAAK,oBAAc,CAAC;AAGjC,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,eAAe,EACpB,0BAA0B,EAC1B,KAAK,aAAa,EAClB,KAAK,KAAK,EACV,KAAK,cAAc,GACpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EACL,2CAA2C,EAC3C,wCAAwC,EACxC,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,GAClC,MAAM,4CAA4C,CAAC;AAEpD,cAAc,YAAY,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAIpD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAE1E"}

package/dist/index.js

@@ -19,6 +19,7 @@ export const azure = azureModule;
 // Phase 0: unified Finding model and analyzer plugin layer
 export { findingsFromAnalysisResult, } from "./finding.js";
 export { AZURE_SOURCE_VALUES } from "./schema.js";
+export { buildSavemoneyInvocationTelemetryAttributes, buildSavemoneyOutcomeTelemetryAttributes, } from "./telemetry/savemoney-command-telemetry.js";
 export * from "./types.js";
 import { loadAzureConfig } from "./azure/config.js";
 /**

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAIL,sBAAsB,GACvB,MAAM,4BAA4B,CAAC;AAMpC,sBAAsB;AACtB,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC;AAEjC,2DAA2D;AAC3D,OAAO,EAGL,0BAA0B,GAI3B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,cAAc,YAAY,CAAC;AAI3B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,UAAmB;IAClD,OAAO,eAAe,CAAC,UAAU,CAAC,CAAC;AACrC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAIL,sBAAsB,GACvB,MAAM,4BAA4B,CAAC;AAMpC,sBAAsB;AACtB,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAChD,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC;AAEjC,2DAA2D;AAC3D,OAAO,EAGL,0BAA0B,GAI3B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EACL,2CAA2C,EAC3C,wCAAwC,GAIzC,MAAM,4CAA4C,CAAC;AAEpD,cAAc,YAAY,CAAC;AAI3B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,UAAmB;IAClD,OAAO,eAAe,CAAC,UAAU,CAAC,CAAC;AACrC,CAAC"}

package/dist/telemetry/savemoney-command-telemetry.d.ts

@@ -0,0 +1,20 @@
+/**
+ * SaveMoney command telemetry helpers.
+ *
+ * Keeps telemetry attribute derivation close to the SaveMoney domain so the
+ * same mapping can be reused by both the DX CLI adapter and a future standalone
+ * SaveMoney CLI entrypoint.
+ */
+import type { AzureConfig, AzureDetailedResourceReport } from "../azure/types.js";
+export type SavemoneyAzqrReportSource = "cli" | "config" | "none";
+export type SavemoneyCommandInput = {
+    azqrReportPathOption?: string;
+    configPathOption?: string;
+    format: string;
+    resolvedConfig: Pick<AzureConfig, "azqrReportPath" | "pricing" | "sources" | "subscriptionIds">;
+    subscriptionIdsEnv?: string;
+};
+export type SavemoneySubscriptionsSource = "config" | "env" | "prompt";
+export declare function buildSavemoneyInvocationTelemetryAttributes(input: SavemoneyCommandInput): Record<string, boolean | number | string>;
+export declare function buildSavemoneyOutcomeTelemetryAttributes(reports: readonly Pick<AzureDetailedResourceReport, "findings">[]): Record<string, number>;
+//# sourceMappingURL=savemoney-command-telemetry.d.ts.map

package/dist/telemetry/savemoney-command-telemetry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"savemoney-command-telemetry.d.ts","sourceRoot":"","sources":["../../src/telemetry/savemoney-command-telemetry.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,2BAA2B,EAC5B,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,yBAAyB,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAElE,MAAM,MAAM,qBAAqB,GAAG;IAClC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,IAAI,CAClB,WAAW,EACX,gBAAgB,GAAG,SAAS,GAAG,SAAS,GAAG,iBAAiB,CAC7D,CAAC;IACF,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEvE,wBAAgB,2CAA2C,CACzD,KAAK,EAAE,qBAAqB,GAC3B,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CAqB3C;AAED,wBAAgB,wCAAwC,CACtD,OAAO,EAAE,SAAS,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC,EAAE,GAChE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQxB"}

package/dist/telemetry/savemoney-command-telemetry.js

@@ -0,0 +1,42 @@
+/**
+ * SaveMoney command telemetry helpers.
+ *
+ * Keeps telemetry attribute derivation close to the SaveMoney domain so the
+ * same mapping can be reused by both the DX CLI adapter and a future standalone
+ * SaveMoney CLI entrypoint.
+ */
+export function buildSavemoneyInvocationTelemetryAttributes(input) {
+    const azqrReportSource = resolveAzqrReportSource(input.azqrReportPathOption, input.resolvedConfig.azqrReportPath);
+    const subscriptionsSource = resolveSubscriptionsSource(input.configPathOption, input.subscriptionIdsEnv);
+    return {
+        "savemoney.azqr_report_source": azqrReportSource,
+        "savemoney.format": input.format,
+        "savemoney.has_config": Boolean(input.configPathOption),
+        "savemoney.pricing_enabled": input.resolvedConfig.pricing?.enabled !== false,
+        "savemoney.sources": input.resolvedConfig.sources.join(","),
+        "savemoney.subscriptions_count": input.resolvedConfig.subscriptionIds.length,
+        "savemoney.subscriptions_source": subscriptionsSource,
+    };
+}
+export function buildSavemoneyOutcomeTelemetryAttributes(reports) {
+    return {
+        "savemoney.findings_count": reports.reduce((sum, report) => sum + (report.findings?.length ?? 0), 0),
+        "savemoney.resources_analyzed": reports.length,
+    };
+}
+function resolveAzqrReportSource(azqrReportPathOption, azqrReportPathResolved) {
+    if (azqrReportPathOption)
+        return "cli";
+    if (azqrReportPathResolved)
+        return "config";
+    return "none";
+}
+function resolveSubscriptionsSource(configPathOption, subscriptionIdsEnv) {
+    // Mirrors loadAzureConfig() priority: config file > ARM_SUBSCRIPTION_ID > prompt.
+    if (configPathOption)
+        return "config";
+    if (subscriptionIdsEnv)
+        return "env";
+    return "prompt";
+}
+//# sourceMappingURL=savemoney-command-telemetry.js.map

package/dist/telemetry/savemoney-command-telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"savemoney-command-telemetry.js","sourceRoot":"","sources":["../../src/telemetry/savemoney-command-telemetry.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAsBH,MAAM,UAAU,2CAA2C,CACzD,KAA4B;IAE5B,MAAM,gBAAgB,GAAG,uBAAuB,CAC9C,KAAK,CAAC,oBAAoB,EAC1B,KAAK,CAAC,cAAc,CAAC,cAAc,CACpC,CAAC;IACF,MAAM,mBAAmB,GAAG,0BAA0B,CACpD,KAAK,CAAC,gBAAgB,EACtB,KAAK,CAAC,kBAAkB,CACzB,CAAC;IAEF,OAAO;QACL,8BAA8B,EAAE,gBAAgB;QAChD,kBAAkB,EAAE,KAAK,CAAC,MAAM;QAChC,sBAAsB,EAAE,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC;QACvD,2BAA2B,EACzB,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,KAAK,KAAK;QACjD,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;QAC3D,+BAA+B,EAC7B,KAAK,CAAC,cAAc,CAAC,eAAe,CAAC,MAAM;QAC7C,gCAAgC,EAAE,mBAAmB;KACtD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wCAAwC,CACtD,OAAiE;IAEjE,OAAO;QACL,0BAA0B,EAAE,OAAO,CAAC,MAAM,CACxC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC,EACrD,CAAC,CACF;QACD,8BAA8B,EAAE,OAAO,CAAC,MAAM;KAC/C,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAC9B,oBAAwC,EACxC,sBAA0C;IAE1C,IAAI,oBAAoB;QAAE,OAAO,KAAK,CAAC;IACvC,IAAI,sBAAsB;QAAE,OAAO,QAAQ,CAAC;IAC5C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,0BAA0B,CACjC,gBAAoC,EACpC,kBAAsC;IAEtC,kFAAkF;IAClF,IAAI,gBAAgB;QAAE,OAAO,QAAQ,CAAC;IACtC,IAAI,kBAAkB;QAAE,OAAO,KAAK,CAAC;IACrC,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagopa/dx-savemoney",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "type": "module",
   "description": "Azure resource analyzer for finding unused or cost-inefficient resources.",
   "repository": {

package/src/__tests__/savemoney-command-telemetry.test.ts

@@ -0,0 +1,117 @@
+import { describe, expect, it } from "vitest";
+
+import type { Finding } from "../finding.js";
+
+import {
+  buildSavemoneyInvocationTelemetryAttributes,
+  buildSavemoneyOutcomeTelemetryAttributes,
+} from "../telemetry/savemoney-command-telemetry.js";
+
+const BASE_FINDING: Finding = {
+  category: "cost",
+  code: "vm.low-cpu",
+  reason: "Low CPU usage.",
+  resourceId:
+    "/subscriptions/sub/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/vm",
+  severity: "low",
+  source: "custom",
+};
+
+describe("buildSavemoneyInvocationTelemetryAttributes", () => {
+  it("sets azqr_report_source to cli when --azqr-report is provided", () => {
+    const attributes = buildSavemoneyInvocationTelemetryAttributes({
+      azqrReportPathOption: "./azqr.json",
+      format: "table",
+      resolvedConfig: {
+        azqrReportPath: "./from-config.json",
+        pricing: { enabled: true },
+        sources: ["advisor", "custom"],
+        subscriptionIds: ["sub-a"],
+      },
+    });
+
+    expect(attributes["savemoney.azqr_report_source"]).toBe("cli");
+  });
+
+  it("sets azqr_report_source to config when only config path is present", () => {
+    const attributes = buildSavemoneyInvocationTelemetryAttributes({
+      format: "table",
+      resolvedConfig: {
+        azqrReportPath: "./from-config.json",
+        pricing: { enabled: true },
+        sources: ["advisor", "custom"],
+        subscriptionIds: ["sub-a"],
+      },
+    });
+
+    expect(attributes["savemoney.azqr_report_source"]).toBe("config");
+  });
+
+  it("sets azqr_report_source to none when azqr is absent", () => {
+    const attributes = buildSavemoneyInvocationTelemetryAttributes({
+      format: "table",
+      resolvedConfig: {
+        pricing: { enabled: true },
+        sources: ["advisor", "custom"],
+        subscriptionIds: ["sub-a"],
+      },
+    });
+
+    expect(attributes["savemoney.azqr_report_source"]).toBe("none");
+  });
+
+  it("derives subscriptions_source as config, env, or prompt", () => {
+    const fromConfig = buildSavemoneyInvocationTelemetryAttributes({
+      configPathOption: "./config.yaml",
+      format: "table",
+      resolvedConfig: {
+        pricing: { enabled: true },
+        sources: ["advisor", "custom"],
+        subscriptionIds: ["sub-a"],
+      },
+      subscriptionIdsEnv: "sub-env",
+    });
+    const fromEnv = buildSavemoneyInvocationTelemetryAttributes({
+      format: "table",
+      resolvedConfig: {
+        pricing: { enabled: true },
+        sources: ["advisor", "custom"],
+        subscriptionIds: ["sub-a"],
+      },
+      subscriptionIdsEnv: "sub-env",
+    });
+    const fromPrompt = buildSavemoneyInvocationTelemetryAttributes({
+      format: "table",
+      resolvedConfig: {
+        pricing: { enabled: true },
+        sources: ["advisor", "custom"],
+        subscriptionIds: ["sub-a"],
+      },
+    });
+
+    expect(fromConfig["savemoney.subscriptions_source"]).toBe("config");
+    expect(fromEnv["savemoney.subscriptions_source"]).toBe("env");
+    expect(fromPrompt["savemoney.subscriptions_source"]).toBe("prompt");
+  });
+});
+
+describe("buildSavemoneyOutcomeTelemetryAttributes", () => {
+  it("counts findings and analyzed resources", () => {
+    const attributes = buildSavemoneyOutcomeTelemetryAttributes([
+      {
+        findings: [BASE_FINDING, { ...BASE_FINDING, code: "disk.unattached" }],
+      },
+      {
+        findings: [
+          { ...BASE_FINDING, code: "advisor.right-size", source: "advisor" },
+        ],
+      },
+      {},
+    ]);
+
+    expect(attributes).toEqual({
+      "savemoney.findings_count": 3,
+      "savemoney.resources_analyzed": 3,
+    });
+  });
+});

package/src/index.ts

@@ -38,6 +38,13 @@ export {
   type ResourceReport,
 } from "./finding.js";
 export { AZURE_SOURCE_VALUES } from "./schema.js";
+export {
+  buildSavemoneyInvocationTelemetryAttributes,
+  buildSavemoneyOutcomeTelemetryAttributes,
+  type SavemoneyAzqrReportSource,
+  type SavemoneyCommandInput,
+  type SavemoneySubscriptionsSource,
+} from "./telemetry/savemoney-command-telemetry.js";
 
 export * from "./types.js";
 

package/src/telemetry/savemoney-command-telemetry.ts

@@ -0,0 +1,83 @@
+/**
+ * SaveMoney command telemetry helpers.
+ *
+ * Keeps telemetry attribute derivation close to the SaveMoney domain so the
+ * same mapping can be reused by both the DX CLI adapter and a future standalone
+ * SaveMoney CLI entrypoint.
+ */
+
+import type {
+  AzureConfig,
+  AzureDetailedResourceReport,
+} from "../azure/types.js";
+
+export type SavemoneyAzqrReportSource = "cli" | "config" | "none";
+
+export type SavemoneyCommandInput = {
+  azqrReportPathOption?: string;
+  configPathOption?: string;
+  format: string;
+  resolvedConfig: Pick<
+    AzureConfig,
+    "azqrReportPath" | "pricing" | "sources" | "subscriptionIds"
+  >;
+  subscriptionIdsEnv?: string;
+};
+
+export type SavemoneySubscriptionsSource = "config" | "env" | "prompt";
+
+export function buildSavemoneyInvocationTelemetryAttributes(
+  input: SavemoneyCommandInput,
+): Record<string, boolean | number | string> {
+  const azqrReportSource = resolveAzqrReportSource(
+    input.azqrReportPathOption,
+    input.resolvedConfig.azqrReportPath,
+  );
+  const subscriptionsSource = resolveSubscriptionsSource(
+    input.configPathOption,
+    input.subscriptionIdsEnv,
+  );
+
+  return {
+    "savemoney.azqr_report_source": azqrReportSource,
+    "savemoney.format": input.format,
+    "savemoney.has_config": Boolean(input.configPathOption),
+    "savemoney.pricing_enabled":
+      input.resolvedConfig.pricing?.enabled !== false,
+    "savemoney.sources": input.resolvedConfig.sources.join(","),
+    "savemoney.subscriptions_count":
+      input.resolvedConfig.subscriptionIds.length,
+    "savemoney.subscriptions_source": subscriptionsSource,
+  };
+}
+
+export function buildSavemoneyOutcomeTelemetryAttributes(
+  reports: readonly Pick<AzureDetailedResourceReport, "findings">[],
+): Record<string, number> {
+  return {
+    "savemoney.findings_count": reports.reduce(
+      (sum, report) => sum + (report.findings?.length ?? 0),
+      0,
+    ),
+    "savemoney.resources_analyzed": reports.length,
+  };
+}
+
+function resolveAzqrReportSource(
+  azqrReportPathOption: string | undefined,
+  azqrReportPathResolved: string | undefined,
+): SavemoneyAzqrReportSource {
+  if (azqrReportPathOption) return "cli";
+  if (azqrReportPathResolved) return "config";
+  return "none";
+}
+
+function resolveSubscriptionsSource(
+  configPathOption: string | undefined,
+  subscriptionIdsEnv: string | undefined,
+): SavemoneySubscriptionsSource {
+  // Mirrors loadAzureConfig() priority: config file > ARM_SUBSCRIPTION_ID > prompt.
+  if (configPathOption) return "config";
+  if (subscriptionIdsEnv) return "env";
+  return "prompt";
+}