Skip to content

Commit

Permalink
[Console Monaco Migration] Fix variable replacement (elastic#188994)
Browse files Browse the repository at this point in the history
Fixes elastic#185999

## Summary

This PR fixes the variable replacement when the variable contains an
object value .

**How to test:**
1. Go to Console and create the following variables:
`var1`: `{"match_all": {}}`
`var2`: `index`
`var3`: `match_all`
2. Test using an object variable inside the request data:
```
GET _search
{
  "query": "${var1}"
}
```
should be sent as `query: {match_all: {}}` in the payload.
3. Test using a variable in the URL:
`PUT /test-${var2}` should be sent as `PUT /test-index` in the payload.
4. Test using a string variable in the request data:
```
GET _search
{
  "query": {
    "${var3}": {}
  }
}
```
should be sent as `query: {match_all: {}}` in the payload.
5. Test using undefined variables:
```
GET _search
{
  "query": {
    "${var4}": {}
  }
}
```
or `PUT /test-${var5}`
Both should be sent as they are.

<!--
### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->
  • Loading branch information
ElenaStoeva authored Jul 26, 2024
1 parent 0395865 commit 7e5907e
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ export const slashRegex = /\//;
export const ampersandRegex = /&/;
export const equalsSignRegex = /=/;
export const questionMarkRegex = /\?/;
export const variableTemplateRegex = /\${(\w+)}/g;
export const urlVariableTemplateRegex = /\${(\w+)}/g;
export const dataVariableTemplateRegex = /"\${(\w+)}"/g;
export const numberStartRegex = /[-\d]/;
export const digitRegex = /[\d]/;
export const lettersRegex = /[A-Za-z]/;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ describe('requests_utils', () => {
name: 'variable2',
value: 'test2',
},
{
id: '3',
name: 'variable3',
value: '{"match_all": {}}',
},
];

describe('replaces variables in the url', () => {
Expand Down Expand Up @@ -96,11 +101,20 @@ describe('requests_utils', () => {
const request = {
method: 'GET',
url: '${variable1}',
data: [JSON.stringify({ '${variable1}': '${variable2}' }, null, 2)],
data: [
JSON.stringify(
{ '${variable1}': '${variable2}', '${variable2}': '${variable3}' },
null,
2
),
],
};
it('works with several variables', () => {
const result = replaceRequestVariables(request, variables);
expect(result.data[0]).toBe(JSON.stringify({ test1: 'test2' }, null, 2));
expect(JSON.parse(result.data[0])).toMatchObject({
test1: 'test2',
test2: { match_all: {} },
});
});
});
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { constructUrl } from '../../../../../lib/es';
import { MetricsTracker } from '../../../../../types';
import type { DevToolsVariable } from '../../../../components';
import type { EditorRequest } from '../types';
import { variableTemplateRegex } from './constants';
import { urlVariableTemplateRegex, dataVariableTemplateRegex } from './constants';
import { removeTrailingWhitespaces } from './tokens_utils';
import { AdjustedParsedRequest } from '../types';

Expand All @@ -38,8 +38,8 @@ export const replaceRequestVariables = (
): EditorRequest => {
return {
method,
url: replaceVariables(url, variables),
data: data.map((dataObject) => replaceVariables(dataObject, variables)),
url: replaceVariables(url, variables, false),
data: data.map((dataObject) => replaceVariables(dataObject, variables, true)),
};
};

Expand Down Expand Up @@ -118,15 +118,35 @@ export const getRequestEndLineNumber = (
return endLineNumber;
};

const isJsonString = (str: string) => {
try {
JSON.parse(str);
} catch (e) {
return false;
}
return true;
};

/*
* Internal helpers
*/
const replaceVariables = (text: string, variables: DevToolsVariable[]): string => {
if (variableTemplateRegex.test(text)) {
text = text.replaceAll(variableTemplateRegex, (match, key) => {
const replaceVariables = (
text: string,
variables: DevToolsVariable[],
isDataVariable: boolean
): string => {
const variableRegex = isDataVariable ? dataVariableTemplateRegex : urlVariableTemplateRegex;
if (variableRegex.test(text)) {
text = text.replaceAll(variableRegex, (match, key) => {
const variable = variables.find(({ name }) => name === key);
const value = variable?.value;

if (isDataVariable && value) {
// If the variable value is an object, add it as it is. Otherwise, surround it with quotes.
return isJsonString(value) ? value : `"${value}"`;
}

return variable?.value ?? match;
return value ?? match;
});
}
return text;
Expand Down

0 comments on commit 7e5907e

Please sign in to comment.