Refactored to rename "service terms" to "terms of service" (#9581)

* #124 renamed identififers from service terms to terms of service

* #124 renamed identififers from service terms to terms of service

* 124 renamed ServiceTerms model to TermsOfService

* 124 Renamed EnableCustomServiceTerms feature flag to EnableCustomTermsOfService

* 124 Renamed EnableCustomServiceTerms feature flag to EnableCustomTermsOfService

* #124 fixed formatting

* #124 fixed formatting

* #132 renamed table ServiceTerms to TermsOfService

* #124 renamed some missed files from 'service_terms' to 'terms_of_service'

* #124 removed fixed TODOs

* drop migrate of ServiceTerms table, since backporting

* s/ServiceTerms/TermsOfService/ in tests

* s/AcceptedServiceTermsId/AcceptedTermsOfServiceId/

Change the model attribute, even though the column name will eventually be removed.

* s/accepted_service_terms_id/accepted_terms_of_service_id/ to match redux

* s/serviceTerms/termsOfService

* rename column too, and add max size constraint

* s/EnableCustomServiceTerms/EnableCustomTermsOfService

app/config.go

@@ -24,7 +24,7 @@ import (
 )
 
 const (
-	ERROR_SERVICE_TERMS_NO_ROWS_FOUND = "store.sql_service_terms_store.get.no_rows.app_error"
+	ERROR_TERMS_OF_SERVICE_NO_ROWS_FOUND = "store.sql_terms_of_service_store.get.no_rows.app_error"
 )
 
 func (a *App) Config() *model.Config {
@@ -246,12 +246,12 @@ func (a *App) AsymmetricSigningKey() *ecdsa.PrivateKey {
 func (a *App) regenerateClientConfig() {
 	a.clientConfig = utils.GenerateClientConfig(a.Config(), a.DiagnosticId(), a.License())
 
-	if a.clientConfig["EnableCustomServiceTerms"] == "true" {
-		serviceTerms, err := a.GetLatestServiceTerms()
+	if a.clientConfig["EnableCustomTermsOfService"] == "true" {
+		termsOfService, err := a.GetLatestTermsOfService()
 		if err != nil {
 			mlog.Err(err)
 		} else {
-			a.clientConfig["CustomServiceTermsId"] = serviceTerms.Id
+			a.clientConfig["CustomTermsOfServiceId"] = termsOfService.Id
 		}
 	}
 

app/diagnostics.go

@@ -417,7 +417,7 @@ func (a *App) trackConfig() {
 		"isdefault_help_link":             isDefault(*cfg.SupportSettings.HelpLink, model.SUPPORT_SETTINGS_DEFAULT_HELP_LINK),
 		"isdefault_report_a_problem_link": isDefault(*cfg.SupportSettings.ReportAProblemLink, model.SUPPORT_SETTINGS_DEFAULT_REPORT_A_PROBLEM_LINK),
 		"isdefault_support_email":         isDefault(*cfg.SupportSettings.SupportEmail, model.SUPPORT_SETTINGS_DEFAULT_SUPPORT_EMAIL),
-		"custom_service_terms_enabled":    *cfg.SupportSettings.CustomServiceTermsEnabled,
+		"custom_terms_of_service_enabled": *cfg.SupportSettings.CustomTermsOfServiceEnabled,
 	})
 
 	a.SendDiagnostic(TRACK_CONFIG_LDAP, map[string]interface{}{

app/service_terms.go

@@ -1,45 +0,0 @@
-// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
-// See License.txt for license information.
-
-package app
-
-import (
-	"github.com/mattermost/mattermost-server/model"
-)
-
-func (a *App) CreateServiceTerms(text, userId string) (*model.ServiceTerms, *model.AppError) {
-	serviceTerms := &model.ServiceTerms{
-		Text:   text,
-		UserId: userId,
-	}
-
-	if _, err := a.GetUser(userId); err != nil {
-		return nil, err
-	}
-
-	result := <-a.Srv.Store.ServiceTerms().Save(serviceTerms)
-	if result.Err != nil {
-		return nil, result.Err
-	}
-
-	serviceTerms = result.Data.(*model.ServiceTerms)
-	return serviceTerms, nil
-}
-
-func (a *App) GetLatestServiceTerms() (*model.ServiceTerms, *model.AppError) {
-	if result := <-a.Srv.Store.ServiceTerms().GetLatest(true); result.Err != nil {
-		return nil, result.Err
-	} else {
-		serviceTerms := result.Data.(*model.ServiceTerms)
-		return serviceTerms, nil
-	}
-}
-
-func (a *App) GetServiceTerms(id string) (*model.ServiceTerms, *model.AppError) {
-	if result := <-a.Srv.Store.ServiceTerms().Get(id, true); result.Err != nil {
-		return nil, result.Err
-	} else {
-		serviceTerms := result.Data.(*model.ServiceTerms)
-		return serviceTerms, nil
-	}
-}

app/terms_of_service.go

@@ -0,0 +1,45 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package app
+
+import (
+	"github.com/mattermost/mattermost-server/model"
+)
+
+func (a *App) CreateTermsOfService(text, userId string) (*model.TermsOfService, *model.AppError) {
+	termsOfService := &model.TermsOfService{
+		Text:   text,
+		UserId: userId,
+	}
+
+	if _, err := a.GetUser(userId); err != nil {
+		return nil, err
+	}
+
+	result := <-a.Srv.Store.TermsOfService().Save(termsOfService)
+	if result.Err != nil {
+		return nil, result.Err
+	}
+
+	termsOfService = result.Data.(*model.TermsOfService)
+	return termsOfService, nil
+}
+
+func (a *App) GetLatestTermsOfService() (*model.TermsOfService, *model.AppError) {
+	if result := <-a.Srv.Store.TermsOfService().GetLatest(true); result.Err != nil {
+		return nil, result.Err
+	} else {
+		termsOfService := result.Data.(*model.TermsOfService)
+		return termsOfService, nil
+	}
+}
+
+func (a *App) GetTermsOfService(id string) (*model.TermsOfService, *model.AppError) {
+	if result := <-a.Srv.Store.TermsOfService().Get(id, true); result.Err != nil {
+		return nil, result.Err
+	} else {
+		termsOfService := result.Data.(*model.TermsOfService)
+		return termsOfService, nil
+	}
+}

app/user.go

@@ -1652,16 +1652,16 @@ func (a *App) UpdateOAuthUserAttrs(userData io.Reader, user *model.User, provide
 	return nil
 }
 
-func (a *App) RecordUserServiceTermsAction(userId, serviceTermsId string, accepted bool) *model.AppError {
+func (a *App) RecordUserTermsOfServiceAction(userId, termsOfServiceId string, accepted bool) *model.AppError {
 	user, err := a.GetUser(userId)
 	if err != nil {
 		return err
 	}
 
 	if accepted {
-		user.AcceptedServiceTermsId = serviceTermsId
+		user.AcceptedTermsOfServiceId = termsOfServiceId
 	} else {
-		user.AcceptedServiceTermsId = ""
+		user.AcceptedTermsOfServiceId = ""
 	}
 	_, err = a.UpdateUser(user, false)
 	if err != nil {

app/user_test.go

@@ -545,7 +545,7 @@ func TestPermanentDeleteUser(t *testing.T) {
 	}
 }
 
-func TestRecordUserServiceTermsAction(t *testing.T) {
+func TestRecordUserTermsOfServiceAction(t *testing.T) {
 	th := Setup().InitBasic()
 	defer th.TearDown()
 
@@ -563,24 +563,24 @@ func TestRecordUserServiceTermsAction(t *testing.T) {
 
 	defer th.App.PermanentDeleteUser(user)
 
-	serviceTerms, err := th.App.CreateServiceTerms("text", user.Id)
+	termsOfService, err := th.App.CreateTermsOfService("text", user.Id)
 	if err != nil {
-		t.Fatalf("failed to create service terms: %v", err)
+		t.Fatalf("failed to create terms of service: %v", err)
 	}
 
-	err = th.App.RecordUserServiceTermsAction(user.Id, serviceTerms.Id, true)
+	err = th.App.RecordUserTermsOfServiceAction(user.Id, termsOfService.Id, true)
 	if err != nil {
 		t.Fatalf("failed to record user action: %v", err)
 	}
 
 	nuser, err := th.App.GetUser(user.Id)
-	assert.Equal(t, serviceTerms.Id, nuser.AcceptedServiceTermsId)
+	assert.Equal(t, termsOfService.Id, nuser.AcceptedTermsOfServiceId)
 
-	err = th.App.RecordUserServiceTermsAction(user.Id, serviceTerms.Id, false)
+	err = th.App.RecordUserTermsOfServiceAction(user.Id, termsOfService.Id, false)
 	if err != nil {
 		t.Fatalf("failed to record user action: %v", err)
 	}
 
 	nuser, err = th.App.GetUser(user.Id)
-	assert.Empty(t, nuser.AcceptedServiceTermsId)
+	assert.Empty(t, nuser.AcceptedTermsOfServiceId)
 }