Merge pull request #17 from ritaagarwala-sf/main

Updating sf data-code-extension function init to accept --use-ini-feature

Author: sbyrne-sf

README.md

@@ -86,20 +86,18 @@ Deploy a Data Code Extension function package to a Salesforce org.
 
 ```
 USAGE
-  $ sf data-code-extension function deploy -n <value> --package-version <value> -d <value> -p <value> -o <value> --function-invoke-opt
-    UnstructuredChunking [--flags-dir <value>] [--network <value>] [--cpu-size CPU_L|CPU_XL|CPU_2XL|CPU_4XL]
+  $ sf data-code-extension function deploy -n <value> --package-version <value> -d <value> -p <value> -o <value> [--flags-dir <value>]
+    [--network <value>] [--cpu-size CPU_L|CPU_XL|CPU_2XL|CPU_4XL]
 
 FLAGS
-  -d, --description=<value>           (required) Description of the package.
-  -n, --name=<value>                  (required) Name of the package to deploy.
-  -o, --target-org=<value>            (required) Target Salesforce org for deployment.
-  -p, --package-dir=<value>           (required) Directory containing the packaged code.
-      --cpu-size=<option>             [default: CPU_2XL] CPU size for the deployment.
-                                      <options: CPU_L|CPU_XL|CPU_2XL|CPU_4XL>
-      --function-invoke-opt=<option>  (required) Function invocation option (function packages only).
-                                      <options: UnstructuredChunking>
-      --network=<value>               Network configuration for Jupyter notebooks.
-      --package-version=<value>       (required) Version of the package to deploy.
+  -d, --description=<value>      (required) Description of the package.
+  -n, --name=<value>             (required) Name of the package to deploy.
+  -o, --target-org=<value>       (required) Target Salesforce org for deployment.
+  -p, --package-dir=<value>      (required) Directory containing the packaged code.
+      --cpu-size=<option>        [default: CPU_2XL] CPU size for the deployment.
+                                 <options: CPU_L|CPU_XL|CPU_2XL|CPU_4XL>
+      --network=<value>          Network configuration for Jupyter notebooks.
+      --package-version=<value>  (required) Version of the package to deploy.
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -115,12 +113,12 @@ EXAMPLES
   Deploy a function package to the org with alias "myorg":
 
     $ sf data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" \
-      --package-dir ./payload --target-org myorg --function-invoke-opt UnstructuredChunking
+      --package-dir ./payload --target-org myorg
 
   Deploy with a specific CPU size:
 
     $ sf data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" \
-      --package-dir ./payload --target-org myorg --cpu-size CPU_4XL --function-invoke-opt UnstructuredChunking
+      --package-dir ./payload --target-org myorg --cpu-size CPU_4XL
 
 FLAG DESCRIPTIONS
   -d, --description=<value>  Description of the package.
@@ -148,10 +146,6 @@ FLAG DESCRIPTIONS
     The CPU allocation size for your deployed package. Options are: CPU_L (small), CPU_XL (large), CPU_2XL (extra large,
     default), CPU_4XL (maximum). Higher CPU sizes provide more processing power but may have quota implications.
 
-  --function-invoke-opt=UnstructuredChunking  Function invocation option (function packages only).
-
-    Configuration for how functions should be invoked. UnstructuredChunking is only valid option at this point
-
   --network=<value>  Network configuration for Jupyter notebooks.
 
     Optional network configuration setting for packages that include Jupyter notebooks. Common values include 'host' for
@@ -171,10 +165,13 @@ Initialize the Data Code Extension function package.
 
 ```
 USAGE
-  $ sf data-code-extension function init -p <value> [--flags-dir <value>]
+  $ sf data-code-extension function init -p <value> [--flags-dir <value>] [-u SearchIndexChunking]
 
 FLAGS
-  -p, --package-dir=<value>  (required) Directory path where the package will be created.
+  -p, --package-dir=<value>      (required) Directory path where the package will be created.
+  -u, --use-in-feature=<option>  [default: SearchIndexChunking] Feature flag for function initialization (function
+                                 packages only).
+                                 <options: SearchIndexChunking>
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
@@ -193,6 +190,11 @@ FLAG DESCRIPTIONS
   -p, --package-dir=<value>  Directory path where the package will be created.
 
     The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
+
+  -u, --use-in-feature=SearchIndexChunking  Feature flag for function initialization (function packages only).
+
+    Configuration for which feature this function will be used in. SearchIndexChunking is the only valid option and is
+    used by default if not specified.
 ```
 
 _See code: [src/commands/data-code-extension/function/init.ts](https://github.com/salesforcecli/plugin-data-code-extension/blob/0.1.5/src/commands/data-code-extension/function/init.ts)_
@@ -203,12 +205,12 @@ Run a Data Code Extension function package locally using data from your Salesfor
 
 ```
 USAGE
-  $ sf data-code-extension function run -e <value> -o <value> [--flags-dir <value>] [--config-file <value>]
+  $ sf data-code-extension function run -e <value> -t <value> [--flags-dir <value>] [--config-file <value>]
   [--dependencies <value>]
 
 FLAGS
   -e, --entrypoint=<value>    (required) Entrypoint file for the package to run.
-  -o, --target-org=<value>    (required) Target Salesforce org to run against.
+  -t, --test-with=<value>     (required) Path to test.json file to test Data Code Extension function
       --config-file=<value>   Path to a config file.
       --dependencies=<value>  Dependencies override for the run.
 
@@ -222,25 +224,24 @@ DESCRIPTION
   before running. Supports both script and function packages with optional config file and dependencies overrides.
 
 EXAMPLES
-  Run a function package against the org with alias "myorg":
+  Run a function package:
 
-    $ sf data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org \
-      myorg
+    $ sf data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --test-with \
+      ./my-function-package/payload/tests/test.json
 
   Run with a custom config file:
 
-    $ sf data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org \
-      myorg --config-file ./my-function-package/payload/config.json
+    $ sf data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --test-with \
+      ./my-function-package/payload/tests/test.json --config-file ./my-function-package/payload/config.json
 
 FLAG DESCRIPTIONS
   -e, --entrypoint=<value>  Entrypoint file for the package to run.
 
     The path to the entrypoint file of your initialized Data Cloud custom code package.
 
-  -o, --target-org=<value>  Target Salesforce org to run against.
+  -t, --test-with=<value>  Path to test.json file to test Data Code Extension function
 
-    The alias or username of the Salesforce org where you want to run the Data Cloud custom code package. The org must
-    have Data Cloud enabled and appropriate permissions.
+    Path to a JSON file that provides input request for the function.
 
   --config-file=<value>  Path to a config file.
 

messages/deploy.md

@@ -30,11 +30,11 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or
 
 - Deploy a function package to the org with alias "myorg":
 
-  <%= config.bin %> data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./payload --target-org myorg --function-invoke-opt UnstructuredChunking
+  <%= config.bin %> data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./payload --target-org myorg
 
 - Deploy with a specific CPU size:
 
-  <%= config.bin %> data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./payload --target-org myorg --cpu-size CPU_4XL --function-invoke-opt UnstructuredChunking
+  <%= config.bin %> data-code-extension function deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./payload --target-org myorg --cpu-size CPU_4XL
 
 # info.checkingPython
 
@@ -152,14 +152,6 @@ Target Salesforce org for deployment.
 
 The alias or username of the Salesforce org where you want to deploy the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions.
 
-# flags.functionInvokeOpt.summary
-
-Function invocation option (function packages only).
-
-# flags.functionInvokeOpt.description
-
-Configuration for how functions should be invoked. UnstructuredChunking is only valid option at this point
-
 # error.flagEmpty
 
 The --%s flag requires a non-empty value.

messages/init.md

@@ -12,6 +12,22 @@ Initializes the Data Code Extension by checking system requirements and setting
 
   <%= config.bin %> data-code-extension %s init --package-dir ./my-%s-package
 
+# examples.function
+
+- Initialize a function package (uses SearchIndexChunking by default):
+
+  <%= config.bin %> data-code-extension function init --package-dir ./my-function-package
+
+- Initialize a function package with explicit feature flag:
+
+  <%= config.bin %> data-code-extension function init --package-dir ./my-function-package --use-in-feature SearchIndexChunking
+
+# examples.script
+
+- Initialize a script package:
+
+  <%= config.bin %> data-code-extension script init --package-dir ./my-script-package
+
 # info.checkingPython
 
 Checking Python version...
