Add '--replace-edited-strings' flag/config option

Author: Konstantinos Bairaktaris

README.md

@@ -590,6 +590,11 @@ fall back to taking the filesystem timestamp into account.
   any time.
 - `--silent`: Reduce verbosity of the output.
 
+- `--replace-edited-strings`: If present, source strings that have been edited
+  (in the editor UI or via the API) will not be protected from this source
+  file push and will instead be replaced. This can also be set on a
+  per-resource level in the configuration file.
+
 ### Pulling Files from Transifex
 
 `tx pull` is used to pull language files (usually translation language files) from

cmd/tx/main.go

@@ -259,6 +259,11 @@ func Main() {
 						Name:  "silent",
 						Usage: "Whether to reduce verbosity of the output",
 					},
+					&cli.BoolFlag{
+						Name: "replace-edited-strings",
+						Usage: "Whether to replace source strings that have been edited in the " +
+							"meantime",
+					},
 				},
 				Action: func(c *cli.Context) error {
 					cfg, err := config.LoadFromPaths(
@@ -327,19 +332,20 @@ func Main() {
 					}
 
 					args := txlib.PushCommandArguments{
-						Source:           c.Bool("source"),
-						Translation:      c.Bool("translation"),
-						Force:            c.Bool("force"),
-						Skip:             c.Bool("skip"),
-						Xliff:            c.Bool("xliff"),
-						Languages:        languages,
-						ResourceIds:      resourceIds,
-						UseGitTimestamps: c.Bool("use-git-timestamps"),
-						Branch:           c.String("branch"),
-						Base:             c.String("base"),
-						All:              c.Bool("all"),
-						Workers:          workers,
-						Silent:           c.Bool("silent"),
+						Source:               c.Bool("source"),
+						Translation:          c.Bool("translation"),
+						Force:                c.Bool("force"),
+						Skip:                 c.Bool("skip"),
+						Xliff:                c.Bool("xliff"),
+						Languages:            languages,
+						ResourceIds:          resourceIds,
+						UseGitTimestamps:     c.Bool("use-git-timestamps"),
+						Branch:               c.String("branch"),
+						Base:                 c.String("base"),
+						All:                  c.Bool("all"),
+						Workers:              workers,
+						Silent:               c.Bool("silent"),
+						ReplaceEditedStrings: c.Bool("replace-edited-strings"),
 					}
 
 					if args.All && len(args.Languages) > 0 {

internal/txlib/config/local.go

@@ -21,17 +21,18 @@ type LocalConfig struct {
 }
 
 type Resource struct {
-	OrganizationSlug  string
-	ProjectSlug       string
-	ResourceSlug      string
-	FileFilter        string
-	SourceFile        string
-	SourceLanguage    string
-	Type              string
-	LanguageMappings  map[string]string
-	Overrides         map[string]string
-	MinimumPercentage int
-	ResourceName      string
+	OrganizationSlug     string
+	ProjectSlug          string
+	ResourceSlug         string
+	FileFilter           string
+	SourceFile           string
+	SourceLanguage       string
+	Type                 string
+	LanguageMappings     map[string]string
+	Overrides            map[string]string
+	MinimumPercentage    int
+	ResourceName         string
+	ReplaceEditedStrings bool
 }
 
 func loadLocalConfig() (*LocalConfig, error) {
@@ -121,18 +122,29 @@ func loadLocalConfigFromBytes(data []byte) (*LocalConfig, error) {
 			return nil, err
 		}
 
+		replaceEditedStrings := false
+		if section.HasKey("replace_edited_strings") {
+			replaceEditedStrings, err = section.Key("replace_edited_strings").Bool()
+			if err != nil {
+				return nil, fmt.Errorf(
+					"'replace_edited_strings' needs to be 'true' or 'false': %s", err,
+				)
+			}
+		}
+
 		resource := Resource{
-			OrganizationSlug:  organizationSlug,
-			ProjectSlug:       projectSlug,
-			ResourceSlug:      resourceSlug,
-			FileFilter:        section.Key("file_filter").String(),
-			SourceFile:        section.Key("source_file").String(),
-			SourceLanguage:    section.Key("source_lang").String(),
-			Type:              section.Key("type").String(),
-			LanguageMappings:  make(map[string]string),
-			Overrides:         make(map[string]string),
-			MinimumPercentage: -1,
-			ResourceName:      section.Key("resource_name").String(),
+			OrganizationSlug:     organizationSlug,
+			ProjectSlug:          projectSlug,
+			ResourceSlug:         resourceSlug,
+			FileFilter:           section.Key("file_filter").String(),
+			SourceFile:           section.Key("source_file").String(),
+			SourceLanguage:       section.Key("source_lang").String(),
+			Type:                 section.Key("type").String(),
+			LanguageMappings:     make(map[string]string),
+			Overrides:            make(map[string]string),
+			MinimumPercentage:    -1,
+			ResourceName:         section.Key("resource_name").String(),
+			ReplaceEditedStrings: replaceEditedStrings,
 		}
 
 		// Get first the perc in string to check if exists because .Key returns
@@ -282,6 +294,10 @@ func (localCfg LocalConfig) saveToWriter(file io.Writer) error {
 				return err
 			}
 		}
+
+		section.NewKey(
+			"replace_edited_strings", strconv.FormatBool(resource.ReplaceEditedStrings),
+		)
 	}
 
 	_, err = cfg.WriteTo(file)
@@ -366,6 +382,10 @@ func localConfigsEqual(left, right *LocalConfig) bool {
 				return false
 			}
 		}
+
+		if leftResource.ReplaceEditedStrings != rightResource.ReplaceEditedStrings {
+			return false
+		}
 	}
 
 	return true

internal/txlib/push.go

@@ -17,19 +17,20 @@ import (
 )
 
 type PushCommandArguments struct {
-	Source           bool
-	Translation      bool
-	Force            bool
-	Skip             bool
-	Xliff            bool
-	Languages        []string
-	ResourceIds      []string
-	UseGitTimestamps bool
-	Branch           string
-	Base             string
-	All              bool
-	Workers          int
-	Silent           bool
+	Source               bool
+	Translation          bool
+	Force                bool
+	Skip                 bool
+	Xliff                bool
+	Languages            []string
+	ResourceIds          []string
+	UseGitTimestamps     bool
+	Branch               string
+	Base                 string
+	All                  bool
+	Workers              int
+	Silent               bool
+	ReplaceEditedStrings bool
 }
 
 func PushCommand(
@@ -445,6 +446,7 @@ func (task *ResourcePushTask) Run(send func(string), abort func()) {
 			remoteStats[sourceLanguage.Id],
 			args,
 			resourceIsNew,
+			args.ReplaceEditedStrings || cfgResource.ReplaceEditedStrings,
 		}
 	}
 	if args.Translation { // -t flag is set
@@ -565,12 +567,13 @@ func (task *LanguagePushTask) Run(send func(string), abort func()) {
 }
 
 type SourceFilePushTask struct {
-	api           *jsonapi.Connection
-	resource      *jsonapi.Resource
-	sourceFile    string
-	remoteStats   *jsonapi.Resource
-	args          PushCommandArguments
-	resourceIsNew bool
+	api                  *jsonapi.Connection
+	resource             *jsonapi.Resource
+	sourceFile           string
+	remoteStats          *jsonapi.Resource
+	args                 PushCommandArguments
+	resourceIsNew        bool
+	replaceEditedStrings bool
 }
 
 func (task *SourceFilePushTask) Run(send func(string), abort func()) {
@@ -580,6 +583,7 @@ func (task *SourceFilePushTask) Run(send func(string), abort func()) {
 	remoteStats := task.remoteStats
 	args := task.args
 	resourceIsNew := task.resourceIsNew
+	replaceEditedStrings := task.replaceEditedStrings
 
 	parts := strings.Split(resource.Id, ":")
 	sendMessage := func(body string, force bool) {
@@ -624,7 +628,7 @@ func (task *SourceFilePushTask) Run(send func(string), abort func()) {
 	err = handleThrottling(
 		func() error {
 			var err error
-			sourceUpload, err = txapi.UploadSource(api, resource, file)
+			sourceUpload, err = txapi.UploadSource(api, resource, file, replaceEditedStrings)
 			return err
 		},
 		"Uploading file",

pkg/jsonapi/resource.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"mime/multipart"
+	"strconv"
 )
 
 type Resource struct {
@@ -191,6 +192,11 @@ func (r *Resource) SaveAsMultipart(fields []string) error {
 				if err != nil {
 					return err
 				}
+			case bool:
+				err := writer.WriteField(field, strconv.FormatBool(data))
+				if err != nil {
+					return err
+				}
 			case []byte:
 				w, err := writer.CreateFormFile(field,
 					fmt.Sprintf("%s.txt", field))

pkg/txapi/resource_strings_async_uploads.go

@@ -36,7 +36,10 @@ func (err *ResourceStringAsyncUploadAttributes) Error() string {
 }
 
 func UploadSource(
-	api *jsonapi.Connection, resource *jsonapi.Resource, file io.Reader,
+	api *jsonapi.Connection,
+	resource *jsonapi.Resource,
+	file io.Reader,
+	replaceEditedStrings bool,
 ) (*jsonapi.Resource, error) {
 	data, err := io.ReadAll(file)
 	if err != nil {
@@ -49,7 +52,8 @@ func UploadSource(
 		// Setting attributes directly here because POST and GET attributes are
 		// different
 		Attributes: map[string]interface{}{
-			"content": data,
+			"content":                data,
+			"replace_edited_strings": replaceEditedStrings,
 		},
 	}
 	upload.SetRelated("resource", resource)