Merge pull request #4198 from dokku/4083-fewer-extracts

Reference extracted Procfile

docs/appendices/0.22.0-migration-guide.md

@@ -5,6 +5,7 @@
 - Underscores are no longer valid characters in app names. Please rename applications before upgrading.
 - Process type names specified in Procfile may no longer use characters not valid in DNS Label Names ([RFC 1123](https://tools.ietf.org/html/rfc1123)).
 - The minimum Docker version is now 17.05.0.
+- The `common.GetDeployingAppImageName()` function now returns an `error` as the second return argument instead of calling `common.LogFail()` internally.
 
 ## Removals
 

docs/development/plugin-triggers.md

@@ -1511,7 +1511,7 @@ set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
 - Description: Removes the extracted Procfile
 - Invoked by: `internally`
-- Arguments: `$APP $PROCFILE_PATH`
+- Arguments: `$APP`
 - Example:
 
 ```shell

plugins/app-json/appjson.go

@@ -138,7 +138,10 @@ func getDokkuAppShell(appName string) string {
 }
 
 func executeScript(appName string, imageTag string, phase string) error {
-	image := common.GetDeployingAppImageName(appName, imageTag, "")
+	image, err := common.GetDeployingAppImageName(appName, imageTag, "")
+	if err != nil {
+		common.LogFail(err.Error())
+	}
 	command := ""
 	phaseSource := ""
 	if phase == "release" {

plugins/common/common.go

@@ -89,26 +89,26 @@ func GetGlobalScheduler() string {
 }
 
 // GetDeployingAppImageName returns deploying image identifier for a given app, tag tuple. validate if tag is presented
-func GetDeployingAppImageName(appName, imageTag, imageRepo string) (imageName string) {
+func GetDeployingAppImageName(appName, imageTag, imageRepo string) (string, error) {
 	if appName == "" {
 		LogFail("(GetDeployingAppImageName) APP must not be empty")
 	}
 
 	b, err := PlugnTriggerOutput("deployed-app-repository", []string{appName}...)
 	if err != nil {
-		LogFail(err.Error())
+		return "", err
 	}
 	imageRemoteRepository := string(b[:])
 
 	b, err = PlugnTriggerOutput("deployed-app-image-tag", []string{appName}...)
 	if err != nil {
-		LogFail(err.Error())
+		return "", err
 	}
 	newImageTag := string(b[:])
 
 	b, err = PlugnTriggerOutput("deployed-app-image-repo", []string{appName}...)
 	if err != nil {
-		LogFail(err.Error())
+		return "", err
 	}
 	newImageRepo := string(b[:])
 
@@ -125,11 +125,11 @@ func GetDeployingAppImageName(appName, imageTag, imageRepo string) (imageName st
 		imageTag = "latest"
 	}
 
-	imageName = fmt.Sprintf("%s%s:%s", imageRemoteRepository, imageRepo, imageTag)
+	imageName := fmt.Sprintf("%s%s:%s", imageRemoteRepository, imageRepo, imageTag)
 	if !VerifyImage(imageName) {
-		LogFail(fmt.Sprintf("App image (%s) not found", imageName))
+		return "", fmt.Errorf("App image (%s) not found", imageName)
 	}
-	return
+	return imageName, nil
 }
 
 // GetAppImageRepo is the central definition of a dokku image repo pattern

plugins/ps/functions.go

@@ -19,11 +19,7 @@ func canScaleApp(appName string) bool {
 	return !common.FileExists(getScalefileExtractedPath(appName))
 }
 
-func extractProcfile(appName, image string, procfilePath string) error {
-	if err := removeProcfile(appName); err != nil {
-		return err
-	}
-
+func extractProcfile(appName, image string) error {
 	destination := getProcfilePath(appName)
 	common.CopyFromImage(appName, image, "Procfile", destination)
 	if !common.FileExists(destination) {

plugins/ps/src/triggers/triggers.go

@@ -62,8 +62,7 @@ func main() {
 		err = ps.TriggerProcfileGetCommand(appName, processType, port)
 	case "procfile-remove":
 		appName := flag.Arg(0)
-		procfilePath := flag.Arg(1)
-		err = ps.TriggerProcfileRemove(appName, procfilePath)
+		err = ps.TriggerProcfileRemove(appName)
 	case "report":
 		appName := flag.Arg(0)
 		err = ps.ReportSingleApp(appName, "")

plugins/ps/subcommands.go

@@ -144,22 +144,25 @@ func CommandScale(appName string, skipDeploy bool, processTuples []string) error
 
 	procfilePath := getProcfilePath(appName)
 	if !common.FileExists(procfilePath) {
-		image := common.GetAppImageRepo(appName)
-		common.SuppressOutput(func() error {
-			extractProcfile(appName, image, procfilePath)
-			return nil
-		})
-	}
+		extract := func() error {
+			image, err := common.GetDeployingAppImageName(appName, "", "")
+			if err != nil {
+				return nil
+			}
 
-	if !hasScaleFile(appName) {
-		err := common.SuppressOutput(func() error {
-			return updateScalefile(appName, make(map[string]int))
-		})
-		if err != nil {
+			return extractProcfile(appName, image)
+		}
+
+		if err := common.SuppressOutput(extract); err != nil {
 			return err
 		}
-	} else if common.FileExists(procfilePath) {
-		if err := updateScalefile(appName, make(map[string]int)); err != nil {
+	}
+
+	if !hasScaleFile(appName) || common.FileExists(procfilePath) {
+		update := func() error {
+			return updateScalefile(appName, make(map[string]int))
+		}
+		if err := common.SuppressOutput(update); err != nil {
 			return err
 		}
 	}

plugins/ps/triggers.go

@@ -17,13 +17,9 @@ func TriggerAppRestart(appName string) error {
 	return Restart(appName)
 }
 
-// TriggerCorePostDeploy removes extracted procfiles
-// and sets a property to allow the app to be restored on boot
+// TriggerCorePostDeploy sets a property to
+// allow the app to be restored on boot
 func TriggerCorePostDeploy(appName string) error {
-	if err := removeProcfile(appName); err != nil {
-		return err
-	}
-
 	entries := map[string]string{
 		"DOKKU_APP_RESTORE": "1",
 	}
@@ -148,11 +144,16 @@ func TriggerPostStop(appName string) error {
 
 // TriggerPreDeploy ensures an app has an up to date scale file
 func TriggerPreDeploy(appName string, imageTag string) error {
-	image := common.GetAppImageRepo(appName)
-	removeProcfile(appName)
+	image, err := common.GetDeployingAppImageName(appName, imageTag, "")
+	if err != nil {
+		return err
+	}
 
-	procfilePath := getProcfilePath(appName)
-	if err := extractProcfile(appName, image, procfilePath); err != nil {
+	if err := removeProcfile(appName); err != nil {
+		return err
+	}
+
+	if err := extractProcfile(appName, image); err != nil {
 		return err
 	}
 
@@ -174,27 +175,27 @@ func TriggerProcfileExtract(appName string, image string) error {
 		return err
 	}
 
-	procfilePath := getProcfilePath(appName)
-
-	if common.FileExists(procfilePath) {
-		if err := common.PlugnTrigger("procfile-remove", []string{appName, procfilePath}...); err != nil {
-			return err
-		}
+	if err := removeProcfile(appName); err != nil {
+		return err
 	}
 
-	return extractProcfile(appName, image, procfilePath)
+	return extractProcfile(appName, image)
 }
 
 // TriggerProcfileGetCommand fetches a command from the procfile
 func TriggerProcfileGetCommand(appName string, processType string, port int) error {
 	procfilePath := getProcfilePath(appName)
 	if !common.FileExists(procfilePath) {
-		image := common.GetDeployingAppImageName(appName, "", "")
-		err := common.SuppressOutput(func() error {
-			return common.PlugnTrigger("procfile-extract", []string{appName, image}...)
-		})
+		extract := func() error {
+			image, err := common.GetDeployingAppImageName(appName, "", "")
+			if err != nil {
+				return err
+			}
 
-		if err != nil {
+			return extractProcfile(appName, image)
+		}
+
+		if err := common.SuppressOutput(extract); err != nil {
 			return err
 		}
 	}
@@ -211,15 +212,6 @@ func TriggerProcfileGetCommand(appName string, processType string, port int) err
 }
 
 // TriggerProcfileRemove removes the procfile if it exists
-func TriggerProcfileRemove(appName string, procfilePath string) error {
-	if procfilePath == "" {
-		procfilePath = getProcfilePath(appName)
-	}
-
-	if !common.FileExists(procfilePath) {
-		return nil
-	}
-
-	os.Remove(procfilePath)
-	return nil
+func TriggerProcfileRemove(appName string) error {
+	return removeProcfile(appName)
 }