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.

Sign up for GitHub

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

Jump to bottom

chore(cypress): test public evaluation links with hmac in live quiz test workflow #4430

Merged
merged 1 commit into from
Jan 3, 2025
Merged

chore(cypress): test public evaluation links with hmac in live quiz test workflow #4430

merged 1 commit into from
Jan 3, 2025

Conversation

sjschlapbach
Copy link
Member

@sjschlapbach sjschlapbach commented Jan 3, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Enhanced link generation for live quiz embedding with more specific identifiers
    • Improved tracking and testing capabilities for public evaluation links

  • Tests

    • Added comprehensive Cypress test for verifying public evaluation links in live quizzes
    • Test covers generic evaluation, question-specific, and leaderboard link functionality

@aviator-app Aviator app
Copy link

aviator-app bot commented Jan 3, 2025 •
edited
Loading

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged manually (without Aviator). Merging manually can negatively impact the performance of the queue. Consider using Aviator next time.

See the real-time status of this PR on the Aviator webapp.
Use the Aviator Chrome Extension to see the status of your PR within GitHub.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 3, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the LazyHMACLink function across multiple files in the frontend components. The primary change is adding a new identifier parameter to the function signature in both frontend-control and frontend-manage components. This modification allows for more specific data-cy attribute generation for testing purposes. Additionally, a new Cypress end-to-end test case has been added to verify the functionality of public evaluation links for live quizzes, ensuring that the links can be accessed and display the correct content.

Changes

File Change Summary
apps/frontend-control/src/components/liveQuizzes/EmbeddingModal.tsx Updated LazyHMACLink function signature to include identifier parameter; modified data-cy attribute generation
apps/frontend-manage/src/components/liveQuiz/EmbeddingModal.tsx Updated LazyHMACLink function signature to include identifier parameter; modified data-cy attribute generation
cypress/cypress/e2e/F-live-quiz-workflow.cy.ts Added new test case to verify public evaluation links for live quizzes

Possibly related PRs

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4c6760 and 181373f.

📒 Files selected for processing (3)
  • apps/frontend-control/src/components/liveQuizzes/EmbeddingModal.tsx (3 hunks)
  • apps/frontend-manage/src/components/liveQuiz/EmbeddingModal.tsx (5 hunks)
  • cypress/cypress/e2e/F-live-quiz-workflow.cy.ts (1 hunks)
🔇 Additional comments (10)
apps/frontend-control/src/components/liveQuizzes/EmbeddingModal.tsx (4)

19-27: Great introduction of the identifier parameter.
This expanded signature provides clear support for specifying unique data-cy attributes for testing. Nicely done!

52-52: Using identifier in the data-cy attribute is a neat improvement.
This helps differentiate evaluation links more precisely for test automation.

102-106: Ensure consistency in naming and usage of identifier.
All usage patterns here look consistent. Just verify that any references to "question-${ix}" are properly tested and documented.

114-118: Good usage for the leaderboard embedding link.
This improves clarity and specificity of data-cy references for the leaderboard.

apps/frontend-manage/src/components/liveQuiz/EmbeddingModal.tsx (5)

13-21: Similar changes for the identifier parameter here maintain parity.
It’s good to see the code remain consistent between frontend-control and frontend-manage.

48-48: Excellent approach to building the data-cy attribute dynamically.
Using identifier fosters a clean and maintainable testing strategy.

105-109: Adopting identifier="generic-evaluation" is well-organized.
Naming is clear, and it should be straightforward for QA engineers to target this element.

124-124: Appending index-based question identifiers.
This approach is consistent and makes it easy to track which question is under evaluation.

136-136: Leaderboard data-cy reference is explicit and consistent.
All usage points are now aligned with the new parameter signature.

cypress/cypress/e2e/F-live-quiz-workflow.cy.ts (1)

915-976: Complete and robust e2e coverage for public evaluation links.
The newly added test effectively validates the new identifier parameter usage by verifying the generated links for evaluation, specific questions, and leaderboard. This ensures thorough coverage of the newly introduced behavior.

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Jan 3, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@cypress Cypress
Copy link

cypress bot commented Jan 3, 2025

klicker-uzh    Run #3917

Run Properties:  status check passed Passed #3917  •  git commit f0cf253702 ℹ️: Merge 181373ff35ee111fb1b9766f9ae926810be176ac into f4c67601f1c5c8e3d435141e2507...
Project klicker-uzh
Branch Review test-public-evaluation-links
Run status status check passed Passed #3917
Run duration 13m 17s
Commit git commit f0cf253702 ℹ️: Merge 181373ff35ee111fb1b9766f9ae926810be176ac into f4c67601f1c5c8e3d435141e2507...
Committer Julius Schlapbach
View all properties for this run ↗︎
Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 173
View all changes introduced in this branch ↗︎

@sjschlapbach sjschlapbach merged commit 0fc153c into v3 Jan 3, 2025
16 checks passed
@sjschlapbach sjschlapbach deleted the test-public-evaluation-links branch January 3, 2025 13:32
@cypress Cypress
Copy link

cypress bot commented Jan 3, 2025

klicker-uzh    Run #3918

Run Properties:  status check passed Passed #3918  •  git commit 0fc153cd4f: chore(cypress): test public evaluation links with hmac in live quiz test workflo...
Project klicker-uzh
Branch Review v3
Run status status check passed Passed #3918
Run duration 13m 23s
Commit git commit 0fc153cd4f: chore(cypress): test public evaluation links with hmac in live quiz test workflo...
Committer Julius Schlapbach
View all properties for this run ↗︎
Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 173
View all changes introduced in this branch ↗︎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sjschlapbach