adding all SHOPIFY_ prefixed environment variables to monorail

Author: saga-dasgupta

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

@@ -33,12 +33,6 @@ export default class FunctionRun extends AppUnlinkedCommand {
       description: 'Name of the WebAssembly export to invoke.',
       env: 'SHOPIFY_FLAG_EXPORT',
     }),
-    'invoked-by': Flags.string({
-      char: 'b',
-      hidden: true,
-      description: 'The client that invoked this command.',
-      env: 'SHOPIFY_FLAG_INVOKED_BY',
-    }),
   }
 
   public async run(): Promise<AppUnlinkedCommandOutput> {

packages/cli-kit/src/private/node/analytics.ts

@@ -97,9 +97,20 @@ export async function getEnvironmentData(config: Interfaces.Config): Promise<Env
 export async function getSensitiveEnvironmentData(config: Interfaces.Config) {
   return {
     env_plugin_installed_all: JSON.stringify(getPluginNames(config)),
+    env_shopify_variables: JSON.stringify(Object.fromEntries(getShopifyEnvironmentVariables())),
   }
 }
 
+function getShopifyEnvironmentVariables() {
+  const shopifyEnvVars = new Map<string, string>()
+  for (const [key, value] of Object.entries(process.env)) {
+    if (key.startsWith('SHOPIFY_') && value !== undefined) {
+      shopifyEnvVars.set(key, value)
+    }
+  }
+  return shopifyEnvVars
+}
+
 function getPluginNames(config: Interfaces.Config) {
   const pluginNames = [...config.plugins.keys()]
   return pluginNames.sort().filter((plugin) => !plugin.startsWith('@oclif/'))

packages/cli-kit/src/public/node/analytics.test.ts

@@ -185,6 +185,36 @@ describe('event tracking', () => {
     })
   })
 
+  test('sends SHOPIFY_ environment variables in sensitive payload', async () => {
+    const originalEnv = {...process.env}
+    process.env.SHOPIFY_TEST_VAR = 'test_value'
+    process.env.SHOPIFY_ANOTHER_VAR = 'another_value'
+    process.env.NOT_SHOPIFY_VAR = 'should_not_appear'
+
+    await inProjectWithFile('package.json', async (args) => {
+      const commandContent = {command: 'dev', topic: 'app'}
+      await startAnalytics({commandContent, args, currentTime: currentDate.getTime() - 100})
+
+      // When
+      const config = {
+        runHook: vi.fn().mockResolvedValue({successes: [], failures: []}),
+        plugins: [],
+      } as any
+      await reportAnalyticsEvent({config, exitMode: 'ok'})
+
+      // Then
+      const sensitivePayload = publishEventMock.mock.calls[0]![2]
+      expect(publishEventMock).toHaveBeenCalledOnce()
+      expect(sensitivePayload).toHaveProperty('env_shopify_variables')
+      expect(sensitivePayload.env_shopify_variables).toBeDefined()
+
+      const shopifyVars = JSON.parse(sensitivePayload.env_shopify_variables as string)
+      expect(shopifyVars).toHaveProperty('SHOPIFY_TEST_VAR', 'test_value')
+      expect(shopifyVars).toHaveProperty('SHOPIFY_ANOTHER_VAR', 'another_value')
+      expect(shopifyVars).not.toHaveProperty('NOT_SHOPIFY_VAR')
+    })
+  })
+
   test('does nothing when analytics are disabled', async () => {
     await inProjectWithFile('package.json', async (args) => {
       // Given

packages/cli-kit/src/public/node/monorail.ts

@@ -27,6 +27,7 @@ export interface Schemas {
 
       // Environment
       env_plugin_installed_all?: Optional<string>
+      env_shopify_variables?: Optional<string>
     }
     public: {
       business_platform_id?: Optional<number>