feat: add ReplaceReadmeNewClientName function (Azure#22165)

* feat: add ReplaceReadmeNewClientName function

* fix

Author: Alancere

eng/tools/generator/autorest/model/changelog.go

@@ -171,7 +171,7 @@ func getNewContents(c *delta.Content) []string {
 	}
 
 	if len(c.Funcs) > 0 {
-		for _, k := range sortFuncItem(c.Funcs) {
+		for _, k := range SortFuncItem(c.Funcs) {
 			v := c.Funcs[k]
 			params := ""
 			if v.Params != nil {
@@ -262,7 +262,7 @@ func getSignatureChangeItems(b *report.BreakingChanges) []string {
 	}
 	// write function changes
 	if len(b.Funcs) > 0 {
-		for _, k := range sortFuncItem(b.Funcs) {
+		for _, k := range SortFuncItem(b.Funcs) {
 			v := b.Funcs[k]
 			if v.Params != nil {
 				line := fmt.Sprintf("Function `%s` parameter(s) have been changed from `(%s)` to `(%s)`", k, v.Params.From, v.Params.To)
@@ -324,7 +324,7 @@ func getRemovedContent(removed *delta.Content) []string {
 	if len(removed.Funcs) > 0 {
 		var lroItem []string
 		var paginationItem []string
-		for _, k := range sortFuncItem(removed.Funcs) {
+		for _, k := range SortFuncItem(removed.Funcs) {
 			v := removed.Funcs[k]
 			if v.ReplacedBy != nil {
 				var line string
@@ -405,7 +405,7 @@ func sortChangeItem[T sortItem](change map[string]T) []string {
 	return s
 }
 
-func sortFuncItem[T delta.FuncSig | exports.Func](change map[string]T) []string {
+func SortFuncItem[T delta.FuncSig | exports.Func](change map[string]T) []string {
 	s := make([]string, 0, len(change))
 	for k := range change {
 		s = append(s, k)

eng/tools/generator/autorest/model/changelog_test.go

@@ -37,7 +37,7 @@ func TestSortFuncItem(t *testing.T) {
 		},
 	}
 
-	sortResult := sortFuncItem(s)
+	sortResult := SortFuncItem(s)
 	expected := []string{
 		"NewPrivateEndpointConnectionsClient",
 		"*PrivateEndpointConnectionsClient.BeginCreate",

eng/tools/generator/cmd/v2/common/fileProcessor.go

@@ -385,7 +385,8 @@ func AddChangelogToFile(changelog *model.Changelog, version *semver.Version, pac
 func ReplaceNewClientNamePlaceholder(packageRootPath string, exports exports.Content) error {
 	path := filepath.Join(packageRootPath, "README.md")
 	var clientName string
-	for k, v := range exports.Funcs {
+	for _, k := range model.SortFuncItem(exports.Funcs) {
+		v := exports.Funcs[k]
 		if newClientMethodNameRegex.MatchString(k) && *v.Params == "string, azcore.TokenCredential, *arm.ClientOptions" {
 			clientName = k
 			break
@@ -629,3 +630,35 @@ func replaceReadmeModule(path, rpName, namespaceName, currentVersion string) err
 
 	return nil
 }
+
+func ReplaceReadmeNewClientName(packageRootPath string, exports exports.Content) error {
+	path := filepath.Join(packageRootPath, "README.md")
+	var clientName string
+	for _, k := range model.SortFuncItem(exports.Funcs) {
+		v := exports.Funcs[k]
+		if newClientMethodNameRegex.MatchString(k) && *v.Params == "string, azcore.TokenCredential, *arm.ClientOptions" {
+			clientName = k
+			break
+		}
+	}
+
+	b, err := os.ReadFile(path)
+	if err != nil {
+		return fmt.Errorf("cannot read from file '%s': %+v", path, err)
+	}
+
+	oldClientName := ""
+	for _, v := range strings.Split(string(b), "\n") {
+		oldClientName = regexp.MustCompile(`New.*Client\(\)`).FindString(v)
+		if oldClientName != "" {
+			break
+		}
+	}
+
+	if oldClientName == fmt.Sprintf("%s()", clientName) {
+		return nil
+	}
+
+	var content = strings.ReplaceAll(string(b), oldClientName, fmt.Sprintf("%s()", clientName))
+	return os.WriteFile(path, []byte(content), 0644)
+}

eng/tools/generator/cmd/v2/common/generation.go

@@ -333,6 +333,11 @@ func (ctx *GenerateContext) GenerateForSingleRPNamespace(generateParam *Generate
 			return nil, err
 		}
 
+		log.Printf("Replace README.md NewClient name...")
+		if err = ReplaceReadmeNewClientName(packagePath, newExports); err != nil {
+			return nil, err
+		}
+
 		// Example generation should be the last step because the package import relay on the new calculated version
 		if !generateParam.SkipGenerateExample {
 			log.Printf("Generate examples...")