feat(dev_env): Dev env bootstrap support for two Python versions #28213

armenzg · 2021-08-26T19:29:37Z

This change adds supports for bootstrapping two different Python versions.
Python 3.8.10 will be used for Apple M1 since we're targetting Python 3.8 for Sentry's
next Python version and it is the first one that supports Apple's M1 chipset.

Fixes: #28154

This change adds supports for bootstrapping two different Python versions. Python 3.8.10 will be used for Apple M1 since we're targetting Python 3.8 for Sentry's next Python version and it is the first one that supports Apple's M1 chipset.

.envrc

armenzg · 2021-08-27T12:35:01Z

.envrc

    cd "$(dirname "${BASH_SOURCE[0]}")"
    pwd -P
 )"

-bold="$(tput bold)"


Centralizing this code for other scripts to use.

armenzg · 2021-08-27T12:35:14Z

.envrc

@@ -58,10 +53,6 @@ report_to_sentry() {
    rm "$_SENTRY_LOG_FILE"
 }

-require() {


Moving it to the main library.

armenzg · 2021-08-27T12:36:46Z

.envrc

@@ -86,6 +77,27 @@ die() {
    return 1
 }

+prompt_python_venv_creation() {


Moving this code into a function so we can call it from within the .envrc context in getsentry (since we source it).

# We depend on a Sentry checkout for this to work. source ../sentry/.envrc

armenzg · 2021-08-27T12:37:26Z

.envrc

+    esac
+}
+
+commands_info() {


Same idea as the previous function.

armenzg · 2021-08-27T16:44:50Z

scripts/pyenv_setup.sh

@@ -44,15 +44,16 @@ _append_to_startup_script() {
    case "$SHELL" in
    */bash)
      # shellcheck disable=SC2016
-      echo "Visit https://github.com/pyenv/pyenv#installation on how to fully set up your Bash shell.";;
+      echo "Visit https://github.com/pyenv/pyenv#installation on how to fully set up your Bash shell."


Auto-formatting.

armenzg · 2021-08-27T16:45:53Z

scripts/pyenv_setup.sh

-    # We can remove this once we upgrade to newer versions of Python
-    if query_big_sur; then
+    if query-apple-m1; then
+      pyenv install --skip-existing "${PYENV_VERSION}"


This is the core that makes installations on Apple M1 to use Python 3.8.10.

armenzg · 2021-08-27T16:47:11Z

scripts/pyenv_setup.sh

    # NOTE: We're dropping support for older pyenv versions
-    if [[ "$pyenv_version" < 2.0.0 ]]; then
+    if [[ "$(pyenv -v | awk '{print $2}')" < 2.0.0 ]]; then


Since we only use the variable here, might as well just place it here. shellcheck also complains since I make a reference to PYENV_VERSION down below, thus, it looks like the two could be the same variable (if ignoring casing).

armenzg · 2021-08-27T16:47:29Z

scripts/pyenv_setup.sh

@@ -111,16 +110,14 @@ install_pyenv() {
 setup_pyenv() {
  configure-sentry-cli
  install_pyenv
-  _startup_script=$(get_shell_startup_script)
-  append_to_config "$_startup_script"
+  append_to_config "$(get_shell_startup_script)"


Merging the two lines.

armenzg · 2021-08-27T16:47:45Z

scripts/pyenv_setup.sh


  # If the script is called with the "dot space right" approach (. ./scripts/pyenv_setup.sh),
  # the effects of this will be persistent outside of this script
-  echo "Activating pyenv and validating Python version"


Making less noise in the output of direnv.

armenzg · 2021-09-01T16:12:57Z

@billyvg @joshuarli this is ready for another review. Thanks!

You can ignore the dev env workflow failure. I will fix that in #28265

billyvg · 2021-09-01T16:36:31Z

.github/workflows/python-deps.yml

-    - '.github/workflows/python-deps.yml'
-    - 'requirements*'
+      - '.github/workflows/python-deps.yml'
+      - 'requirements*'


Ah we should make this run on precommit

armenzg · 2021-09-01T16:51:23Z

I will follow up on any other comments on my next PR.

* master: (109 commits) ref(js): Add notice to use useApi when applicable (#28365) fix(tests): Temporarily disable test for migration 0223 (#28363) fix(ui): Use theme border for form footer border (#28359) ref(ts): Authenticators have names (#28362) feat(cdc_search): Implement cdc search for `is:unresolved` query. (#28006) ref(rrweb): Upgrade to latest player (#28333) feat(issue-alerts): Add Sentry Apps Alert Rule Action as an Action (#28338) feat(notifications): Remove NotificationSettings when Slack is uninstalled (#28216) py38(django 2.2): bump django-crispy-forms to 1.8.1 (#28344) types(python): Slack Integration Types (#28236) ref(jira ac): Rm fk constraints from JiraTenant (#28349) chore(js): Upgrade storybook from 6.3.6 -> 6.3.7 (#28323) feat(symbol-sources): Redact symbol source secrets from audit logs (#28334) feat(notifications): Add `actor_id` to Analytics Events (#28347) ref(performance): Separate header from content in transaction events (#28346) Adding in new text styles for the codeowners sync CTA in the issues detail. (#28133) fix(django 2.2): rename view method to avoid clashing (#28312) fix(alerts): Project breadcrumb link to project rule list (#28339) ref(performance): Separate header from content in transaction vitals (#28343) feat(dev_env): Dev env bootstrap support for two Python versions (#28213) ...

In #28213 we removed the leniant Python version check and it hit few engineers. This adds it back and better wording for Python 3.8 version check.

) This change adds supports for bootstrapping two different Python versions. Python 3.8 will be used for Apple M1 since it's the next Python version for Sentry and it is the first one that supports Apple's M1 chip-set. Other miscellaneous fixes and changes included. Co-authored-by: Billy Vong <billyvg@users.noreply.github.com>

In #28213 we removed the leniant Python version check and it hit few engineers. This adds it back and better wording for Python 3.8 version check.

evanpurkhiser · 2021-10-25T23:29:43Z

.python-version

@@ -1 +0,0 @@
-3.6.13


I believe removing this has broken brand new dev environments, since pyenv will just default to the system python version, we never actually have people set their python to 3.8 so they can do python -m venv .venv

We probably can bring this back now?

Now that they have been reunited we can do that, however, if folks are using direnv, the bootstrap script they would be using the PYENV_VERSION env variable which pyenv recognizes.

I can see how using pyenv directly w/o direnv guidance will not have PYENV_VERSION set.

In that case perhaps our develop docs are out of date and should be suggesting more direnv things

I'm going back to the .python-version file approach; simplifying the setup.

armenzg self-assigned this Aug 26, 2021

armenzg added the Component: Developer Environment This covers issues related to setting up a developer's environment label Aug 26, 2021

armenzg added this to the Apple M1 dev env support milestone Aug 26, 2021

Fix the CI

54ac396

vercel bot deployed to Preview – storybook August 26, 2021 19:47 View deployment

vercel bot deployed to Preview – sentry August 26, 2021 19:47 View deployment

Debug info

954436d

vercel bot deployed to Preview – sentry August 26, 2021 19:53 View deployment

vercel bot deployed to Preview – storybook August 26, 2021 19:53 View deployment

Fix

6f7d952

vercel bot deployed to Preview – sentry August 27, 2021 12:14 View deployment

vercel bot deployed to Preview – storybook August 27, 2021 12:14 View deployment

Fix

354a915

vercel bot deployed to Preview – storybook August 27, 2021 12:18 View deployment

vercel bot deployed to Preview – sentry August 27, 2021 12:18 View deployment

Debug info

b206418

vercel bot deployed to Preview – storybook August 27, 2021 12:21 View deployment

vercel bot deployed to Preview – sentry August 27, 2021 12:21 View deployment

Fix

cf06765

vercel bot deployed to Preview – storybook August 27, 2021 12:27 View deployment

vercel bot deployed to Preview – sentry August 27, 2021 12:27 View deployment

vercel bot deployed to Preview – storybook August 27, 2021 12:30 View deployment

vercel bot deployed to Preview – sentry August 27, 2021 12:30 View deployment

Do not check venv

859f94e

armenzg force-pushed the armenzg/devenv/support-dual-python-apple-m1 branch from 014d44e to 859f94e Compare August 27, 2021 16:21

vercel bot deployed to Preview – storybook August 27, 2021 16:21 View deployment

vercel bot deployed to Preview – sentry August 27, 2021 16:21 View deployment

armenzg commented Aug 27, 2021

View reviewed changes

Fix mismatch

9f326a6

vercel bot deployed to Preview – storybook September 1, 2021 13:03 View deployment

vercel bot deployed to Preview – sentry September 1, 2021 13:03 View deployment

Merge branch 'master' into armenzg/devenv/support-dual-python-apple-m1

ea8aeb9

vercel bot deployed to Preview – sentry September 1, 2021 14:06 View deployment

vercel bot deployed to Preview – storybook September 1, 2021 14:06 View deployment

Typo

9f2778b

vercel bot deployed to Preview – sentry September 1, 2021 15:05 View deployment

vercel bot deployed to Preview – storybook September 1, 2021 15:05 View deployment

Try again

57d4a02

vercel bot deployed to Preview – sentry September 1, 2021 15:15 View deployment

vercel bot deployed to Preview – storybook September 1, 2021 15:15 View deployment

Try again

aaecdf4

vercel bot deployed to Preview – sentry September 1, 2021 15:45 View deployment

vercel bot deployed to Preview – storybook September 1, 2021 15:45 View deployment

billyvg approved these changes Sep 1, 2021

View reviewed changes

armenzg enabled auto-merge (squash) September 1, 2021 16:50

armenzg merged commit faa028a into master Sep 1, 2021

armenzg deleted the armenzg/devenv/support-dual-python-apple-m1 branch September 1, 2021 16:50

armenzg added a commit that referenced this pull request Sep 2, 2021

feat(devenv): Leniant Python version check

a082d17

In #28213 we removed the leniant Python version check and it hit few engineers. This adds it back and better wording for Python 3.8 version check.

armenzg mentioned this pull request Sep 2, 2021

feat(devenv): Leniant Python version check #28373

Merged

armenzg added a commit that referenced this pull request Sep 2, 2021

feat(devenv): Leniant Python version check (#28373)

a89b47b

In #28213 we removed the leniant Python version check and it hit few engineers. This adds it back and better wording for Python 3.8 version check.

shruthilayaj pushed a commit that referenced this pull request Sep 7, 2021

feat(devenv): Leniant Python version check (#28373)

516e713

In #28213 we removed the leniant Python version check and it hit few engineers. This adds it back and better wording for Python 3.8 version check.

github-actions bot locked and limited conversation to collaborators Sep 17, 2021

evanpurkhiser reviewed Oct 25, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(dev_env): Dev env bootstrap support for two Python versions #28213

feat(dev_env): Dev env bootstrap support for two Python versions #28213

armenzg commented Aug 26, 2021 •

edited

Loading

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg Aug 27, 2021

armenzg commented Sep 1, 2021

billyvg Sep 1, 2021

armenzg commented Sep 1, 2021

evanpurkhiser Oct 25, 2021

armenzg Oct 26, 2021

evanpurkhiser Oct 26, 2021

armenzg Oct 26, 2021

		@@ -1 +0,0 @@
		3.6.13

feat(dev_env): Dev env bootstrap support for two Python versions #28213

feat(dev_env): Dev env bootstrap support for two Python versions #28213

Conversation

armenzg commented Aug 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

armenzg commented Sep 1, 2021

Choose a reason for hiding this comment

armenzg commented Sep 1, 2021

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

armenzg commented Aug 26, 2021 •

edited

Loading