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

[grid]: Update CLI options aligned with version 4.26.0 #2022

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Conversation

VietND96
Copy link
Member

@VietND96 VietND96 commented Oct 30, 2024

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

CLI options added/updated in Grid v4.26.0 released

Motivation and Context

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

documentation


Description

  • Updated the --vnc-env-var option to accept multiple environment variables, enhancing flexibility in determining VNC stream availability.
  • Introduced a new CLI option --connection-limit-per-session to set a maximum number of websocket connections per session, preventing a single session from exhausting the host's connection limit.
  • Changes applied across multiple language documentation files, including English, Japanese, Portuguese, and Chinese.

Changes walkthrough 📝

Relevant files
Documentation
cli_options.en.md
Update CLI options for Grid version 4.26.0                             

website_and_docs/content/documentation/grid/configuration/cli_options.en.md

  • Updated --vnc-env-var option to accept multiple environment variables.
  • Added new CLI option --connection-limit-per-session.
  • +2/-1     
    cli_options.ja.md
    Update CLI options for Grid version 4.26.0                             

    website_and_docs/content/documentation/grid/configuration/cli_options.ja.md

  • Updated --vnc-env-var option to accept multiple environment variables.
  • Added new CLI option --connection-limit-per-session.
  • +6/-5     
    cli_options.pt-br.md
    Update CLI options for Grid version 4.26.0                             

    website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md

  • Updated --vnc-env-var option to accept multiple environment variables.
  • Added new CLI option --connection-limit-per-session.
  • +2/-1     
    cli_options.zh-cn.md
    Update CLI options for Grid version 4.26.0                             

    website_and_docs/content/documentation/grid/configuration/cli_options.zh-cn.md

  • Updated --vnc-env-var option to accept multiple environment variables.
  • Added new CLI option --connection-limit-per-session.
  • +2/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Update
    Verify that the new --connection-limit-per-session option is correctly documented and its purpose is clearly explained.

    Translation Consistency
    Ensure that the Japanese translation for the new --connection-limit-per-session option is accurate and consistent with the English version.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Translate new option descriptions to Japanese for consistency

    Translate the descriptions for the new --enable-managed-downloads,
    --selenium-manager, and --connection-limit-per-session options into Japanese to
    maintain consistency with the rest of the document.

    website_and_docs/content/documentation/grid/configuration/cli_options.ja.md [228-230]

    -| `--enable-managed-downloads`| boolean  | `false` | This causes the Node to auto manage files downloaded for a given session on the Node. |
    -| `--selenium-manager`| boolean  | `false` | When drivers are not available on the current system, use Selenium Manager. False by default. |
    -| `--connection-limit-per-session` | int      | `10` | Let X be the maximum number of websocket connections per session.This will ensure one session is not able to exhaust the connection limit of the host. |
    +| `--enable-managed-downloads`| boolean  | `false` | ノード上の特定のセッションでダウンロードされたファイルを自動管理します。 |
    +| `--selenium-manager`| boolean  | `false` | 現在のシステムでドライバーが利用できない場合、Selenium Managerを使用します。デフォルトはfalseです。 |
    +| `--connection-limit-per-session` | int      | `10` | セッションごとの最大WebSocket接続数を設定します。これにより、1つのセッションがホストの接続制限を使い果たすことを防ぎます。 |
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Translating the new option descriptions into Japanese ensures consistency with the rest of the document, making it more accessible to Japanese-speaking users. This is important for maintaining the document's usability across different languages.

    7
    Clarify the purpose and benefits of limiting websocket connections per session

    Add a brief explanation of why limiting websocket connections per session is
    important, such as preventing resource exhaustion or improving overall system
    stability.

    website_and_docs/content/documentation/grid/configuration/cli_options.en.md [231]

    -| `--connection-limit-per-session` | int | `10` | Let X be the maximum number of websocket connections per session.This will ensure one session is not able to exhaust the connection limit of the host. |
    +| `--connection-limit-per-session` | int | `10` | Maximum number of websocket connections allowed per session. This prevents a single session from exhausting the host's connection limit, ensuring fair resource allocation and improving system stability. |
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: This suggestion enhances the documentation by explaining the benefits of limiting websocket connections, which can help users understand the importance of this feature. It improves clarity but is not essential for understanding the basic functionality.

    6
    Clarify the usage of multiple environment variables for the VNC stream check

    Consider adding a brief explanation or example of how to use multiple environment
    variables with the --vnc-env-var option. This will help users understand how to
    properly configure and use this updated feature.

    website_and_docs/content/documentation/grid/configuration/cli_options.en.md [224]

    -| `--vnc-env-var`| string[] | `SE_START_XVFB SE_START_VNC SE_START_NO_VNC` | Environment variable to check in order to determine if a vnc stream is available or not. |
    +| `--vnc-env-var`| string[] | `SE_START_XVFB SE_START_VNC SE_START_NO_VNC` | Environment variables to check in order to determine if a VNC stream is available. Multiple variables can be specified, separated by spaces. The Node will check for the presence of any of these variables. |
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: The suggestion provides a clearer explanation of how to use multiple environment variables with the --vnc-env-var option, which can help users understand the feature better. However, it is not critical to the functionality of the documentation.

    5

    💡 Need additional feedback ? start a PR chat

    Copy link

    netlify bot commented Oct 30, 2024

    Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit f91f7b9
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/6722080e1c41140008d60382
    😎 Deploy Preview https://deploy-preview-2022--selenium-dev.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Copy link
    Member

    @harsha509 harsha509 left a comment

    Choose a reason for hiding this comment

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

    Thank you @VietND96 !

    @harsha509 harsha509 merged commit 0b1ea01 into trunk Oct 30, 2024
    6 checks passed
    @harsha509 harsha509 deleted the grid-4.26.0 branch October 30, 2024 17:25
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants