Add support for displayName from childReferences

packages/utils/src/utils/index.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2019-2023 The Tekton Authors
+Copyright 2019-2024 The Tekton Authors
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
@@ -448,8 +448,9 @@ export function getPlaceholderTaskRun({ clusterTasks, pipelineTask, tasks }) {
  };
 }
 
-function addDashboardLabels({ pipelineTask, taskRun }) {
- const { description, displayName } = pipelineTask;
+function addDashboardLabels({ displayName, pipelineTask, taskRun }) {
+ const { description, displayName: pipelineTaskDisplayName } = pipelineTask;
+ const displayNameToUse = displayName || pipelineTaskDisplayName;
  // eslint-disable-next-line no-param-reassign
  taskRun.metadata.labels = {
  ...taskRun.metadata.labels,
@@ -458,9 +459,9 @@ function addDashboardLabels({ pipelineTask, taskRun }) {
  [labelConstants.DASHBOARD_DESCRIPTION]: description
  }
  : null),
- ...(displayName
+ ...(displayNameToUse
  ? {
- [labelConstants.DASHBOARD_DISPLAY_NAME]: displayName
+ [labelConstants.DASHBOARD_DISPLAY_NAME]: displayNameToUse
  }
  : null)
  };
@@ -475,6 +476,7 @@ export function getTaskRunsWithPlaceholders({
  tasks
 }) {
  let pipelineTasks = [];
+ const childReferences = pipelineRun?.status?.childReferences || [];
 
  if (pipelineRun?.status?.pipelineSpec?.tasks) {
  pipelineTasks = pipelineTasks.concat(pipelineRun.status.pipelineSpec.tasks);
@@ -502,8 +504,23 @@ export function getTaskRunsWithPlaceholders({
  pipelineTask.name
  );
 
+ const displayNames = childReferences.reduce((acc, childReference) => {
+ if (
+ childReference.displayName &&
+ childReference.pipelineTaskName === pipelineTask.name
+ ) {
+ acc[childReference.name] = childReference.displayName;
+ }
+ return acc;
+ }, {});
  realTaskRuns.forEach(taskRun => {
- taskRunsToDisplay.push(addDashboardLabels({ pipelineTask, taskRun }));
+ taskRunsToDisplay.push(
+ addDashboardLabels({
+ displayName: displayNames[taskRun.metadata.name],
+ pipelineTask,
+ taskRun
+ })
+ );
  });
 
  if (!realTaskRuns.length) {

packages/utils/src/utils/index.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2019-2023 The Tekton Authors
+Copyright 2019-2024 The Tekton Authors
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
@@ -844,6 +844,51 @@ describe('getTaskRunsWithPlaceholders', () => {
  const runs = getTaskRunsWithPlaceholders({ pipelineRun, taskRuns });
  expect(runs).toEqual([taskRun, finallyTaskRun]);
  });
+
+ it('handles displayName in childReferences', () => {
+ const displayName = 'aDisplayName';
+ const pipelineTaskName = 'aPipelineTaskName';
+ const taskRunName = 'aTaskRunName';
+
+ const pipelineRun = {
+ spec: {
+ pipelineRef: {
+ name: 'dummy-pipeline'
+ }
+ },
+ status: {
+ childReferences: [
+ {
+ displayName,
+ name: taskRunName,
+ pipelineTaskName
+ }
+ ],
+ pipelineSpec: {
+ tasks: [
+ {
+ name: pipelineTaskName
+ }
+ ]
+ }
+ }
+ };
+ const taskRun = {
+ metadata: {
+ labels: {
+ [labels.PIPELINE_TASK]: pipelineTaskName
+ },
+ name: taskRunName
+ }
+ };
+ const runs = getTaskRunsWithPlaceholders({
+ pipelineRun,
+ taskRuns: [taskRun]
+ });
+ expect(runs[0].metadata.labels[labels.DASHBOARD_DISPLAY_NAME]).toEqual(
+ displayName
+ );
+ });
 });
 
 describe('taskRunHasWarning', () => {