Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hide System Field Updates in Record Page Timelines #6761

Open
Bonapara opened this issue Aug 28, 2024 · 6 comments
Open

Hide System Field Updates in Record Page Timelines #6761

Bonapara opened this issue Aug 28, 2024 · 6 comments
Labels
good first issue Good for newcomers scope: backend Issues that are affecting the backend side only size: short

Comments

@Bonapara
Copy link
Member

Current Behavior

Some system field updates are displayed in record page timelines. However, as they lack a FieldDisplay, no value appears near the field title.

CleanShot 2024-08-28 at 11 48 36

Desired Behavior

We shouldn't display system fields in the timeline.

@Bonapara Bonapara added scope: backend Issues that are affecting the backend side only size: short for experienced contributor labels Aug 28, 2024
@Faisal-imtiyaz123
Copy link
Contributor

@Bonapara I would like to work here.

@Bonapara
Copy link
Member Author

Sure @Faisal-imtiyaz123, thanks for contributing!

@charlesBochet
Copy link
Member

charlesBochet commented Sep 1, 2024

@Bonapara @FelixMalfait should we rather add a isAuditable on field level?

I don't like the isSystem one :p
We have a settings column on Fields, we plan to add things in it such as: isSearchable, we could add isAuditable there too

@FelixMalfait
Copy link
Member

@charlesBochet At the field-level it's a bit more subtle than isAuditable because we still want these fields to be audit-logged but we don't want the timelineActivity to display include them, so I'd advocate for a different name (isDisplayedInTimelineActivity or something like that).
But I don't see a case where a field would be displayed in the page, and wouldn't be displayed in the timeline.
So in my opinion, the field we should use here is the same we will introduce to replace most use-cases for isSystem (isDisplayed or something like that).
Bottom line is I think we should use isSystem

@charlesBochet
Copy link
Member

Okay I understand the reasoning! Let's go for isSystem as long as we don't have a better naming

@FelixMalfait
Copy link
Member

Changing to GoodFirstIssue as it shouldn't be too difficult.
We should filter out fields where isSystem = true in the diff.
Think about the edge case where just 1 field was changed (e.g. position was changed by dragging the item on the list view), then we don't want to create any timelineActivity.

Do it on the backend rather than on the frontend. I would probably do it in EntityEventsToDbListener

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers scope: backend Issues that are affecting the backend side only size: short
Projects
None yet
Development

No branches or pull requests

4 participants