aem-boilerplate icon indicating copy to clipboard operation
aem-boilerplate copied to clipboard

loadScript, loadCSS doesn't wait for script loading / parsing when invoked multiple times in parallel

Open yugandhar02 opened this issue 1 year ago • 3 comments

Expected Behaviour

When loadScript or loadCSS is called multiple times in parallel, the subsequent invocations after first call doesn't wait for script loading or parsing. It returns resolved promise

Actual Behaviour

loadScript or loadCSS should return pending promise if loading or parsing is still in progress

Steps to Reproduce

  1. call loadScript or loadCSS multiple times in same page with same src url

Sample Code that illustrates the problem

async function renderVideo(block) {
  await Promise.all([
    loadCSS(VIDEO_JS_CSS),
    loadScript(VIDEO_JS_SCRIPT),
  ]);
  
  // render
}

async function decorateCard(card) {
  await renderVideo(card);
}

await Promise.all([
  decorateCard(card1),
  decorateCard(card2),
  decorateCard(card3),
]

Test page where it fails: https://issue-399-demo--franklin-assets-selector--hlxsites.hlx.page/_drafts/yug/demo

Test page with fix applied: https://issue-399-fix--franklin-assets-selector--hlxsites.hlx.page/_drafts/yug/demo

yugandhar02 avatar Sep 09 '24 06:09 yugandhar02

@rofe @sdmcraft The current assumption is that script will be loaded only once in block and works in most of the cases. In case developer is using some utility function which internally loads some script, he/she will have to ensure that function is not called multiple times in a row Can you please suggest if this issue is worth addressing ?

yugandhar02 avatar Sep 10 '24 11:09 yugandhar02

@yugandhar02 as far as I can see, you can await both functions. They resolve their promise once the element is loaded:

  • https://github.com/adobe/aem-boilerplate/blob/main/scripts/aem.js#L223
  • https://github.com/adobe/aem-boilerplate/blob/main/scripts/aem.js#L248

In any case, this code is in aem.js which is being maintained in https://github.com/adobe/aem-lib.

rofe avatar Sep 14 '24 14:09 rofe

@rofe

you can await both functions. They resolve their promise once the element is loaded

that's right. but when the function is invoked again with same parameter while script is still getting dowloaded or parsed, it will return resolved promise. the issue can be reproduced with this test page https://issue-399-demo--franklin-assets-selector--hlxsites.hlx.page/_drafts/yug/demo

yugandhar02 avatar Sep 25 '24 11:09 yugandhar02