[8.6] [Lens] Log counter_rate column only once in the inspector (#146056) (#146151)

# Backport

This will backport the following commits from `main` to `8.6`:
- [[Lens] Log counter_rate column only once in the inspector
(#146056)](https://github.com/elastic/kibana/pull/146056)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Marco
Liberati","email":"dej611@users.noreply.github.com"},"sourceCommit":{"committedDate":"2022-11-23T13:59:26Z","message":"[Lens]
Log counter_rate column only once in the inspector (#146056)\n\n##
Summary\r\n\r\nFixes #145746 \r\n\r\nThe bug was in an expression
utility which was appending a clone of an\r\nexisting column within the
`time_scale` evaluation. The fix was to\r\nensure the column was
actually overwritten rather than duplicated in\r\nthat specific
case.\r\n\r\nNow the `Counter rate` function is no longer duplicated in
the\r\ninspector:\r\n\r\n<img width=\"701\" alt=\"Screenshot 2022-11-22
at 19 47
49\"\r\nsrc=\"https://user-images.githubusercontent.com/924948/203397030-39761bdc-c8f5-4b09-bff2-12be64cd198d.png\">\r\n\r\n\r\nCreated
also some unit tests for the utility function.\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] Any UI
touched in this PR is usable by keyboard only (learn more\r\nabout
[keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n-
[ ] Any UI touched in this PR does not create any new axe
failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\nCo-authored-by:
Stratoula Kalafateli
<efstratia.kalafateli@elastic.co>","sha":"0f061f0203737a11368c0eefa0a31529b99a2113","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Feature:ExpressionLanguage","Team:Visualizations","Feature:Lens","v8.6.0","v8.7.0"],"number":146056,"url":"https://github.com/elastic/kibana/pull/146056","mergeCommit":{"message":"[Lens]
Log counter_rate column only once in the inspector (#146056)\n\n##
Summary\r\n\r\nFixes #145746 \r\n\r\nThe bug was in an expression
utility which was appending a clone of an\r\nexisting column within the
`time_scale` evaluation. The fix was to\r\nensure the column was
actually overwritten rather than duplicated in\r\nthat specific
case.\r\n\r\nNow the `Counter rate` function is no longer duplicated in
the\r\ninspector:\r\n\r\n<img width=\"701\" alt=\"Screenshot 2022-11-22
at 19 47
49\"\r\nsrc=\"https://user-images.githubusercontent.com/924948/203397030-39761bdc-c8f5-4b09-bff2-12be64cd198d.png\">\r\n\r\n\r\nCreated
also some unit tests for the utility function.\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] Any UI
touched in this PR is usable by keyboard only (learn more\r\nabout
[keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n-
[ ] Any UI touched in this PR does not create any new axe
failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\nCo-authored-by:
Stratoula Kalafateli
<efstratia.kalafateli@elastic.co>","sha":"0f061f0203737a11368c0eefa0a31529b99a2113"}},"sourceBranch":"main","suggestedTargetBranches":["8.6"],"targetPullRequestStates":[{"branch":"8.6","label":"v8.6.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/146056","number":146056,"mergeCommit":{"message":"[Lens]
Log counter_rate column only once in the inspector (#146056)\n\n##
Summary\r\n\r\nFixes #145746 \r\n\r\nThe bug was in an expression
utility which was appending a clone of an\r\nexisting column within the
`time_scale` evaluation. The fix was to\r\nensure the column was
actually overwritten rather than duplicated in\r\nthat specific
case.\r\n\r\nNow the `Counter rate` function is no longer duplicated in
the\r\ninspector:\r\n\r\n<img width=\"701\" alt=\"Screenshot 2022-11-22
at 19 47
49\"\r\nsrc=\"https://user-images.githubusercontent.com/924948/203397030-39761bdc-c8f5-4b09-bff2-12be64cd198d.png\">\r\n\r\n\r\nCreated
also some unit tests for the utility function.\r\n\r\n###
Checklist\r\n\r\nDelete any items that are not applicable to this
PR.\r\n\r\n- [ ] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[
]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [ ] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] Any UI
touched in this PR is usable by keyboard only (learn more\r\nabout
[keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n-
[ ] Any UI touched in this PR does not create any new axe
failures\r\n(run axe in
browser:\r\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\r\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\r\n-
[ ] If a plugin configuration key changed, check if it needs to
be\r\nallowlisted in the cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n-
[ ] This was checked for
[cross-browser\r\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\r\n\r\n\r\n###
Risk Matrix\r\n\r\nDelete this section if it is not applicable to this
PR.\r\n\r\nBefore closing this PR, invite QA, stakeholders, and other
developers to\r\nidentify risks that should be tested prior to the
change/feature\r\nrelease.\r\n\r\nWhen forming the risk matrix, consider
some of the following examples\r\nand how they may potentially impact
the change:\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes
|\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n|
Multiple Spaces&mdash;unexpected behavior in non-default Kibana
Space.\r\n| Low | High | Integration tests will verify that all features
are still\r\nsupported in non-default Kibana Space and when user
switches between\r\nspaces. |\r\n| Multiple nodes&mdash;Elasticsearch
polling might have race conditions\r\nwhen multiple Kibana nodes are
polling for the same tasks. | High | Low\r\n| Tasks are idempotent, so
executing them multiple times will not result\r\nin logical error, but
will degrade performance. To test for this case we\r\nadd plenty of unit
tests around this logic and document manual testing\r\nprocedure. |\r\n|
Code should gracefully handle cases when feature X or plugin Y
are\r\ndisabled. | Medium | High | Unit tests will verify that any
feature flag\r\nor plugin combination still results in our service
operational. |\r\n| [See more potential
risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
|\r\n\r\n\r\n### For maintainers\r\n\r\n- [ ] This was checked for
breaking API changes and was
[labeled\r\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\nCo-authored-by:
Stratoula Kalafateli
<efstratia.kalafateli@elastic.co>","sha":"0f061f0203737a11368c0eefa0a31529b99a2113"}}]}]
BACKPORT-->

Co-authored-by: Marco Liberati <dej611@users.noreply.github.com>

src/plugins/expressions/common/expression_functions/series_calculation_helpers.test.ts

@@ -0,0 +1,66 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { buildResultColumns, Datatable } from '..';
+
+describe('buildResultColumns', () => {
+  function getDatatable(columns: Datatable['columns']): Datatable {
+    const row: Datatable['rows'][number] = {};
+    for (const { id, meta } of columns) {
+      row[id] = meta.type === 'number' ? 5 : 'a';
+    }
+    return {
+      type: 'datatable',
+      columns,
+      rows: Array(5).fill(row),
+    };
+  }
+  it('should append the new output column', () => {
+    const newColumns = buildResultColumns(
+      getDatatable([{ id: 'inputId', name: 'value', meta: { type: 'number' } }]),
+      'outputId',
+      'inputId',
+      undefined
+    );
+    expect(newColumns).not.toBeUndefined();
+    expect(newColumns).toHaveLength(2);
+    expect(newColumns![1]).toEqual({ id: 'outputId', name: 'outputId', meta: { type: 'number' } });
+  });
+
+  it('should create a new column with the passed name', () => {
+    const newColumns = buildResultColumns(
+      getDatatable([{ id: 'inputId', name: 'value', meta: { type: 'number' } }]),
+      'outputId',
+      'inputId',
+      'newName'
+    );
+    expect(newColumns![1]).toEqual({ id: 'outputId', name: 'newName', meta: { type: 'number' } });
+  });
+
+  it('should throw if same id is passed for input and output', () => {
+    expect(() =>
+      buildResultColumns(
+        getDatatable([{ id: 'inputId', name: 'value', meta: { type: 'number' } }]),
+        'inputId',
+        'inputId',
+        undefined
+      )
+    ).toThrow();
+  });
+
+  it('should overwrite column with the correct flag', () => {
+    const newColumns = buildResultColumns(
+      getDatatable([{ id: 'inputId', name: 'value', meta: { type: 'number' } }]),
+      'inputId',
+      'inputId',
+      undefined,
+      { allowColumnOverwrite: true }
+    );
+    expect(newColumns).toHaveLength(1);
+  });
+});

src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts

@@ -65,7 +65,17 @@ export function buildResultColumns(
   };
 
   const resultColumns = [...input.columns];
-  // add output column after input column in the table
-  resultColumns.splice(resultColumns.indexOf(inputColumnDefinition) + 1, 0, outputColumnDefinition);
+
+  // If input and output are the same, replace the input column with the output one
+  // otherwise add output column after input column in the table
+  const offset = inputColumnId === outputColumnId ? 0 : 1;
+  // replace 1 item in case of same column, otherwise just append
+  const replacingItems = inputColumnId === outputColumnId ? 1 : 0;
+  resultColumns.splice(
+    resultColumns.indexOf(inputColumnDefinition) + offset,
+    replacingItems,
+    outputColumnDefinition
+  );
+
   return resultColumns;
 }