search

WordPress / gutenberg

The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
https://wordpress.org/gutenberg/
Other
10.5k stars 4.19k forks source link

Mobile App: Avoid code references that create cyclic dependencies #27751

Open gziolo opened 3 years ago

gziolo commented 3 years ago

Originally reported by @rafaelgalani when working on #27414 - refactoring to replace the store name wth the exposed store definition for @wordpress/edit-post package. The related part of the comment:

The problem now looks like a cyclic dependency problem... Though I'm not sure of it. That is what I could understand by looking at the stack in the action's log:

FAIL packages/block-library/src/list/test/edit.native.js
  ● Test suite failed to run

    TypeError: Cannot read property 'SETTINGS_DEFAULTS' of undefined

 ---> at Object.SETTINGS_DEFAULTS (packages/block-editor/src/index.js:24:22)
      at Object.<anonymous> (packages/editor/src/store/defaults.js:25:5)
      at Object.<anonymous> (packages/editor/src/store/reducer.js:15:1)
      at Object.<anonymous> (packages/editor/src/store/reducer.native.js:14:1)
      at Object.<anonymous> (packages/editor/src/store/index.js:10:1)
      at Object.<anonymous> (packages/editor/src/index.native.js:13:1)
      at Object.<anonymous> (packages/edit-post/src/editor.native.js:12:1)
      at Object.<anonymous> (packages/edit-post/src/index.native.js:13:1)
      at Object.<anonymous> (packages/components/src/mobile/link-settings/index.native.js:10:1)
      at Object.<anonymous> (packages/components/src/index.native.js:78:1)
      at Object.<anonymous> (packages/rich-text/src/component/index.native.js:20:1)
      at Object.<anonymous> (packages/rich-text/src/index.js:37:1)
 ---> at Object.<anonymous> (packages/block-editor/src/index.js:4:1)   
      at Object.<anonymous> (packages/block-library/src/list/edit.js:6:1)
      at Object.<anonymous> (packages/block-library/src/list/test/edit.native.js:9:1)

There are some architectural issues in React Native files that this PR uncovers. The packages should depend on each other in the following direction:

There is also some mix in the picture as edit-post itself might be using one of the deeper dependencies directly, and so on.

We left hardcoded strings outside of the @wordpress/edit-post package and plan to fix all of the issues separately. There are other high-level packages: edit-site, edit-widgets, or edit-navigation that shouldn't be referenced in other parts of Gutenberg core as well.

Since @wordpress/edit-post is an entry point, it should never be the dependency of other core components (it's a different story for 3rd party plugins that customize UI). I'm aware it's a bit of gray area for stores as they are usually consumed inside components so basically it works. There is this issue though that codebase is tightly coupled to the specific screen - edit post. As soon as you will want to support other screens for things like a site, theme templates, or maybe post comments, it will become a blocker. We don't have a solid solution for that, so far we were using props or editor settings for passing down information where necessary. It feels like we need some sort of scope detection to make it more robust. If you have some ideas, I'm happy to hear your thoughts.

Packages to fix

You can search for core/edit-post string in the following packages to discover those issues:

All those packages should find a different way to obtain data from @wordpress/edit-post. /cc @Tug @hypest

geriux commented 5 months ago

@wordpress/components

Has been addressed in https://github.com/WordPress/gutenberg/pull/61102