!!!TASK: Remove plow-js #3306

grebaldi · 2022-12-22T16:20:38Z

solves: #3118

I'm moving from package to package. Until the last package is finished, this remains a WIP.

TODOs

Remove plow-js from @neos-project/neos-ui-sagas

Remove plow-js from @neos-project/neos-ui

This package registers plow-js as a runtime dependency for plugins. Removing plow from here will break every plugin that uses plow-js itself. ~~What do we do about that?~~ I think it's feasible to offer plugin vendors support with this. I con open PRs for the most common plugins that use plow in this manner. Everyone else needs to be warned in advance, while 9.0 needs to be released with proper instructions. If removing plow is not feasible, Plugin vendors basically only need to add plow-js as an explicit dependency and rebuild.
- Yoast.YoastSeoForNeos: TASK: Remove dependency on plow-js Yoast/Yoast-SEO-for-Neos#92
- Psmb.FlatNav: https://github.com/psmb/Psmb.FlatNav
- Psmb.SplitAdd: https://github.com/psmb/Psmb.SplitAdd
- Breadlesscode.SimpleEditorExtend: https://github.com/breadlesscode/neos-simple-editor-extend
- Visol.Neos.LinkClass: https://github.com/visol/Visol.Neos.LinkClass
Don't know how to test node tree presets
~~User impersonation needs testing~~
- works properly

ClientEval: in Inspector needs testing:

neos-ui/packages/neos-ui/src/Containers/RightSideBar/Inspector/index.js

Lines 155 to 160 in 1f4766c

    
           viewConfiguration = produce( 
        
               viewConfiguration, 
        
               draft => { 
        
                   return $set(newPath, evaluatedValue, draft); 
        
               } 
        
           );

(This is a bit funny, tbh 🙂 )

This is fixed in BUGFIX: fix interdependent properties in node creation dialog #3304

Remove plow-js from @neos-project/neos-ui-backend-connector
Remove plow-js from @neos-project/neos-ui-ckeditor5-bindings
- Tables aren't working atm (unrelated to this PR) -> this needs more testing once they work again (see: BUGFIX: Position tableCreationGrid absolutely #3321)
Remove plow-js from @neos-project/neos-ui-contentrepository
Remove plow-js from @neos-project/neos-ui-editors
- ~~RichTextEditor causes UI crash when formattingOptions are not configured (unrelated to this PR) -> this needs more testing once it works properly~~
  - Nope, that was me. Missed an optchain 🙈
- Don't know how to test MasterPluginEditor
- Don't know how to test PluginViewEditor
- Don't know how to test PluginViewsEditor
  - This one also doesn't seem to show up when configured (unrelated to this PR)
- Don't know how to test CreateNew decorator
- ~~Don't know how to~~ test LinkInputOptions ~~-> possibly dead code?~~
  - They work fine, but there's different trouble that I need to reproduce down to 7.3: BUG: (LinkInput) Warning: A component is changing an uncontrolled input of type undefined to be controlled. #3317
Remove plow-js from @neos-project/neos-ui-guest-frame
Remove plow-js from @neos-project/neos-ui-inspector

Remove plow-js from @neos-project/neos-ui-redux-store

This function is particularly problematic:

neos-ui/packages/neos-ui-redux-store/src/CR/Nodes/selectors.ts

Lines 241 to 246 in 1f4766c

    
           // TODO: deprecate 
        
           export const getPathInNode = (state: GlobalState, contextPath: NodeContextPath, propertyPath: any) => { 
        
               const node = $get(['cr', 'nodes', 'byContextPath', contextPath], state); 
        
               return $get(propertyPath, node); 
        
           };

I'll do the following:
- As it is stated in the TODO comment, I will add a deprecation warning (via console) for any caller of this function
- Remove the plow-js $get reference while retaining the functionality of getPathInNode through a manual replacement implementation
- Remove/Replace all references to getPathInNode from the Neos UI code base
- Change the TODO comment, so it states that getPathInNode is up for removal in v10

Remove plow-js from @neos-project/neos-ui-validators
Remove plow-js from @neos-project/neos-ui-views
- Need to understand views better, so documentation comes first (see: DOCS: Add reference documentation for inspector views neos-development-collection#3990)
- I'm using lodash.get to replace $get for data retrieval (as mentioned here: Remove PlowJS & immutable-js #3118 (comment))
Remove plow-js from @neos-project/react-ui-components
Rebase on 9.0, once present

mhsdesign · 2023-01-30T11:27:17Z

we could also merge this into 8.3 already and remove the extensibility export of plow starting with 9.0 ...

and due to plows frequent usage, the neos extensibility api could augment all plow methods with a deprecated warning, so plugin authors and users know what to expect with neos 9 :)

mhsdesign · 2023-02-20T19:39:33Z

Classes/Service/NodePolicyService.php

