Create New Project contrib and store project configuration #2899

sharon-wang · 2024-04-25T21:52:39Z

Intent

Most of this work is scaffolding for Project Wizard: Create a new Python Project #2818, Project Wizard: Create a new R Project #2819, Project Wizard: Create a new Jupyter Notebook #2820
Address Project Wizard: New Project can be toggled on/off in release builds #2939
- related to Project Wizard: enable New Project functionality in release builds #2878

Summary

scaffolding to set up New Project contrib and service
storing the new project config in the storage service
some cleanup and refactoring to ensure the project config is stored correctly
adding config setting to support testing the project wizard work in release builds

Config Setting Preview

Approach

store the project configuration in the storage service
- create interface for this data so it can be JSON stringified on write and JSON parsed on read
- use StorageScope.APPLICATION so any workspace can check to see if it is the new project workspace and StorageTarget.MACHINE since the new project is being created on the machine
scaffold NewProject contrib and service, where the new project initialization will occur (selecting interpreter, creating new files, etc.)
add configuration flag so the project wizard can be enabled via settings in release builds (setting ID positron.projectWizardEnabled)
- project wizard will still be enabled by default in dev builds
- update existing IsDevelopmentContext checks to also check this config setting

Next, I'll be leveraging the stored info in the NewProject contribution and service to initialize the project.

QA Notes

The project wizard should be accessible in release builds by enabling the positron.projectWizardEnabled setting.

Using this new contribution, we can wait for workbench initialization and run the project initialization tasks.

configuration id: `positron.useProjectWizard`

Add the flag to the Welcome page check as well.

nstrayer

Overall LGTM!

I had a few philisophical questions about the feature flag + dev mode switching and comments.

