Add rename variable feature #733

wwqrd · 2021-09-08T14:44:50Z

Updates codebook and inline variable selection to include a rename variable dialog.

Delete button in codebook has been changed to an icon to create more room for the rename button.

Rename dialog

Codebook view

Inline view

Resolves #732

rebeccamadsen · 2021-09-15T16:20:13Z

Renaming variables is generally working well for me! There were just a few places that editing the variable name was allowed, but it did not trigger a save for the stage so didn't take:

additional variables
layout variables (sociogram and narrative)
toggle variables (sociogram).

And there are a few places that variables cannot be renamed but maybe could be:

edge selection (dyad census, tie-strength, sociogram)
group variable (narrative)

Editing from the codebook worked for all the variables, though!

When navigating to the codebook, I saw these three warnings:

index.js:1 Warning: Failed prop type: The prop `type` is marked as required in `Variables`, but its value is `undefined`.
    in Variables (created by withProps(Variables))
    in withProps(Variables) (created by withStateHandlers(withProps(Variables)))
    in withStateHandlers(withProps(Variables)) (created by withHandlers(withStateHandlers(withProps(Variables))))
    in withHandlers(withStateHandlers(withProps(Variables))) (created by ConnectFunction)
    in ConnectFunction (created by EgoType)
    in div (created by EgoType)
    in div (created by EgoType)
    in EgoType (created by ConnectFunction)
    in ConnectFunction (created by Codebook)
    in div (created by CodebookCategory)
    in div (created by Section)
    in Section (created by CodebookCategory)
    in CodebookCategory (created by Codebook)
    in div (created by Codebook)
    in Codebook (created by ConnectFunction)
    in ConnectFunction (created by CodebookScreen)
    in div (created by Layout)
    in Layout (created by CodebookScreen)
    in CardErrorBoundary (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in Screen (created by withContext(Screen))
    in withContext(Screen) (created by withState(withContext(Screen)))
    in withState(withContext(Screen)) (created by CodebookScreen)
    in CodebookScreen (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in Screens (created by () => `Window(${getDisplayName(WrappedComponent)})`)
    in () => `Window(${getDisplayName(WrappedComponent)})` (created by getContext(() => `Window(${getDisplayName(WrappedComponent)})`))
    in getContext(() => `Window(${getDisplayName(WrappedComponent)})`) (created by ConnectFunction)
    in ConnectFunction (created by Routes)
    in Routes (created by AppView)
    in AppErrorBoundary (created by AppView)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by AppView)
    in AppView (created by Context.Consumer)
    in Route (created by ViewManager)
    in Switch (created by ViewManager)
    in Router (created by HashRouter)
    in HashRouter (created by ViewManager)
    in ViewManager
    in PersistGate
    in Provider

index.js:1 Warning: Failed prop type: The prop `type` is marked as required in `ControlsColumn`, but its value is `undefined`.
    in ControlsColumn (created by Variables)
    in Variables (created by withProps(Variables))
    in withProps(Variables) (created by withStateHandlers(withProps(Variables)))
    in withStateHandlers(withProps(Variables)) (created by withHandlers(withStateHandlers(withProps(Variables))))
    in withHandlers(withStateHandlers(withProps(Variables))) (created by ConnectFunction)
    in ConnectFunction (created by EgoType)
    in div (created by EgoType)
    in div (created by EgoType)
    in EgoType (created by ConnectFunction)
    in ConnectFunction (created by Codebook)
    in div (created by CodebookCategory)
    in div (created by Section)
    in Section (created by CodebookCategory)
    in CodebookCategory (created by Codebook)
    in div (created by Codebook)
    in Codebook (created by ConnectFunction)
    in ConnectFunction (created by CodebookScreen)
    in div (created by Layout)
    in Layout (created by CodebookScreen)
    in CardErrorBoundary (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in Screen (created by withContext(Screen))
    in withContext(Screen) (created by withState(withContext(Screen)))
    in withState(withContext(Screen)) (created by CodebookScreen)
    in CodebookScreen (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in Screens (created by () => `Window(${getDisplayName(WrappedComponent)})`)
    in () => `Window(${getDisplayName(WrappedComponent)})` (created by getContext(() => `Window(${getDisplayName(WrappedComponent)})`))
    in getContext(() => `Window(${getDisplayName(WrappedComponent)})`) (created by ConnectFunction)
    in ConnectFunction (created by Routes)
    in Routes (created by AppView)
    in AppErrorBoundary (created by AppView)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by AppView)
    in AppView (created by Context.Consumer)
    in Route (created by ViewManager)
    in Switch (created by ViewManager)
    in Router (created by HashRouter)
    in HashRouter (created by ViewManager)
    in ViewManager
    in PersistGate
    in Provider

index.js:1 Warning: Failed prop type: The prop `type` is marked as required in `RenameVariableControl`, but its value is `undefined`.
    in RenameVariableControl (created by ConnectFunction)
    in ConnectFunction (created by ControlsColumn)
    in ControlsColumn (created by Variables)
    in td (created by Variables)
    in tr (created by Variables)
    in tbody (created by Variables)
    in table (created by Variables)
    in div (created by Variables)
    in Variables (created by withProps(Variables))
    in withProps(Variables) (created by withStateHandlers(withProps(Variables)))
    in withStateHandlers(withProps(Variables)) (created by withHandlers(withStateHandlers(withProps(Variables))))
    in withHandlers(withStateHandlers(withProps(Variables))) (created by ConnectFunction)
    in ConnectFunction (created by EgoType)
    in div (created by EgoType)
    in div (created by EgoType)
    in EgoType (created by ConnectFunction)
    in ConnectFunction (created by Codebook)
    in div (created by CodebookCategory)
    in div (created by Section)
    in Section (created by CodebookCategory)
    in CodebookCategory (created by Codebook)
    in div (created by Codebook)
    in Codebook (created by ConnectFunction)
    in ConnectFunction (created by CodebookScreen)
    in div (created by Layout)
    in Layout (created by CodebookScreen)
    in CardErrorBoundary (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in Screen (created by withContext(Screen))
    in withContext(Screen) (created by withState(withContext(Screen)))
    in withState(withContext(Screen)) (created by CodebookScreen)
    in CodebookScreen (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in Screens (created by () => `Window(${getDisplayName(WrappedComponent)})`)
    in () => `Window(${getDisplayName(WrappedComponent)})` (created by getContext(() => `Window(${getDisplayName(WrappedComponent)})`))
    in getContext(() => `Window(${getDisplayName(WrappedComponent)})`) (created by ConnectFunction)
    in ConnectFunction (created by Routes)
    in Routes (created by AppView)
    in AppErrorBoundary (created by AppView)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by AppView)
    in AppView (created by Context.Consumer)
    in Route (created by ViewManager)
    in Switch (created by ViewManager)
    in Router (created by HashRouter)
    in HashRouter (created by ViewManager)
    in ViewManager
    in PersistGate
    in Provider

This showed up when navigating to a name generator stage and an ego stage, and an alter form stage. So probably unrelated?

index.js:1 Warning: Failed prop type: Invalid prop `item` of type `object` supplied to `OrderedList`, expected `function`.
    in OrderedList (created by sortableList(OrderedList))
    in sortableList(OrderedList) (created by withHandlers(sortableList(OrderedList)))
    in withHandlers(sortableList(OrderedList)) (created by renameProp(withHandlers(sortableList(OrderedList))))
    in renameProp(withHandlers(sortableList(OrderedList))) (created by defaultProps(renameProp(withHandlers(sortableList(OrderedList)))))
    in defaultProps(renameProp(withHandlers(sortableList(OrderedList)))) (created by ConnectedFieldArray)
    in ConnectedFieldArray (created by ConnectFunction)
    in ConnectFunction (created by Connect(ConnectedFieldArray))
    in Connect(ConnectedFieldArray) (created by FieldArray)
    in FieldArray (created by Context.Consumer)
    in Hoc (created by FieldArray)
    in FieldArray (created by Validated)
    in Validated (created by EditableList)
    in div (created by EditableList)
    in div (created by EditableList)
    in div (created by l)
    in l (created by EditableList)
    in div (created by Section)
    in Section (created by EditableList)
    in EditableList (created by ConnectFunction)
    in ConnectFunction (created by withHandlers(Connect(EditableList)))
    in withHandlers(Connect(EditableList)) (created by withStateHandlers(withHandlers(Connect(EditableList))))
    in withStateHandlers(withHandlers(Connect(EditableList))) (created by ConnectFunction)
    in ConnectFunction (created by defaultProps(Connect(withStateHandlers(withHandlers(Connect(EditableList))))))
    in defaultProps(Connect(withStateHandlers(withHandlers(Connect(EditableList))))) (created by defaultProps(defaultProps(Connect(withStateHandlers(withHandlers(Connect(EditableList)))))))
    in defaultProps(defaultProps(Connect(withStateHandlers(withHandlers(Connect(EditableList)))))) (created by Form)
    in div (created by Section)
    in Section (created by Form)
    in Form (created by withProps(Form))
    in withProps(Form) (created by withProps(withProps(Form)))
    in withProps(withProps(Form)) (created by withHandlers(withProps(withProps(Form))))
    in withHandlers(withProps(withProps(Form))) (created by ConnectFunction)
    in ConnectFunction (created by ConnectFunction)
    in ConnectFunction (created by Editor)
    in div (created by Layout)
    in Layout (created by Editor)
    in form (created by Form)
    in Form (created by Context.Consumer)
    in Hoc (created by Form)
    in Form (created by Editor)
    in Editor (created by ConnectFunction)
    in ConnectFunction (created by Form(Connect(Editor)))
    in Form(Connect(Editor)) (created by ConnectFunction)
    in ConnectFunction (created by Connect(Form(Connect(Editor))))
    in Connect(Form(Connect(Editor))) (created by ReduxForm)
    in ReduxForm (created by Context.Consumer)
    in Hoc (created by ReduxForm)
    in ReduxForm (created by withStateHandlers(ReduxForm))
    in withStateHandlers(ReduxForm) (created by StageEditor)
    in StageEditor (created by withHandlers(StageEditor))
    in withHandlers(StageEditor) (created by ConnectFunction)
    in ConnectFunction (created by ConnectFunction)
    in ConnectFunction (created by defaultProps(Connect(Connect(withHandlers(StageEditor)))))
    in defaultProps(Connect(Connect(withHandlers(StageEditor)))) (created by Screen)
    in CardErrorBoundary (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in div (created by Screen)
    in Screen (created by withContext(Screen))
    in withContext(Screen) (created by withState(withContext(Screen)))
    in withState(withContext(Screen)) (created by EditorScreen)
    in EditorScreen (created by ConnectFunction)
    in ConnectFunction (created by withProps(Connect(EditorScreen)))
    in withProps(Connect(EditorScreen)) (created by withHandlers(withProps(Connect(EditorScreen))))
    in withHandlers(withProps(Connect(EditorScreen))) (created by ConnectFunction)
    in ConnectFunction (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by Screens)
    in Screens (created by () => `Window(${getDisplayName(WrappedComponent)})`)
    in () => `Window(${getDisplayName(WrappedComponent)})` (created by getContext(() => `Window(${getDisplayName(WrappedComponent)})`))
    in getContext(() => `Window(${getDisplayName(WrappedComponent)})`) (created by ConnectFunction)
    in ConnectFunction (created by Routes)
    in Routes (created by AppView)
    in AppErrorBoundary (created by AppView)
    in div (created by ForwardRef(MotionComponent))
    in ForwardRef(MotionComponent) (created by AppView)
    in AppView (created by Context.Consumer)
    in Route (created by ViewManager)
    in Switch (created by ViewManager)
    in Router (created by HashRouter)
    in HashRouter (created by ViewManager)
    in ViewManager
    in PersistGate
    in Provider

…reen

wwqrd · 2021-09-28T11:01:01Z

Thanks for this feedback!

Renaming variables is generally working well for me! There were just a few places that editing the variable name was allowed, but it did not trigger a save for the stage so didn't take:

This was an interesting one, as normally that's controlled by the form "dirty" state, but variable names are edited directly in the protocol. I updated it to detect when the locus point (a pointer to the last place in the protocol history before the screen was opened), is no longer the last point in the protocol history. This feature is used for the "cancel" button, so I think it's reasonably coherent conceptually. However, it does look a bit weird when you have a prompt open, which has it's own save/cancel buttons, and the main screen finish editing button is displayed - any thoughts?

Additionally in working on this feature I discovered quite a big bug in the history/rewind feature (a redux enhancer). It was considering any action as a change to snapshot instead of only changes to the protocol (the intent), that means the entire protocol state was being duplicated multiple times for any redux-form actions (which there are quite a lot of!). Performance has been improved, and the history object is much slimmer. I am concerned that there could be other knock on effects, but there is no reason for that to be the case unless there is some unusual behaviour somewhere that I've forgotten about.

And there are a few places that variables cannot be renamed but maybe could be:

I've added this feature to the narrative group variable.

I might be misunderstanding, but the edge selection doesn't involve variables (though the UI is very similar so it does seem like a similar feature would fit here).

rebeccamadsen · 2021-09-28T18:05:10Z

I agree that it looks a bit weird when the "finished editing" button pops up while still having the prompt open. More than once I clicked on "finished editing" instead of the "save and close". Sounds like a tricky issue though! It definitely needs to trigger a save, but it'd be nice not to do so until the prompt closes, like the other prompt edits would. Is there a way to do that, or is that too involved?

Good find with the history/rewind bug! I'll let you know if I come across any oddities. I haven't yet, so fingers crossed.

Good point about how the edge selection is different from variables...at the level of the node type. The UI similarities made me forget that distinction. It sounds to me like a separate issue if we decide we want that also.

jthrilly · 2021-10-04T15:54:30Z

It definitely needs to trigger a save, but it'd be nice not to do so until the prompt closes, like the other prompt edits would. Is there a way to do that, or is that too involved?

Any thoughts, @wwqrd?

wwqrd · 2021-10-05T09:50:18Z

It definitely needs to trigger a save, but it'd be nice not to do so until the prompt closes, like the other prompt edits would. Is there a way to do that, or is that too involved?

This change has also retrospectively impacted some other features - like inline variable creation (also seen as a change in protocol)

I'd be tempted to find a way to disable those controls until the sub window is closed.

jthrilly · 2021-10-08T09:21:10Z

I'm working on something for this, so please don't merge for now.

wwqrd · 2021-12-20T16:35:41Z

Superseded by: #738

wwqrd added 30 commits August 4, 2021 17:19

Add preview button in asset browser

59e1aac

window

da4f87a

Show network asset

dc2324b

Add download

66000c2

WIP

b4a055b

Download from asset thumbnail

bd69f60

Style asset controls

072ac93

Style preview contents

33e18f8

Display and style video and audio

c9820b7

Lint scss/js

8105355

Style preview window

8d81adc

React table for data

94a36b8

Style table

013261e

Lint scss/js

cd8611d

Prevent linebreak in headings and enlarge sort direction icon

39691c6

Rename dialog box

f7ee727

Working rename form

806682c

User can update variable name

7e78cca

Generalize Link

862bc17

Rename link

6950a99

Rename button

1802005

Lint

c37b18f

Fix variable button to update callback when id changes.

745a095

Add variable renamer to VariableSelect

705700a

Add variable edit prop to all uses of VariableSelect

1e0dfeb

Lint

413c271

Rename RenameVariableControl

6b42be8

Add variable name validation

d3bc06c

Add style for VariableSelect

2b3fb31

Icon buttons for Variable section of Codebook

978f33f

wwqrd added 2 commits September 8, 2021 13:54

Style contextual dialog

b6242a8

Lint

a061762

wwqrd requested a review from rebeccamadsen September 9, 2021 15:35

wwqrd added 2 commits September 27, 2021 12:14

Make type prob optional in Codebook/Variables

106d53b

Any protocol change should trigger 'save changes' button on editor sc…

4e8b5b1

…reen

wwqrd mentioned this pull request Sep 28, 2021

Improved new stage screen #734

Merged

3 tasks

wwqrd added 2 commits September 28, 2021 11:41

Remove console log

0c9d703

Add variable rename to group variable in Narrative screen

b38adef

wwqrd added 2 commits September 28, 2021 12:10

Fix timeline test

107e3fe

Refactor timeline selectors

33561a9

wwqrd closed this Dec 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add rename variable feature #733

Add rename variable feature #733

wwqrd commented Sep 8, 2021

rebeccamadsen commented Sep 15, 2021

wwqrd commented Sep 28, 2021 •

edited

Loading

rebeccamadsen commented Sep 28, 2021

jthrilly commented Oct 4, 2021

wwqrd commented Oct 5, 2021

jthrilly commented Oct 8, 2021

wwqrd commented Dec 20, 2021

Add rename variable feature #733

Add rename variable feature #733

Conversation

wwqrd commented Sep 8, 2021

rebeccamadsen commented Sep 15, 2021

wwqrd commented Sep 28, 2021 • edited Loading

rebeccamadsen commented Sep 28, 2021

jthrilly commented Oct 4, 2021

wwqrd commented Oct 5, 2021

jthrilly commented Oct 8, 2021

wwqrd commented Dec 20, 2021

wwqrd commented Sep 28, 2021 •

edited

Loading