@@ -249,6 +249,8 @@ public function getDisallowedProperties(NodeInterface $node): array
        };

        $disallowedProperties = array_filter(array_keys($node->getNodeType()->getProperties()), $filter);
+        $disallowedProperties = array_values($disallowedProperties);


hi :D why has this been added?

array_filter leaves keys intact. Through json_encode this can lead to arrays being serialized as objects. array_values makes sure that we always end up with a strictly numerical array.

mhsdesign · 2023-02-20T19:48:12Z

id like to merge this before we tackle: #3217 as there will be (some easy to fix) merge conflicts. Im planning the css rename for 8.3 ...

also the earlier we merge, the more we can test ^^

mhsdesign · 2023-02-22T14:30:10Z

#3304 will result in a small merge conflict ;)

mhsdesign · 2023-03-06T13:17:26Z

it was discussed that PluginViewEditor will be deprecated with 8.3

mhsdesign · 2023-03-09T14:23:46Z

will resolve merge conflicts

mhsdesign · 2023-03-10T17:31:50Z

packages/neos-ui/src/Containers/RightSideBar/Inspector/index.js

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import {produce} from 'immer';
 import mapValues from 'lodash.mapvalues';
 import {connect} from 'react-redux';
-import {$get, $contains, $set} from 'plow-js';


biggest merge conflict was in this file (packages/neos-ui/src/Containers/RightSideBar/Inspector/index.js)

because of @JamesAlias and @markusguenther work

#3304
#2989

As you @grebaldi also did some refactoring here (extract preprocessViewConfiguration into evaluateExpression), i suspect we need to migrate this file again and start fresh

mhsdesign · 2023-03-21T07:22:54Z

packages/neos-ui-ckeditor5-bindings/src/manifest.config.js

 const addPlugin = (Plugin, isEnabled) => (ckEditorConfiguration, options) => {
    // we duplicate editorOptions here so it would be possible to write smth like `$get('formatting.sup')`
    if (!isEnabled || isEnabled(options.editorOptions, options)) {
-        ckEditorConfiguration.plugins = ckEditorConfiguration.plugins || [];
-        return $add('plugins', Plugin, ckEditorConfiguration);
+        return {
+            ...ckEditorConfiguration,
+            plugins: [
+                ...(ckEditorConfiguration.plugins ?? []),
+                Plugin
+            ]
+        };
    }
    return ckEditorConfiguration;
 };


Highlighting this addPlugin utility function for everyone migrating $add to normal js

grebaldi · 2023-05-03T14:41:28Z

Just noticed potential conflict with #3478 (I think #3478 should take precedence)

…w-js

mhsdesign

I did a full "by reading" review of this once and now seeing that the e2e tests also succeed i give this green light ;)

# Conflicts: # Classes/Service/NodePolicyService.php # packages/neos-ui-sagas/src/Changes/index.js # packages/neos-ui-sagas/src/Publish/index.js # packages/neos-ui/src/Containers/PrimaryToolbar/PublishDropDown/index.js

markusguenther

Updated the PR and resolved conflicts. Also tested the PR locally. Thanks to @grebaldi for all the work.

grebaldi linked an issue Dec 22, 2022 that may be closed by this pull request

Remove PlowJS & immutable-js #3118

Closed

8 tasks

TASK: Remove plow-js from @neos-project/neos-ui-sagas

8603b0c

grebaldi force-pushed the task/3118/remove-plow-js branch from 7020c93 to 8603b0c Compare December 22, 2022 16:32

TASK: Remove plow-js from @neos-project/neos-ui-backend-connector

171e8d0

grebaldi added 9.0 Technical debt labels Dec 24, 2022

grebaldi added 5 commits December 26, 2022 14:37

TASK: Remove plow-js from @neos-project/neos-ui-ckeditor5-bindings

a849341

TASK: Remove plow-js from @neos-project/neos-ui-contentrepository

5d6b9de

TASK: Remove plow-js from @neos-project/neos-ui-guest-frame

5366ff9

TASK: Remove plow-js from @neos-project/react-ui-components

6282a44

TASK: Remove plow-js from @neos-project/neos-ui-editors

4d1baf9

grebaldi force-pushed the task/3118/remove-plow-js branch from 10dd28a to 4d1baf9 Compare December 26, 2022 13:41

grebaldi added 3 commits December 26, 2022 15:20

TASK: Remove plow-js from @neos-project/neos-ui-validators

cf9a45c

TASK: Remove plow-js from @neos-project/neos-ui-inspector

eeb6b51

TASK: Remove plow-js from @neos-project/neos-ui-redux-store

9a47f88

grebaldi force-pushed the task/3118/remove-plow-js branch from 6cc67f9 to 9a47f88 Compare December 26, 2022 17:18

TASK: Remove plow-js from @neos-project/neos-ui

d64b583

grebaldi force-pushed the task/3118/remove-plow-js branch from 8ec508f to d64b583 Compare December 27, 2022 23:50

