feat(onboarding): add poetry as an option to python install snippets #90365

shellmayr · 2025-04-25T10:59:00Z

Add poetry as an option in the python installation instructions along with pip and uv
Move adding of quotation marks into the central utility for consistency & use double quotation marks after alignment with Python SDK team
Add tests for the install instructions utility

Example:

…ison option

…orgs that don't have dynamic sampling or custom sample rates

…l-snippets

codecov · 2025-04-28T08:47:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #90365      +/-   ##
==========================================
- Coverage   87.82%   83.15%   -4.67%     
==========================================
  Files       10267    10280      +13     
  Lines      579568   579158     -410     
  Branches    22622    22648      +26     
==========================================
- Hits       508984   481599   -27385     
- Misses      70150    97121   +26971     
- Partials      434      438       +4

priscilawebdev · 2025-04-29T06:37:34Z

we probably want to remove the quotes here too:

sentry/static/app/gettingStartedDocs/python/falcon.tsx

Line 76 in a17e709

configurations: getPythonInstallConfig({packageName: "'sentry-sdk[falcon]'"}),

priscilawebdev · 2025-04-29T06:39:21Z

static/app/utils/gettingStartedDocs/python.tsx

@@ -67,6 +70,16 @@ export function getPythonInstallConfig({
            minimumVersion,
          }),
        },
