Avoid PATH overflow from SetupPython calls #11215

mmisol · 2020-10-28T13:54:06Z

Purpose

Calling Installer.SetupPython from Python.Included makes sure Python is
installed and also adds the install location to the PATH env variable.
The location is added to the PATH even if it was already there, so this
can potentially lead to an env variable overflow with the message
'Environment variable name or value is too long', after which the only
way to get CPython3 back to work would be to restart Dynamo.

The problem is avoided by remembering if Python was setup using a local
field. This should reduce the number of calls to a maximum of 2, which
is not the best (1 would be) but is far from resulting in an overflow.

Declarations

Check these if you believe they are true

The codebase is in a better state after this PR
Is documented according to the standards
The level of testing this PR includes is appropriate
User facing strings, if any, are extracted into *.resx files
All tests pass using the self-service CI.
Snapshot of UI changes, if any.
Changes to the API follow Semantic Versioning and are documented in the API Changes document.
This PR modifies some build requirements and the readme is updated

Calling Installer.SetupPython from Python.Included makes sure Python is installed and also adds the install location to the PATH env variable. The location is added to the PATH even if it was already there, so this can potentially lead to an env variable overflow with the message 'Environment variable name or value is too long', after which the only way to get CPython3 back to work would be to restart Dynamo. The problem is avoided by remembering if Python was setup using a local field. This should reduce the number of calls to a maximum of 2, which is not the best (1 would be) but is far from resulting in an overflow.

mjkkirschner · 2020-10-28T14:37:09Z

@mmisol is it worth adding a test for this functionality to preserve this behavior in the future or you are satisfied with the comment?

mmisol · 2020-10-28T14:59:50Z

Reproducing this with a unit test would be easy too, you would only need to execute code with CPython3 in a loop until you run into the overflow. I thought about it and went with the comment, since it seemed cleaner than that test. Let me know what you think.

mmisol · 2020-10-29T13:06:52Z

Strange. The build is this https://master-5.jenkins.autodesk.com/job/Dynamo/job/DynamoSelfServe/job/pullRequestValidation/1689/ and it passed but somehow it got disconnected from the PR. Merging.

mmisol requested review from mjkkirschner and reddyashish October 28, 2020 13:54

mjkkirschner approved these changes Oct 28, 2020

View reviewed changes

reddyashish approved these changes Oct 28, 2020

View reviewed changes

mmisol merged commit 4c6d232 into DynamoDS:master Oct 29, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Avoid PATH overflow from SetupPython calls #11215

Avoid PATH overflow from SetupPython calls #11215

Uh oh!

mmisol commented Oct 28, 2020 •

edited

Loading

Uh oh!

mjkkirschner commented Oct 28, 2020

Uh oh!

mmisol commented Oct 28, 2020

Uh oh!

mmisol commented Oct 29, 2020

Uh oh!

Uh oh!

Avoid PATH overflow from SetupPython calls #11215

Avoid PATH overflow from SetupPython calls #11215

Uh oh!

Conversation

mmisol commented Oct 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Declarations

Uh oh!

mjkkirschner commented Oct 28, 2020

Uh oh!

mmisol commented Oct 28, 2020

Uh oh!

mmisol commented Oct 29, 2020

Uh oh!

Uh oh!

mmisol commented Oct 28, 2020 •

edited

Loading