ShiftLeftSecurity / ShiftLeftSecurity/codepropertygraph
Remove io.shiftleft.semanticcpg.language.operatorextension
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 597
- Forks
- 84
- Avg merge
- 18h 29m
- Merged PRs (30d)
- 1
Description
The corresponding classes extend from Noderef.
This means that they create a second Noderef referencing the same underlying Node.
However, overflowdb cannot deal with that: The entire logic (e.g. https://github.com/ShiftLeftSecurity/overflowdb/blob/5bf234034dc7b58edf0983753adb253ce340578a/core/src/main/java/overflowdb/NodeRef.java#L91) synchronizes the storage on the Ref, not the node.
Afaiu this part of the API is not used in prod. So let's get rid of it, and afterwards add checks in overflowdb that guarantee the right invariant (every node can only have a unique reference to it).
cc @fabsx00 because you know best which parts of the API are important for whom, and @mpollmeier because you know overflowdb best.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the io.shiftleft.semanticcpg.language.operatorextension classes and their Noderef inheritance. Review overflowdb's NodeRef.java synchronization logic, especially the referenced line, and identify whether this API is used elsewhere. Done means the unused operator extension is removed and the requested invariant checks are added in overflowdb.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- devtools
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100