+        {


since all of the 3x packages are being used here. what about just return

return { uv: `uv add ${upgradeFlag}${versionedPackage}`, pip: `pip install ${upgradeFlag}${versionedPackage}`, poetry: `poetry add ${versionedPackage}`, }

in the getPythonInstallSnippet? this way we don't need to call the function 3x times but only 1x and we can do pythonInstallSnippet.poetry for example

Good point, changed it 👍

antonpirker

From my limited frontend knowledge this looks good to me.

priscilawebdev · 2025-04-30T08:10:59Z

static/app/utils/gettingStartedDocs/python.spec.tsx

+    const result = getPythonInstallSnippet({
+      packageName: 'sentry-sdk',
+    });


nit:

Suggested change

const result = getPythonInstallSnippet({

packageName: 'sentry-sdk',

});

const result = getPythonInstallSnippet();

Isn't "sentry-sdk" the default packageName?

Not in the InstallSnippet; only in the InstallConfig, which is why it needs to be passed in here in the test

priscilawebdev · 2025-04-30T08:14:00Z

static/app/utils/gettingStartedDocs/python.spec.tsx

+  it('generates uv install command with default parameters', () => {
+    const result = getPythonInstallSnippet({
+      packageName: 'sentry-sdk',
+    });
+
+    expect(result.uv).toBe(`uv add "sentry-sdk"`);
+  });


we could combine the tests for uv, pip, and poetry into a single one - this test , for example, could be combined with the first one

Good point - changed

priscilawebdev · 2025-04-30T08:15:02Z

static/app/utils/gettingStartedDocs/python.spec.tsx

+// Mock the modules that cause circular dependencies
+jest.mock('sentry/utils/gettingStartedDocs/python', () => {
+  const original = jest.requireActual('sentry/utils/gettingStartedDocs/python');
+  return {
+    ...original,
+    // Mock any functions causing circular dependencies
+    getPythonProfilingOnboarding: jest.fn(),
+  };
+});


is this needed?

We do need it, because otherwise the tests don't work

priscilawebdev · 2025-04-30T08:16:57Z

what about falcon?

sentry/static/app/gettingStartedDocs/python/falcon.tsx

Line 76 in 2e9a873

configurations: getPythonInstallConfig({packageName: "'sentry-sdk[falcon]'"}),

priscilawebdev

left a few suggestions, but overall it looks good to me! 🙌

priscilawebdev · 2025-05-06T09:29:47Z

static/app/utils/gettingStartedDocs/python.spec.tsx

+    expect(result.poetry).toBe(`poetry add "sentry-sdk"`);
+  });
+
+  it('generates pip install command with minimum version and extras', () => {


Suggested change

it('generates pip install command with minimum version and extras', () => {

it('generates install commands with minimum version and extras', () => {

now we test more than just pip :)

priscilawebdev · 2025-05-06T09:29:53Z

static/app/utils/gettingStartedDocs/python.spec.tsx

+    const result = getPythonInstallSnippet({
+      packageName: 'sentry-sdk',
+    });
+


Suggested change

sentry-io · 2025-05-07T10:57:58Z

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

‼️ TypeError: (0 , _python.getPythonInstallSnippet) is not a function Object.?(python.spec.tsx) View Issue
‼️ TypeError: (0 , _python.getPythonInstallSnippet) is not a function Object.?(python.spec.tsx) View Issue

_{Did you find this useful? React with a 👍 or 👎}

TkDodo · 2025-05-07T11:23:15Z

static/app/utils/gettingStartedDocs/python.spec.tsx

+
+import {getPythonInstallSnippet} from 'sentry/utils/gettingStartedDocs/python';
+
+describe('getPythonInstallSnippet', () => {


can we maybe write those tests against getPythonInstallConfig instead of getPythonInstallSnippet?

getPythonInstallSnippet is only used inside getPythonInstallConfig, so it’s an implementation detail of getPythonInstallSnippet. The “public interface” that is used by consumers is getPythonInstallConfig, and we should be free to change how that is implemented internally without having to change tests

Will be resolved in #91119

…90365)

shellmayr added 5 commits April 25, 2025 09:35

feat(onboarding): unify python install instructions & add minimum ver…

9f7b966

…ison option

feat(dynamic-sampling): add explanatory message on settings page for …

03dc6fd

…orgs that don't have dynamic sampling or custom sample rates

wording

47d150e

wording

59909c0

feat(onboarding): add poetry as an option to python install snippets

8ad4ca7

github-actions bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Apr 25, 2025

vercel bot deployed to Preview April 25, 2025 11:01 View deployment

shellmayr and others added 4 commits April 28, 2025 10:36

Merge branch 'master' into shellmayr/feat/add-poetry-to-python-instal…

2ceb0cc

…l-snippets

consistent single quotation marks

d3dc7e6

consistent double quotation marks

05b76d3

add comment for reasoning

701bcf7

shellmayr marked this pull request as ready for review April 28, 2025 08:41

shellmayr requested a review from a team as a code owner April 28, 2025 08:41

shellmayr requested review from antonpirker and a team and removed request for a team April 28, 2025 08:41

vercel bot deployed to Preview April 28, 2025 08:45 View deployment

shellmayr mentioned this pull request Apr 28, 2025

docs(python): add uv option to python install instructions getsentry/sentry-docs#13510

Merged

priscilawebdev reviewed Apr 29, 2025

View reviewed changes

antonpirker approved these changes Apr 29, 2025

View reviewed changes

refactor

2e9a873

vercel bot deployed to Preview April 29, 2025 08:47 View deployment

priscilawebdev reviewed Apr 30, 2025

View reviewed changes

shellmayr added 2 commits April 30, 2025 10:42

make tests more compact

3689501

falcon quotation marks

161a5a1

vercel bot deployed to Preview April 30, 2025 08:47 View deployment

vercel bot deployed to Preview April 30, 2025 08:51 View deployment

shellmayr requested a review from priscilawebdev April 30, 2025 12:32

priscilawebdev approved these changes May 6, 2025

View reviewed changes

shellmayr merged commit 47fec42 into master May 7, 2025
41 checks passed

shellmayr deleted the shellmayr/feat/add-poetry-to-python-install-snippets branch May 7, 2025 09:33

TkDodo reviewed May 7, 2025

View reviewed changes

andrewshie-sentry pushed a commit that referenced this pull request May 12, 2025

feat(onboarding): add poetry as an option to python install snippets (#…

ccbe623

…90365)

github-actions bot locked and limited conversation to collaborators May 22, 2025

	it('generates pip install command with minimum version and extras', () => {
	it('generates install commands with minimum version and extras', () => {


		import {getPythonInstallSnippet} from 'sentry/utils/gettingStartedDocs/python';

		describe('getPythonInstallSnippet', () => {

Uh oh!

feat(onboarding): add poetry as an option to python install snippets #90365

feat(onboarding): add poetry as an option to python install snippets #90365

Uh oh!

Conversation

shellmayr commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

priscilawebdev commented Apr 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

antonpirker left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

priscilawebdev commented Apr 30, 2025

Uh oh!

priscilawebdev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sentry-io bot commented May 7, 2025

Suspect Issues

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shellmayr commented Apr 25, 2025 •

edited

Loading

codecov bot commented Apr 28, 2025 •

edited

Loading