Fix/pro 173

[christianzoppi]

This PR fixes some problems that happen when running pull-components with the --separate-files parameter. Some files will be corrupted during the asynchronous save. The code of the CLI doesn't even wait for the writing operation to be over.

Pull request type

Jira Link: INT-

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Other (please describe):

How to test this PR

In the same parent folder as the storyblok-cli one, create one called data, then run:
Run npm run dev pull-components -- --space 88751 --separate-files --path ./../data/
You should get no errors. Now open any JSON file and inspect the content. The content should be correct.

What is the new behavior?

Files from pull-components command are stored synchronously

Other information

[notion-workspace]

Pull components save bug

[Edo-San]

Thanks for this PR @christianzoppi 🙏
I finally had some time to look more deeply into this.

This weird behaviour we're currently getting is probably caused by concurrent writeFile calls on the same files.
If we take a look at the Default-88751.json file that is created, for example, which is a file for a Preset, the result is a weird "merge" of two presets:

• A preset named Default for the enterprise_group_cta blok
• A preset named Default for the link_board component

Making those requests synchronous would mean that we'd be getting well-formatted JSONs, but this doesn't solve the underlying issue: the CLI is not handling presets for different bloks that share the same name.

To solve this issue we should probably come up with a more refined naming strategy, or a folder-based structure.

Something like:

[PREFIX - blok name]-[preset name]-[spaceID].json

examples
link_board-Default-88751.json
enterprise_group_cta-Default-88751.json

or

[FOLDER - blok name, containing both blok schema and its presets]
    [preset name]-[spaceID].json
    [blok name]-[spaceID].json

examples
/link_board
  link_board-88751.json
  Default-88751.json
/enterprise_group_cta
  enterprise_group_cta-88751.json
  Default-88751.json

If this is going to be a breaking change (albeit a fix), we might consider taking some time to think about this whole naming update more thoroughly and group it with other breaking changes, so that we don't release a bunch of new majors, one for each breaking change.

[christianzoppi]

Hey @Edo-San, like we agreed in DM I added a parameter for the pull-components command to prefix the presets names with the name of the component. I updated also the readme file. I also stressed in the readme that in a future major release this will become the default behavior. Could you please test it with this parameter?

[Edo-San]

LGTM 👍 At this point, I don't think it's even necessary to swap writeFile with its sync counterpart but the end result is basically the same 😊 We can leave it as it is right now, knowing that this is going to be rewritten from the ground up, eventually.

[Edo-San]

Typo: compoentns instead of components

[christianzoppi]

Fixed, thank you!

[github-actions]

🎉 This PR is included in version 3.32.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