fix: bookmark icon should be visible for unauthenticated user in article test suite

[JohnAllenTech]

✨ Codu Pull Request 💻

Fixes a flaky bookmark E2E test. No issue for this one

Pull Request details

• This was just faulty logic on my part. I thought the bookmark icons were not displayed to unauthenticated users but they actually are
• Reason this was passing but flaky was because the articles were not loaded in time before the test assertions. This resulted in them being 'hidden'

Any Breaking changes

• None

Associated Screenshots

Shows bookmark icon for unauthenticated user

[vercel]

@JohnAllenTech is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the Playwright test suite for the articles page. Key changes include the renaming of a test case regarding the bookmark article icon, reflecting a shift in expected behavior for unauthenticated users. A new test case has been added for authenticated users to verify the visibility of the bookmark icon. Additionally, an assertion was included to check for the visibility of the "Publish now" button during the article publishing process, enhancing the overall test coverage.

Changes

File	Change Summary
e2e/articles.spec.ts	- Renamed test case from "Should not show bookmark article icon" to "Should show bookmark article icon". - Added test case "Should show bookmark article icon" for authenticated users. - Added assertion to check visibility of "Publish now" button after article details are filled.

Possibly related PRs

• chore: added article creation e2e test #1139: This PR adds a new test case titled "Should write and publish an article" in the e2e/articles.spec.ts, which directly relates to the changes made in the main PR regarding the visibility of the "Publish now" button after filling in article details.
• chore: removed flaky test from article suite #1156: This PR modifies the e2e/articles.spec.ts to enhance the loading and visibility checks for articles, which aligns with the main PR's focus on testing the visibility of elements based on user authentication status.

Suggested labels

hacktoberfest-accepted, hacktoberfest

Suggested reviewers

• NiallJoeMaher

Poem

In the land of articles, bright and bold,
A bookmark icon's story unfolds.
For users logged in, it shines with glee,
While others just watch, as it should be.
With a button to publish, all set to go,
Testing our features, we make them glow! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

e2e/articles.spec.ts (2)

Line range hint 19-28: LGTM! Consider clarifying the test description.

The changes correctly align with the PR objectives, addressing the misunderstanding about bookmark icon visibility for unauthenticated users. The test now properly checks for the visibility of the bookmark icon.

Consider updating the test description to be more specific:

test("Should show bookmark article icon for unauthenticated users", async ({ page }) => {
  // ... (rest of the test remains the same)
});

This change would make the test's purpose clearer and distinguish it from the similar test for authenticated users.

---

167-170: LGTM! Consider adding a timeout for improved reliability.

The addition of this assertion enhances the test coverage for the article publishing workflow and can help prevent flaky tests by ensuring the "Publish now" button is visible before clicking.

To further improve reliability, consider adding a timeout to the assertion:

await expect(
  page.getByRole("button", { name: "Publish now" })
).toBeVisible({ timeout: 5000 });

This change would allow more time for the button to appear, which could be helpful in slower test environments.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 91c4627 and dbfce08.

📒 Files selected for processing (1)

• e2e/articles.spec.ts (3 hunks)

🧰 Additional context used

🔇 Additional comments (2)

e2e/articles.spec.ts (2)

Line range hint 19-28: Duplicate code segment.

This code segment is identical to the one reviewed earlier. No additional comments are necessary.

---

Line range hint 1-189: Overall, the changes effectively address the PR objectives and improve test coverage.

The modifications in this file successfully address the reported issue regarding bookmark icon visibility for unauthenticated users. The addition of a new test case for authenticated users and the extra assertion for the "Publish now" button visibility enhance the overall test coverage and robustness.

Key improvements:

1. Updated expectations for bookmark icon visibility in unauthenticated user tests.
2. Added a new test case to verify bookmark icon visibility for authenticated users.
3. Included an additional assertion to check "Publish now" button visibility during article publishing.

These changes should help reduce test flakiness and provide more accurate test results.

[NiallJoeMaher]

🌮

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
codu	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 20, 2024 9:26am