[MM-37772] Idiomatic naming (URL, URI, API) (#18128)

* s/Url/URL/g & s/Uri/URI/g

* s/Api/API/g
This commit is contained in:
Ben Schumacher
2021-08-16 19:46:44 +02:00
committed by GitHub
parent a7f5512ff3
commit 757dc96461
155 changed files with 1680 additions and 1681 deletions

View File

@@ -98,7 +98,7 @@ func (rcs *Service) sendFileToRemote(timeout time.Duration, task sendFileTask) (
if err != nil {
return nil, fmt.Errorf("invalid siteURL while sending file to remote %s: %w", task.rc.RemoteId, err)
}
u.Path = path.Join(u.Path, model.ApiUrlSuffix, "remotecluster", "upload", task.us.Id)
u.Path = path.Join(u.Path, model.APIURLSuffix, "remotecluster", "upload", task.us.Id)
req, err := http.NewRequest("POST", u.String(), r)
if err != nil {

View File

@@ -99,7 +99,7 @@ func (rcs *Service) sendProfileImageToRemote(timeout time.Duration, task sendPro
if err != nil {
return fmt.Errorf("invalid siteURL while sending file to remote %s: %w", task.rc.RemoteId, err)
}
u.Path = path.Join(u.Path, model.ApiUrlSuffix, "remotecluster", task.userID, "image")
u.Path = path.Join(u.Path, model.APIURLSuffix, "remotecluster", task.userID, "image")
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)

View File

@@ -104,7 +104,7 @@ type TelemetryService struct {
type RudderConfig struct {
RudderKey string
DataplaneUrl string
DataplaneURL string
}
func New(srv ServerIface, dbStore store.Store, searchEngine *searchengine.Broker, log *mlog.Logger) *TelemetryService {
@@ -154,8 +154,8 @@ func (ts *TelemetryService) telemetryEnabled() bool {
func (ts *TelemetryService) sendDailyTelemetry(override bool) {
config := ts.getRudderConfig()
if ts.telemetryEnabled() && ((config.DataplaneUrl != "" && config.RudderKey != "") || override) {
ts.initRudder(config.DataplaneUrl, config.RudderKey)
if ts.telemetryEnabled() && ((config.DataplaneURL != "" && config.RudderKey != "") || override) {
ts.initRudder(config.DataplaneURL, config.RudderKey)
ts.trackActivity()
ts.trackConfig()
ts.trackLicense()
@@ -373,8 +373,8 @@ func (ts *TelemetryService) trackConfig() {
"enable_custom_emoji": *cfg.ServiceSettings.EnableCustomEmoji,
"enable_emoji_picker": *cfg.ServiceSettings.EnableEmojiPicker,
"enable_gif_picker": *cfg.ServiceSettings.EnableGifPicker,
"gfycat_api_key": isDefault(*cfg.ServiceSettings.GfycatApiKey, model.ServiceSettingsDefaultGfycatApiKey),
"gfycat_api_secret": isDefault(*cfg.ServiceSettings.GfycatApiSecret, model.ServiceSettingsDefaultGfycatApiSecret),
"gfycat_api_key": isDefault(*cfg.ServiceSettings.GfycatAPIKey, model.ServiceSettingsDefaultGfycatAPIKey),
"gfycat_api_secret": isDefault(*cfg.ServiceSettings.GfycatAPISecret, model.ServiceSettingsDefaultGfycatAPISecret),
"experimental_enable_authentication_transfer": *cfg.ServiceSettings.ExperimentalEnableAuthenticationTransfer,
"restrict_custom_emoji_creation": *cfg.ServiceSettings.DEPRECATED_DO_NOT_USE_RestrictCustomEmojiCreation,
"enable_testing": cfg.ServiceSettings.EnableTesting,
@@ -393,7 +393,7 @@ func (ts *TelemetryService) trackConfig() {
"session_length_sso_in_days": *cfg.ServiceSettings.SessionLengthSSOInDays,
"session_cache_in_minutes": *cfg.ServiceSettings.SessionCacheInMinutes,
"session_idle_timeout_in_minutes": *cfg.ServiceSettings.SessionIdleTimeoutInMinutes,
"isdefault_site_url": isDefault(*cfg.ServiceSettings.SiteURL, model.ServiceSettingsDefaultSiteUrl),
"isdefault_site_url": isDefault(*cfg.ServiceSettings.SiteURL, model.ServiceSettingsDefaultSiteURL),
"isdefault_tls_cert_file": isDefault(*cfg.ServiceSettings.TLSCertFile, model.ServiceSettingsDefaultTLSCertFile),
"isdefault_tls_key_file": isDefault(*cfg.ServiceSettings.TLSKeyFile, model.ServiceSettingsDefaultTLSKeyFile),
"isdefault_read_timeout": isDefault(*cfg.ServiceSettings.ReadTimeout, model.ServiceSettingsDefaultReadTimeout),
@@ -755,7 +755,7 @@ func (ts *TelemetryService) trackConfig() {
})
ts.sendTelemetry(TrackConfigElasticsearch, map[string]interface{}{
"isdefault_connection_url": isDefault(*cfg.ElasticsearchSettings.ConnectionUrl, model.ElasticsearchSettingsDefaultConnectionUrl),
"isdefault_connection_url": isDefault(*cfg.ElasticsearchSettings.ConnectionURL, model.ElasticsearchSettingsDefaultConnectionURL),
"isdefault_username": isDefault(*cfg.ElasticsearchSettings.Username, model.ElasticsearchSettingsDefaultUsername),
"isdefault_password": isDefault(*cfg.ElasticsearchSettings.Password, model.ElasticsearchSettingsDefaultPassword),
"enable_indexing": *cfg.ElasticsearchSettings.EnableIndexing,
@@ -776,7 +776,7 @@ func (ts *TelemetryService) trackConfig() {
"trace": *cfg.ElasticsearchSettings.Trace,
})
ts.trackPluginConfig(cfg, model.PluginSettingsDefaultMarketplaceUrl)
ts.trackPluginConfig(cfg, model.PluginSettingsDefaultMarketplaceURL)
ts.sendTelemetry(TrackConfigDataRetention, map[string]interface{}{
"enable_message_deletion": *cfg.DataRetentionSettings.EnableMessageDeletion,
@@ -803,7 +803,7 @@ func (ts *TelemetryService) trackConfig() {
ts.sendTelemetry(TrackConfigDisplay, map[string]interface{}{
"experimental_timezone": *cfg.DisplaySettings.ExperimentalTimezone,
"isdefault_custom_url_schemes": len(cfg.DisplaySettings.CustomUrlSchemes) != 0,
"isdefault_custom_url_schemes": len(cfg.DisplaySettings.CustomURLSchemes) != 0,
})
ts.sendTelemetry(TrackConfigGuestAccounts, map[string]interface{}{
@@ -1306,15 +1306,15 @@ func (ts *TelemetryService) trackPluginConfig(cfg *model.Config, marketplaceURL
"enable_nps_survey": pluginSetting(&cfg.PluginSettings, "com.mattermost.nps", "enablesurvey", true),
"enable": *cfg.PluginSettings.Enable,
"enable_uploads": *cfg.PluginSettings.EnableUploads,
"allow_insecure_download_url": *cfg.PluginSettings.AllowInsecureDownloadUrl,
"allow_insecure_download_url": *cfg.PluginSettings.AllowInsecureDownloadURL,
"enable_health_check": *cfg.PluginSettings.EnableHealthCheck,
"enable_marketplace": *cfg.PluginSettings.EnableMarketplace,
"require_pluginSignature": *cfg.PluginSettings.RequirePluginSignature,
"enable_remote_marketplace": *cfg.PluginSettings.EnableRemoteMarketplace,
"automatic_prepackaged_plugins": *cfg.PluginSettings.AutomaticPrepackagedPlugins,
"is_default_marketplace_url": isDefault(*cfg.PluginSettings.MarketplaceUrl, model.PluginSettingsDefaultMarketplaceUrl),
"is_default_marketplace_url": isDefault(*cfg.PluginSettings.MarketplaceURL, model.PluginSettingsDefaultMarketplaceURL),
"signature_public_key_files": len(cfg.PluginSettings.SignaturePublicKeyFiles),
"chimera_oauth_proxy_url": *cfg.PluginSettings.ChimeraOAuthProxyUrl,
"chimera_oauth_proxy_url": *cfg.PluginSettings.ChimeraOAuthProxyURL,
}
// knownPluginIDs lists all known plugin IDs in the Marketplace

View File

@@ -532,7 +532,7 @@ func TestRudderTelemetry(t *testing.T) {
config := telemetryService.getRudderConfig()
assert.Equal(t, "arudderstackplace", config.DataplaneUrl)
assert.Equal(t, "arudderstackplace", config.DataplaneURL)
assert.Equal(t, "abc123", config.RudderKey)
})
}

View File

@@ -69,7 +69,7 @@ func (wc *writeCounter) Write(p []byte) (int, error) {
return n, nil
}
func getCurrentVersionTgzUrl() string {
func getCurrentVersionTgzURL() string {
version := model.CurrentVersion
if strings.HasPrefix(model.BuildNumber, version+"-rc") {
version = model.BuildNumber
@@ -184,24 +184,24 @@ func UpgradeToE0() error {
return err
}
filename, err := download(getCurrentVersionTgzUrl(), 1024*1024*300)
filename, err := download(getCurrentVersionTgzURL(), 1024*1024*300)
if err != nil {
if filename != "" {
os.Remove(filename)
}
upgradeError = fmt.Errorf("error downloading the new Mattermost server binary file (percentage: %d)", upgradePercentage)
mlog.Error("Unable to download the Mattermost server binary file", mlog.Int64("percentage", upgradePercentage), mlog.String("url", getCurrentVersionTgzUrl()), mlog.Err(err))
mlog.Error("Unable to download the Mattermost server binary file", mlog.Int64("percentage", upgradePercentage), mlog.String("url", getCurrentVersionTgzURL()), mlog.Err(err))
upgradePercentage = 0
return err
}
defer os.Remove(filename)
sigfilename, err := download(getCurrentVersionTgzUrl()+".sig", 1024)
sigfilename, err := download(getCurrentVersionTgzURL()+".sig", 1024)
if err != nil {
if sigfilename != "" {
os.Remove(sigfilename)
}
upgradeError = errors.New("error downloading the signature file of the new server")
mlog.Error("Unable to download the signature file of the new Mattermost server", mlog.String("url", getCurrentVersionTgzUrl()+".sig"), mlog.Err(err))
mlog.Error("Unable to download the signature file of the new Mattermost server", mlog.String("url", getCurrentVersionTgzURL()+".sig"), mlog.Err(err))
upgradePercentage = 0
return err
}

View File

@@ -35,7 +35,7 @@ func TestCanIUpgradeToE0(t *testing.T) {
})
}
func TestGetCurrentVersionTgzUrl(t *testing.T) {
func TestGetCurrentVersionTgzURL(t *testing.T) {
t.Run("get release version in regular version", func(t *testing.T) {
currentVersion := model.CurrentVersion
buildNumber := model.CurrentVersion
@@ -45,7 +45,7 @@ func TestGetCurrentVersionTgzUrl(t *testing.T) {
model.CurrentVersion = currentVersion
model.BuildNumber = buildNumber
}()
require.Equal(t, "https://releases.mattermost.com/5.22.0/mattermost-5.22.0-linux-amd64.tar.gz", getCurrentVersionTgzUrl())
require.Equal(t, "https://releases.mattermost.com/5.22.0/mattermost-5.22.0-linux-amd64.tar.gz", getCurrentVersionTgzURL())
})
t.Run("get release version in dev version", func(t *testing.T) {
@@ -57,7 +57,7 @@ func TestGetCurrentVersionTgzUrl(t *testing.T) {
model.CurrentVersion = currentVersion
model.BuildNumber = buildNumber
}()
require.Equal(t, "https://releases.mattermost.com/5.22.0/mattermost-5.22.0-linux-amd64.tar.gz", getCurrentVersionTgzUrl())
require.Equal(t, "https://releases.mattermost.com/5.22.0/mattermost-5.22.0-linux-amd64.tar.gz", getCurrentVersionTgzURL())
})
t.Run("get release version in rc version", func(t *testing.T) {
@@ -69,7 +69,7 @@ func TestGetCurrentVersionTgzUrl(t *testing.T) {
model.CurrentVersion = currentVersion
model.BuildNumber = buildNumber
}()
require.Equal(t, "https://releases.mattermost.com/5.22.0-rc2/mattermost-5.22.0-rc2-linux-amd64.tar.gz", getCurrentVersionTgzUrl())
require.Equal(t, "https://releases.mattermost.com/5.22.0-rc2/mattermost-5.22.0-rc2-linux-amd64.tar.gz", getCurrentVersionTgzURL())
})
}