Fix #791

[aenniw]

Signed-off-by: Martin Mihálek aenniw@gmail.com

Summary

Fixed out of orded embedding of include files

What kind of change does this PR introduce? (check at least one)

• Bugfix
• Feature
• Code style update
• Refactor
• Docs
• Build-related changes
• Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

• Yes
• No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

• When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

• Chrome 74.0.3729.169
• Firefox
• Safari
• Edge
• IE

If adding a new feature, the PR's description includes:

• A convincing reason for adding this feature
• Related documents have been updated
• Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

---

• DO NOT include files inside lib directory.

[aenniw]

Addresses #791

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[anikethsaha]

@aenniw please rebase and resolve the conflicts.
also change the commit message. make it more detailed in order to fit better for changlog

[anikethsaha]

can you resolve the conflicts

[aenniw]

Rebased, however not sure whats Security Flow about...

[trusktr]

Thanks for attempting to fix this! Let's make sure

• current tests pass (I suppose this just requires fixing the conflict)
• add new tests that ensure multiple embeds work as we're expecting

[aenniw]

Not sure how to approach the tests, as It occurs only when embedded files are downloaded out of order mainly due their size difference and network delay...
On local server setup despite big difference in embedded file sizes only way how to partially reproduce the issue is with throttling in browser...

[aenniw]

Added e2e scenario and updated live-server to delay serving of one of embedded files to replicate the issue...

[anikethsaha]

thanks for the update. few notes

[Koooooo-7]

yea, per to the docs, failureThreshold should be changed to smaller.
and I thing It is not a good way that showing test cases on the documentation, it makes users messy.

[anikethsaha]

I agree with @Koooooo-7 , we cant show testing fixture in docs.
@aenniw can you make those files just for the testing. try added script here.
that file is copy-pasting content from the original docs. so after the copy-pasting, you can add function to create a file and write the content as you need or in some other way whichever you prefer.
I know its a bit of extra work but we don't have strong test. and the issue addressing in this PR is quite common we noticed in chats. so it would be great to have a good setup and it will help in reviewing this better

[aenniw]

Extracted test specific blocks from docs, updated cypress setup.js to inline content before predefined tag

[jthegedus]

Looking good

[anikethsaha]

looks good to me.
can you fix the CI and we are good to go.

[aenniw]

CI fixed by updating reference img as new lines were added to docs via PR and it wasn't updated...

[trusktr]

Unfortunately (or fortunately, depending on your view) the test system changed from cypress to playwright, making a lot of conflicts in the PR. We need to update this to playwright.

[trusktr]

needs conflicts resolved, moving from cypress to playwright.