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

Bug 2014161: Fix pipeline run logs autoscrolling issue #11056

Merged

Conversation

karthikjeeyar
Copy link
Contributor

Fixes:

https://issues.redhat.com/browse/OCPBUGSM-36824

Analysis / Root cause:

High volume of data streaming into the logs components, causes too many calls to scrollIntoView method. It results failure to autoscroll to the latest content and sometimes the browser goes unresponsive.

Solution Description:

Added throttling to the append the content to the dom and to scroller function.

Screen shots / Gifs for design review:

piepline-logs-autoscroll.mov

Unit test coverage report:

No tests changed.

Test setup:

  1. Import an application with pipeline option enabled in Import from Git flow (use: https://github.com/alexeykazakov/spring-petclinic)
  2. Go to pipelinerun logs page.

Browser conformance:

  • Chrome
  • Firefox
  • Safari
  • Edge

@openshift-ci openshift-ci bot added component/pipelines Related to pipelines-plugin approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Feb 15, 2022
blockContentRef.current = '';
}, 300);

const contentScrollerRef = React.useRef<() => void>(addContentAndScroll);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need a ref for a throttled function?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ref is not needed and I have updated the code to use useCallback.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 22, 2022

@karthikjeeyar: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@karthikjeeyar karthikjeeyar changed the title Fix pipeline run logs autoscrolling issue Bug 2014161: Fix pipeline run logs autoscrolling issue Feb 22, 2022
@openshift-ci openshift-ci bot added bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. labels Feb 22, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 22, 2022

@karthikjeeyar: This pull request references Bugzilla bug 2014161, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.11.0) matches configured target release for branch (4.11.0)
  • bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @sanketpathak

In response to this:

Bug 2014161: Fix pipeline run logs autoscrolling issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Contributor

@rohitkrai03 rohitkrai03 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@rohitkrai03
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 22, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 22, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: karthikjeeyar, rohitkrai03

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 85c8201 into openshift:master Feb 22, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 22, 2022

@karthikjeeyar: All pull requests linked via external trackers have merged:

Bugzilla bug 2014161 has been moved to the MODIFIED state.

In response to this:

Bug 2014161: Fix pipeline run logs autoscrolling issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@karthikjeeyar
Copy link
Contributor Author

/cherry-pick release-4.10

@openshift-cherrypick-robot

@karthikjeeyar: new pull request created: #11092

In response to this:

/cherry-pick release-4.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. component/pipelines Related to pipelines-plugin lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants