Project

General

Profile

User story #12740

Make conditions visible in the Technique editor

Added by Florian Heigl about 1 year ago. Updated 6 months ago.

Status:
Released
Priority:
N/A
Category:
Technique editor - UI/UX
Target version:
Suggestion strength:
User visibility:
Operational - other Techniques | Rudder settings | Plugins
Effort required:
Very Small
Tags:

Description

Hi,

I already suggested this a few times, and you also agreed times it would be useful. But probably there's no story for it so far which might be why it never happened:

If in the NCF editor a condition is set for method, there's no visual way to tell so if the "conditions" area is folder.
This is a workflow issue - there is not enough space on the screen, so we need to usually keep it folded.
But we might not be aware of the conditions we got until we unfold it.
If you got a few methods in the technique you need to go through all of them, etc.

I would be ieasiest if there was a somewhat-subtle-but-not-too-subtle color coding on the conditions/classes area if one is set (other than "any").

I suppose that is a 15 minute hack that would immediately help all users.

A smart bonus would be to scan all those conditions and then also flag in colour all return classes that are currently used somewhere.
(need to update on technique save, and now it's not a 15 min hack anymore. but you'd be 1/3 way to a full dependency graph though all of NCF)

Best wishes,
Flo


Subtasks

User story #13978: Add condition tooltip and upgrade all js dependenciesReleasedVincent MEMBRÉActions
Bug #13985: Style tests are failing on a new icon file formatReleasedVincent MEMBRÉActions

Associated revisions

Revision fe04d1d4 (diff)
Added by Vincent MEMBRÉ 7 months ago

Fixes #12740: Make conditionals visible / Make used classes visible

History

#1

Updated by François ARMAND about 1 year ago

  • Effort required set to Very Small
#2

Updated by François ARMAND about 1 year ago

  • Tracker changed from User story to Bug
  • Assignee set to Raphael GAUTHIER
  • Target version set to 4.1.13
  • Suggestion strength deleted (Want - This would make my life a lot easier but I can manage without)
  • Priority set to 0

I ok with it being called a bug because I'm pretty sure we already did something to make non default filter be immediatly visable, and it seems to not have worked out as expected.

#3

Updated by Benoît PECCATTE about 1 year ago

  • Severity set to Minor - inconvenience | misleading | easy workaround
  • User visibility changed from First impressions of Rudder to Getting started - demo | first install | level 1 Techniques
  • Priority changed from 0 to 79
#4

Updated by Benoît PECCATTE about 1 year ago

  • User visibility changed from Getting started - demo | first install | level 1 Techniques to Operational - other Techniques | Technique editor | Rudder settings
  • Priority changed from 79 to 61
#5

Updated by Vincent MEMBRÉ about 1 year ago

  • Target version changed from 4.1.13 to 4.1.14
#6

Updated by Benoît PECCATTE 12 months ago

  • Target version changed from 4.1.14 to 4.1.15
  • Priority changed from 61 to 60
#7

Updated by Vincent MEMBRÉ 9 months ago

  • Target version changed from 4.1.15 to 4.1.16
  • Priority changed from 60 to 58
#8

Updated by Vincent MEMBRÉ 9 months ago

  • Target version changed from 4.1.16 to 4.1.17
  • Priority changed from 58 to 57
#9

Updated by François ARMAND 8 months ago

  • Tags set to Sponsored
  • Priority changed from 57 to 0
#10

Updated by François ARMAND 8 months ago

  • User visibility changed from Operational - other Techniques | Technique editor | Rudder settings to Operational - other Techniques | Rudder settings | Plugins
  • Priority changed from 0 to 88
#11

Updated by Vincent MEMBRÉ 8 months ago

  • Target version changed from 4.1.17 to 4.1.18
  • Priority changed from 88 to 87
#12

Updated by François ARMAND 8 months ago

  • Tracker changed from Bug to User story
  • Target version changed from 4.1.18 to 4.3.8
  • Severity deleted (Minor - inconvenience | misleading | easy workaround)
  • Priority deleted (87)
