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

Docker: Install Firefox from multiple package types #2547

Merged
merged 1 commit into from
Jan 1, 2025
Merged

Conversation

VietND96
Copy link
Member

@VietND96 VietND96 commented Jan 1, 2025

User description

Thanks for contributing to the Docker-Selenium project!
A PR well described will help maintainers to quickly review and merge it

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

Description

Instead of downloading package .tar.bz2, execute and link the executable file. We switch to install by apt from .deb file.
The benefit is that apt will help install all dependencies needed for Firefox. Also, we can do apt update to update deps for patching CVEs. Here is the result on CVEs by extracting .tar.bz2 and installing .deb

image

Motivation and Context

Types of changes

  • 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)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

PR Type

Enhancement


Description

  • Add support for multiple Firefox package formats

  • Implement unified package installation script

  • Update default package to .deb format

  • Simplify and refactor Dockerfile installation logic


Changes walkthrough 📝

Relevant files
Enhancement
install-firefox-package.sh
Add Firefox package installation script                                   

NodeFirefox/install-firefox-package.sh

  • New script to handle Firefox installation from different package types
    (deb, tar.bz2, tar.xz)
  • Implements package extraction and installation functions
  • Includes dependency installation and Firefox configuration
  • +44/-0   
    Dockerfile
    Refactor Firefox installation in Dockerfile                           

    NodeFirefox/Dockerfile

  • Added new install-firefox-package.sh script to container
  • Modified Firefox installation logic to use new package script
  • Updated package URLs to prefer .deb format
  • Simplified installation logic by removing redundant code
  • +8/-15   
    Configuration changes
    Makefile
    Update default Firefox package URL                                             

    Makefile

  • Updated default Firefox download URL to use .deb package instead of
    .tar.bz2
  • +1/-1     

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

    Copy link

    qodo-merge-pro bot commented Jan 1, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Error Handling

    The script lacks error handling for failed downloads or package installations. Failed operations could leave Firefox in an inconsistent state.

    wget -q -O /tmp/firefox.deb "${FIREFOX_DOWNLOAD_URL}"
    echo "Installing Firefox from deb package..."
    sudo apt-get install -y --allow-downgrades -f /tmp/firefox.deb
    rm -f /tmp/firefox.deb
    Resource Cleanup

    Multiple cleanup attempts of the same temporary files. The rm commands are duplicated both in the extract functions and main script body.

      rm -f /tmp/firefox.tar.bz2
    elif [[ "${FIREFOX_DOWNLOAD_URL}" == *".tar.xz"* ]]; then
      echo "Downloading Firefox from ${FIREFOX_DOWNLOAD_URL}"
      wget -q -O /tmp/firefox.tar.xz "${FIREFOX_DOWNLOAD_URL}"
      extract_package_tar_xz
      install_package
      rm -f /tmp/firefox.tar.xz

    Copy link

    qodo-merge-pro bot commented Jan 1, 2025

    PR Code Suggestions ✨

    Copy link

    qodo-merge-pro bot commented Jan 1, 2025

    CI Failure Feedback 🧐

    (Checks updated until commit 4c46e5b)

    Action: Rerun workflow when failure

    Failed stage: Authenticate GitHub CLI for PR [❌]

    Failure summary:

    The action failed because the GitHub authentication token lacks the required 'read:org' permission
    scope. The error occurred during the gh auth login command, which requires proper authorization to
    access organization-related information.

    Relevant error logs:
    1:  ##[group]Operating System
    2:  Ubuntu
    ...
    
    28:  SecurityEvents: write
    29:  Statuses: write
    30:  ##[endgroup]
    31:  Secret source: Actions
    32:  Prepare workflow directory
    33:  Prepare all required actions
    34:  Getting action download info
    35:  Download action repository 'actions/checkout@main' (SHA:cbb722410c2e876e24abbe8de2cc27693e501dcb)
    36:  Complete job name: Rerun workflow when failure
    ...
    
    48:  show-progress: true
    49:  lfs: false
    50:  submodules: false
    51:  set-safe-directory: true
    52:  env:
    53:  GH_CLI_TOKEN: ***
    54:  GH_CLI_TOKEN_PR: ***
    55:  RUN_ID: 12571932548
    56:  RERUN_FAILED_ONLY: true
    ...
    
    119:  ##[group]Run sudo apt update
    120:  �[36;1msudo apt update�[0m
    121:  �[36;1msudo apt install gh�[0m
    122:  shell: /usr/bin/bash -e {0}
    123:  env:
    124:  GH_CLI_TOKEN: ***
    125:  GH_CLI_TOKEN_PR: ***
    126:  RUN_ID: 12571932548
    127:  RERUN_FAILED_ONLY: true
    ...
    
    164:  0 upgraded, 0 newly installed, 0 to remove and 48 not upgraded.
    165:  ##[group]Run echo "$GH_CLI_TOKEN_PR" | gh auth login --with-token
    166:  �[36;1mecho "$GH_CLI_TOKEN_PR" | gh auth login --with-token�[0m
    167:  shell: /usr/bin/bash -e {0}
    168:  env:
    169:  GH_CLI_TOKEN: ***
    170:  GH_CLI_TOKEN_PR: ***
    171:  RUN_ID: 12571932548
    172:  RERUN_FAILED_ONLY: true
    173:  RUN_ATTEMPT: 1
    174:  ##[endgroup]
    175:  error validating token: missing required scope 'read:org'
    176:  ##[error]Process completed with exit code 1.
    

    ✨ CI feedback usage guide:

    The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
    The tool analyzes the failed checks and provides several feedbacks:

    • Failed stage
    • Failed test name
    • Failure summary
    • Relevant error logs

    In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

    /checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"
    

    where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

    Configuration options

    • enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
    • excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
    • enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
    • persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
    • final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

    See more information about the checks tool in the docs.

    @VietND96 VietND96 merged commit 75c70ea into trunk Jan 1, 2025
    29 of 36 checks passed
    @VietND96 VietND96 deleted the firefox-deb branch January 1, 2025 17:08
    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.

    1 participant