feat: split stack property into per-builder properties
The `stack` property lived on the `buildpacks` plugin but was shared by both the herokuish and pack builders, so a value valid for one builder broke the other. Each builder now owns its own `stack` property managed via `builder-herokuish:set` and `builder-pack:set`, while `buildpacks:set-property stack` is deprecated and forwards the value to the builder detected from it; existing values migrate automatically on upgrade and changing a builder's stack clears that builder's cache.
This commit is contained in:
1
plugins/buildpacks/.gitignore
vendored
1
plugins/buildpacks/.gitignore
vendored
@@ -2,7 +2,6 @@
|
||||
/subcommands/*
|
||||
/triggers/*
|
||||
/triggers
|
||||
/buildpack-stack-name
|
||||
/install
|
||||
/post-*
|
||||
/report
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
SUBCOMMANDS = subcommands/add subcommands/clear subcommands/detect subcommands/list subcommands/remove subcommands/report subcommands/set subcommands/set-property
|
||||
TRIGGERS = triggers/buildpack-stack-name triggers/install triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/post-extract triggers/report
|
||||
TRIGGERS = triggers/install triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/post-extract triggers/report
|
||||
BUILD = commands subcommands triggers
|
||||
PLUGIN_NAME = buildpacks
|
||||
|
||||
|
||||
@@ -1,13 +1,24 @@
|
||||
package buildpacks
|
||||
|
||||
import "strings"
|
||||
|
||||
var (
|
||||
// DefaultProperties is a map of all valid buildpacks properties with corresponding default property values
|
||||
DefaultProperties = map[string]string{
|
||||
"stack": "",
|
||||
}
|
||||
DefaultProperties = map[string]string{}
|
||||
|
||||
// GlobalProperties is a map of all valid global buildpacks properties
|
||||
GlobalProperties = map[string]bool{
|
||||
"stack": true,
|
||||
}
|
||||
GlobalProperties = map[string]bool{}
|
||||
)
|
||||
|
||||
// isHerokuishStack reports whether a stack value targets the herokuish builder
|
||||
func isHerokuishStack(value string) bool {
|
||||
return strings.Contains(value, "herokuish")
|
||||
}
|
||||
|
||||
// builderForStack returns the builder plugin name a stack value should be written to
|
||||
func builderForStack(value string) string {
|
||||
if isHerokuishStack(value) {
|
||||
return "builder-herokuish"
|
||||
}
|
||||
return "builder-pack"
|
||||
}
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
package buildpacks
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/dokku/dokku/plugins/common"
|
||||
@@ -17,15 +16,10 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
|
||||
|
||||
var flags map[string]common.ReportFunc
|
||||
if appName == "--global" {
|
||||
flags = map[string]common.ReportFunc{
|
||||
"--buildpacks-global-stack": reportGlobalStack,
|
||||
}
|
||||
flags = map[string]common.ReportFunc{}
|
||||
} else {
|
||||
flags = map[string]common.ReportFunc{
|
||||
"--buildpacks-computed-stack": reportComputedStack,
|
||||
"--buildpacks-global-stack": reportGlobalStack,
|
||||
"--buildpacks-list": reportList,
|
||||
"--buildpacks-stack": reportStack,
|
||||
"--buildpacks-list": reportList,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -48,31 +42,6 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
|
||||
})
|
||||
}
|
||||
|
||||
func reportComputedStack(appName string) string {
|
||||
if stack := common.PropertyGetDefault("buildpacks", appName, "stack", ""); stack != "" {
|
||||
return stack
|
||||
}
|
||||
|
||||
if stack := common.PropertyGetDefault("buildpacks", "--global", "stack", ""); stack != "" {
|
||||
return stack
|
||||
}
|
||||
|
||||
results, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{
|
||||
Trigger: "config-get",
|
||||
Args: []string{appName, "DOKKU_IMAGE"},
|
||||
})
|
||||
if dokkuImage := results.StdoutContents(); dokkuImage != "" {
|
||||
common.LogWarn("Deprecated: use buildpacks:set-property instead of specifying DOKKU_IMAGE environment variable")
|
||||
return dokkuImage
|
||||
}
|
||||
|
||||
return os.Getenv("DOKKU_IMAGE")
|
||||
}
|
||||
|
||||
func reportGlobalStack(appName string) string {
|
||||
return common.PropertyGetDefault("buildpacks", "--global", "stack", "")
|
||||
}
|
||||
|
||||
func reportList(appName string) string {
|
||||
buildpacks, err := common.PropertyListGet("buildpacks", appName, "buildpacks")
|
||||
if err != nil {
|
||||
@@ -81,7 +50,3 @@ func reportList(appName string) string {
|
||||
|
||||
return strings.Join(buildpacks, ",")
|
||||
}
|
||||
|
||||
func reportStack(appName string) string {
|
||||
return common.PropertyGetDefault("buildpacks", appName, "stack", "")
|
||||
}
|
||||
|
||||
@@ -18,9 +18,6 @@ func main() {
|
||||
|
||||
var err error
|
||||
switch trigger {
|
||||
case "buildpack-stack-name":
|
||||
appName := flag.Arg(0)
|
||||
err = buildpacks.TriggerBuildpackStackName(appName)
|
||||
case "install":
|
||||
err = buildpacks.TriggerInstall()
|
||||
case "post-app-clone-setup":
|
||||
|
||||
@@ -215,35 +215,64 @@ func setBuildpackList(appName string, buildpacks []string, index int) error {
|
||||
|
||||
// CommandSetProperty implements buildpacks:set-property
|
||||
func CommandSetProperty(appName string, property string, value string) error {
|
||||
oldStack := ""
|
||||
if property == "stack" {
|
||||
oldStack = common.PropertyGet("buildpacks", appName, "stack")
|
||||
if property != "stack" {
|
||||
common.CommandPropertySet("buildpacks", appName, property, value, DefaultProperties, GlobalProperties)
|
||||
return nil
|
||||
}
|
||||
|
||||
common.CommandPropertySet("buildpacks", appName, property, value, DefaultProperties, GlobalProperties)
|
||||
if property == "stack" && oldStack != value {
|
||||
if appName != "--global" {
|
||||
_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
|
||||
Trigger: "post-stack-set",
|
||||
Args: []string{appName, value},
|
||||
StreamStdio: true,
|
||||
})
|
||||
if value != "" {
|
||||
builder := builderForStack(value)
|
||||
common.LogWarn(fmt.Sprintf("Deprecated: buildpacks:set-property stack is deprecated, use %s:set stack instead", builder))
|
||||
if err := common.PropertyWrite(builder, appName, "stack", value); err != nil {
|
||||
return err
|
||||
}
|
||||
return clearBuilderCache(builder, appName)
|
||||
}
|
||||
|
||||
apps, err := common.DokkuApps()
|
||||
if err != nil && !errors.Is(err, common.NoAppsExist) {
|
||||
common.LogWarn("Deprecated: buildpacks:set-property stack is deprecated, use builder-herokuish:set stack or builder-pack:set stack instead")
|
||||
for _, builder := range []string{"builder-herokuish", "builder-pack"} {
|
||||
if err := common.PropertyDelete(builder, appName, "stack"); err != nil {
|
||||
return err
|
||||
}
|
||||
for _, app := range apps {
|
||||
_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
|
||||
Trigger: "post-stack-set",
|
||||
Args: []string{app, value},
|
||||
StreamStdio: true,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if err := clearBuilderCache(builder, appName); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// clearBuilderCache clears the build cache for the given builder after a stack
|
||||
// change. The herokuish cache is the cache-$APP volume removed by repo via the
|
||||
// post-stack-set trigger, while the pack cache lives in pack-managed volumes and
|
||||
// is cleared by flagging the next build to run with --clear-cache.
|
||||
func clearBuilderCache(builder string, appName string) error {
|
||||
apps := []string{appName}
|
||||
if appName == "--global" {
|
||||
dokkuApps, err := common.DokkuApps()
|
||||
if err != nil {
|
||||
if errors.Is(err, common.NoAppsExist) {
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
apps = dokkuApps
|
||||
}
|
||||
|
||||
for _, app := range apps {
|
||||
if builder == "builder-herokuish" {
|
||||
if _, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
|
||||
Trigger: "post-stack-set",
|
||||
Args: []string{app, ""},
|
||||
StreamStdio: true,
|
||||
}); err != nil {
|
||||
return err
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
if err := common.PropertyWrite("builder-pack", app, "clear-cache", "true"); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@ package buildpacks
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
@@ -9,38 +10,46 @@ import (
|
||||
"github.com/dokku/dokku/plugins/common"
|
||||
)
|
||||
|
||||
// TriggerBuildpackStackName echos the stack name for the app
|
||||
func TriggerBuildpackStackName(appName string) error {
|
||||
if stack := common.PropertyGetDefault("buildpacks", appName, "stack", ""); stack != "" {
|
||||
fmt.Println(stack)
|
||||
return nil
|
||||
}
|
||||
|
||||
if stack := common.PropertyGetDefault("buildpacks", "--global", "stack", ""); stack != "" {
|
||||
fmt.Println(stack)
|
||||
return nil
|
||||
}
|
||||
|
||||
results, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{
|
||||
Trigger: "config-get",
|
||||
Args: []string{appName, "DOKKU_IMAGE"},
|
||||
})
|
||||
dokkuImage := results.StdoutContents()
|
||||
if dokkuImage != "" {
|
||||
common.LogWarn("Deprecated: use buildpacks:set-property instead of specifying DOKKU_IMAGE environment variable")
|
||||
fmt.Println(dokkuImage)
|
||||
return nil
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// TriggerInstall runs the install step for the buildpacks plugin
|
||||
func TriggerInstall() error {
|
||||
if err := common.PropertySetup("buildpacks"); err != nil {
|
||||
return fmt.Errorf("Unable to install the buildpacks plugin: %s", err.Error())
|
||||
}
|
||||
|
||||
return migrateStackProperty()
|
||||
}
|
||||
|
||||
// migrateStackProperty moves any legacy buildpacks stack values to the
|
||||
// appropriate builder plugin, detecting herokuish vs pack stacks. It is
|
||||
// idempotent: once a value is migrated the buildpacks stack key is removed.
|
||||
func migrateStackProperty() error {
|
||||
appNames := []string{"--global"}
|
||||
apps, err := common.DokkuApps()
|
||||
if err != nil && !errors.Is(err, common.NoAppsExist) {
|
||||
return err
|
||||
}
|
||||
appNames = append(appNames, apps...)
|
||||
|
||||
for _, appName := range appNames {
|
||||
if !common.PropertyExists("buildpacks", appName, "stack") {
|
||||
continue
|
||||
}
|
||||
|
||||
value := common.PropertyGet("buildpacks", appName, "stack")
|
||||
if value != "" {
|
||||
builder := builderForStack(value)
|
||||
if !common.PropertyExists(builder, appName, "stack") {
|
||||
if err := common.PropertyWrite(builder, appName, "stack", value); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if err := common.PropertyDelete("buildpacks", appName, "stack"); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user