Merge pull request #170 from go-flutter-desktop/fix/debug-mode-segfault

Fix segfault in debug mode

Author: jld3103

cmd/build.go

@@ -582,7 +582,7 @@ func buildGoBinary(targetOS string, vmArguments []string) {
 		log.Warnf("The '--opengl=none' flag makes go-flutter incompatible with texture plugins!")
 	}
 
-	if targetOS == "darwin" {
+	if targetOS == "darwin" && buildOrRunMode != build.DebugMode {
 		darwinDyldHack(filepath.Join(build.OutputDirectoryPath(targetOS, buildOrRunMode), build.EngineFiles(targetOS, buildOrRunMode)[0]))
 	}
 
@@ -603,7 +603,7 @@ func buildGoBinary(targetOS string, vmArguments []string) {
 		os.Exit(1)
 	}
 	log.Infof("Successfully compiled executable binary for %s", targetOS)
-	if targetOS == "darwin" {
+	if targetOS == "darwin" && buildOrRunMode != build.DebugMode {
 		darwinDyldHack(build.OutputBinaryPath(config.GetConfig().GetExecutableName(pubspec.GetPubSpec().Name), targetOS, buildOrRunMode))
 	}
 }
@@ -638,8 +638,13 @@ func buildEnv(targetOS string, engineCachePath string) []string {
 
 	switch targetOS {
 	case "darwin":
-		cgoLdflags += fmt.Sprintf(" -L%s -L%s", engineCachePath, outputDirPath)
-		cgoLdflags += fmt.Sprintf(" -lflutter_engine -Wl,-rpath,.")
+		if buildOrRunMode == build.DebugMode {
+			cgoLdflags += fmt.Sprintf(" -F%s -Wl,-rpath,@executable_path", engineCachePath)
+			cgoLdflags += fmt.Sprintf(" -F%s -L%s -framework FlutterEmbedder", outputDirPath, outputDirPath)
+		} else {
+			cgoLdflags += fmt.Sprintf(" -L%s -L%s", engineCachePath, outputDirPath)
+			cgoLdflags += " -lflutter_engine -Wl,-rpath,."
+		}
 		cgoLdflags += " -mmacosx-version-min=10.10"
 		cgoCflags += " -mmacosx-version-min=10.10"
 	case "linux":

internal/build/build.go

@@ -95,7 +95,11 @@ func ExecutableExtension(targetOS string) string {
 func EngineFiles(targetOS string, mode Mode) []string {
 	switch targetOS {
 	case "darwin":
-		return []string{"libflutter_engine.dylib"}
+		if mode.IsAot {
+			return []string{"libflutter_engine.dylib"}
+		} else {
+			return []string{"FlutterEmbedder.framework"}
+		}
 	case "linux":
 		return []string{"libflutter_engine.so"}
 	case "windows":

internal/enginecache/cache.go

@@ -241,29 +241,87 @@ func ValidateOrUpdateEngine(targetOS, cachePath, requiredEngineVersion string, m
 
 	log.Printf("Downloading engine for platform %s at version %s...", EngineConfig(targetOS, mode), requiredEngineVersion)
 
-	file := ""
-	switch targetOS {
-	case "linux":
-		file += "linux"
-	case "darwin":
-		file += "macosx"
-	case "windows":
-		file += "windows"
-	}
-	file += fmt.Sprintf("_x64-host_%s.zip", mode.Name)
-	engineDownloadURL := fmt.Sprintf("https://github.com/flutter-rs/engine-builds/releases/download/f-%s/%s", requiredEngineVersion, file)
+	if mode == build.DebugMode {
+		targetedDomain := "https://storage.googleapis.com"
+		envURLFlutter := os.Getenv("FLUTTER_STORAGE_BASE_URL")
+		if envURLFlutter != "" {
+			targetedDomain = envURLFlutter
+		}
+		var engineDownloadURL = fmt.Sprintf(targetedDomain+"/flutter_infra/flutter/%s/%s-x64/", requiredEngineVersion, targetOS)
+		switch targetOS {
+		case "darwin":
+			engineDownloadURL += "FlutterEmbedder.framework.zip"
+		case "linux":
+			engineDownloadURL += targetOS + "-x64-embedder"
+		case "windows":
+			engineDownloadURL += targetOS + "-x64-embedder.zip"
+		default:
+			log.Errorf("Cannot run on %s, download engine not implemented.", targetOS)
+			os.Exit(1)
+		}
+
+		artifactsZipPath := filepath.Join(dir, "artifacts.zip")
+		artifactsDownloadURL := fmt.Sprintf(targetedDomain+"/flutter_infra/flutter/%s/%s-x64/artifacts.zip", requiredEngineVersion, targetOS)
+
+		err = downloadFile(engineZipPath, engineDownloadURL)
+		if err != nil {
+			log.Errorf("Failed to download engine: %v", err)
+			os.Exit(1)
+		}
+		_, err = unzip(engineZipPath, engineExtractPath)
+		if err != nil {
+			log.Warnf("%v", err)
+		}
+
+		err = downloadFile(artifactsZipPath, artifactsDownloadURL)
+		if err != nil {
+			log.Errorf("Failed to download artifacts: %v", err)
+			os.Exit(1)
+		}
+		_, err = unzip(artifactsZipPath, engineExtractPath)
+		if err != nil {
+			log.Warnf("%v", err)
+		}
+		if targetOS == "darwin" {
+			frameworkZipPath := filepath.Join(engineExtractPath, "FlutterEmbedder.framework.zip")
+			frameworkDestPath := filepath.Join(engineExtractPath, "FlutterEmbedder.framework")
+			_, err = unzip(frameworkZipPath, frameworkDestPath)
+			if err != nil {
+				log.Errorf("Failed to unzip engine framework: %v", err)
+				os.Exit(1)
+			}
+			createSymLink("A", frameworkDestPath+"/Versions/Current")
+			createSymLink("Versions/Current/FlutterEmbedder", frameworkDestPath+"/FlutterEmbedder")
+			createSymLink("Versions/Current/Headers", frameworkDestPath+"/Headers")
+			createSymLink("Versions/Current/Modules", frameworkDestPath+"/Modules")
+			createSymLink("Versions/Current/Resources", frameworkDestPath+"/Resources")
+		}
+	} else {
+		file := ""
+		switch targetOS {
+		case "linux":
+			file += "linux"
+		case "darwin":
+			file += "macosx"
+		case "windows":
+			file += "windows"
+		}
+		file += fmt.Sprintf("_x64-host_%s.zip", mode.Name)
+		engineDownloadURL := fmt.Sprintf("https://github.com/flutter-rs/engine-builds/releases/download/f-%s/%s", requiredEngineVersion, file)
+
+		err = downloadFile(engineZipPath, engineDownloadURL)
+		if err != nil {
+			log.Errorf("Failed to download engine: %v", err)
+			log.Errorf("Engine builds are a bit delayed after they are published in flutter.")
+			log.Errorf("You can either try again later or switch the flutter channel to beta, because these engines are more likely to be already built.")
+			log.Errorf("To dig into the already built engines look at https://github.com/flutter-rs/engine-builds/releases and https://github.com/flutter-rs/engine-builds/actions")
+			os.Exit(1)
+		}
+		_, err = unzip(engineZipPath, engineExtractPath)
+		if err != nil {
+			log.Warnf("%v", err)
+		}
 
-	err = downloadFile(engineZipPath, engineDownloadURL)
-	if err != nil {
-		log.Errorf("Failed to download engine: %v", err)
-		log.Errorf("Engine builds are a bit delayed after they are published in flutter.")
-		log.Errorf("You can either try again later or switch the flutter channel to beta, because these engines are more likely to be already built.")
-		log.Errorf("To dig into the already built engines look at https://github.com/flutter-rs/engine-builds/releases and https://github.com/flutter-rs/engine-builds/actions")
-		os.Exit(1)
-	}
-	_, err = unzip(engineZipPath, engineExtractPath)
-	if err != nil {
-		log.Warnf("%v", err)
 	}
 
 	for _, engineFile := range build.EngineFiles(targetOS, mode) {
@@ -288,11 +346,16 @@ func ValidateOrUpdateEngine(targetOS, cachePath, requiredEngineVersion string, m
 	}
 
 	files := []string{
-		"dart" + build.ExecutableExtension(targetOS),
-		"gen_snapshot" + build.ExecutableExtension(targetOS),
 		"icudtl.dat",
-		"gen",
-		"flutter_patched_sdk",
+	}
+	if mode != build.DebugMode {
+		files = append(
+			files,
+			"dart"+build.ExecutableExtension(targetOS),
+			"gen_snapshot"+build.ExecutableExtension(targetOS),
+			"gen",
+			"flutter_patched_sdk",
+		)
 	}
 	for _, file := range files {
 		err = copy.Copy(