Investigate environment detection in our overall environment UX to see if there are scenarios where discovery is unnecessary #19102

Activity

1. Kartik Raj (karrtikr)

   added

   feature-requestRequest for new features or functionalityRequest for new features or functionality

   needs PR

   area-environmentsFeatures relating to handling interpreter environmentsFeatures relating to handling interpreter environments

   on May 9, 2022
2. Kartik Raj (karrtikr)

   self-assigned this

   on May 9, 2022
3. Kartik Raj (karrtikr)

   added this to the May 2022 milestone on May 9, 2022
4. karrtikr commented on May 13, 2022

   

   Kartik Raj (karrtikr)

   on May 13, 2022

   Last edited by karrtikr

   Author

   More actions

   Auto-triggering discovery is probably not needed. Only a couple places need it:

   • When auto-selecting interpreters for a new workspace.
   • Triggering it for every scope exactly once (across sessions).
5. karrtikr commented on May 13, 2022

   

   Kartik Raj (karrtikr)

   on May 13, 2022

   Last edited by karrtikr

   Author

   More actions

   Question: Is triggering it once in the first session even needed, if an interpreter is already selected?

   Perhaps not from a user perspective (#18647), but yes, the discovery API is only considered to be ready for query once refresh has been triggered.

   Reasons for doing it in the first session:

   • Jupyter is going to do that anyways via the API to fetch kernels.
   • Internally it is assumed discovery is triggered atleast once, changing which might not be worth it for now. For example, Auto-selection (which triggers discovery) is always triggered even if an interpreter is explicitly selected, so that user has an auto-selected interpreter to fallback on if the selected interpreter is cleared. Another example: Investigate environment detection in our overall environment UX to see if there are scenarios where discovery is unnecessary #19102 (comment)
   • Select Interpreter section in the getting started section already has environments populated.
   • Rest of sessions should be good.
6. Kartik Raj (karrtikr)

   changed the title [-]Investigate environment detection in our overall environment UX to see if there are scenarios where discovery is unnecessary[/-] [+]Only trigger auto environment discovery once in the first session for a particular scope[/+] on May 13, 2022
7. Kartik Raj (karrtikr)

   added

   verification-neededVerification of issue is requestedVerification of issue is requested

   on May 13, 2022
8. Kartik Raj (karrtikr)

   closed this as completedin #19145on May 13, 2022
9. Kartik Raj (karrtikr)

   reopened this on May 13, 2022
10. Kartik Raj (karrtikr)

    removed

    verification-neededVerification of issue is requestedVerification of issue is requested

    on May 13, 2022
11. Kartik Raj (karrtikr)

    changed the title [-]Only trigger auto environment discovery once in the first session for a particular scope[/-] [+]Investigate environment detection in our overall environment UX to see if there are scenarios where discovery is unnecessary[/+] on May 13, 2022
12. karrtikr commented on May 16, 2022

    

    Kartik Raj (karrtikr)

    on May 16, 2022

    Author

    More actions

    We also need to make sure legacy jupyter integration APIs still work.
13. karrtikr commented on May 17, 2022

    

    Kartik Raj (karrtikr)

    on May 17, 2022

    Last edited by karrtikr

    Author

    More actions

    Proposed approach, only auto-trigger discovery if:

    • A user attempts to choose a different interpreter
    • When a particular scope (workspace or global) is opened for the first time
    • When jupyter queries legacy discovery APIs for envs (Jupyter currently queries this on startup)
    • Environment cache is empty

    Note we also need to make sure that the selected environment has the latest version, now that discovery isn't run by default.
14. Kartik Raj (karrtikr)

    closed this as completedin #19162on May 18, 2022
15. Kartik Raj (karrtikr)

    added

    verification-neededVerification of issue is requestedVerification of issue is requested

    on May 18, 2022
16. karrtikr commented on May 18, 2022

    

    Kartik Raj (karrtikr)

    on May 18, 2022

    Last edited by karrtikr

    Author

    More actions

    Verification steps:

    If Jupyter is not installed or disabled, verify we auto-trigger discovery only if:

    • A user attempts to choose a different interpreter when quickpick list is opened the first time.
    • When a particular scope (workspace or global) is opened for the first time
    • No Python is installed

    If Jupyter is installed, discovery is always triggered.
17. karrtikr commented on May 19, 2022

    

    Kartik Raj (karrtikr)

    on May 19, 2022

    Author

    More actions

    Certain components (like diagnostics) call for hasInterpreters() API, which requires that discovery is triggered atleast once for it to work. See if we can avoid calling it and make sure information returned by it is reliable enough.
18. Kartik Raj (karrtikr)

    reopened this on May 19, 2022
19. Kartik Raj (karrtikr)

    closed this as completedin #19169on May 19, 2022
20. Rich Chiodo (rchiodo)

    added

    verifiedVerification succeededVerification succeeded

    on Jun 1, 2022
21. rchiodo commented on Jun 1, 2022

    

    Rich Chiodo (rchiodo)

    on Jun 1, 2022

    More actions

    /verified?

    It does trigger discovery just when opening 'Select interpreters'? Is this expected?

    Otherwise behaves as you outlined.
22. karrtikr commented on Jun 1, 2022

    

    Kartik Raj (karrtikr)

    on Jun 1, 2022

    Author

    More actions

    A user attempts to choose a different interpreter when quickpick list is opened the first time

    Yep, that's what the above point means in #19102 (comment), only happens the first time though.
23. github-actions

    locked as resolved and limited conversation to collaborators on Jul 2, 2022