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

optimise suboptimal code #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kurciqs
Copy link
Contributor

@kurciqs kurciqs commented Jun 11, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The recent changes to script.js focus on enhancing the table scrolling behavior. The primary modifications include transitioning from jQuery to vanilla JavaScript, optimizing the scrolling logic, and detecting support for sticky positioning. This refactor aims to improve performance, reduce dependencies, and simplify the codebase.

Changes

File Change Summary
script.js Replaced jQuery with vanilla JavaScript, optimized scrolling logic, and added support for sticky positioning detection. Removed obsolete functions and variables.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant script.js

    User->>Browser: Load Page
    Browser->>script.js: DOMContentLoaded Event
    script.js->>Browser: Check sticky positioning support
    alt Sticky Position Supported
        script.js->>Browser: Initialize sticky scrolling
    else
        script.js->>Browser: Initialize fallback scrolling
    end
    script.js->>Browser: Start periodic scrolling
Loading

Poem

In lines of code, a change unfolds,
From jQuery's grip, to vanilla it molds.
Tables now scroll with grace and ease,
Sticky support, a modern breeze.
Old functions gone, the clutter we cease,
Our script now dances, a refined masterpiece.
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 64724dd and 002888c.

Files selected for processing (1)
  • script.js (1 hunks)
Additional context used
Biome
script.js

[error] 35-35: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.


[error] 1-47: This function expression can be turned into an arrow function. (lint/complexity/useArrowFunction)

Function expressions that don't use this can be turned into arrow functions.
Safe fix: Use an arrow function instead.

Additional comments not posted (3)
script.js (3)

3-7: The implementation of isPositionStickySupported using modern JavaScript is correct and efficient.


9-15: The conditional handling for sticky position support is well-implemented and clear.


40-46: The setup for periodic scrolling in startScroll is correctly implemented.

Comment on lines +22 to +37
function _scroll() {
// Determine the height of the first cell in the table header
var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
var scrollAmount = topElement.getBoundingClientRect();
var backupScrollTop = table.scrollTop;
table.scrollTop += scrollAmount.height;

// console.log(scrollAmount.height);
// Check if the table has reached the bottom
if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
table.scrollTop = backupScrollTop;
// Clone the original table body and append it to the table
var newClonedBody = originalTableBody.cloneNode(true);
table.appendChild(newClonedBody);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Move the variable declaration to the top of the function to improve clarity and adhere to best practices.

- function _scroll() {
+ function _scroll() {
+    var newClonedBody;
     // Determine the height of the first cell in the table header
     var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
     var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
     var scrollAmount = topElement.getBoundingClientRect();
     var backupScrollTop = table.scrollTop;
     table.scrollTop += scrollAmount.height;

     // console.log(scrollAmount.height);
     // Check if the table has reached the bottom
     if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
         table.scrollTop = backupScrollTop;
         // Clone the original table body and append it to the table
-        var newClonedBody = originalTableBody.cloneNode(true);
+        newClonedBody = originalTableBody.cloneNode(true);
         table.appendChild(newClonedBody);
     }
 }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
function _scroll() {
// Determine the height of the first cell in the table header
var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
var scrollAmount = topElement.getBoundingClientRect();
var backupScrollTop = table.scrollTop;
table.scrollTop += scrollAmount.height;
// console.log(scrollAmount.height);
// Check if the table has reached the bottom
if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
table.scrollTop = backupScrollTop;
// Clone the original table body and append it to the table
var newClonedBody = originalTableBody.cloneNode(true);
table.appendChild(newClonedBody);
}
function _scroll() {
var newClonedBody;
// Determine the height of the first cell in the table header
var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
var scrollAmount = topElement.getBoundingClientRect();
var backupScrollTop = table.scrollTop;
table.scrollTop += scrollAmount.height;
// console.log(scrollAmount.height);
// Check if the table has reached the bottom
if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
table.scrollTop = backupScrollTop;
// Clone the original table body and append it to the table
newClonedBody = originalTableBody.cloneNode(true);
table.appendChild(newClonedBody);
}
}
Tools
Biome

[error] 35-35: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