One thing I noticed in looking at the code was that some of the useState()s were doing extra computation. The code wasn't from this PR though so I couldn't figure out how to comment on it.
In pythonEnvironmentStep.tsx for the const [interpreterEntries, setInterpreterEntries]... example it will rerun the getPythonInterpreterEntries() every re-render. (You can verify by putting a debug or console.count() at the top of that function. If you just switch to adding a lambda in front you avoid this.

nstrayer · 2024-04-29T14:14:45Z

src/vs/workbench/browser/actions/positronActions.ts

+		// TODO: [New Project] Remove feature flag when New Project action is ready for release
+		// This removes the action in the New menu, the application bar File menu, and the command
+		// palette when the feature flag is not enabled.
+		const projectWizardEnabled = ContextKeyExpr.deserialize(`config.${USE_POSITRON_PROJECT_WIZARD_CONFIG_KEY}`);


Does this mean we won't be able to turn off the wizard? I wonder if it would be better to just switch the default value for the flag to true? (Obviously not applicable to this PR though.)

Currently, the wizard is enabled by default in dev builds and not available at all in release builds. To allow for testing of the WIP wizard in release builds while not making the wizard accessible by default (since functionality is incomplete), the config flag allows us to manually enable the wizard in release builds. In other words, the new flagging logic maintains that the wizard can't be switched off in dev builds, but can now be toggled on/off in release builds (off by default).

Once the wizard is ready for general use, the config flag and dev environment checks will be removed, and the wizard will be available in all the applicable menus.

nstrayer · 2024-04-29T14:19:51Z

src/vs/workbench/services/positronNewProject/common/positronNewProjectEnablement.ts

+	properties: {
+		[USE_POSITRON_PROJECT_WIZARD_CONFIG_KEY]: {
+			type: 'boolean',
+			default: false,


Could this be set to default with the development status to simplify the logic in other places? Then when things are good to go you'd just need to switch this default value instead of modifying the logic elsewhere?

I'd like to do this as it would make toggling the switch much cleaner! I might be blocked by when IsDevelopmentContext is available though.

I tried to use the development status as the default here, but I wasn't sure how to access IsDevelopmentContext without using the ContextKeyService, which I'd need to pass via the PositronNewProjectContribution constructor and wrap this config flag registration call in a function. This delays the registration of the config option, which is okay for the main entrypoints to the wizard, but seems to be too late for the Welcome page (need to trigger a re-render for the config setting to be reflected).

I think IsDevelopmentContext isn't set until the ContextKeyService is initialized, which is why reading IsDevelopmentContext in top-level code didn't yield the expected result.

proj_wizard_config.mp4

src/vs/workbench/browser/positronNewProjectWizard/components/steps/pythonEnvironmentStep.tsx

Although envType is irrelevant for the Existing Environment env setup type, clearing it from the config means that if the user chooses New Environment after having chosen Existing Environment, the envType will be cleared and the user will have to re-select it. The envType can be cleared if applicable when the project config is being constructed.

Some of the `useState`s in pythonEnvironmentStep involve function calls that re-computed on every render. To avoid the unnecessary re-computation, wrap the initial values in arrow functions.

sharon-wang

@nstrayer Thank you for the useState extra computation tip! This is now in my React cheatsheet :)

I've modified a couple of the useStates in the pythonEnvironmentStep.tsx to use arrow functions to avoid the re-evaluation on each render.

sharon-wang · 2024-04-29T16:00:41Z

src/vs/workbench/browser/actions/positronActions.ts

+		// TODO: [New Project] Remove feature flag when New Project action is ready for release
+		// This removes the action in the New menu, the application bar File menu, and the command
+		// palette when the feature flag is not enabled.
+		const projectWizardEnabled = ContextKeyExpr.deserialize(`config.${USE_POSITRON_PROJECT_WIZARD_CONFIG_KEY}`);


Currently, the wizard is enabled by default in dev builds and not available at all in release builds. To allow for testing of the WIP wizard in release builds while not making the wizard accessible by default (since functionality is incomplete), the config flag allows us to manually enable the wizard in release builds. In other words, the new flagging logic maintains that the wizard can't be switched off in dev builds, but can now be toggled on/off in release builds (off by default).

Once the wizard is ready for general use, the config flag and dev environment checks will be removed, and the wizard will be available in all the applicable menus.

sharon-wang · 2024-04-29T16:35:38Z

src/vs/workbench/services/positronNewProject/common/positronNewProjectEnablement.ts

+	properties: {
+		[USE_POSITRON_PROJECT_WIZARD_CONFIG_KEY]: {
+			type: 'boolean',
+			default: false,


I'd like to do this as it would make toggling the switch much cleaner! I might be blocked by when IsDevelopmentContext is available though.

I tried to use the development status as the default here, but I wasn't sure how to access IsDevelopmentContext without using the ContextKeyService, which I'd need to pass via the PositronNewProjectContribution constructor and wrap this config flag registration call in a function. This delays the registration of the config option, which is okay for the main entrypoints to the wizard, but seems to be too late for the Welcome page (need to trigger a re-render for the config setting to be reflected).

I think IsDevelopmentContext isn't set until the ContextKeyService is initialized, which is why reading IsDevelopmentContext in top-level code didn't yield the expected result.

proj_wizard_config.mp4

sharon-wang · 2024-04-30T17:57:59Z

Thank you for the review!

I'll merge this and see if I can simplify the flagging as I build out the contribution/service.

sharon-wang added 7 commits April 23, 2024 16:17

move env config update into reusable function

efeb89b

ensure the initial project config is saved

03171be

update comments and function docs

c7e76a5

Update pythonEnvironmentStepUtils.ts to support undefined envType

5b4a8c3

store the new project configuration in the StorageService

a5173bf

add initial PositronNewProjectContribution

0a0e00e

Using this new contribution, we can wait for workbench initialization and run the project initialization tasks.

use configuration flag to enable/disable Project Wizard

f18d298

configuration id: `positron.useProjectWizard`

sharon-wang marked this pull request as ready for review April 26, 2024 13:35

sharon-wang requested review from nstrayer and timtmok April 26, 2024 13:35

enable new project when config enabled or dev context

328b295

Add the flag to the Welcome page check as well.

nstrayer approved these changes Apr 29, 2024

View reviewed changes

sharon-wang added 3 commits April 29, 2024 12:47

comment on empty dependency array for useEffect

2af2e76

wrap useState initial values in arrow functions to avoid re-evaluation

7829a44

Some of the `useState`s in pythonEnvironmentStep involve function calls that re-computed on every render. To avoid the unnecessary re-computation, wrap the initial values in arrow functions.

sharon-wang commented Apr 29, 2024

View reviewed changes

sharon-wang mentioned this pull request Apr 24, 2024

Project Wizard: enable New Project functionality in release builds #2878

Closed

sharon-wang merged commit 3a9a26f into main Apr 30, 2024
1 check passed

sharon-wang deleted the feature/project-wizard-store-config branch April 30, 2024 17:58

sharon-wang mentioned this pull request Apr 30, 2024

Project Wizard: New Project can be toggled on/off in release builds #2939

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create New Project contrib and store project configuration #2899

Create New Project contrib and store project configuration #2899

sharon-wang commented Apr 25, 2024 •

edited

Loading

nstrayer left a comment

nstrayer Apr 29, 2024

sharon-wang Apr 29, 2024

nstrayer Apr 29, 2024

sharon-wang Apr 29, 2024

sharon-wang left a comment •

edited

Loading

sharon-wang Apr 29, 2024

sharon-wang Apr 29, 2024

sharon-wang commented Apr 30, 2024

Create New Project contrib and store project configuration #2899

Create New Project contrib and store project configuration #2899

Conversation

sharon-wang commented Apr 25, 2024 • edited Loading

Intent

Summary

Config Setting Preview

Approach

QA Notes

nstrayer left a comment

Choose a reason for hiding this comment

nstrayer Apr 29, 2024

Choose a reason for hiding this comment

sharon-wang Apr 29, 2024

Choose a reason for hiding this comment

nstrayer Apr 29, 2024

Choose a reason for hiding this comment

sharon-wang Apr 29, 2024

Choose a reason for hiding this comment

sharon-wang left a comment • edited Loading

Choose a reason for hiding this comment

sharon-wang Apr 29, 2024

Choose a reason for hiding this comment

sharon-wang Apr 29, 2024

Choose a reason for hiding this comment

sharon-wang commented Apr 30, 2024

sharon-wang commented Apr 25, 2024 •

edited

Loading

sharon-wang left a comment •

edited

Loading