using function runner info to provide necessary info about function for function run

Author: saga-dasgupta

packages/app/src/cli/commands/app/function/info.ts

@@ -0,0 +1,64 @@
+import {chooseFunction, functionFlags, getOrGenerateSchemaPath} from '../../../services/function/common.js'
+import {functionRunnerBinary, downloadBinary} from '../../../services/function/binaries.js'
+import {localAppContext} from '../../../services/app-context.js'
+import {appFlags} from '../../../flags.js'
+import AppUnlinkedCommand, {AppUnlinkedCommandOutput} from '../../../utilities/app-unlinked-command.js'
+import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
+import {outputResult} from '@shopify/cli-kit/node/output'
+
+export default class FunctionInfo extends AppUnlinkedCommand {
+  static summary = 'Get information about the function.'
+
+  static description = 'Returns information about the function.'
+
+  static hidden = true
+
+  static flags = {
+    ...globalFlags,
+    ...appFlags,
+    ...functionFlags,
+    ...jsonFlag,
+  }
+
+  public async run(): Promise<AppUnlinkedCommandOutput> {
+    const {flags} = await this.parse(FunctionInfo)
+
+    const app = await localAppContext({
+      directory: flags.path,
+      userProvidedConfigName: flags.config,
+    })
+
+    const ourFunction = await chooseFunction(app, flags.path)
+    const functionRunner = functionRunnerBinary()
+    await downloadBinary(functionRunner)
+
+    const inputQueryPath = ourFunction?.configuration.targeting?.[0]?.input_query
+    const queryPath = inputQueryPath && `${ourFunction?.directory}/${inputQueryPath}`
+    const schemaPath = await getOrGenerateSchemaPath(
+      ourFunction,
+      flags.path,
+      flags['client-id'],
+      flags.reset,
+      flags.config,
+    )
+
+    if (flags.json) {
+      outputResult(
+        JSON.stringify({
+          functionRunnerPath: functionRunner.path,
+          functionRunnerVersion: functionRunner.version,
+          functionInputQueryPath: queryPath,
+          functionSchemaPath: schemaPath,
+          functionWasmPath: ourFunction.outputPath,
+        }),
+      )
+    } else {
+      outputResult(`functionRunnerPath: ${functionRunner.path}`)
+      outputResult(`functionRunnerVersion: ${functionRunner.version}`)
+      outputResult(`functionInputQueryPath: ${queryPath}`)
+      outputResult(`functionSchemaPath: ${schemaPath}`)
+    }
+
+    return {app}
+  }
+}

packages/app/src/cli/index.ts

@@ -28,6 +28,7 @@ import gatherSensitiveMetadata from './hooks/sensitive_metadata.js'
 import AppLinkedCommand from './utilities/app-linked-command.js'
 import DevClean from './commands/app/dev/clean.js'
 import AppUnlinkedCommand from './utilities/app-unlinked-command.js'
+import FunctionInfo from './commands/app/function/info.js'
 
 /**
  * All app commands should extend AppCommand.
@@ -51,6 +52,7 @@ export const commands: {[key: string]: typeof AppLinkedCommand | typeof AppUnlin
   'app:function:build': FunctionBuild,
   'app:function:replay': FunctionReplay,
   'app:function:run': FunctionRun,
+  'app:function:info': FunctionInfo,
   'app:function:schema': FetchSchema,
   'app:function:typegen': FunctionTypegen,
   'app:generate:extension': AppGenerateExtension,

packages/cli/oclif.manifest.json

@@ -887,6 +887,94 @@
       "strict": true,
       "summary": "Compile a function to wasm."
     },
+    "app:function:info": {
+      "aliases": [
+      ],
+      "args": {
+      },
+      "customPluginName": "@shopify/app",
+      "description": "Returns information about the function.",
+      "flags": {
+        "client-id": {
+          "description": "The Client ID of your app.",
+          "env": "SHOPIFY_FLAG_CLIENT_ID",
+          "exclusive": [
+            "config"
+          ],
+          "hasDynamicHelp": false,
+          "hidden": false,
+          "multiple": false,
+          "name": "client-id",
+          "type": "option"
+        },
+        "config": {
+          "char": "c",
+          "description": "The name of the app configuration.",
+          "env": "SHOPIFY_FLAG_APP_CONFIG",
+          "hasDynamicHelp": false,
+          "hidden": false,
+          "multiple": false,
+          "name": "config",
+          "type": "option"
+        },
+        "json": {
+          "allowNo": false,
+          "char": "j",
+          "description": "Output the result as JSON.",
+          "env": "SHOPIFY_FLAG_JSON",
+          "hidden": false,
+          "name": "json",
+          "type": "boolean"
+        },
+        "no-color": {
+          "allowNo": false,
+          "description": "Disable color output.",
+          "env": "SHOPIFY_FLAG_NO_COLOR",
+          "hidden": false,
+          "name": "no-color",
+          "type": "boolean"
+        },
+        "path": {
+          "description": "The path to your function directory.",
+          "env": "SHOPIFY_FLAG_PATH",
+          "hasDynamicHelp": false,
+          "hidden": false,
+          "multiple": false,
+          "name": "path",
+          "noCacheDefault": true,
+          "type": "option"
+        },
+        "reset": {
+          "allowNo": false,
+          "description": "Reset all your settings.",
+          "env": "SHOPIFY_FLAG_RESET",
+          "exclusive": [
+            "config"
+          ],
+          "hidden": false,
+          "name": "reset",
+          "type": "boolean"
+        },
+        "verbose": {
+          "allowNo": false,
+          "description": "Increase the verbosity of the output.",
+          "env": "SHOPIFY_FLAG_VERBOSE",
+          "hidden": false,
+          "name": "verbose",
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hidden": true,
+      "hiddenAliases": [
+      ],
+      "id": "app:function:info",
+      "pluginAlias": "@shopify/cli",
+      "pluginName": "@shopify/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Get information about the function."
+    },
     "app:function:replay": {
       "aliases": [
       ],