grebaldi mentioned this pull request Dec 30, 2022

TASK: Remove dependency on plow-js Yoast/Yoast-SEO-for-Neos#92

Merged

TASK: Remove plow-js from @neos-project/neos-ui-views

8adb3be

grebaldi mentioned this pull request Feb 14, 2023

BUGFIX: Lazy-Load focused node, if it's not fully loaded yet #3364

Merged

mhsdesign reviewed Feb 20, 2023

View reviewed changes

mhsdesign mentioned this pull request Feb 20, 2023

TASK: Script: Rename all import style from "./style.css" to style.module.css #3217

Merged

Merge remote-tracking branch 'origin/8.3' into task/3118/remove-plow-js

02ef655

github-actions bot added the 8.3 label Mar 10, 2023

mhsdesign reviewed Mar 10, 2023

View reviewed changes

mhsdesign mentioned this pull request Mar 10, 2023

TASK: 8.3 Deprecate plow ($get, /\$[a-z]+\) in plugins #3425

Closed

mhsdesign reviewed Mar 21, 2023

View reviewed changes

markusguenther changed the base branch from 8.3 to 9.0 April 11, 2023 11:29

markusguenther removed the 8.3 label Apr 11, 2023

Merge remote-tracking branch 'upstream/8.3' into task/3118/remove-plo…

29336f2

…w-js

grebaldi mentioned this pull request Jun 23, 2023

FEATURE: add ButtonEditor as new editor #3475

Open

grebaldi mentioned this pull request Jul 3, 2023

BUGFIX: 3557 placeholder plugin with autoparagraph false #3558

Merged

mhsdesign mentioned this pull request Jul 15, 2023

TASK: cleanup imports of components #3465

Merged

grebaldi mentioned this pull request Aug 17, 2023

TASK: Make E2E tests work for Neos 9.0 #3569

Merged

37 tasks

grebaldi added 3 commits September 28, 2023 17:41

Merge branch '9.0' into task/3118/remove-plow-js

84e9302

TASK: Remove remaining references to plow-js after 9.0 merge

c5a28f2

TASK: Satisfy linter

425dd42

grebaldi marked this pull request as ready for review September 28, 2023 16:30

grebaldi changed the title ~~WIP: !!!TASK: Remove plow-js~~ !!!TASK: Remove plow-js Sep 28, 2023

mhsdesign approved these changes Sep 29, 2023

View reviewed changes

markusguenther approved these changes Nov 9, 2023

View reviewed changes

TASK: Allow development versions for CI

f34f62c

markusguenther force-pushed the task/3118/remove-plow-js branch from 87fa293 to f34f62c Compare November 9, 2023 13:48

mhsdesign merged commit 66889e3 into neos:9.0 Nov 9, 2023
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

!!!TASK: Remove plow-js #3306

!!!TASK: Remove plow-js #3306

grebaldi commented Dec 22, 2022 •

edited

Loading

mhsdesign commented Jan 30, 2023 •

edited

Loading

mhsdesign Feb 20, 2023

grebaldi Mar 13, 2023

mhsdesign commented Feb 20, 2023

mhsdesign commented Feb 22, 2023

mhsdesign commented Mar 6, 2023

mhsdesign commented Mar 9, 2023

mhsdesign Mar 10, 2023

mhsdesign Mar 13, 2023

mhsdesign Mar 21, 2023

grebaldi commented May 3, 2023

mhsdesign left a comment

markusguenther left a comment

	viewConfiguration = produce(
	viewConfiguration,
	draft => {
	return $set(newPath, evaluatedValue, draft);
	}
	);

	// TODO: deprecate
	export const getPathInNode = (state: GlobalState, contextPath: NodeContextPath, propertyPath: any) => {
	const node = $get(['cr', 'nodes', 'byContextPath', contextPath], state);

	return $get(propertyPath, node);
	};

!!!TASK: Remove plow-js #3306

!!!TASK: Remove plow-js #3306

Conversation

grebaldi commented Dec 22, 2022 • edited Loading

TODOs

mhsdesign commented Jan 30, 2023 • edited Loading

mhsdesign Feb 20, 2023

Choose a reason for hiding this comment

grebaldi Mar 13, 2023

Choose a reason for hiding this comment

mhsdesign commented Feb 20, 2023

mhsdesign commented Feb 22, 2023

mhsdesign commented Mar 6, 2023

mhsdesign commented Mar 9, 2023

mhsdesign Mar 10, 2023

Choose a reason for hiding this comment

mhsdesign Mar 13, 2023

Choose a reason for hiding this comment

mhsdesign Mar 21, 2023

Choose a reason for hiding this comment

grebaldi commented May 3, 2023

mhsdesign left a comment

Choose a reason for hiding this comment

markusguenther left a comment

Choose a reason for hiding this comment

grebaldi commented Dec 22, 2022 •

edited

Loading

mhsdesign commented Jan 30, 2023 •

edited

Loading