Nightly Dotty workflow of 2024-03-05 failed

[github-actions[bot]]

See https://github.com/lampepfl/dotty/actions/runs/8150374165

[nicolasstucki]

Error:  Caused by: java.lang.NullPointerException: Cannot invoke "java.lang.Integer.intValue()" because the return value of "java.util.HashMap.get(Object)" is null
Error:      at com.vladsch.flexmark.html.renderer.HeaderIdGenerator.generateId(HeaderIdGenerator.java:124)
Error:      at com.vladsch.flexmark.html.renderer.HeaderIdGenerator.getId(HeaderIdGenerator.java:148)
Error:      at dotty.tools.scaladoc.tasty.comments.markdown.SectionRenderingExtension$SectionHandler$.render(SectionRenderingExtension.scala:38)
Error:      at dotty.tools.scaladoc.tasty.comments.markdown.SectionRenderingExtension$SectionHandler$.render(SectionRenderingExtension.scala:32)
Error:      at com.vladsch.flexmark.html.renderer.NodeRenderingHandler.render(NodeRenderingHandler.java:16)
Error:      at com.vladsch.flexmark.html.HtmlRenderer$MainNodeRenderer.renderNode(HtmlRenderer.java:779)
Error:      at 
...

[sjrd]

According to the CI build history for pushes on main, this was broken by https://github.com/lampepfl/dotty/pull/19860

/cc @Linyxus

This needs to be addressed today, as we're moving the repo tomorrow morning and we need the CI to be working at that time. If it's not fixed by 3pm, I will revert the PR.

[sjrd]

Reverting #19860 does not fix the issue. Any idea what else could have caused this?

[dwijnand]

Duplicate of #18344

details in https://github.com/lampepfl/dotty/issues/19524#issuecomment-1910357898

cc @Florian3k

[sjrd]

Huh. It's been quite consistent in the past few builds, though.

[dwijnand]

Yeah, it's a not-too-often flaky failure. But there's a whole bunch of backreferences to the various duplicates

[dwijnand]

I think it's a race-condition:

                if (headerBaseIds.containsKey(baseRefId)) {
                    int index = headerBaseIds.get(baseRefId);

                    index++;
                    headerBaseIds.put(baseRefId, index);
                    baseRefId += "-" + index;
                } else {
                    headerBaseIds.put(baseRefId, 0);
                }

The get is being called concurrently while one of those puts caused the hashmap to rehash its internal table. I'm not sure, though, how we fix that in SectionRenderingExtension.SectionHandler...

[Florian3k]

We may put this as a temporary fix in SectionRenderingExtension.scala:

val id = idGenerator.synchronized:
  idGenerator.getId(headerText + ifSuffixStr)

Not sure how much this will affect performance, but I guess it's better than nothing for now.

[sjrd]

Yes, let's do that. Can you send a PR?