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

feat(game-lobby): display disclaimer for small screens #853

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

antoinezanardi
Copy link
Owner

@antoinezanardi antoinezanardi commented Sep 11, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced toast notifications to display warnings for small screens, improving user feedback.
    • Added localization support for small screen detection messages in English and French.
  • Bug Fixes

    • Adjusted styling of toast notifications for better visibility across different screen sizes.
  • Tests

    • Expanded test coverage to include scenarios for responsive behavior related to screen size and toast notifications.

@antoinezanardi antoinezanardi added the 🚀 feature New feature or request label Sep 11, 2024
@antoinezanardi antoinezanardi self-assigned this Sep 11, 2024
Copy link

coderabbitai bot commented Sep 11, 2024

Walkthrough

The pull request introduces enhancements to the application, focusing on responsive design and user notifications. Key changes include the addition of toast notifications for small screens in the game lobby, updates to localization files for English and French, and improvements to testing coverage for responsive behavior. The modifications ensure that users receive timely feedback regarding their screen size, enhancing the overall user experience.

Changes

Files Change Summary
app/app.vue Added a class to the PrimeVueToast component to limit its maximum width.
app/pages/game-lobby.vue Introduced screen size detection and toast notifications for small screens.
modules/i18n/locales/en.json Added keys for small screen detection messages in English.
modules/i18n/locales/fr.json Added keys for small screen detection messages in French.
tests/acceptance/features/game-lobby/features/game-lobby.feature Added scenarios for toast notifications based on screen size.
tests/acceptance/features/playwright/step-definitions/toasts/playwright-toasts.then-steps.ts Added step definition for checking visibility of toast notifications.
tests/acceptance/features/playwright/step-definitions/viewports/playwright-viewports.when-steps.ts Introduced step definition for rendering the app on specific devices.
tests/unit/specs/pages/game-lobby/game-lobby.nuxt.spec.ts Enhanced test suite with mocks and tests for responsive behavior and toast notifications.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GameLobby
    participant ToastService

    User->>GameLobby: Open Game Lobby
    GameLobby->>GameLobby: Detect Screen Size
    alt Small Screen Detected
        GameLobby->>ToastService: Trigger Small Screen Warning
        ToastService-->>User: Show Toast Notification
    end
Loading

🐇 In a world where screens are small,
The rabbit hops to heed the call.
With toasts that warn of size so tight,
A larger view brings pure delight!
So gather round, both big and small,
For a better view, we’ll have a ball! 🌟


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cefe4af and e28ac10.

