[Chore] Update timeline default expression

[joshuarrrr]

Description

Update default expression from .es(*) to opensearch(*) in the timeline visualization. Both work, but we'd prefer the latter

Issues Resolved

#1631

Check List

• All tests pass
  • yarn test:jest
  • yarn test:jest_integration
  • yarn test:ftr
• New functionality includes testing.
• New functionality has been documented.
• Update CHANGELOG.md
• Commits are signed per the DCO using --signoff

[kavilla]

Thank you so much for doing this!

[zhongnansu]

• plz add change log
• I ran a string search in code base and found more places using .es() than the changes you made in this PR. I haven't looked into details. Do you think those defaults need to be refactored as well?

  • OpenSearch-Dashboards/src/plugins/timeline/public/services/_saved_sheet.ts

    Line 78 in 0c9ca96

    timelion_sheet: ['.es(*)'],

  • 

[kavilla]

• plz add change log

  • I ran a string search in code base and found more places using .es() than the changes you made in this PR. I haven't looked into details. Do you think those defaults need to be refactored as well?

    • OpenSearch-Dashboards/src/plugins/timeline/public/services/_saved_sheet.ts

      Line 78 in 0c9ca96

      timelion_sheet: ['.es(*)'],

    • 

for the cypress ones i would leave the same*, those are BWC tests so it's there to ensure that .es(*) still works.

[kavilla]

Could we also add to this script to make the query .es https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/cypress/integration/without-security/helpers/generate_data.js#L59 (and do the with-security script as well? Sorry for the redundancy, I followed the format of the previously BWC tests for consistency but we should fix that).

But if we can add to the section to ensure that it updates the value to be .es because the BWC test is to verify end-users to migrated from the legacy application to OpenSearch Dashboards that their queries still work instead of having to change to .opensearch

[ananzh]

I am a bit curious. Won't this cause backward compatibility issue? For example, if an saved expression is using .es(). So is this fix for 3.0.0?

[kavilla]

I am a bit curious. Won't this cause backward compatibility issue? For example, if an saved expression is using .es(). So is this fix for 3.0.0?

It should only cause a failure in the test after generation existing timeline visualizations should still contain .es()

[joshuarrrr]

Thanks @zhongnansu - I went ahead and updated all the other references, except for those in the BWC cypress tests as per @kavilla's note.

[ashwin-pc]

@joshuarrrr @kavilla is there anything pending for this PR?

[kavilla]

Timeline BWC test is passing locally for me

[joshuarrrr]

Timeline BWC test is passing locally for me

huh... that's surprising. Maybe I'll try re-running and hoping. 🤞

[joshuarrrr]

converting to draft until I have some time to investigate/fix bwc tests

[codecov-commenter]

Codecov Report

Merging #2720 (6401ff4) into main (1e127b0) will decrease coverage by 0.02%.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main    #2720      +/-   ##
==========================================
- Coverage   66.41%   66.39%   -0.02%     
==========================================
  Files        3206     3209       +3     
  Lines       61597    61633      +36     
  Branches     9503     9507       +4     
==========================================
+ Hits        40909    40921      +12     
- Misses      18410    18426      +16     
- Partials     2278     2286       +8     

Flag	Coverage Δ
Linux	66.39% <ø> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 38 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ananzh]

NIT: do you think we could create a common function

Cypress.Commands.add('clearWithBackspaces', (selector, count) => {
  cy.get(selector).then($element => {
    const backspaces = '{backspace}'.repeat(count);
    $element.type(`{selectAll}${backspaces}`);
  });
});

So this could simplifies to

cy.clearWithBackspaces('[class="view-line"]', 15).type('.es(*)');

and this function could also be imported in other tests. I see there are 2 more tests using similar function. maybe put it in a until or common folder?

Also curious why we need these many backspaces

[joshuarrrr]

Yeah, I meant to call this out in a comment. For some reason, the {selectAll} cypress sequence doesn't work in this field the way it's supposed to (or at least the way I understand that it's supposed to work). Previously, when the default expression was .es(*), there were 6 total characters - you'll see that some tests "cleared" the input by repeating five backspaces (and reusing the .). Now that we've made the default expression opensearch(*), there are 14 total characters that need deleting, if you delete them one by one. I didn't try .clear() either, but because it's supposed to just alias type({selectAll}{backspace}), I suspect it won't work either.

I do like the simplification idea, although I don't think we need a common function for it.

[joshuarrrr]

See if you like my latest approach better! I sure do 😁

[ananzh]

kk I like it