map[string]string inside a struct

Question

Apologies for the title, but this is a weird one and out of my ability to understand.

I'm working with a go library that's sort of finished, but sort of not:

https://github.com/yfronto/go-statuspage-api

The statuspage.io API supports the following params when posting an incident:

incident[components][component_id] - Map of status changes to apply to affected components.

An example would be:

"incident[components][ftgks51sfs2d]=degraded_performance"

Unfortunately, the struct defined in the library doesn't support that particular field:

type NewIncidentUpdate struct {
    Name               string
    Status             string
    Message            string
    WantsTwitterUpdate bool
    ImpactOverride     string
    ComponentIDs       []string
}

func (i *NewIncidentUpdate) String() string {
    return encodeParams(map[string]interface{}{
        "incident[name]":                 i.Name,
        "incident[status]":               i.Status,
        "incident[message]":              i.Message,
        "incident[wants_twitter_update]": i.WantsTwitterUpdate,
        "incident[impact_override]":      i.ImpactOverride,
        "incident[component_ids]":        i.ComponentIDs,
    })
}

How can I update this struct (and the associated encodeParams function) to support passing an arbitrary map of components and associated statuses?

Adam Smith · Accepted Answer · 2018-07-31 22:24:41Z

1

You could embed a NewIncidentUpdate inside your own struct that defines the component status changes.

type MyIncidentUpdate struct {
    NewIncidentUpdate
    ComponentStatusChanges map[string]string
}

then define String the same way, while accomodating for your ComponentStatusChanges map.

func (i *MyIncidentUpdate) String() string {
    params := map[string]interface{}{
        "incident[name]":                 i.Name,
        "incident[status]":               i.Status,
        "incident[message]":              i.Message,
        "incident[wants_twitter_update]": i.WantsTwitterUpdate,
        "incident[impact_override]":      i.ImpactOverride,
        "incident[component_ids]":        i.ComponentIDs,
    }
    for k, val := range i.ComponentStatusChanges {
        key := fmt.Sprintf("incident[components][%s]", k)
        params[key] = val
    }

    return encodeParams(params)
}

answered Jul 31, 2018 at 22:24

Adam Smith

54.6k13 gold badges84 silver badges120 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

jaxxstorm Over a year ago

This is assuming I didn't want to modify the existing library, but I'm quite happy to fork the repo and update the repo in place, is there a way to do that?

Adam Smith Over a year ago

@jaxxstorm if they accept your PR, then sure. Simply change their NewIncidentUpdate to include the status changes map and update the String method (and any other method that might be affected -- I haven't scoured the repo) accordingly. (and good on you for contributing to existing projects!)

jaxxstorm Over a year ago

Thanks for the fantastic answer, really appreciated!

Collectives™ on Stack Overflow

map[string]string inside a struct

1 Answer 1

3 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Related