Comment on lines +1 to 47
document.addEventListener('DOMContentLoaded', function() {

function isPositionStickySupported() {
var testElement = document.createElement('div');
testElement.style.position = 'sticky';
return testElement.style.position === 'sticky';
}

if (isPositionStickySupported()) {
console.log('position: sticky is supported');
// Add a class or perform some action
} else {
console.log('position: sticky is not supported');
// Fallback or other actions
}

var scrollSpeed = 1;
var scrollInterval = 65;
//
// setInterval(function () {
// var scrollTop = table.scrollTop();
// var scrollHeight = table.prop('scrollHeight');
// var visibleHeight = table.height();
//
// // Check if the scroll has reached near the end of the cloned table body
// if (scrollTop + visibleHeight >= scrollHeight - 20) {
var newClonedBody = originalTableBody.clone();
var newDivider = divider.clone();
table.append(newClonedBody);
table.append(newDivider);
// }
//
// table.animate()
//
// }, scrollInterval);
let counter = 1;
function FilipStupid() {
table.animate({
scrollTop: table.height() * (counter++)
}, 40000, 'linear', () => {
var newClonedBody = originalTableBody.clone();
var newDivider = divider.clone();
table.append(newClonedBody);
table.append(newDivider);
console.log("added new element")
});
FilipStupid();
var table = document.getElementById('scroll-table');
var originalTableBody = table.querySelector('tbody');
var divider = document.createElement('div');
divider.className = 'divider';

function _scroll() {
// Determine the height of the first cell in the table header
var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
var scrollAmount = topElement.getBoundingClientRect();
var backupScrollTop = table.scrollTop;
table.scrollTop += scrollAmount.height;

// console.log(scrollAmount.height);
// Check if the table has reached the bottom
if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
table.scrollTop = backupScrollTop;
// Clone the original table body and append it to the table
var newClonedBody = originalTableBody.cloneNode(true);
table.appendChild(newClonedBody);
}
}
FilipStupid();

function startScroll() {
_scroll(); // Initial scroll
setInterval(_scroll, 5000); // Set interval for periodic scrolling
}

// Call startScroll() to initiate scrolling
startScroll();
});
Copy link
Contributor

Choose a reason for hiding this comment

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

Convert function expression to arrow function for cleaner syntax.

- document.addEventListener('DOMContentLoaded', function() {
+ document.addEventListener('DOMContentLoaded', () => {
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
document.addEventListener('DOMContentLoaded', function() {
function isPositionStickySupported() {
var testElement = document.createElement('div');
testElement.style.position = 'sticky';
return testElement.style.position === 'sticky';
}
if (isPositionStickySupported()) {
console.log('position: sticky is supported');
// Add a class or perform some action
} else {
console.log('position: sticky is not supported');
// Fallback or other actions
}
var scrollSpeed = 1;
var scrollInterval = 65;
//
// setInterval(function () {
// var scrollTop = table.scrollTop();
// var scrollHeight = table.prop('scrollHeight');
// var visibleHeight = table.height();
//
// // Check if the scroll has reached near the end of the cloned table body
// if (scrollTop + visibleHeight >= scrollHeight - 20) {
var newClonedBody = originalTableBody.clone();
var newDivider = divider.clone();
table.append(newClonedBody);
table.append(newDivider);
// }
//
// table.animate()
//
// }, scrollInterval);
let counter = 1;
function FilipStupid() {
table.animate({
scrollTop: table.height() * (counter++)
}, 40000, 'linear', () => {
var newClonedBody = originalTableBody.clone();
var newDivider = divider.clone();
table.append(newClonedBody);
table.append(newDivider);
console.log("added new element")
});
FilipStupid();
var table = document.getElementById('scroll-table');
var originalTableBody = table.querySelector('tbody');
var divider = document.createElement('div');
divider.className = 'divider';
function _scroll() {
// Determine the height of the first cell in the table header
var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
var scrollAmount = topElement.getBoundingClientRect();
var backupScrollTop = table.scrollTop;
table.scrollTop += scrollAmount.height;
// console.log(scrollAmount.height);
// Check if the table has reached the bottom
if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
table.scrollTop = backupScrollTop;
// Clone the original table body and append it to the table
var newClonedBody = originalTableBody.cloneNode(true);
table.appendChild(newClonedBody);
}
}
FilipStupid();
function startScroll() {
_scroll(); // Initial scroll
setInterval(_scroll, 5000); // Set interval for periodic scrolling
}
// Call startScroll() to initiate scrolling
startScroll();
});
document.addEventListener('DOMContentLoaded', () => {
function isPositionStickySupported() {
var testElement = document.createElement('div');
testElement.style.position = 'sticky';
return testElement.style.position === 'sticky';
}
if (isPositionStickySupported()) {
console.log('position: sticky is supported');
// Add a class or perform some action
} else {
console.log('position: sticky is not supported');
// Fallback or other actions
}
var table = document.getElementById('scroll-table');
var originalTableBody = table.querySelector('tbody');
var divider = document.createElement('div');
divider.className = 'divider';
function _scroll() {
// Determine the height of the first cell in the table header
var rect = table.querySelector('thead tr').children[0].getBoundingClientRect();
var topElement = document.elementFromPoint(rect.left + 1, rect.bottom + 1);
var scrollAmount = topElement.getBoundingClientRect();
var backupScrollTop = table.scrollTop;
table.scrollTop += scrollAmount.height;
// console.log(scrollAmount.height);
// Check if the table has reached the bottom
if (table.scrollTop >= table.scrollHeight - table.clientHeight) {
table.scrollTop = backupScrollTop;
// Clone the original table body and append it to the table
var newClonedBody = originalTableBody.cloneNode(true);
table.appendChild(newClonedBody);
}
}
function startScroll() {
_scroll(); // Initial scroll
setInterval(_scroll, 5000); // Set interval for periodic scrolling
}
// Call startScroll() to initiate scrolling
startScroll();
});
Tools
Biome

[error] 35-35: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.


[error] 1-47: This function expression can be turned into an arrow function. (lint/complexity/useArrowFunction)

Function expressions that don't use this can be turned into arrow functions.
Safe fix: Use an arrow function instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant