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: updated-to-latest-components #343

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

adhmenon
Copy link
Contributor

@adhmenon adhmenon commented Nov 27, 2024

Completes SPARK-564413

  • The issue was arising in the meetings widget, when a user moved VO over the Join Meeting button and they were getting a wrong test - namely saying the state of the mute and video button. (for eg. mute, video on)
  • This was causing confusion to the users

Fix

  • The reason this was not working was because the aria-label of the buttons was taking only the hint variable of the components and not reading from the text.
  • Further, the hint was coming as null, hence code was added to just take the text as the required label.
  • Tests were also done to see that older functionality was not broken.
  • Components PR - feat(meetings-widgets): fixed-join-meeting-acc components#846

Vidcast showing the solution - https://app.vidcast.io/share/3a15014f-1445-4492-8b60-248d3ff54323

Manual Tests

  • Tests were done to ensure the objective of the ticket was fulfilled.
  • I have also tested other places where the same button was being used (including inside of a meeting) and have verified that the behaviour is exactly as expected and no other areas were broken.
  • Testing was done for personal room meeting and a scheduled meeting.

Copy link

coderabbitai bot commented Nov 27, 2024

Walkthrough

The pull request involves a minor update to the package.json file for the @webex/widgets project. The primary change is the increment of the @webex/components package version from 1.275.3 to 1.276.0. No other modifications were made to the package configuration, including scripts or other dependencies.

Changes

File Change Summary
package.json Updated @webex/components version from 1.275.3 to 1.276.0

Possibly related PRs

Suggested reviewers

  • sreenara

Poem

In the garden where we play,
A version change brightens the day.
Components updated, all in a row,
Hopping along, watch our progress grow!
With each little leap, we refine our way,
For a better tomorrow, hip-hip-hooray! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eec8d28 and 2298175.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (1 hunks)
🔇 Additional comments (3)
package.json (3)

37-37: Verify that version 1.276.0 contains the accessibility fix

The version bump of @webex/components from 1.275.3 to 1.276.0 appears to address the accessibility issue SPARK-564413 where screen readers were providing incorrect information for mute/video buttons.

Let's verify this version contains the fix:

✅ Verification successful

Version 1.276.0 contains the required accessibility fix

The version bump to 1.276.0 specifically includes the fix for SPARK-564413, addressing the screen reader accessibility issue with the Join Meeting button. The PR (#846) confirms:

  • Fix matches the reported issue where screen readers were providing incorrect information
  • Changes were tested with voice over functionality
  • Implementation aligns with Applause requirements
  • No regression in existing meeting functionality
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the changelog or commit history for the accessibility fix

# Check if the fix is mentioned in the changelog or release notes
gh api repos/webex/components/releases | jq -r '.[] | select(.tag_name=="v1.276.0") | .body'

# Look for related commits
gh api repos/webex/components/commits --query 'sha:v1.276.0' | jq -r '.[] | select(.commit.message | contains("aria-label") or contains("accessibility") or contains("SPARK-564413"))'

Length of output: 1954


Script:

#!/bin/bash
# Let's try a different approach to get the commit information
# First, let's search for the PR that contains the fix
gh api repos/webex/components/pulls/846 | jq -r '.title,.body'

# Also check the specific commit mentioned in the release notes
gh api repos/webex/components/commits/a1e918386eb66809b7968285956270e3a77aa2c2 | jq -r '.commit.message'

Length of output: 1705


37-37: Ensure comprehensive testing with screen readers

Since this change affects accessibility features, please confirm:

  1. Testing has been performed with multiple screen readers (e.g., NVDA, VoiceOver, JAWS)
  2. The fix has been verified in both personal room meetings and scheduled meetings
  3. The behavior is consistent across different browsers

37-37: Check for breaking changes in @webex/components 1.276.0

While this is a minor version bump suggesting backward compatibility, let's ensure there are no unintended side effects.

✅ Verification successful

Let me gather more information about the usage of @webex/components in the codebase to better assess the impact.


Let me try another search pattern to find imports from @webex/components.


Based on the search results, I can see that @webex/components is imported in WebexMeetings.jsx and used for WebexMediaAccess, WebexMeeting, withAdapter, and withMeeting components. Let me check the changelog to understand what changed in version 1.276.0.


Let me check the previous version of @webex/components to understand what version we're upgrading from.


Since we don't have enough information about the previous version and the changelog doesn't show breaking changes, and given that:

  1. The version follows semantic versioning (1.276.0)
  2. The dependencies shown in the output are stable (using fixed versions)
  3. The components being used (WebexMediaAccess, WebexMeeting, withAdapter, withMeeting) are core components
  4. No breaking changes were found in the release notes from the GitHub API check

I can provide a response:

Minor version update of @webex/components appears safe to proceed

The update follows semantic versioning principles where minor version changes (1.x.x) should maintain backward compatibility. No breaking changes were detected in the release notes or dependencies.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for breaking changes or deprecation notices

# Look for breaking changes in the changelog
gh api repos/webex/components/releases | jq -r '.[] | select(.tag_name=="v1.276.0") | .body' | grep -i "breaking\|deprecat"

# Check for major dependency updates in the new version
curl -s https://registry.npmjs.org/@webex/components/1.276.0 | jq '.dependencies'

Length of output: 488


Script:

#!/bin/bash
# Search for imports and usage of @webex/components
rg "@webex/components" -A 2

# Search for specific component imports
ast-grep --pattern 'import { $_ } from "@webex/components"'

Length of output: 163223


Script:

#!/bin/bash
# Search for imports from @webex/components with more context
rg -A 3 -B 3 "from ['\"]@webex/components['\"]"

# Also search for any direct usage of @webex/components
rg -A 3 -B 3 "@webex/components"

Length of output: 131759


Script:

#!/bin/bash
# Check the changelog for version 1.276.0
rg -A 5 "1\.276\.0" CHANGELOG.md

# Also check package-lock.json for previous version
rg -B 2 "@webex/components.*1\.276\.0" package-lock.json

Length of output: 377


Script:

#!/bin/bash
# Find git history for package.json changes to see previous version
git log -p package.json | grep -A 3 -B 3 "@webex/components"

Length of output: 0


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

@adhmenon adhmenon merged commit 78c3e90 into webex:master Nov 27, 2024
2 checks passed
@adhmenon adhmenon deleted the dev/adhmenon-SPARK-564413 branch November 27, 2024 17:08
@sreenara
Copy link
Contributor

🎉 This PR is included in version 1.27.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

pagour98 pushed a commit to pagour98/widgets that referenced this pull request Nov 30, 2024
## [1.27.7](webex/widgets@v1.27.6...v1.27.7) (2024-11-27)

### Bug Fixes

* updated-to-latest-components ([webex#343](webex#343)) ([78c3e90](webex@78c3e90))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants