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

fix: remove .map function that doesn't work in SSR support #94 #95

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

jason-capsule42
Copy link
Member

@jason-capsule42 jason-capsule42 commented Oct 31, 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

Fix the SSR issue in auro-table by replacing the .map function with .forEach and update tests to reflect these changes.

Bug Fixes:

  • Fix the issue with the .map function in server-side rendering (SSR) by replacing it with .forEach in the auro-table component.

Tests:

  • Update tests for auro-table to correctly select table columns and rows, ensuring compatibility with the new implementation.

@jason-capsule42 jason-capsule42 requested a review from a team as a code owner October 31, 2024 21:17
Copy link

sourcery-ai bot commented Oct 31, 2024

Reviewer's Guide by Sourcery

This PR fixes a server-side rendering (SSR) issue by replacing the .map function with .forEach in the table header rendering logic and adjusts the test suite's column selection approach to properly target table cells.

Updated class diagram for AuroTable component

classDiagram
    class AuroTable {
        - columnHeaders
        + renderTableHeader()
    }
    note for AuroTable "Replaced .map with .forEach in renderTableHeader method"
Loading

File-Level Changes

Change Details Files
Fixed SSR compatibility issue in table header rendering
  • Replaced Array.map() with Array.forEach() in table header template rendering
  • Modified header cell rendering implementation to ensure proper SSR support
src/auro-table.js
Updated test suite column selection logic
  • Changed column selector from 'th' to 'td' elements
  • Added row selection before getting columns
  • Updated column selection to target specific row index
test/auro-table.test.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 Oct 31, 2024
@jason-capsule42 jason-capsule42 linked an issue Oct 31, 2024 that may be closed by this pull request
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:

  • Using forEach here will break the table headers - forEach returns undefined while map returns the array of elements we need. (link)

Overall Comments:

  • Using .forEach() in the template literal won't work as it returns undefined. Consider using Array.from() or keeping .map() as it needs to return the transformed array.
  • The test changes appear incorrect - selecting columns from rows[1] looks at data cells (td) instead of header cells (th), which doesn't properly test the header rendering.
Here's what I looked at during the review
  • 🔴 General issues: 1 blocking issue
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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
test/auro-table.test.js Show resolved Hide resolved
@jason-capsule42 jason-capsule42 merged commit ce1d30e into master Oct 31, 2024
6 checks passed
@jason-capsule42 jason-capsule42 deleted the jbaker/removeMapFromTable branch October 31, 2024 21:33
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 31, 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.

.map function for headers breaks in SSR
3 participants