add some comments on common pitfalls

[bbrehm]

This adds some fixme notes on fundamental architecture/API/performance issues I spotted.

I also started to write down some of the general pitfalls. How do we want these general pitfalls documented @fabsx00 ?

[maltek]

Maybe some of the discussion on time complexity of collection classes can be replaced with a link to the Scala docs on the topic? (I found these very useful when I finally decided I should actually know where each of these types is appropriate.)

https://docs.scala-lang.org/overviews/collections-2.13/concrete-immutable-collection-classes.html https://docs.scala-lang.org/overviews/collections-2.13/performance-characteristics.html

(These links go to the Scala 2.13 docs, because the Scala 3 book still links there, too.)

[DavidBakerEffendi]

Before this branch gets ignored into oblivion, I've made a candidate entry on the Joern docs https://github.com/joernio/website/pull/109

[bbrehm]

Lol, I'm always happy to provide the example of code for people to learn what not to do 😉

Don't feel bad about it -- concurrency is hard, lazy iterators are really scary API, and I am also giving examples from the java standard library like Collectors.toList(), so you're in very good company ;)

[fabsx00]

Yeah, let's put it in the docs. The chances of it being read there are higher.

[DavidBakerEffendi]

Yeah, let's put it in the docs. The chances of it being read there are higher.

@bbrehm then are you happy with https://github.com/joernio/website/pull/109? I'll give it another comb through first then add you as a reviewer once I feel it's ready

[DavidBakerEffendi]

It's been on my backlog for a while, but will be implementing the mutable program summary maps and concurrent util stream update today

[DavidBakerEffendi]

Closed by https://github.com/joernio/joern/pull/4620 and https://github.com/joernio/website/pull/109