From 7e2b5b196a63ff838102c4a921d54c78e379badc Mon Sep 17 00:00:00 2001 From: momantech <166911910+momantech@users.noreply.github.com> Date: Wed, 8 May 2024 14:47:23 +0800 Subject: [PATCH] chore: fix some comments (#2918) --- controllers/enrollmentkeys.go | 2 +- controllers/migrate.go | 2 +- logic/telemetry.go | 2 +- logic/version.go | 2 +- logic/version_test.go | 10 +++++----- logic/zombie.go | 2 +- pro/logic/nodes.go | 2 +- servercfg/serverconf.go | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/controllers/enrollmentkeys.go b/controllers/enrollmentkeys.go index ec9701e2..2cfb1363 100644 --- a/controllers/enrollmentkeys.go +++ b/controllers/enrollmentkeys.go @@ -279,7 +279,7 @@ func handleHostRegister(w http.ResponseWriter, r *http.Request) { return } // version check - if !logic.IsVersionComptatible(newHost.Version) { + if !logic.IsVersionCompatible(newHost.Version) { err := fmt.Errorf("bad client version on register: %s", newHost.Version) logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest")) return diff --git a/controllers/migrate.go b/controllers/migrate.go index c5590fda..a0b2a902 100644 --- a/controllers/migrate.go +++ b/controllers/migrate.go @@ -51,7 +51,7 @@ func migrate(w http.ResponseWriter, r *http.Request) { } var legacyNode models.LegacyNode if err = json.Unmarshal([]byte(record), &legacyNode); err != nil { - slog.Error("decoding legacy node", "errror", err) + slog.Error("decoding legacy node", "error", err) logic.ReturnErrorResponse(w, r, logic.FormatError(fmt.Errorf("decode legacy node %w", err), "badrequest")) return } diff --git a/logic/telemetry.go b/logic/telemetry.go index 764c1c1a..5902c048 100644 --- a/logic/telemetry.go +++ b/logic/telemetry.go @@ -106,7 +106,7 @@ func FetchTelemetryData() telemetryData { func getServerCount() int { data, err := database.FetchRecords(database.SERVER_UUID_TABLE_NAME) if err != nil { - logger.Log(0, "errror retrieving server data", err.Error()) + logger.Log(0, "error retrieving server data", err.Error()) } return len(data) } diff --git a/logic/version.go b/logic/version.go index 24576a93..c9cfd331 100644 --- a/logic/version.go +++ b/logic/version.go @@ -10,7 +10,7 @@ import ( const MinVersion = "v0.17.0" // IsVersionCompatible checks that the version passed is compabtible (>=) with MinVersion -func IsVersionComptatible(ver string) bool { +func IsVersionCompatible(ver string) bool { // during dev, assume developers know what they are doing if ver == "dev" { return true diff --git a/logic/version_test.go b/logic/version_test.go index c94af967..1682574e 100644 --- a/logic/version_test.go +++ b/logic/version_test.go @@ -9,27 +9,27 @@ import ( func TestVersion(t *testing.T) { t.Run("valid version", func(t *testing.T) { is := is.New(t) - valid := IsVersionComptatible("v0.17.1-testing") + valid := IsVersionCompatible("v0.17.1-testing") is.Equal(valid, true) }) t.Run("dev version", func(t *testing.T) { is := is.New(t) - valid := IsVersionComptatible("dev") + valid := IsVersionCompatible("dev") is.Equal(valid, true) }) t.Run("invalid version", func(t *testing.T) { is := is.New(t) - valid := IsVersionComptatible("v0.14.2-refactor") + valid := IsVersionCompatible("v0.14.2-refactor") is.Equal(valid, false) }) t.Run("no version", func(t *testing.T) { is := is.New(t) - valid := IsVersionComptatible("testing") + valid := IsVersionCompatible("testing") is.Equal(valid, false) }) t.Run("incomplete version", func(t *testing.T) { is := is.New(t) - valid := IsVersionComptatible("0.18") + valid := IsVersionCompatible("0.18") is.Equal(valid, true) }) } diff --git a/logic/zombie.go b/logic/zombie.go index 14bb9523..ad06b377 100644 --- a/logic/zombie.go +++ b/logic/zombie.go @@ -49,7 +49,7 @@ func CheckZombies(newnode *models.Node) { func checkForZombieHosts(h *models.Host) { hosts, err := GetAllHosts() if err != nil { - logger.Log(3, "errror retrieving all hosts", err.Error()) + logger.Log(3, "error retrieving all hosts", err.Error()) } for _, existing := range hosts { if existing.ID == h.ID { diff --git a/pro/logic/nodes.go b/pro/logic/nodes.go index 646e2400..4bad2de6 100644 --- a/pro/logic/nodes.go +++ b/pro/logic/nodes.go @@ -148,7 +148,7 @@ func GetNetworkIngresses(network string) ([]models.Node, error) { return ingresses, nil } -// GetAllowedIpsForInet - get inet cidr for node using a inet gw +// GetAllowedIpForInetNodeClient - get inet cidr for node using a inet gw func GetAllowedIpForInetNodeClient(node, peer *models.Node) []net.IPNet { var allowedips = []net.IPNet{} diff --git a/servercfg/serverconf.go b/servercfg/serverconf.go index dcf66342..56e00e34 100644 --- a/servercfg/serverconf.go +++ b/servercfg/serverconf.go @@ -620,7 +620,7 @@ func GetNetmakerTenantID() string { return netmakerTenantID } -// GetNetworkLimit - fetches free tier limits on users +// GetUserLimit - fetches free tier limits on users func GetUserLimit() int { var userslimit int if os.Getenv("USERS_LIMIT") != "" {