Files ignored due to path filters (1)
  • tests/unit/specs/__snapshots__/app.nuxt.spec.ts.snap is excluded by !**/*.snap
Files selected for processing (8)
  • app/app.vue (1 hunks)
  • app/pages/game-lobby.vue (4 hunks)
  • modules/i18n/locales/en.json (1 hunks)
  • modules/i18n/locales/fr.json (1 hunks)
  • tests/acceptance/features/game-lobby/features/game-lobby.feature (1 hunks)
  • tests/acceptance/features/playwright/step-definitions/toasts/playwright-toasts.then-steps.ts (1 hunks)
  • tests/acceptance/features/playwright/step-definitions/viewports/playwright-viewports.when-steps.ts (1 hunks)
  • tests/unit/specs/pages/game-lobby/game-lobby.nuxt.spec.ts (4 hunks)
Additional comments not posted (25)
tests/acceptance/features/playwright/step-definitions/viewports/playwright-viewports.when-steps.ts (1)

5-7: LGTM!

The code changes are approved for the following reasons:

  • The function is correctly implemented and uses the appropriate types and imports.
  • The function name and the regular expression pattern clearly describe the purpose of the step definition.
  • The function uses the devices object from playwright-core to set the viewport size, which is a good practice as it ensures that the viewport sizes are consistent with the actual devices.
tests/acceptance/features/playwright/step-definitions/toasts/playwright-toasts.then-steps.ts (1)

12-15: LGTM!

The new step definition for checking the invisibility of toast notifications is implemented correctly and enhances the testing capabilities. It is consistent with the existing step definition for checking the visibility of toast notifications.

The code changes are approved.

app/app.vue (1)

11-14: LGTM! The change enhances the visual presentation of the toast notification.

The addition of the !max-w-x-screen-9/10 class attribute to the PrimeVueToast component is a positive change that improves the visual presentation of the toast notification, especially on small screens.

The class attribute is likely using a CSS utility library like Tailwind CSS to set the maximum width of the toast to 90% of the screen width. This ensures that the toast doesn't take up the full width of the screen on small devices, providing a better user experience.

The use of the ! prefix in the class name suggests that the class is being applied with a higher specificity to override any existing styles, ensuring that the maximum width constraint is enforced.

It's important to note that this change is purely visual and does not affect the functionality of the component.

app/pages/game-lobby.vue (5)

42-42: LGTM!

The code changes are approved.

Also applies to: 57-57


61-61: LGTM!

The code changes are approved.


73-74: LGTM!

The code changes are approved.


81-82: LGTM!

The code changes are approved.


166-172: LGTM!

The code changes are approved.

Also applies to: 179-186

tests/acceptance/features/game-lobby/features/game-lobby.feature (2)

27-30: LGTM!

The scenario is correctly implemented and improves the testing coverage related to screen size responsiveness.


32-35: LGTM!

The scenario is correctly implemented and improves the testing coverage related to screen size responsiveness.

tests/unit/specs/pages/game-lobby/game-lobby.nuxt.spec.ts (12)

Line range hint 4-8: LGTM!

The new imports are necessary for the added test cases.


23-29: LGTM!

The new mocks are necessary for the added test cases.

Also applies to: 34-41


130-155: LGTM!

The "Small Screen Toast" test suite is well-structured and the test cases cover the expected behavior.


Line range hint 157-178:


Line range hint 180-205:


Line range hint 207-224:


Line range hint 226-243:


Line range hint 245-262:


Line range hint 264-289:


Line range hint 291-330:


Line range hint 332-357:


Line range hint 359-382:

modules/i18n/locales/en.json (1)

424-425: LGTM!

The new keys provide helpful notifications to users about small screen detection and recommendations for optimal usage. The additions are correctly formatted.

modules/i18n/locales/fr.json (2)

424-424: LGTM!

The new localized string for small screen detection looks good.


425-425: Looks good!

The warning message for small screens is clear and provides a helpful recommendation to users.


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

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

sonarcloud bot commented Sep 11, 2024

@antoinezanardi antoinezanardi merged commit 81029b8 into develop Sep 11, 2024
16 checks passed
@antoinezanardi antoinezanardi deleted the feat/responsive-disclaimer branch September 11, 2024 14:18
antoinezanardi pushed a commit that referenced this pull request Sep 18, 2024
## [1.32.0](v1.31.0...v1.32.0) (2024-09-18)

### 🚀 Features

* **audio:** audio settings in local storage ([#831](#831)) ([cd8a2cb](cd8a2cb))
* **game-lobby:** all game lobby is responsive ([#877](#877)) ([aaccf38](aaccf38))
* **game-lobby:** auto-focus on player name input ([#860](#860)) ([7897da3](7897da3))
* **game-lobby:** auto-focus on player name input even after changing page ([#873](#873)) ([3bb8401](3bb8401))
* **game-lobby:** display disclaimer for small screens ([#853](#853)) ([81029b8](81029b8))
* **game-lobby:** game options confirm step in lobby ([#845](#845)) ([20cc2ce](20cc2ce))
* **game:** all game screens are responsive ([#880](#880)) ([b54b1dc](b54b1dc))
* **game:** game over screens are responsive ([#883](#883)) ([aacb761](aacb761))
* **misc-pages:** responsive for canceled game and not found game pages ([#888](#888)) ([deeb7b2](deeb7b2))
* **nuxt:** set route announcer ([#835](#835)) ([dd1115f](dd1115f))
* **nuxt:** typecheck on hooks and ci ([#832](#832)) ([794157f](794157f))

### 🐛 Bug Fixes

* **deps:** update dependency @primevue/themes to ^4.0.6 ([#842](#842)) ([4d3e063](4d3e063))
* **deps:** update dependency @primevue/themes to ^4.0.7 ([#855](#855)) ([2b80485](2b80485))
* **deps:** update dependency primevue to ^4.0.6 ([#843](#843)) ([3a20f01](3a20f01))
* **deps:** update dependency primevue to ^4.0.7 ([#856](#856)) ([6c75a61](6c75a61))
* **game-events:** icon animation null instance handler ([#889](#889)) ([ee0a17e](ee0a17e))
* **pwa:** remove redirect fallback ([#830](#830)) ([69c2c21](69c2c21))

### 🔩 Refactor

* **primevue:** use new accordion component ([#834](#834)) ([f611995](f611995))
* **primevue:** use new tab components ([#836](#836)) ([4f9c1b9](4f9c1b9))

### ✅ Tests

* **scapegoat:** acceptance tests ([#884](#884)) ([add895e](add895e))

### 🔁 CI

* **node:** use last node version in ci ([#848](#848)) ([aa047b3](aa047b3))

### 🧹 Chore

* **deps:** update commitlint monorepo to ^19.5.0 ([#852](#852)) ([cefe4af](cefe4af))
* **deps:** update dependency @cucumber/cucumber to ^11.0.1 ([#869](#869)) ([c00d3e7](c00d3e7))
* **deps:** update dependency @cucumber/cucumber to v11 ([#817](#817)) ([dcbad46](dcbad46))
* **deps:** update dependency @faker-js/faker to ^9.0.1 ([#870](#870)) ([da15f7c](da15f7c))
* **deps:** update dependency @nuxt/test-utils to ^3.14.2 ([#846](#846)) ([f0f715a](f0f715a))
* **deps:** update dependency @nuxtjs/i18n to ^8.5.2 ([#764](#764)) ([0fe9bf0](0fe9bf0))
* **deps:** update dependency @nuxtjs/i18n to ^8.5.3 ([#849](#849)) ([1689312](1689312))
* **deps:** update dependency @nuxtjs/robots to ^4.1.7 ([#861](#861)) ([4cf88c8](4cf88c8))
* **deps:** update dependency @primevue/nuxt-module to ^4.0.6 ([#841](#841)) ([7384c1e](7384c1e))
* **deps:** update dependency @primevue/nuxt-module to ^4.0.7 ([#854](#854)) ([22c3f4a](22c3f4a))
* **deps:** update dependency @stylistic/eslint-plugin to ^2.8.0 ([#838](#838)) ([1c15410](1c15410))
* **deps:** update dependency @types/qs to ^6.9.16 ([#868](#868)) ([8560a5d](8560a5d))
* **deps:** update dependency @vueuse/core to ^11.1.0 ([#875](#875)) ([b568680](b568680))
* **deps:** update dependency @vueuse/nuxt to ^11.1.0 ([#876](#876)) ([0f358b6](0f358b6))
* **deps:** update dependency circle-progress.vue to ^3.2.2 ([#878](#878)) ([4cd09ac](4cd09ac))
* **deps:** update dependency husky to ^9.1.6 ([#858](#858)) ([03b278b](03b278b))
* **deps:** update dependency msw to ^2.4.3 ([#827](#827)) ([6cd07ef](6cd07ef))
* **deps:** update dependency msw to ^2.4.4 ([#833](#833)) ([44814db](44814db))
* **deps:** update dependency msw to ^2.4.5 ([#850](#850)) ([773674a](773674a))
* **deps:** update dependency msw to ^2.4.6 ([#864](#864)) ([93b4a45](93b4a45))
* **deps:** update dependency msw to ^2.4.7 ([#871](#871)) ([b6cef68](b6cef68))
* **deps:** update dependency msw to ^2.4.8 ([#882](#882)) ([96d9d56](96d9d56))
* **deps:** update dependency node to v22.9.0 ([#886](#886)) ([8f28e99](8f28e99))
* **deps:** update dependency sass to ^1.79.1 ([#887](#887)) ([02e728a](02e728a))
* **deps:** update dependency semantic-release to ^24.1.1 ([#851](#851)) ([9a5d974](9a5d974))
* **deps:** update dependency tailwindcss to ^3.4.11 ([#857](#857)) ([74668ab](74668ab))
* **deps:** update dependency tailwindcss to ^3.4.12 ([#885](#885)) ([b2d182d](b2d182d))
* **deps:** update dependency tsx to ^4.19.1 ([#859](#859)) ([6e771c3](6e771c3))
* **deps:** update dependency type-fest to ^4.26.1 ([#829](#829)) ([7b715fd](7b715fd))
* **deps:** update dependency typescript to ^5.6.2 ([#839](#839)) ([69b99b1](69b99b1))
* **deps:** update dependency vue to ^3.5.4 ([#844](#844)) ([09fd254](09fd254))
* **deps:** update dependency vue to ^3.5.5 ([#865](#865)) ([13ae2b7](13ae2b7))
* **deps:** update dependency vue to ^3.5.6 ([#874](#874)) ([77302a2](77302a2))
* **deps:** update dependency vue-router to ^4.4.4 ([#847](#847)) ([23430aa](23430aa))
* **deps:** update dependency vue-router to ^4.4.5 ([#863](#863)) ([28a6c29](28a6c29))
* **deps:** update nuxtjs monorepo to ^3.13.2 ([#872](#872)) ([28e0e43](28e0e43))
* **deps:** update playwright monorepo to ^1.47.1 ([#866](#866)) ([ae9e014](ae9e014))
* **deps:** update pnpm to v9.10.0 ([#837](#837)) ([05be262](05be262))
* **deps:** update typescript-eslint monorepo to ^8.5.0 ([#840](#840)) ([b230013](b230013))
* **deps:** update typescript-eslint monorepo to ^8.6.0 ([#881](#881)) ([c291635](c291635))
* **deps:** update vitest monorepo to ^2.1.0 ([#862](#862)) ([b25b312](b25b312))
* **deps:** update vitest monorepo to ^2.1.1 ([#867](#867)) ([a1ad2f8](a1ad2f8))
* **screenshots:** missing screenshots for linux ([8bfa635](8bfa635))
@antoinezanardi
Copy link
Owner Author

🎉 This PR is included in version 1.32.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚀 feature New feature or request released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant