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

Dev Docker: add php extensions needed for unit testing and code coverage #41409

Merged
merged 6 commits into from
Jan 30, 2025

Conversation

kraftbj
Copy link
Contributor

@kraftbj kraftbj commented Jan 29, 2025

The new Dev Docker container need additional php extensions for WordPress (for unit testing/WorDBless) and code coverage.

Proposed changes:

  • Add various PHP extensions.
  • Adds a npm_config_update_notifier env var to prevent PNPM from alerting to update the in-docker pnpm version.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

#41057 (comment)

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

  • BUILD_LOCAL=1 jp test php packages/image-cdn -v
  • BUILD_LOCAL=1 jp test coverage packages/image-cdn (or any other package with PHP code coverage.
  • Note: may need to delete local copies of the image within Docker to force the new build.

@kraftbj kraftbj added [Type] Bug When a feature is broken and / or not performing as intended [Status] In Progress [Pri] Normal labels Jan 29, 2025
@kraftbj kraftbj self-assigned this Jan 29, 2025
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@kraftbj kraftbj mentioned this pull request Jan 29, 2025
3 tasks
@kraftbj kraftbj added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. and removed [Status] In Progress labels Jan 30, 2025
@kraftbj kraftbj requested a review from anomiex January 30, 2025 05:04
@kraftbj kraftbj marked this pull request as ready for review January 30, 2025 05:04
DEBIAN_FRONTEND=noninteractive \
PNPM_HOME=/usr/local/pnpm \
PATH="/usr/local/pnpm:${PATH}" \
npm_config_update_notifier=false
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll update the PR description. This snuck in. It's to disable the prompt to update pnpm when running jp commands. Since each container is destroyed after use, even if someone updated pnpm within the docker container, the image would still have 9.15.0.

I struggled to find documentation of this related to pnpm, but npm added it via npm/cli#1632 and pnpm claims to follow npm's update notification framework. In testing, it seemed to work. At worst, it does nothing.

@@ -8,28 +8,31 @@ ARG PNPM_VERSION

ENV LANG=en_US.UTF-8 \
LC_ALL=en_US.UTF-8 \
JETPACK_MONOREPO_ENV=1
JETPACK_MONOREPO_ENV=1 \
DEBIAN_FRONTEND=noninteractive \
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want DEBIAN_FRONTEND set inside the image itself? From https://docs.docker.com/reference/dockerfile/#env

Environment variable persistence can cause unexpected side effects. For example, setting ENV DEBIAN_FRONTEND=noninteractive changes the behavior of apt-get, and may confuse users of your image.

If an environment variable is only needed during build, and not in the final image, consider setting a value for a single command instead:

RUN DEBIAN_FRONTEND=noninteractive apt-get update && apt-get install -y ...

Or using ARG, which is not persisted in the final image:

ARG DEBIAN_FRONTEND=noninteractive
RUN apt-get update && apt-get install -y ...

tools/docker/Dockerfile.monorepo Outdated Show resolved Hide resolved
tools/docker/Dockerfile.monorepo Outdated Show resolved Hide resolved
Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

Let's do it!

@kraftbj kraftbj merged commit 42477b9 into trunk Jan 30, 2025
60 checks passed
@kraftbj kraftbj deleted the add/docker-dev-env-php-ext branch January 30, 2025 21:12
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 30, 2025
jboland88 pushed a commit that referenced this pull request Feb 3, 2025
…age (#41409)

* Add additional ext needed for WordPress [unit testing] and code coverage

* Other additions from 41057 originally

* condense the build steps in attempt to make building more reliable

* Move pnpm_home declaration to avoid docker build warning

* Update needed packages

* Re-allow rec packages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docker [Pri] Normal Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants