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

perf: refactor header generation #96

Merged
merged 1 commit into from
Nov 1, 2024

Conversation

jason-capsule42
Copy link
Member

@jason-capsule42 jason-capsule42 commented Nov 1, 2024

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Enhancements:

  • Refactor header generation logic in the AuroTable component to improve performance by extracting header creation into a separate method.

@jason-capsule42 jason-capsule42 requested a review from a team as a code owner November 1, 2024 02:45
Copy link

sourcery-ai bot commented Nov 1, 2024

Reviewer's Guide by Sourcery

The PR refactors the header generation in the AuroTable component by extracting it into a separate method. Instead of using lit-html template literals for header creation, the implementation now uses direct DOM manipulation for better performance. The header generation is triggered when the columnHeaders property changes.

Sequence diagram for header generation in AuroTable

sequenceDiagram
    participant User
    participant AuroTable
    participant DOM

    User->>AuroTable: Update columnHeaders
    AuroTable->>AuroTable: updated(changedProperties)
    AuroTable->>AuroTable: extractHeaders()
    AuroTable->>DOM: Clear existing headers
    AuroTable->>DOM: Create and append new headers
Loading

Updated class diagram for AuroTable component

classDiagram
    class AuroTable {
        +updated(changedProperties)
        +firstUpdated()
        -extractHeaders()
        -extractRows(columns, data)
        columnHeaders
        componentData
    }
    note for AuroTable "extractHeaders method added for header generation"
Loading

File-Level Changes

Change Details Files
Implement new header generation logic
  • Added new extractHeaders() method to handle header creation
  • Added updated() lifecycle method to trigger header extraction when columnHeaders change
  • Replaced lit-html template-based header generation with direct DOM manipulation
  • Simplified table template by removing header template logic
src/auro-table.js

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@jason-capsule42 jason-capsule42 self-assigned this Nov 1, 2024
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jason-capsule42 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider reverting to the original template literal implementation for header generation. Direct DOM manipulation with createElement is less idiomatic in lit-element and potentially less performant than letting lit-element handle the rendering through its template system.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/auro-table.js Show resolved Hide resolved
src/auro-table.js Show resolved Hide resolved
@jason-capsule42 jason-capsule42 force-pushed the jbaker/refactorHtmlGeneration branch from 2b751e1 to ffdab8d Compare November 1, 2024 02:49
@jason-capsule42
Copy link
Member Author

@sourcery-ai review

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @jason-capsule42 - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Use textContent instead of innerHTML for better security and performance (link)

Overall Comments:

  • Consider reverting to using Lit's template literal syntax (html``) instead of direct DOM manipulation. This would be more idiomatic, potentially more performant due to Lit's built-in optimizations, and easier to maintain.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🔴 Security: 1 blocking issue
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/auro-table.js Show resolved Hide resolved
src/auro-table.js Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit a3ba3e7 into master Nov 1, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the jbaker/refactorHtmlGeneration branch November 1, 2024 02:51
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants