Support optional python and r section attributes

cmd/publisher/commands/deploy.go

@@ -53,12 +53,12 @@ func (cmd *DeployCmd) Run(args *cli_types.CommonArgs, ctx *cli_types.CLIContext)
 			return err
 		}
 	}
-	i := initialize.NewDefaultInitialize()
-	err = i.InitIfNeeded(absPath, cmd.ConfigName, ctx.Logger)
+	i := initialize.NewDefaultInitialize(nil, nil)
+	err = i.InitIfNeeded(absPath, cmd.ConfigName, ctx.Logger, false)
 	if err != nil {
 		return err
 	}
-	stateStore, err := state.New(absPath, cmd.AccountName, cmd.ConfigName, "", cmd.SaveName, ctx.Accounts, nil, false)
+	stateStore, err := state.New(absPath, cmd.AccountName, cmd.ConfigName, "", cmd.SaveName, ctx.Accounts, nil, false, nil, nil)
 	if err != nil {
 		return err
 	}

cmd/publisher/commands/init.go

@@ -52,8 +52,8 @@ func (cmd *InitCommand) Run(args *cli_types.CommonArgs, ctx *cli_types.CLIContex
 	if cmd.ConfigName == "" {
 		cmd.ConfigName = config.DefaultConfigName
 	}
-	i := initialize.NewDefaultInitialize()
-	cfg, err := i.Init(absPath, cmd.ConfigName, cmd.Python, cmd.R, ctx.Logger)
+	i := initialize.NewDefaultInitialize(nil, nil)
+	cfg, err := i.Init(absPath, cmd.ConfigName, ctx.Logger, false)
 	if err != nil {
 		return err
 	}

cmd/publisher/commands/redeploy.go

@@ -33,8 +33,8 @@ func (cmd *RedeployCmd) Run(args *cli_types.CommonArgs, ctx *cli_types.CLIContex
 	}
 	ctx.Logger = events.NewCLILogger(args.Verbose, os.Stderr)
 
-	i := initialize.NewDefaultInitialize()
-	err = i.InitIfNeeded(absPath, cmd.ConfigName, ctx.Logger)
+	i := initialize.NewDefaultInitialize(nil, nil)
+	err = i.InitIfNeeded(absPath, cmd.ConfigName, ctx.Logger, false)
 	if err != nil {
 		return err
 	}
@@ -43,7 +43,7 @@ func (cmd *RedeployCmd) Run(args *cli_types.CommonArgs, ctx *cli_types.CLIContex
 	if err != nil {
 		return fmt.Errorf("invalid deployment name '%s': %w", cmd.TargetName, err)
 	}
-	stateStore, err := state.New(absPath, "", cmd.ConfigName, cmd.TargetName, "", ctx.Accounts, nil, false)
+	stateStore, err := state.New(absPath, "", cmd.ConfigName, cmd.TargetName, "", ctx.Accounts, nil, false, nil, nil)
 	if err != nil {
 		return err
 	}

cmd/publisher/commands/requirements_create.go

@@ -35,7 +35,7 @@ func (cmd *CreateRequirementsCommand) Run(args *cli_types.CommonArgs, ctx *cli_t
 	if exists && !cmd.Force {
 		return errRequirementsFileExists
 	}
-	inspector, _ := inspect.NewPythonInspector(absPath, cmd.Python, ctx.Logger, nil, nil)
+	inspector, _ := inspect.NewPythonInspector(absPath, nil, ctx.Logger, nil)
 	reqs, incomplete, pythonExecutable, err := inspector.ScanRequirements(absPath)
 	if err != nil {
 		return err

cmd/publisher/commands/requirements_show.go

@@ -21,7 +21,7 @@ func (cmd *ShowRequirementsCommand) Run(args *cli_types.CommonArgs, ctx *cli_typ
 	if err != nil {
 		return err
 	}
-	inspector, _ := inspect.NewPythonInspector(absPath, cmd.Python, ctx.Logger, nil, nil)
+	inspector, _ := inspect.NewPythonInspector(absPath, nil, ctx.Logger, nil)
 	reqs, incomplete, pythonExecutable, err := inspector.ScanRequirements(absPath)
 	if err != nil {
 		return err

docs/configuration.md

@@ -104,19 +104,30 @@ API_URL = "https://example.com/api"
 
 ## Python settings
 
+The existence of the `python` section indicates a dependency on python for the deployment. All attributes are
+optional, so the python section can be as simple as:
+
+```toml
+[python]
+```
+
 #### package_file
 
-File containing package dependencies. The file must exist and be listed under 'files'. The default is 'requirements.txt'.
+File containing package dependencies. This entry is optional and defaults to `requirements.txt`. When provided, the file must exist and be listed within `files`.
 
 #### package_manager
 
-Package manager that will install the dependencies. Supported values are `pip` and `none`. If package-manager is `none`, dependencies will not be installed.
+Package manager that will install the dependencies. This entry is optional and defaults to `pip`. Supported values are `pip` and `none`. If package-manager is `none`, dependencies will not be installed.
 
 #### version
 
-Python version. The server must have a matching Python major/minor version in order to run the content.
+Python version. The server must have a matching Python major/minor version in order to run the content. This entry is
+optional and defaults to the version of the active Python interpreter.
 
-Example:
+By not supplying the python version attribute, the requested python version will "float" to the active version of Python being
+used at the time of deployment. This may or may not be desired. If you need to "lock" it down, then provide the desired target value
+
+#### Example: (with all attributes provided)
 
 ```toml
 [python]
@@ -127,19 +138,30 @@ package_manager = "pip"
 
 ## R settings
 
+The existence of the `r` section indicates a dependency on R for the deployment. All attributes are
+optional, so the r section can be as simple as:
+
+```toml
+[r]
+```
+
 #### package_file
 
-File containing package dependencies. This is usually `renv.lock`. The file must exist and be listed under 'files'.
+File containing package dependencies. This entry is optional and defaults to the package file configured within the active R interpreter's `renv` installation (this is usually `renv.lock`). When provided, the file must exist and be listed within `files`.
 
 #### package_manager
 
-Package manager that will install the dependencies. Supported values are `renv` and `none`. If package-manager is `none`, dependencies will be assumed to be pre-installed on the server.
+Package manager that will install the dependencies. This entry is optional and defaults to `renv`. Supported values are `renv` and `none`. If package-manager is `none`, dependencies will not be installed.
 
 #### version
 
-R version. The server will use the nearest R version to run the content.
+R version. The server will use the nearest R version to run the content. This entry is
+optional and defaults to the version of the active R interpreter.
 
-Example:
+By not supplying the r version attribute, the requested r version will "float" to the active version of R being
+used at the time of deployment. This may or may not be desired. If you need to "lock" it down, then provide the desired target value
+
+#### Example: (with all attributes provided)
 
 ```toml
 [r]

extensions/vscode/src/api/resources/Configurations.ts

@@ -9,6 +9,8 @@ import {
   ConfigurationInspectionResult,
 } from "../types/configurations";
 
+import { PythonExecutable, RExecutable } from "../../types/shared";
+
 export class Configurations {
   private client: AxiosInstance;
 
@@ -20,25 +22,41 @@ export class Configurations {
   // 200 - success
   // 404 - not found
   // 500 - internal server error
-  get(configName: string, dir: string) {
+  get(
+    configName: string,
+    dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
+  ) {
     const encodedName = encodeURIComponent(configName);
     return this.client.get<Configuration | ConfigurationError>(
       `/configurations/${encodedName}`,
       {
-        params: { dir },
+        params: {
+          dir,
+          python: python.pythonPath,
+          r: r.rPath,
+        },
       },
     );
   }
 
   // Returns:
   // 200 - success
   // 500 - internal server error
-  getAll(dir: string, params?: { entrypoint?: string; recursive?: boolean }) {
+  getAll(
+    dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
+    params?: { entrypoint?: string; recursive?: boolean },
+  ) {
     return this.client.get<Array<Configuration | ConfigurationError>>(
       "/configurations",
       {
         params: {
           dir,
+          r: r.rPath,
+          python: python.pythonPath,
           ...params,
         },
       },
@@ -80,19 +98,18 @@ export class Configurations {
   // 500 - internal server error
   inspect(
     dir: string,
-    python?: string,
-    r?: string,
+    r: RExecutable,
+    python: PythonExecutable,
     params?: { entrypoint?: string; recursive?: boolean },
   ) {
     return this.client.post<ConfigurationInspectionResult[]>(
       "/inspect",
-      {
-        python,
-        r,
-      },
+      {},
       {
         params: {
           dir,
+          python: python.pythonPath,
+          r: r.rPath,
           ...params,
         },
       },

extensions/vscode/src/api/resources/ContentRecords.ts

@@ -8,6 +8,7 @@ import {
   ContentRecord,
   Environment,
 } from "../types/contentRecords";
+import { PythonExecutable, RExecutable } from "../../types/shared";
 
 export class ContentRecords {
   private client: AxiosInstance;
@@ -74,17 +75,15 @@ export class ContentRecords {
     configName: string,
     insecure: boolean,
     dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
     secrets?: Record<string, string>,
-    r?: string,
-    python?: string,
   ) {
     const data = {
       account: accountName,
       config: configName,
       secrets: secrets,
       insecure: insecure,
-      r: r,
-      python: python,
     };
     const encodedTarget = encodeURIComponent(targetName);
     return this.client.post<{ localId: string }>(
@@ -93,6 +92,8 @@ export class ContentRecords {
       {
         params: {
           dir,
+          python: python.pythonPath,
+          r: r.rPath,
         },
       },
     );

extensions/vscode/src/api/resources/Files.ts

@@ -4,6 +4,7 @@ import { AxiosInstance } from "axios";
 
 import { ContentRecordFile, FileAction } from "../types/files";
 import { Configuration } from "../types/configurations";
+import { PythonExecutable, RExecutable } from "../../types/shared";
 
 export class Files {
   private client: AxiosInstance;
@@ -26,11 +27,22 @@ export class Files {
   // 404 - configuration does not exist
   // 422 - configuration files list contains invalid patterns
   // 500 - internal server error
-  getByConfiguration(configName: string, dir: string) {
+  getByConfiguration(
+    configName: string,
+    dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
+  ) {
     const encodedName = encodeURIComponent(configName);
     return this.client.get<ContentRecordFile>(
       `/configurations/${encodedName}/files`,
-      { params: { dir } },
+      {
+        params: {
+          dir,
+          python: python.pythonPath,
+          r: r.rPath,
+        },
+      },
     );
   }
 

extensions/vscode/src/api/resources/Packages.ts

@@ -6,6 +6,7 @@ import {
   PythonPackagesResponse,
   ScanPythonPackagesResponse,
 } from "../types/packages";
+import { PythonExecutable, RExecutable } from "../../types/shared";
 
 export class Packages {
   private client: AxiosInstance;
@@ -20,11 +21,22 @@ export class Packages {
   // 409 - conflict (Python is not configured)
   // 422 - package file is invalid
   // 500 - internal server error
-  getPythonPackages(configName: string, dir: string) {
+  getPythonPackages(
+    configName: string,
+    dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
+  ) {
     const encodedName = encodeURIComponent(configName);
     return this.client.get<PythonPackagesResponse>(
       `/configurations/${encodedName}/packages/python`,
-      { params: { dir } },
+      {
+        params: {
+          dir,
+          python: python.pythonPath,
+          r: r.rPath,
+        },
+      },
     );
   }
 
@@ -34,11 +46,22 @@ export class Packages {
   // 409 - conflict (R is not configured)
   // 422 - package file is invalid
   // 500 - internal server error
-  getRPackages(configName: string, dir: string) {
+  getRPackages(
+    configName: string,
+    dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
+  ) {
     const encodedName = encodeURIComponent(configName);
     return this.client.get<GetRPackagesResponse>(
       `/configurations/${encodedName}/packages/r`,
-      { params: { dir } },
+      {
+        params: {
+          dir,
+          python: python.pythonPath,
+          r: r.rPath,
+        },
+      },
     );
   }
 
@@ -48,25 +71,43 @@ export class Packages {
   // 500 - internal server error
   createPythonRequirementsFile(
     dir: string,
-    python?: string,
+    r: RExecutable,
+    python: PythonExecutable,
     saveName?: string,
   ) {
     return this.client.post<ScanPythonPackagesResponse>(
       "packages/python/scan",
-      { python, saveName },
-      { params: { dir } },
+      { saveName },
+      {
+        params: {
+          dir,
+          python: python.pythonPath,
+          r: r.rPath,
+        },
+      },
     );
   }
 
   // Returns:
   // 200 - success
   // 400 - bad request
   // 500 - internal server error
-  createRRequirementsFile(dir: string, saveName?: string, r?: string) {
+  createRRequirementsFile(
+    dir: string,
+    r: RExecutable,
+    python: PythonExecutable,
+    saveName?: string,
+  ) {
     return this.client.post<void>(
       "packages/r/scan",
-      { saveName, r },
-      { params: { dir } },
+      { saveName },
+      {
+        params: {
+          dir,
+          python: python.pythonPath,
+          r: r.rPath,
+        },
+      },
     );
   }
 }