#13

Updated by Vincent MEMBRÉ 7 months ago

  • Status changed from New to Pending technical review
  • Pull Request set to https://github.com/Normation/ncf/pull/881
#14

Updated by Vincent MEMBRÉ 7 months ago

Wip for now:

#15

Updated by Florian Heigl 7 months ago

From my end, already overkill. just give it a slighly different colour. The screen estate management of NCF is already pretty "challenged", your change increases use by 30%, meaning 30% less fits. Try around some more and imagine how to make it help you.

#16

Updated by Florian Heigl 7 months ago

Even changing the colour of the Arrow on the right would be sufficient.

#17

Updated by Vincent MEMBRÉ 7 months ago

Thanks for you feedback Florian !

Yes I also want to try some colors on condition/parameter, I think on the small 'title', don't yet which one ( I think some blue )

I'm also thinking of having the value on the same line than the 'title'

What still need to be done (but should be ok as v1, if v2 comes soon):

  • Add a way to expand the value at will (not display 4k value by default ... )

Things that have changes you can't see in a picture:

  • Fix the fact that you couldn't copy/paste the parameter ( and the new condition, they follow the same scheme) (js/css hell to make it selectable ...)
  • But on counterpart you can only drag/drop with left side (the ::: part), which is a common/basic way to indicate a draggable element, so i guess it's better (it was messing with the click action)

Next steps (this week, in another issue):

  • Remove some icons on the central part( up/down arrow which are useless since can drag/drop, windows/cog icons ... )
  • Add clone action to clone a generic method
  • I need to think about the way we select/edit a generic method, The arrow may be replaced by a pen "button"
  • Filter on generic methods
#18

Updated by François ARMAND 7 months ago

@florian: I think it's important to see the condition because one use case that is extremelly itchy right now is: I need to change the condition for that technique from "condA" to "condA.condB" (and then it happens it's more like "(condA.condB | condC).condD etc") and I need to be able, with just a glance, to see if al the cond are consistant or if I still messed up some of them".

Perhaps I'm more enclined to other to miss a copy and paste or forget if I changed something in three or the whole four methods (and on which), but it's extremelly important for me. And for that, I need to be able to see them all at once.

That being said, and to concure with @Vincent, we need to simplify the displaying of a technique so that the list of generic let the logic be much more apparent.

Idea: write nothing when no condition ; if a condition is present, add a "if: cond" before the method name, pehaps with some visual parenthesing (a border of color with the same color than the if ?)

#19

Updated by Vincent MEMBRÉ 7 months ago

Yes i do think we need to display the value.

(I also think we should change back to two columns, instead of three, and do the editing of a method in the middle section)

#20

Updated by Florian Heigl 7 months ago

@fanf I understand your reasoning, and it would be helpful.
But: I keep trying to get this simple change for 3 years now. The way I suggested takes away no screen estate.
Now you're suggesting to build it in a way that will get us A (but not in a highly visual way but one that requires a lot more reading and does NOT do the one main thing this was about: "highlight where it matters") but on the other end, B, you increase the amount of screen estate used meaning NCF will be even less usable as it is now.

This will NOT be an improvement.

#21

Updated by Vincent MEMBRÉ 7 months ago

Some progress on wip:

#22

Updated by Vincent MEMBRÉ 7 months ago

Current state:

#23

Updated by Vincent MEMBRÉ 7 months ago

  • Status changed from Pending technical review to Pending release
#24

Updated by Vincent MEMBRÉ 6 months ago

  • Subject changed from Make conditionals visible / Make used classes visible to Make conditions visible in the Technique editor
#25

Updated by Vincent MEMBRÉ 6 months ago

  • Status changed from Pending release to Released
This bug has been fixed in Rudder 4.3.8 and 5.0.4 which were released today.
Changelog
Changelog

Also available in: Atom PDF