Cross reference array gives an empty array

[kh0ma]

var performantArrayToTree = require("performant-array-to-tree")

console.log(performantArrayToTree.arrayToTree([
    { num: "4", ref: "31", custom: "abc" },
    { num: "31", ref: "4", custom: "12" },
  ],
  { id: "num", parentId: "ref", childrenField: "nodes", throwIfOrphans: true }
));

// result = []

version: 1.9.1

Actually, I don't have a strong opinion on the expected result from this situation. But it seems strange that the lib silently cut an array. Probably it should be an error?

[philipstanislaus]

Good find, I agree, there should be an error on circular structures.

[philipstanislaus]

Would you have time to create a PR for this?

[kh0ma]

Temporary in my project I did it the following way:

• call arrayToTree with a given array
• count entries in Tree
• compare the length of an array vs "length" of Tree

Here we can count on Tree length w/o needs to recalculate it. So will validate it at the end.

Do we care about backward compatibility?

Should it be a config throwIfCircular: true similar to throwIfOrphans: true?

[philipstanislaus]

Sorry for the delay in resolving this.

I just checked out the current code, and realized that this is actually a special case of throwIfOrphans, since any items with a circular parent/child relationship would just be a group of orphans that will not be part of the tree.

[philipstanislaus]

Released in https://www.npmjs.com/package/performant-array-to-tree/v/1.10.0