fix: hide custom ddev pull and ddev push commands from Amplitude, fixes #6128

[stasadev]

The Issue

• DDEV sends a bit too much to Amplitude on commands (ddev pull arguments?) #6128

How This PR Solves The Issue

Marks the command as custom, but only if the name is not in predefined provider list (like acquia, git, lagoon, etc.)

Manual Testing Instructions

Tested:

"event_properties": {
    "Arguments": null,
    "Called As": "",
    "Command Name": "custom-command",
    "Command Path": "ddev pull custom-command"
}

Automated Testing Overview

Related Issue Link(s)

• refactor: anonymize user-defined custom commands #5110

Release/Deployment Notes

[github-actions]

Download the artifacts for this pull request:

• all-ddev-executables.zip
• ddev-linux-amd64.zip
• ddev-linux-arm64.zip
• ddev-macos-amd64.zip
• ddev-macos-arm64.zip
• ddev-windows-amd64-installer.zip

See Testing a PR.

[rfay]

This looks fine to me, thanks. Does need manual testing. DDEV_VERBOSE=true might be good enough, but probably step-debugging it would be adequate as well. We can just rename one of the existing ones like lagoon or whatever and use it and see what happens.

[stasadev]

I tested what would be sent to Amplitude after my change:

ddev pull platform123

"event_properties": {
    "Arguments": null,
    "Called As": "platform123",
    "Command Name": "custom-command",
    "Command Path": "ddev pull custom-command"
}

Command Name and Command Path are hidden, but not Called As.

I think this is unintentional and should be fixed.

cmd.CalledAs() is a getter function that has access to a non-public attribute, and we can't override it here:

ddev/cmd/ddev/cmd/root.go

Lines 42 to 48 in 195334d

	// Anonymize user defined custom commands.
	cmdCopy := *cmd
	argsCopy := args
	if IsUserDefinedCustomCommand(&cmdCopy) {
	cmdCopy.Use = "custom-command"
	argsCopy = []string{}
	}

I tried to add IsUserDefinedCustomCommand() here, where cmd.CalledAs() is added to Amplitude:

ddev/pkg/amplitude/amplitude.go

Lines 77 to 81 in 195334d

	builder := ampli.Command.Builder().
	Arguments(args).
	CalledAs(cmd.CalledAs()).
	CommandName(cmd.Name()).
	CommandPath(cmd.CommandPath())

Like this:

import (
    cmd2 "github.com/ddev/ddev/cmd/ddev/cmd"
)

// Anonymize user defined custom commands.
calledAs := cmd.CalledAs()
if cmd2.IsUserDefinedCustomCommand(cmd) {
    calledAs = "custom-command"
}

builder := ampli.Command.Builder().
    Arguments(args).
    CalledAs(calledAs).
    CommandName(cmd.Name()).
    CommandPath(cmd.CommandPath())

But without success because of import cycle not allowed.

What is the best way to add a check for custom commands in amplitude.go?

[stasadev]

I found the solution (assign a new command instead of reusing), now it sends it as:

"event_properties": {
    "Arguments": null,
    "Called As": "",
    "Command Name": "custom-command",
    "Command Path": "ddev pull custom-command"
}

[rfay]

This is working great, thanks for the excellent work.

I did note with surprise that every time autocompletion happens, it comes through as a command.

I'll open an issue to exclude __complete

[rfay]

Very small nit, not worth messing with.

Suggested change

	// Mark custom command
	// Mark custom provider

[rfay]

This approach is fine. In reality, we probably wouldn't want to show any args to rsync or localfile, but let's just let that be.