[GitHub] alficles commented on a change in pull request #1950: Added CRUD for /parameters
alficles commented on a change in pull request #1950: Added CRUD for /parameters URL: https://github.com/apache/incubator-trafficcontrol/pull/1950#discussion_r171953955 ## File path: traffic_ops/traffic_ops_golang/parameter/parameters.go ## @@ -0,0 +1,354 @@ +package parameter + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import ( + "errors" + "fmt" + "strconv" + + "github.com/apache/incubator-trafficcontrol/lib/go-log" + "github.com/apache/incubator-trafficcontrol/lib/go-tc" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/api" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/auth" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/dbhelpers" + + "github.com/jmoiron/sqlx" + "github.com/lib/pq" +) + +//we need a type alias to define functions on +type TOParameter tc.ParameterNullable + +//the refType is passed into the handlers where a copy of its type is used to decode the json. +var refType = TOParameter(tc.ParameterNullable{}) + +func GetRefType() *TOParameter { + return &refType +} + +//Implementation of the Identifier, Validator interface functions +func (parameter *TOParameter) GetID() (int, bool) { + if parameter.ID == nil { + return 0, false + } + return *parameter.ID, true +} + +func (parameter *TOParameter) GetAuditName() string { + if parameter.Name != nil { + return *parameter.Name + } + if parameter.ID != nil { + return strconv.Itoa(*parameter.ID) + } + return "unknown" +} + +func (parameter *TOParameter) GetType() string { + return "parameter" +} + +func (parameter *TOParameter) SetID(i int) { + parameter.ID = &i +} + +func (pl *TOParameter) Validate(db *sqlx.DB) []error { + errs := []error{} Review comment: `errs := []error(nil)` would be my preferred answer. It's not meaningfully longer and it avoids an allocation with effectively no work. Still... the code as it exists is fine. It's mostly a note for future work. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] alficles commented on a change in pull request #1950: Added CRUD for /parameters
alficles commented on a change in pull request #1950: Added CRUD for /parameters URL: https://github.com/apache/incubator-trafficcontrol/pull/1950#discussion_r171944478 ## File path: traffic_ops/traffic_ops_golang/parameter/parameters.go ## @@ -0,0 +1,354 @@ +package parameter + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import ( + "errors" + "fmt" + "strconv" + + "github.com/apache/incubator-trafficcontrol/lib/go-log" + "github.com/apache/incubator-trafficcontrol/lib/go-tc" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/api" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/auth" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/dbhelpers" + + "github.com/jmoiron/sqlx" + "github.com/lib/pq" +) + +//we need a type alias to define functions on +type TOParameter tc.ParameterNullable + +//the refType is passed into the handlers where a copy of its type is used to decode the json. +var refType = TOParameter(tc.ParameterNullable{}) + +func GetRefType() *TOParameter { + return &refType +} + +//Implementation of the Identifier, Validator interface functions +func (parameter *TOParameter) GetID() (int, bool) { + if parameter.ID == nil { + return 0, false + } + return *parameter.ID, true +} + +func (parameter *TOParameter) GetAuditName() string { + if parameter.Name != nil { + return *parameter.Name + } + if parameter.ID != nil { + return strconv.Itoa(*parameter.ID) + } + return "unknown" +} + +func (parameter *TOParameter) GetType() string { + return "parameter" +} + +func (parameter *TOParameter) SetID(i int) { + parameter.ID = &i +} + +func (pl *TOParameter) Validate(db *sqlx.DB) []error { + errs := []error{} Review comment: Do you intend to be allocating an empty array here? You can almost always save the allocation with `var errs []error`, so that in the typical case, that of no errors, it doesn't do any allocation? It's small and mostly pointless as an optimization in this particular code, but it's a good practice to be in. Also, this annoys some of the linters. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] alficles commented on a change in pull request #1950: Added CRUD for /parameters
alficles commented on a change in pull request #1950: Added CRUD for /parameters URL: https://github.com/apache/incubator-trafficcontrol/pull/1950#discussion_r171946284 ## File path: traffic_ops/traffic_ops_golang/parameter/parameters.go ## @@ -0,0 +1,354 @@ +package parameter + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import ( + "errors" + "fmt" + "strconv" + + "github.com/apache/incubator-trafficcontrol/lib/go-log" + "github.com/apache/incubator-trafficcontrol/lib/go-tc" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/api" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/auth" + "github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/dbhelpers" + + "github.com/jmoiron/sqlx" + "github.com/lib/pq" +) + +//we need a type alias to define functions on +type TOParameter tc.ParameterNullable + +//the refType is passed into the handlers where a copy of its type is used to decode the json. +var refType = TOParameter(tc.ParameterNullable{}) + +func GetRefType() *TOParameter { + return &refType +} + +//Implementation of the Identifier, Validator interface functions +func (parameter *TOParameter) GetID() (int, bool) { + if parameter.ID == nil { + return 0, false + } + return *parameter.ID, true +} + +func (parameter *TOParameter) GetAuditName() string { + if parameter.Name != nil { + return *parameter.Name + } + if parameter.ID != nil { + return strconv.Itoa(*parameter.ID) + } + return "unknown" +} + +func (parameter *TOParameter) GetType() string { + return "parameter" +} + +func (parameter *TOParameter) SetID(i int) { + parameter.ID = &i +} + +func (pl *TOParameter) Validate(db *sqlx.DB) []error { + errs := []error{} + name := pl.Name + if name != nil && len(*name) < 1 { + errs = append(errs, errors.New(`Parameter 'name' is required.`)) + } + return errs +} + +//The TOParameter implementation of the Creator interface +//all implementations of Creator should use transactions and return the proper errorType +//ParsePQUniqueConstraintError is used to determine if a parameter with conflicting values exists +//if so, it will return an errorType of DataConflict and the type should be appended to the +//generic error message returned +//The insert sql returns the id and lastUpdated values of the newly inserted parameter and have +//to be added to the struct +func (pl *TOParameter) Create(db *sqlx.DB, user auth.CurrentUser) (error, tc.ApiErrorType) { + rollbackTransaction := true + tx, err := db.Beginx() + defer func() { + if tx == nil || !rollbackTransaction { + return + } + err := tx.Rollback() + if err != nil { + log.Errorln(errors.New("rolling back transaction: " + err.Error())) + } + }() + + if err != nil { + log.Error.Printf("could not begin transaction: %v", err) + return tc.DBError, tc.SystemError + } + resultRows, err := tx.NamedQuery(insertQuery(), pl) + if err != nil { + if pqErr, ok := err.(*pq.Error); ok { + err, eType := dbhelpers.ParsePQUniqueConstraintError(pqErr) + if eType == tc.DataConflictError { + return errors.New("a parameter with " + err.Error()), eType + } + return err, eType + } + log.Errorf("received non pq error: %++v from create execution", err) + return tc.DBError, tc.SystemError + } + defer resultRows.Close() + + var id int + var lastUpdated tc.TimeNoMod + rowsAffected := 0 + for resultRows.Next() { + rowsAffected++ + if err := resultRows.Scan(&id, &lastUpdated); err != nil { + log.Error.Printf("could not scan id from insert: %s\n", err) +
[GitHub] alficles commented on a change in pull request #1950: Added CRUD for /parameters
alficles commented on a change in pull request #1950: Added CRUD for /parameters URL: https://github.com/apache/incubator-trafficcontrol/pull/1950#discussion_r171947162 ## File path: traffic_ops/traffic_ops_golang/systeminfo/system_info.go ## @@ -87,15 +88,18 @@ WHERE p.config_file='global'` info := make(map[string]string) for rows.Next() { - p := tc.Parameter{} + p := tc.ParameterNullable{} if err = rows.StructScan(&p); err != nil { return nil, fmt.Errorf("getting system_info: %v", err) } - if p.Secure && privLevel < auth.PrivLevelAdmin { + isSecure := *p.Secure Review comment: This will panic if p.Secure is null, which it will be if it's missing. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] alficles commented on a change in pull request #1950: Added CRUD for /parameters
alficles commented on a change in pull request #1950: Added CRUD for /parameters URL: https://github.com/apache/incubator-trafficcontrol/pull/1950#discussion_r171947506 ## File path: traffic_ops/traffic_ops_golang/systeminfo/system_info.go ## @@ -87,15 +88,18 @@ WHERE p.config_file='global'` info := make(map[string]string) for rows.Next() { - p := tc.Parameter{} + p := tc.ParameterNullable{} if err = rows.StructScan(&p); err != nil { return nil, fmt.Errorf("getting system_info: %v", err) } - if p.Secure && privLevel < auth.PrivLevelAdmin { + isSecure := *p.Secure + name := p.Name + value := p.Value + if isSecure && privLevel < auth.PrivLevelAdmin { // Secure params only visible to admin continue } - info[p.Name] = p.Value + info[*name] = *value Review comment: This will panic if name or value are null, but they haven't been checked anywhere. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
[GitHub] alficles commented on a change in pull request #1950: Added CRUD for /parameters
alficles commented on a change in pull request #1950: Added CRUD for /parameters URL: https://github.com/apache/incubator-trafficcontrol/pull/1950#discussion_r171942670 ## File path: lib/go-tc/regions.go ## @@ -19,10 +19,12 @@ package tc * under the License. */ +// RegionsResponse ... Review comment: These comments should generally be removed, I think. They suppress the linter but don't address its concern. This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services