Skip to content

[BUG] hooks run twice unexpectedly #1732

Closed
#1736
Closed
[BUG] hooks run twice unexpectedly#1732
#1736
Assignees
trusktr
Labels
bugconfirmed as a bug

Description

@trusktr
trusktr
opened on Jan 23, 2022

Bug Report

Steps to reproduce

Not sure what the cause is yet, but I've written local playwright tests that verify that doneEach runs twice on initial page load for a particular test (so the case is isolated).

This is unexpected. For most sites/tests, doneEach runs once, but in some rare case it runs twice. I have experienced this before in practice too.

This might possibly explain what I was seeing in #906 with scripts running twice

What is current behaviour

doneEach runs twice on initial render sometimes.

What is the expected behaviour

It should run one time all the time, or twice all the time. Or something similar, but right now there is something that seems inconsistent.

Other relevant information

  • Bug does still occur when all/other plugins are disabled?

  • Your OS: Linux

  • Node.js version: 17

  • npm/yarn version: 8

  • Browser version: Chrome

  • Docsify version: 4.12.2

  • Docsify plugins: Added a plugin in docs/index.html to log, and log happens twice.

Please create a reproducible sandbox

Not sure how yet.

Mention the docsify version in which this bug was not present (if any)

Activity

  1. trusktr
    self-assigned this
    on Jan 23, 2022
  2. trusktr
    added
    bugconfirmed as a bug
    on Jan 23, 2022
  3. trusktr
    changed the title [-]hook.doneEach runs twice on initial page load sometimes.[/-] [+][BUG] hook.doneEach runs twice on initial page load sometimes.[/+] on Jan 23, 2022

  4. trusktr commented on Jan 23, 2022

    @trusktr
    trusktr
    on Jan 23, 2022
    MemberAuthor

    Here are two stack traces, one from each doneEach call, based on commit 9658ed4 with minification disabled, in lib/docsify.min.js:

          LOG FROM INSIDE PAGE, TEST 1:  RenderCountPlugin/<@http://127.0.0.1:3001/docs/index.html#/:238:27
      step@http://127.0.0.1:3001/lib/docsify.min.js:9908:36
      step@http://127.0.0.1:3001/lib/docsify.min.js:9910:19
      step@http://127.0.0.1:3001/lib/docsify.min.js:9910:19
      callHook@http://127.0.0.1:3001/lib/docsify.min.js:9917:13
      done@http://127.0.0.1:3001/lib/docsify.min.js:9687:16
      $fetch/<@http://127.0.0.1:3001/lib/docsify.min.js:9698:13
      fn@http://127.0.0.1:3001/lib/docsify.min.js:9606:13
      then/<@http://127.0.0.1:3001/lib/docsify.min.js:2919:20
      EventListener.handleEvent*on@http://127.0.0.1:3001/lib/docsify.min.js:2872:28
      then@http://127.0.0.1:3001/lib/docsify.min.js:2907:11
      loadNested@http://127.0.0.1:3001/lib/docsify.min.js:9548:79
      _loadSideAndNav/<@http://127.0.0.1:3001/lib/docsify.min.js:9610:21
      _renderMain/</<@http://127.0.0.1:3001/lib/docsify.min.js:9401:15
      prerenderEmbed/<@http://127.0.0.1:3001/lib/docsify.min.js:9103:13
      walkFetchEmbed@http://127.0.0.1:3001/lib/docsify.min.js:8963:14
      prerenderEmbed@http://127.0.0.1:3001/lib/docsify.min.js:9077:19
      _renderMain/<@http://127.0.0.1:3001/lib/docsify.min.js:9392:27
      step@http://127.0.0.1:3001/lib/docsify.min.js:9900:17
      step@http://127.0.0.1:3001/lib/docsify.min.js:9910:19
      callHook@http://127.0.0.1:3001/lib/docsify.min.js:9917:13
      _renderMain@http://127.0.0.1:3001/lib/docsify.min.js:9376:14
      _fetch/<@http://127.0.0.1:3001/lib/docsify.min.js:9640:40
      then/<@http://127.0.0.1:3001/lib/docsify.min.js:2919:20
      EventListener.handleEvent*on@http://127.0.0.1:3001/lib/docsify.min.js:2872:28
      then@http://127.0.0.1:3001/lib/docsify.min.js:2907:11
      _fetch@http://127.0.0.1:3001/lib/docsify.min.js:9640:15
      $fetch@http://127.0.0.1:3001/lib/docsify.min.js:9696:16
      initFetch@http://127.0.0.1:3001/lib/docsify.min.js:9773:16
      Docsify@http://127.0.0.1:3001/lib/docsify.min.js:9941:12
      @http://127.0.0.1:3001/lib/docsify.min.js:9962:22
      EventListener.handleEvent*documentReady@http://127.0.0.1:3001/lib/docsify.min.js:796:9
      @http://127.0.0.1:3001/lib/docsify.min.js:9962:16
      @http://127.0.0.1:3001/lib/docsify.min.js:9964:3

          LOG FROM INSIDE PAGE, TEST 1:  RenderCountPlugin/<@http://127.0.0.1:3001/docs/index.html#/:238:27
      step@http://127.0.0.1:3001/lib/docsify.min.js:9908:36
      step@http://127.0.0.1:3001/lib/docsify.min.js:9910:19
      step@http://127.0.0.1:3001/lib/docsify.min.js:9910:19
      callHook@http://127.0.0.1:3001/lib/docsify.min.js:9917:13
      done@http://127.0.0.1:3001/lib/docsify.min.js:9687:16
      $fetch/<@http://127.0.0.1:3001/lib/docsify.min.js:9698:13
      fn@http://127.0.0.1:3001/lib/docsify.min.js:9606:13
      then@http://127.0.0.1:3001/lib/docsify.min.js:2879:23
      loadNested@http://127.0.0.1:3001/lib/docsify.min.js:9548:79
      _loadSideAndNav/<@http://127.0.0.1:3001/lib/docsify.min.js:9610:21
      _renderMain/</<@http://127.0.0.1:3001/lib/docsify.min.js:9401:15
      prerenderEmbed/<@http://127.0.0.1:3001/lib/docsify.min.js:9103:13
      walkFetchEmbed@http://127.0.0.1:3001/lib/docsify.min.js:8963:14
      prerenderEmbed@http://127.0.0.1:3001/lib/docsify.min.js:9077:19
      _renderMain/<@http://127.0.0.1:3001/lib/docsify.min.js:9392:27
      step@http://127.0.0.1:3001/lib/docsify.min.js:9900:17
      step@http://127.0.0.1:3001/lib/docsify.min.js:9910:19
      callHook@http://127.0.0.1:3001/lib/docsify.min.js:9917:13
      _renderMain@http://127.0.0.1:3001/lib/docsify.min.js:9376:14
      _fetch/<@http://127.0.0.1:3001/lib/docsify.min.js:9640:40
      then@http://127.0.0.1:3001/lib/docsify.min.js:2879:23
      _fetch@http://127.0.0.1:3001/lib/docsify.min.js:9640:15
      $fetch@http://127.0.0.1:3001/lib/docsify.min.js:9696:16
      initRouter/<@http://127.0.0.1:3001/lib/docsify.min.js:1225:16
      onchange/<@http://127.0.0.1:3001/lib/docsify.min.js:1039:11
      EventListener.handleEvent*on@http://127.0.0.1:3001/lib/docsify.min.js:754:25
      onchange@http://127.0.0.1:3001/lib/docsify.min.js:1036:9
      initRouter@http://127.0.0.1:3001/lib/docsify.min.js:1215:16
      Docsify@http://127.0.0.1:3001/lib/docsify.min.js:9935:12
      @http://127.0.0.1:3001/lib/docsify.min.js:9962:22
      EventListener.handleEvent*documentReady@http://127.0.0.1:3001/lib/docsify.min.js:796:9
      @http://127.0.0.1:3001/lib/docsify.min.js:9962:16
      @http://127.0.0.1:3001/lib/docsify.min.js:9964:3

    In this example, one doneEach happens due to the initFetch process, and the other happens due to the initRouter process.

  5. trusktr
    changed the title [-][BUG] hook.doneEach runs twice on initial page load sometimes.[/-] [+][BUG] hooks run twice unexpectedly[/+] on Jan 24, 2022

  6. trusktr commented on Jan 26, 2022

    @trusktr
    trusktr
    on Jan 26, 2022
    MemberAuthor

    This may be an issue that only happens in an e2e test (as I just discovered), although I thought I experienced this before elsewhere.

  7. jhildenbiddle commented on Jan 30, 2022

    @jhildenbiddle
    jhildenbiddle
    on Jan 30, 2022
    Member

    Addressed by #1736.

  8. jhildenbiddle
    linked a pull request that will close this issuerefactor: Update test environments and lint configuration #1736on Jan 30, 2022
  9. jhildenbiddle
    closed this as completedin #1736on Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

bugconfirmed as a bug

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions