Normalize compose commands when generating for heroku migration (#1384)

* normalize compose commands for heroku migration

to avoid the issue where the railpack container drops command arguments
because the entrypoint is `bash -c`.

* shell quote

* update nix vendorHash

* comment type

Co-authored-by: Eric Liu <[email protected]>

* use shellescape.QuoteCommand

Co-authored-by: Lio李歐 <[email protected]>

---------

Co-authored-by: Eric Liu <[email protected]>
Co-authored-by: Lio李歐 <[email protected]>

Author: 3 people

pkgs/defang/cli.nix

@@ -7,7 +7,7 @@ buildGoModule {
   pname = "defang-cli";
   version = "git";
   src = ../../src;
-  vendorHash = "sha256-g8for7OBYwgOlEl6iB4Bkc71WL5OYzhBbU9WFf6fwqo="; # TODO: use fetchFromGitHub
+  vendorHash = "sha256-SpV97d+MskTCcdsBYJe/afzxzCo5TUtAef9m+lZT6/o="; # TODO: use fetchFromGitHub
 
   subPackages = [ "cmd/cli" ];
 

src/go.mod

@@ -119,6 +119,7 @@ require (
 )
 
 require (
+	al.essio.dev/pkg/shellescape v1.6.0
 	github.com/Microsoft/go-winio v0.6.2 // indirect
 	github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.2 // indirect
 	github.com/aws/aws-sdk-go-v2/credentials v1.16.16

src/go.sum

@@ -1,3 +1,5 @@
+al.essio.dev/pkg/shellescape v1.6.0 h1:NxFcEqzFSEVCGN2yq7Huv/9hyCEGVa/TncnOOBBeXHA=
+al.essio.dev/pkg/shellescape v1.6.0/go.mod h1:6sIqp7X2P6mThCQ7twERpZTuigpr6KbZWtls1U8I890=
 cel.dev/expr v0.20.0 h1:OunBvVCfvpWlt4dN7zg3FM6TDkzOePe1+foGJ9AXeeI=
 cel.dev/expr v0.20.0/go.mod h1:MrpN08Q+lEBs+bGYdLxxHkZoUSsCp0nSKTs0nTymJgw=
 cloud.google.com/go v0.120.0 h1:wc6bgG9DHyKqF5/vQvX1CiZrtHnxJjBlKUyF9nP6meA=
@@ -181,6 +183,8 @@ github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 h1:yAJXTCF9TqKcTiHJAE
 github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
 github.com/google/s2a-go v0.1.9 h1:LGD7gtMgezd8a/Xak7mEWL0PjoTQFvpRudN895yqKW0=
 github.com/google/s2a-go v0.1.9/go.mod h1:YA0Ei2ZQL3acow2O62kdp9UlnvMmU7kA6Eutn0dXayM=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/enterprise-certificate-proxy v0.3.6 h1:GW/XbdyBFQ8Qe+YAmFU9uHLo7OnF5tL52HFAgMmyrf4=

src/pkg/migrate/migrate.go

@@ -9,6 +9,7 @@ import (
 	"slices"
 	"strings"
 
+	"al.essio.dev/pkg/shellescape"
 	"github.com/DefangLabs/defang/src/pkg/cli/client"
 	"github.com/DefangLabs/defang/src/pkg/cli/compose"
 	"github.com/DefangLabs/defang/src/pkg/surveyor"
@@ -232,6 +233,50 @@ func cleanupComposeFile(in string) (string, error) {
 							})
 						}
 					}
+
+					// railpack generates images with `Entrypoint: "bash -c"`, and
+					// compose-go normalizes string commands into arrays, for example:
+					// `command: npm start` -> `command: [ "npm", "start" ]`. As a
+					// result, the command which ultimately gets run is
+					// `bash -c npm start`. When this gets run, `bash` will ignore
+					// `start` and `npm` will get run in a subprocess--only printing
+					// the help text. As it is common for users to type their service
+					// command as a string, this cleanup step will help ensure the
+					// command is run as intended by replacing `command: npm start`
+					// with `command: [ "npm start" ]`.
+					if kk.Value == "command" {
+						if vk.Kind == yaml.ScalarNode {
+							cmd := vk.Value
+							vk.Value = ""
+							vk.Kind = yaml.SequenceNode
+							vk.Tag = "!!seq"
+							vk.Content = []*yaml.Node{
+								{
+									Tag:   "!!str",
+									Kind:  yaml.ScalarNode,
+									Value: cmd,
+								},
+							}
+						}
+						// We will do the same for
+						// `command: ["npm", "start"]`, which will also get transformed
+						// to `command: [ "npm start" ]`.
+						if vk.Kind == yaml.SequenceNode && len(vk.Content) > 1 {
+							var parts []string
+							for _, c := range vk.Content {
+								parts = append(parts, c.Value)
+							}
+							cmd := shellescape.QuoteCommand(parts)
+							// combine content nodes into one
+							vk.Content = []*yaml.Node{
+								{
+									Tag:   "!!str",
+									Kind:  yaml.ScalarNode,
+									Value: cmd,
+								},
+							}
+						}
+					}
 				}
 			}
 		}

src/pkg/migrate/migrate_test.go

@@ -469,6 +469,58 @@ services:
     db:
         image: postgres:latest # EOL comment
         x-defang-postgres: "true"
+`,
+			expectingError: false,
+		},
+		{
+			name: "string command",
+			input: `
+services:
+  web:
+    build: .
+    command: npm start
+`,
+			expected: `services:
+    web:
+        build: .
+        command:
+            - npm start
+`,
+			expectingError: false,
+		},
+		{
+			name: "array command",
+			input: `
+services:
+  web:
+    build: .
+    command:
+      - npm
+      - start
+`,
+			expected: `services:
+    web:
+        build: .
+        command:
+            - npm start
+`,
+			expectingError: false,
+		},
+		{
+			name: "array command with multiple words",
+			input: `
+services:
+  web:
+    build: .
+    command:
+      - echo
+      - hello world
+`,
+			expected: `services:
+    web:
+        build: .
+        command:
+            - echo 'hello world'
 `,
 			expectingError: false,
 		},