Relation Resolution - stringifiedStoriesCache prevents resolution of 1st level story relation if the story is also a 2nd level/nested relation

[lakeboerg]

Dear storyblok client team,

it's a pleasure to interact with your libs and I want to thank you for your work.
And while doing so, I ran into a rather particular issue. A little deep-dive into the relations resolution mechanism yielded a funny issue.

Could be an edge-case scenario, however we ran into it and I think it is not so "edge-casy" after all.

Let's go:

stringifiedStoriesCache prevents resolution of 1st level story relation if the story is also a 2nd level/nested relation.

Expected Behavior

All found relations should be fully processed for relation resolution, regardless whether it is used as a nested/2nd level relation.

Current Behavior

If the relation is used as a 2nd level/nested relation in a 1st level relation, the 1st level relations won't be resolved because the stringifiedStoriesCache returns the API provided, non resolved item due to the first 2nd level relation resolution.

Important
It depends on the order of keys of this.relatations in resolveStories which story gets processed and cached eagerly.

Steps to Reproduce

Required data- and relation-structure:

+ story-1 refs
    - story-2 refs
        - story-432
    - story-3 refs
        - story-432
        - story-4
    - story-4 refs
        - story-432 
    - story-5 refs
        - story-432

The API correctly returns all relations:

• story-2
• story-3
• story-4
• story-5
• story-432

Now when within resolveStories the code iterates over relations and passes every relation object into iterateTree to resolve AND story-3 is iterated earlier than story-4, the resolution of story-4 as a relation of story-3 leads to getStoryReference to store the non-resolved, API provided story-4 in the stringifiedCache.

Now story-4 gets processed to resolve it's relations, but story-432's relations can't be resolved, because it is already in the stringifiedCache.

I am happy to help out in any case.

Looking forward to a reply and best regards,

l