reverting to using a full flag so it gets automatically included in monorail payload args field

saga-dasgupta · saga-dasgupta · commit 58585e0ec2e2 · 2025-11-03T11:03:49.000-06:00
diff --git a/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts b/docs-shopify.dev/commands/interfaces/app-function-run.interface.ts
@@ -24,6 +24,12 @@ export interface appfunctionrun {
    */
   '-i, --input <value>'?: string
 
+  /**
+   * The client that invoked this command.
+   * @environment SHOPIFY_FLAG_INVOKED_BY
+   */
+  '-b, --invoked-by <value>'?: string
+
   /**
    * Output the result as JSON.
    * @environment SHOPIFY_FLAG_JSON
diff --git a/docs-shopify.dev/generated/generated_docs_data.json b/docs-shopify.dev/generated/generated_docs_data.json
@@ -1292,6 +1292,15 @@
                 "isOptional": true,
                 "environmentValue": "SHOPIFY_FLAG_VERBOSE"
               },
+              {
+                "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
+                "syntaxKind": "PropertySignature",
+                "name": "-b, --invoked-by <value>",
+                "value": "string",
+                "description": "The client that invoked this command.",
+                "isOptional": true,
+                "environmentValue": "SHOPIFY_FLAG_INVOKED_BY"
+              },
               {
                 "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",
                 "syntaxKind": "PropertySignature",
@@ -1329,7 +1338,7 @@
                 "environmentValue": "SHOPIFY_FLAG_JSON"
               }
             ],
-            "value": "export interface appfunctionrun {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Name of the WebAssembly export to invoke.\n   * @environment SHOPIFY_FLAG_EXPORT\n   */\n  '-e, --export <value>'?: string\n\n  /**\n   * The input JSON to pass to the function. If omitted, standard input is used.\n   * @environment SHOPIFY_FLAG_INPUT\n   */\n  '-i, --input <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
+            "value": "export interface appfunctionrun {\n  /**\n   * The Client ID of your app.\n   * @environment SHOPIFY_FLAG_CLIENT_ID\n   */\n  '--client-id <value>'?: string\n\n  /**\n   * The name of the app configuration.\n   * @environment SHOPIFY_FLAG_APP_CONFIG\n   */\n  '-c, --config <value>'?: string\n\n  /**\n   * Name of the WebAssembly export to invoke.\n   * @environment SHOPIFY_FLAG_EXPORT\n   */\n  '-e, --export <value>'?: string\n\n  /**\n   * The input JSON to pass to the function. If omitted, standard input is used.\n   * @environment SHOPIFY_FLAG_INPUT\n   */\n  '-i, --input <value>'?: string\n\n  /**\n   * The client that invoked this command.\n   * @environment SHOPIFY_FLAG_INVOKED_BY\n   */\n  '-b, --invoked-by <value>'?: string\n\n  /**\n   * Output the result as JSON.\n   * @environment SHOPIFY_FLAG_JSON\n   */\n  '-j, --json'?: ''\n\n  /**\n   * Disable color output.\n   * @environment SHOPIFY_FLAG_NO_COLOR\n   */\n  '--no-color'?: ''\n\n  /**\n   * The path to your function directory.\n   * @environment SHOPIFY_FLAG_PATH\n   */\n  '--path <value>'?: string\n\n  /**\n   * Reset all your settings.\n   * @environment SHOPIFY_FLAG_RESET\n   */\n  '--reset'?: ''\n\n  /**\n   * Increase the verbosity of the output.\n   * @environment SHOPIFY_FLAG_VERBOSE\n   */\n  '--verbose'?: ''\n}"
           }
         }
       }
diff --git a/packages/app/src/cli/commands/app/function/run.ts b/packages/app/src/cli/commands/app/function/run.ts
@@ -7,7 +7,6 @@ import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {Flags} from '@oclif/core'
 import {renderAutocompletePrompt, isTTY} from '@shopify/cli-kit/node/ui'
 import {outputDebug} from '@shopify/cli-kit/node/output'
-import {addPublicMetadata} from '@shopify/cli-kit/node/metadata'
 
 const DEFAULT_FUNCTION_EXPORT = '_start'
 
@@ -34,19 +33,16 @@ export default class FunctionRun extends AppUnlinkedCommand {
       description: 'Name of the WebAssembly export to invoke.',
       env: 'SHOPIFY_FLAG_EXPORT',
     }),
+    'invoked-by': Flags.string({
+      char: 'b',
+      description: 'The client that invoked this command.',
+      env: 'SHOPIFY_FLAG_INVOKED_BY',
+    }),
   }
 
   public async run(): Promise<AppUnlinkedCommandOutput> {
     const {flags} = await this.parse(FunctionRun)
 
-    // Track which client invoked this command
-    const invokedBy = process.env.INVOKED_BY
-    if (invokedBy) {
-      await addPublicMetadata(() => ({
-        cmd_all_invoked_by: invokedBy,
-      }))
-    }
-
     let functionExport = DEFAULT_FUNCTION_EXPORT
 
     const app = await localAppContext({
diff --git a/packages/cli-kit/src/public/node/monorail.ts b/packages/cli-kit/src/public/node/monorail.ts
@@ -57,7 +57,6 @@ export interface Schemas {
       cmd_all_exit?: Optional<string>
       cmd_all_force?: Optional<boolean>
       cmd_all_last_graphql_request_id?: Optional<string>
-      cmd_all_invoked_by?: Optional<string>
 
       cmd_all_timing_network_ms?: Optional<number>
       cmd_all_timing_prompts_ms?: Optional<number>
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -414,19 +414,20 @@ Run a function locally for testing.
 
 ```
 USAGE
-  $ shopify app function run [--client-id <value> | -c <value>] [-e <value>] [-i <value>] [-j] [--no-color] [--path
-    <value>] [--reset | ] [--verbose]
-
-FLAGS
-  -c, --config=<value>     The name of the app configuration.
-  -e, --export=<value>     Name of the WebAssembly export to invoke.
-  -i, --input=<value>      The input JSON to pass to the function. If omitted, standard input is used.
-  -j, --json               Output the result as JSON.
-      --client-id=<value>  The Client ID of your app.
-      --no-color           Disable color output.
-      --path=<value>       The path to your function directory.
-      --reset              Reset all your settings.
-      --verbose            Increase the verbosity of the output.
+  $ shopify app function run [--client-id <value> | -c <value>] [-e <value>] [-i <value>] [-b <value>] [-j]
+    [--no-color] [--path <value>] [--reset | ] [--verbose]
+
+FLAGS
+  -b, --invoked-by=<value>  The client that invoked this command.
+  -c, --config=<value>      The name of the app configuration.
+  -e, --export=<value>      Name of the WebAssembly export to invoke.
+  -i, --input=<value>       The input JSON to pass to the function. If omitted, standard input is used.
+  -j, --json                Output the result as JSON.
+      --client-id=<value>   The Client ID of your app.
+      --no-color            Disable color output.
+      --path=<value>        The path to your function directory.
+      --reset               Reset all your settings.
+      --verbose             Increase the verbosity of the output.
 
 DESCRIPTION
   Run a function locally for testing.
diff --git a/packages/cli/oclif.manifest.json b/packages/cli/oclif.manifest.json
@@ -1131,6 +1131,15 @@
           "name": "input",
           "type": "option"
         },
+        "invoked-by": {
+          "char": "b",
+          "description": "The client that invoked this command.",
+          "env": "SHOPIFY_FLAG_INVOKED_BY",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "name": "invoked-by",
+          "type": "option"
+        },
         "json": {
           "allowNo": false,
           "char": "j",

Original file line number	Diff line number	Diff line change
`@@ -1292,6 +1292,15 @@`
`1292`	`1292`	`"isOptional": true,`
`1293`	`1293`	`"environmentValue": "SHOPIFY_FLAG_VERBOSE"`
`1294`	`1294`	`},`
	`1295`	`+ {`
	`1296`	`+ "filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",`
	`1297`	`+ "syntaxKind": "PropertySignature",`
	`1298`	`+ "name": "-b, --invoked-by <value>",`
	`1299`	`+ "value": "string",`
	`1300`	`+ "description": "The client that invoked this command.",`
	`1301`	`+ "isOptional": true,`
	`1302`	`+ "environmentValue": "SHOPIFY_FLAG_INVOKED_BY"`
	`1303`	`+ },`
`1295`	`1304`	`{`
`1296`	`1305`	`"filePath": "docs-shopify.dev/commands/interfaces/app-function-run.interface.ts",`
`1297`	`1306`	`"syntaxKind": "PropertySignature",`
`@@ -1329,7 +1338,7 @@`
`1329`	`1338`	`"environmentValue": "SHOPIFY_FLAG_JSON"`
`1330`	`1339`	`}`
`1331`	`1340`	`],`
`1332`		- "value": "export interface appfunctionrun {\n /*\n The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n /\n '--client-id <value>'?: string\n\n /\n The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n /\n '-c, --config <value>'?: string\n\n /\n Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n /\n '-e, --export <value>'?: string\n\n /\n The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n /\n '-i, --input <value>'?: string\n\n /\n Output the result as JSON.\n * @environment SHOPIFY_FLAG_JSON\n /\n '-j, --json'?: ''\n\n /\n Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n /\n '--no-color'?: ''\n\n /\n The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n /\n '--path <value>'?: string\n\n /\n Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n /\n '--reset'?: ''\n\n /\n Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
	`1341`	+ "value": "export interface appfunctionrun {\n /*\n The Client ID of your app.\n * @environment SHOPIFY_FLAG_CLIENT_ID\n /\n '--client-id <value>'?: string\n\n /\n The name of the app configuration.\n * @environment SHOPIFY_FLAG_APP_CONFIG\n /\n '-c, --config <value>'?: string\n\n /\n Name of the WebAssembly export to invoke.\n * @environment SHOPIFY_FLAG_EXPORT\n /\n '-e, --export <value>'?: string\n\n /\n The input JSON to pass to the function. If omitted, standard input is used.\n * @environment SHOPIFY_FLAG_INPUT\n /\n '-i, --input <value>'?: string\n\n /\n The client that invoked this command.\n * @environment SHOPIFY_FLAG_INVOKED_BY\n /\n '-b, --invoked-by <value>'?: string\n\n /\n Output the result as JSON.\n * @environment SHOPIFY_FLAG_JSON\n /\n '-j, --json'?: ''\n\n /\n Disable color output.\n * @environment SHOPIFY_FLAG_NO_COLOR\n /\n '--no-color'?: ''\n\n /\n The path to your function directory.\n * @environment SHOPIFY_FLAG_PATH\n /\n '--path <value>'?: string\n\n /\n Reset all your settings.\n * @environment SHOPIFY_FLAG_RESET\n /\n '--reset'?: ''\n\n /\n Increase the verbosity of the output.\n * @environment SHOPIFY_FLAG_VERBOSE\n */\n '--verbose'?: ''\n}"
`1333`	`1342`	`}`
`1334`	`1343`	`}`
`1335`	`1344`	`}`