@@ -67,3 +83,11 @@ Directory path where the package will be created.
 # flags.packageDir.description
 
 The directory path where the new package will be initialized. The directory will be created if it doesn't exist.
+
+# flags.useInFeature.summary
+
+Feature flag for function initialization (function packages only).
+
+# flags.useInFeature.description
+
+Configuration for which feature this function will be used in. SearchIndexChunking is the only valid option and is used by default if not specified.

messages/run.md

@@ -18,13 +18,13 @@ Executes an initialized Data Cloud custom code package against a Salesforce org.
 
 # examples.function
 
-- Run a function package against the org with alias "myorg":
+- Run a function package:
 
-  <%= config.bin %> data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org myorg
+  <%= config.bin %> data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --test-with ./my-function-package/payload/tests/test.json
 
 - Run with a custom config file:
 
-  <%= config.bin %> data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --target-org myorg --config-file ./my-function-package/payload/config.json
+  <%= config.bin %> data-code-extension function run --entrypoint ./my-function-package/payload/entrypoint.py --test-with ./my-function-package/payload/tests/tests.json --config-file ./my-function-package/payload/config.json
 
 # info.checkingPython
 
@@ -98,6 +98,14 @@ Target Salesforce org to run against.
 
 The alias or username of the Salesforce org where you want to run the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions.
 
+# flags.testWith.summary
+
+Path to test.json file to test Data Code Extension function
+
+# flags.testWith.description
+
+Path to a JSON file that provides input request for the function.
+
 # flags.configFile.summary
 
 Path to a config file.

src/base/deployBase.ts

@@ -130,8 +130,6 @@ export abstract class DeployBase<TFlags extends BaseDeployFlags = BaseDeployFlag
     const cpuSize = flags['cpu-size'] || 'CPU_2XL';
     const network = flags.network;
 
-    const additionalFlags = this.getAdditionalFlags(flags);
-
     if (packageDir.length === 0) {
       throw new SfError(messages.getMessage('error.flagEmpty', ['package-dir']), 'InvalidFlagValue');
     }
@@ -160,8 +158,7 @@ export abstract class DeployBase<TFlags extends BaseDeployFlags = BaseDeployFlag
         packageDir,
         orgUsername,
         cpuSize,
-        network,
-        additionalFlags.functionInvokeOpt as string | undefined
+        network
       );
 
       this.log(cmdMessages.getMessage('info.deploymentComplete', [name, version]));
@@ -193,5 +190,4 @@ export abstract class DeployBase<TFlags extends BaseDeployFlags = BaseDeployFlag
 
   protected abstract getCodeType(): 'script' | 'function';
   protected abstract getMessages(): Messages<string>;
-  protected abstract getAdditionalFlags(flags: TFlags): Record<string, unknown>;
 }

src/base/initBase.ts

@@ -28,15 +28,17 @@ export type InitResult = SharedResultProps & {
 };
 
 // eslint-disable-next-line sf-plugin/command-summary, sf-plugin/command-example
-export abstract class InitBase extends SfCommand<InitResult> {
+export abstract class InitBase<TFlags extends BaseInitFlags = BaseInitFlags> extends SfCommand<InitResult> {
   public static enableJsonFlag = false;
 
   public async run(): Promise<InitResult> {
-    const { flags } = (await this.parse(this.constructor as typeof InitBase)) as unknown as { flags: BaseInitFlags };
+    const { flags } = (await this.parse(this.constructor as typeof InitBase)) as unknown as { flags: TFlags };
     const codeType = this.getCodeType();
     const messages = this.getMessages();
     const packageDir = flags['package-dir'];
 
+    const additionalFlags = this.getAdditionalFlags(flags);
+
     try {
       const { pythonInfo, packageInfo, binaryInfo } = await checkEnvironment(
         this.spinner,
@@ -45,7 +47,11 @@ export abstract class InitBase extends SfCommand<InitResult> {
       );
 
       this.spinner.start(messages.getMessage('info.executingInit'));
-      const executionResult = await DatacodeBinaryExecutor.executeBinaryInit(codeType, packageDir);
+      const executionResult = await DatacodeBinaryExecutor.executeBinaryInit(
+        codeType,
+        packageDir,
+        additionalFlags.useInFeature as string | undefined
+      );
 
       this.spinner.stop();
       this.log(messages.getMessage('info.initExecuted', [packageDir]));
@@ -77,4 +83,5 @@ export abstract class InitBase extends SfCommand<InitResult> {
 
   protected abstract getCodeType(): 'script' | 'function';
   protected abstract getMessages(): Messages<string>;
+  protected abstract getAdditionalFlags(flags: TFlags): Record<string, unknown>;
 }

src/base/runBase.ts

@@ -21,13 +21,14 @@ import { type SharedResultProps } from './types.js';
 
 export type BaseRunFlags = {
   entrypoint: string;
-  'target-org': Org;
+  'target-org'?: Org;
+  'test-with'?: string;
   'config-file'?: string;
   dependencies?: string;
 };
 
 export type RunResult = SharedResultProps & {
-  targetOrg: string;
+  targetOrg?: string;
   status?: string;
   output?: string;
   executionResult?: DatacodeRunExecutionResult;
@@ -44,6 +45,7 @@ export abstract class RunBase extends SfCommand<RunResult> {
 
     const packageDir = flags.entrypoint;
     const targetOrg = flags['target-org'];
+    const testWith = flags['test-with'];
     const configFile = flags['config-file'];
     const dependencies = flags.dependencies;
 
@@ -54,19 +56,24 @@ export abstract class RunBase extends SfCommand<RunResult> {
         messages
       );
 
-      const orgUsername = targetOrg.getUsername() ?? 'target org';
-      this.spinner.start(messages.getMessage('info.authenticating', [orgUsername]));
+      let orgUsername: string | undefined;
 
-      const connection = targetOrg.getConnection();
-      await connection.refreshAuth();
+      if (targetOrg) {
+        orgUsername = targetOrg.getUsername() ?? 'target org';
+        this.spinner.start(messages.getMessage('info.authenticating', [orgUsername]));
 
-      this.spinner.stop();
-      this.log(messages.getMessage('info.authenticated', [orgUsername]));
+        const connection = targetOrg.getConnection();
+        await connection.refreshAuth();
+
+        this.spinner.stop();
+        this.log(messages.getMessage('info.authenticated', [orgUsername]));
+      }
 
       this.spinner.start(messages.getMessage('info.runningPackage'));
       const executionResult = await DatacodeBinaryExecutor.executeBinaryRun(
         packageDir,
         orgUsername,
+        testWith,
         configFile,
         dependencies
       );

src/commands/data-code-extension/function/deploy.ts

@@ -13,33 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
-import { DeployBase, type BaseDeployFlags } from '../../../base/deployBase.js';
+import { DeployBase } from '../../../base/deployBase.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-code-extension', 'deploy');
 
-export type FunctionDeployFlags = BaseDeployFlags & {
-  'function-invoke-opt': string;
-};
-
 // eslint-disable-next-line sf-plugin/only-extend-SfCommand
-export default class Deploy extends DeployBase<FunctionDeployFlags> {
+export default class Deploy extends DeployBase {
   public static readonly state = 'beta';
   public static readonly summary = messages.getMessage('summary', ['function']);
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples.function');
 
   public static readonly flags = {
     ...DeployBase.flags,
-    // Function-specific flag
-    'function-invoke-opt': Flags.string({
-      summary: messages.getMessage('flags.functionInvokeOpt.summary'),
-      description: messages.getMessage('flags.functionInvokeOpt.description'),
-      options: ['UnstructuredChunking'],
-      required: true,
-    }),
   };
 
   // eslint-disable-next-line class-methods-use-this
@@ -51,11 +39,4 @@ export default class Deploy extends DeployBase<FunctionDeployFlags> {
   protected getMessages(): Messages<string> {
     return messages;
   }
-
-  // eslint-disable-next-line class-methods-use-this
-  protected getAdditionalFlags(flags: FunctionDeployFlags): Record<string, unknown> {
-    return {
-      functionInvokeOpt: flags['function-invoke-opt'],
-    };
-  }
 }