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(calling): fix-hydra-url-constant #3950

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

Shreyas281299
Copy link
Contributor

@Shreyas281299 Shreyas281299 commented Nov 4, 2024

COMPLETES # https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-575999

This pull request addresses

An extra 'https://' was added when we try to fetch call settings. The issue was in the way we defined the endpoint
Screenshot 2024-11-04 at 10 16 25 AM

by making the following changes

Removed the extra https
Screenshot 2024-11-04 at 12 00 16 PM

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

  • Ran UTs
  • Fetched all call settings for a user.
Screenshot 2024-11-04 at 12 06 45 PM

I certified that

  • I have read and followed contributing guidelines

  • I discussed changes with code owners prior to submitting this pull request

  • I have not skipped any automated checks

  • All existing and new tests passed

  • I have updated the documentation accordingly


Make sure to have followed the contributing guidelines before submitting.

Summary by CodeRabbit

  • Bug Fixes
    • Updated internal API URL constants to remove the https:// prefix, ensuring correct URL construction for API calls.

@Shreyas281299 Shreyas281299 requested a review from a team as a code owner November 4, 2024 06:29
Copy link

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes involve the modification of two constants, WEBEX_API_CONFIG_INT_URL and WEBEX_API_CONFIG_PROD_URL, in the packages/calling/src/common/constants.ts file. The updates remove the https:// prefix from these URLs, changing them to utilize base URL variables (WEBEX_API_BTS and WEBEX_API_PROD) followed by the path /v1/uc/config. This adjustment alters how these constants are constructed, which may affect any dependent functionality.

Changes

File Path Change Summary
packages/calling/src/common/constants.ts Updated WEBEX_API_CONFIG_INT_URL and WEBEX_API_CONFIG_PROD_URL to remove https:// prefix.

Poem

In a world of URLs, oh so bright,
A rabbit hops with pure delight.
No more https, just paths we see,
To connect with joy, so happily!
With constants changed, we leap and play,
Celebrating code in a new way! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1715035 and 193c3d0.

📒 Files selected for processing (1)
  • packages/calling/src/common/constants.ts (1 hunks)
🔇 Additional comments (1)
packages/calling/src/common/constants.ts (1)

50-51: LGTM! URL construction fixed correctly.

The removal of the redundant https:// prefix is correct since the base URL constants (WEBEX_API_BTS and WEBEX_API_PROD) already include the protocol.

Let's verify the usage of these constants to ensure the changes don't affect other parts of the codebase:

✅ Verification successful

Let me check the usage of these constants in the identified files to ensure there are no issues.


URL constants are used correctly and changes are safe

The verification confirms that:

  • The constants are only used in UcmBackendConnector.ts and its test file
  • They are properly imported and used for constructing API endpoints
  • No hardcoded values of the config URLs exist in the codebase
  • The usage pattern shows the constants are concatenated with additional path segments, so fixing the double https:// was necessary
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check usage of the config URL constants and verify no hardcoded values exist

# Test 1: Find all usages of the config URL constants
echo "=== Checking usages of config URL constants ==="
rg -l "WEBEX_API_CONFIG_(INT|PROD)_URL"

# Test 2: Look for any hardcoded config URLs that might need updating
echo "=== Checking for hardcoded config URLs ==="
rg -i "/v1/uc/config"

Length of output: 653


Script:

#!/bin/bash
# Check the implementation in UcmBackendConnector.ts and its test file
echo "=== Checking UcmBackendConnector.ts ==="
rg -A 5 "WEBEX_API_CONFIG_(INT|PROD)_URL" packages/calling/src/CallSettings/UcmBackendConnector.ts

echo -e "\n=== Checking UcmBackendConnector.test.ts ==="
rg -A 5 "WEBEX_API_CONFIG_(INT|PROD)_URL" packages/calling/src/CallSettings/UcmBackendConnector.test.ts

Length of output: 1474


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.

@Shreyas281299 Shreyas281299 added the validated If the pull request is validated for automation. label Nov 4, 2024
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-3950.d3m3l2kee0btzx.amplifyapp.com

Copy link
Contributor

@rarajes2 rarajes2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Do we have any UT for this?

Copy link
Contributor

@Kesari3008 Kesari3008 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving with one comment and check the UT changes

@Shreyas281299
Copy link
Contributor Author

LGTM. Do we have any UT for this?

There are no UTS for this.

@Shreyas281299 Shreyas281299 merged commit 54c2042 into webex:next Nov 4, 2024
12 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validated If the pull request is validated for automation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants