From a42c4676969811350eed5fb0964b7543ca49d6e6 Mon Sep 17 00:00:00 2001
From: Samuel Padgett <spadgett@redhat.com>
Date: Tue, 3 Dec 2024 12:12:08 -0500
Subject: [PATCH] OCPBUGS-45915: prefer OpenShift release version in telemetry
 events

Previously, we were reporting the internal console version, which is
opaque and difficult to correlate to a specific OpenShift version.
---
 .../src/hooks/__tests__/useTelemetry.spec.ts  | 23 ++++++++++++++-----
 .../console-shared/src/hooks/useTelemetry.ts  |  4 +++-
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/frontend/packages/console-shared/src/hooks/__tests__/useTelemetry.spec.ts b/frontend/packages/console-shared/src/hooks/__tests__/useTelemetry.spec.ts
index 434d554eedff..2a53c6f226fd 100644
--- a/frontend/packages/console-shared/src/hooks/__tests__/useTelemetry.spec.ts
+++ b/frontend/packages/console-shared/src/hooks/__tests__/useTelemetry.spec.ts
@@ -39,17 +39,28 @@ afterAll(() => {
 });
 
 describe('getClusterProperties', () => {
-  it('returns undefined when consoleVersion is not configured', () => {
+  it('prefers releaseVersion to consoleVersion', () => {
+    window.SERVER_FLAGS = {
+      ...originServerFlags,
+      releaseVersion: '4.17.4',
+      consoleVersion: 'v6.0.6-23079-g6689498225',
+    };
+    expect(getClusterProperties().consoleVersion).toBe('4.17.4');
+  });
+
+  it('falls back to consoleVersion if releaseVersion is not set', () => {
+    window.SERVER_FLAGS = { ...originServerFlags, consoleVersion: 'v6.0.6-23079-g6689498225' };
+    delete window.SERVER_FLAGS.releaseVersion;
+    expect(getClusterProperties().consoleVersion).toBe('v6.0.6-23079-g6689498225');
+  });
+
+  it('returns undefined when releaseVersion and consoleVersion are not set', () => {
     window.SERVER_FLAGS = { ...originServerFlags };
     delete window.SERVER_FLAGS.consoleVersion;
+    delete window.SERVER_FLAGS.releaseVersion;
     expect(getClusterProperties().consoleVersion).toBe(undefined);
   });
 
-  it('returns the right version when it is configured', () => {
-    window.SERVER_FLAGS = { ...originServerFlags, consoleVersion: 'x.y.z' };
-    expect(getClusterProperties().consoleVersion).toBe('x.y.z');
-  });
-
   it('returns undefined when telemetry is missing at all', () => {
     window.SERVER_FLAGS = { ...originServerFlags };
     delete window.SERVER_FLAGS.telemetry;
diff --git a/frontend/packages/console-shared/src/hooks/useTelemetry.ts b/frontend/packages/console-shared/src/hooks/useTelemetry.ts
index cdac520fce73..a2dbf3c31a0a 100644
--- a/frontend/packages/console-shared/src/hooks/useTelemetry.ts
+++ b/frontend/packages/console-shared/src/hooks/useTelemetry.ts
@@ -31,7 +31,9 @@ export const getClusterProperties = () => {
   ) {
     clusterProperties.clusterType = 'DEVSANDBOX';
   }
-  clusterProperties.consoleVersion = window.SERVER_FLAGS?.consoleVersion;
+  // Prefer to report the OCP version (releaseVersion) if available.
+  clusterProperties.consoleVersion =
+    window.SERVER_FLAGS?.releaseVersion || window.SERVER_FLAGS?.consoleVersion;
   clusterProperties.organizationId = window.SERVER_FLAGS?.telemetry?.ORGANIZATION_ID;
   return clusterProperties;
 };