Fixed lastUpdated timestamp format in api v5 federation resolvers #7596
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,19 +23,24 @@ package federation_resolvers | |
|
|
||
| import ( | ||
| "database/sql" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/apache/trafficcontrol/lib/go-log" | ||
| "github.com/apache/trafficcontrol/lib/go-rfc" | ||
| "github.com/apache/trafficcontrol/lib/go-tc" | ||
| "github.com/apache/trafficcontrol/lib/go-tc/tovalidate" | ||
| "github.com/apache/trafficcontrol/lib/go-util" | ||
| "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api" | ||
| "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/dbhelpers" | ||
| "github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/util/ims" | ||
|
|
||
| "github.com/jmoiron/sqlx" | ||
|
|
||
| validation "github.com/go-ozzo/ozzo-validation" | ||
| ) | ||
|
|
||
| const insertFederationResolverQuery = ` | ||
|
|
@@ -301,3 +306,153 @@ func deleteFederationResolver(inf *api.APIInfo) (tc.Alert, tc.FederationResolver | |
|
|
||
| return alert, result, userErr, sysErr, statusCode | ||
| } | ||
|
|
||
| // GetFederationResolvers [V5] - get list of federation resolver for APIv5 | ||
|
There was a problem hiding this comment. Since federation_resolvers is not using the CRUDer interface, it will be much easier (and would involve lesser lines of code) if we could just check the api version in the There was a problem hiding this comment. nice, i would do this srijeet |
||
| func GetFederationResolvers(w http.ResponseWriter, r *http.Request) { | ||
| var maxTime time.Time | ||
| var runSecond bool | ||
| inf, sysErr, userErr, errCode := api.NewInfo(r, nil, nil) | ||
| tx := inf.Tx | ||
| if sysErr != nil || userErr != nil { | ||
| api.HandleErr(w, r, tx.Tx, errCode, userErr, sysErr) | ||
| return | ||
| } | ||
| defer inf.Close() | ||
|
|
||
| queryParamsToQueryCols := map[string]dbhelpers.WhereColumnInfo{ | ||
| "id": dbhelpers.WhereColumnInfo{Column: "federation_resolver.id", Checker: api.IsInt}, | ||
| "ipAddress": dbhelpers.WhereColumnInfo{Column: "federation_resolver.ip_address"}, | ||
| "type": dbhelpers.WhereColumnInfo{Column: "type.name"}, | ||
| } | ||
| if _, ok := inf.Params["orderby"]; !ok { | ||
| inf.Params["orderby"] = "id" | ||
| } | ||
|
|
||
| where, orderBy, pagination, queryValues, errs := dbhelpers.BuildWhereAndOrderByAndPagination(inf.Params, queryParamsToQueryCols) | ||
| if len(errs) > 0 { | ||
| sysErr = util.JoinErrs(errs) | ||
| errCode = http.StatusBadRequest | ||
| api.HandleErr(w, r, tx.Tx, errCode, nil, sysErr) | ||
| return | ||
| } | ||
|
|
||
| query := readQuery + where + orderBy + pagination | ||
| useIMS := false | ||
| config, e := api.GetConfig(r.Context()) | ||
| if e == nil && config != nil { | ||
| useIMS = config.UseIMS | ||
| } else { | ||
| log.Warnf("Couldn't get config %v", e) | ||
| } | ||
| if useIMS { | ||
| runSecond, maxTime = ims.TryIfModifiedSinceQuery(tx, r.Header, queryValues, SelectMaxLastUpdatedQuery(where, "federation_resolver")) | ||
| if !runSecond { | ||
| log.Debugln("IMS HIT") | ||
| api.AddLastModifiedHdr(w, maxTime) | ||
| w.WriteHeader(http.StatusNotModified) | ||
| api.WriteResp(w, r, []tc.FederationResolverV5{}) | ||
| return | ||
| } | ||
| log.Debugln("IMS MISS") | ||
| } else { | ||
| log.Debugln("Non IMS request") | ||
| } | ||
|
|
||
| rows, err := inf.Tx.NamedQuery(query, queryValues) | ||
|
||
| if err != nil { | ||
| userErr, sysErr, errCode = api.ParseDBError(err) | ||
| if sysErr != nil { | ||
| sysErr = fmt.Errorf("federation_resolver read query: %v", sysErr) | ||
| } | ||
|
|
||
| api.HandleErr(w, r, tx.Tx, errCode, userErr, sysErr) | ||
| return | ||
| } | ||
| defer rows.Close() | ||
|
|
||
| var resolvers = []tc.FederationResolverV5{} | ||
| for rows.Next() { | ||
| var resolver tc.FederationResolverV5 | ||
| if err := rows.Scan(&resolver.ID, &resolver.IPAddress, &resolver.LastUpdated, &resolver.Type); err != nil { | ||
| userErr, sysErr, errCode = api.ParseDBError(err) | ||
| if sysErr != nil { | ||
| sysErr = fmt.Errorf("federation_resolver scanning: %v", sysErr) | ||
| } | ||
| api.HandleErr(w, r, tx.Tx, errCode, userErr, sysErr) | ||
| return | ||
| } | ||
|
|
||
| resolvers = append(resolvers, resolver) | ||
| } | ||
|
|
||
| api.WriteResp(w, r, resolvers) | ||
| } | ||
|
|
||
| // CreateFederationResolver [V5] - creates the federation resolver with given data for APIv5 | ||
| func CreateFederationResolver(w http.ResponseWriter, r *http.Request) { | ||
|
|
||
| inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil) | ||
| if userErr != nil || sysErr != nil { | ||
| api.HandleErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr) | ||
| return | ||
| } | ||
| defer inf.Close() | ||
| tx := inf.Tx.Tx | ||
|
|
||
| fr, readValErr := readAndValidateJsonStructV5(r) | ||
| if readValErr != nil { | ||
| api.HandleErr(w, r, tx, http.StatusBadRequest, readValErr, nil) | ||
| return | ||
| } | ||
|
|
||
| // check if type already exists | ||
| var exists bool | ||
| checkQuery := fmt.Sprintf("SELECT EXISTS(%s WHERE ip_address = $1)", readQuery) | ||
| err := tx.QueryRow(checkQuery, fr.IPAddress).Scan(&exists) | ||
|
|
||
| if err != nil { | ||
| api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, fmt.Errorf("error: %w, when checking if federation_resolver with ip_address %s exists", err, fr.IPAddress)) | ||
| return | ||
| } | ||
| if exists { | ||
| api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("federation_resolver ip_address '%s' already exists", *fr.IPAddress), nil) | ||
| return | ||
| } | ||
|
|
||
| // create type | ||
| err = tx.QueryRow(insertFederationResolverQuery, fr.IPAddress, fr.TypeID).Scan(&fr.ID, &fr.IPAddress, &fr.Type, &fr.TypeID) | ||
| if err != nil { | ||
| if errors.Is(err, sql.ErrNoRows) { | ||
| api.HandleErr(w, r, tx, http.StatusInternalServerError, fmt.Errorf("error: %w in creating federation_resolver ip_address with ip_address: %s", err, fr.IPAddress), nil) | ||
| return | ||
| } | ||
| usrErr, sysErr, code := api.ParseDBError(err) | ||
| api.HandleErr(w, r, tx, code, usrErr, sysErr) | ||
| return | ||
| } | ||
| message := fmt.Sprintf("Federation Resolver created [ IP = %s ] with id: %d", *fr.IPAddress, *fr.ID) | ||
| alerts := tc.CreateAlerts(tc.SuccessLevel, message) | ||
| w.Header().Set("Location", fmt.Sprintf("/api/%d.%d/federation_resolvers?id=%s", inf.Version.Major, inf.Version.Minor, fr.ID)) | ||
| api.WriteAlertsObj(w, r, http.StatusCreated, alerts, fr) | ||
| return | ||
| } | ||
|
|
||
| // readAndValidateJsonStructV5 [V5] - validates the JSON object passed for APIv5 | ||
| func readAndValidateJsonStructV5(r *http.Request) (tc.FederationResolverV5, error) { | ||
| var fr tc.FederationResolverV5 | ||
| if err := json.NewDecoder(r.Body).Decode(&fr); err != nil { | ||
| userErr := fmt.Errorf("error decoding POST request body into FederationResolverV5 struct %w", err) | ||
| return fr, userErr | ||
| } | ||
|
|
||
| // validate JSON body | ||
| rule := validation.NewStringRule(tovalidate.IsValidIPorCIDR, "invalid network IP or CIDR-notation subnet.") | ||
| errs := tovalidate.ToErrors(validation.Errors{ | ||
| "ip_address": validation.Validate(fr.IPAddress, validation.Required, rule), | ||
| }) | ||
| if len(errs) > 0 { | ||
| userErr := util.JoinErrs(errs) | ||
| return fr, userErr | ||
| } | ||
| return fr, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a part of the "fixed" section.