Adds toast ID to toast api

[ashwin-pc]

Description

Currently sending the same toast multiple times results in multiple toasts being rendered on the screen. This change allows the toast api to additionally accept an id parameter that

Before:

Now:

Issues Resolved

• closes [BUG] [Vis Builder] Incorrect index pattern causes multiple errors #2643

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

[codecov-commenter]

Codecov Report

Merging #3752 (92ccc30) into main (1edb195) will increase coverage by 0.01%.
The diff coverage is 50.00%.

📣 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    #3752      +/-   ##
==========================================
+ Coverage   66.43%   66.45%   +0.01%     
==========================================
  Files        3209     3208       -1     
  Lines       61741    61752      +11     
  Branches     9537     9539       +2     
==========================================
+ Hits        41020    41035      +15     
+ Misses      18431    18429       -2     
+ Partials     2290     2288       -2     

Flag	Coverage Δ
Linux	66.39% <50.00%> (+<0.01%)	⬆️
Windows	66.39% <50.00%> (+<0.01%)	⬆️

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

Impacted Files	Coverage Δ
...uilder/public/application/components/workspace.tsx	6.25% <0.00%> (-0.21%)	⬇️
...public/application/utils/state_management/store.ts	18.75% <0.00%> (ø)
src/plugins/vis_builder/public/plugin.ts	22.44% <0.00%> (-0.47%)	⬇️
...rc/core/public/notifications/toasts/toasts_api.tsx	88.23% <100.00%> (+2.52%)	⬆️

... and 6 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.

[kavilla]

do we know the historical reason why?

[ashwin-pc]

I looked at the git history but as far as I can tell, there isn't a good reason. That's why I kept the default behavior as is. Only if you explicitly pass an id does the behavior change

[joshuarrrr]

After reviewing, my understanding is that it was just intended to be an internal property, that simply auto-increments with each new toast. Ashwin's change here changes the purpose and usage of the property a bit (for example, passing string ids instead of a number), but not in a way that affects the historical usage. So I don't think it was intended as "specifying id is prohibited" and instead meant "specifying id is not necessary".

[joshuarrrr]

@ashwin-pc I tried re-running the cypress tests, but you may want to take a look at why there are failed tests there.

[ashwin-pc]

The branch was behind main by quite a bit. They should be passing now

[joshuarrrr]

I wonder if it's somewhat surprising that we still increment the idCounter, but throw away the value. On the one hand, it means that the counter really does match the total number, but on the other, there are now some idCounter values that don't exist in the map of toast IDs.

[ashwin-pc]

We dont still increment, if an existing toast is found, we exit this function when we return the existing toast.

[joshuarrrr]

Right, I'm talking about the case where an id is provided, but there's no existing matching toast. In that case we increment, but don't use the incremented value.