Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not store null for channel options #230

Merged
merged 2 commits into from
Jul 15, 2024

Conversation

nilmerg
Copy link
Member

@nilmerg nilmerg commented Jul 15, 2024

No description provided.

@nilmerg nilmerg added this to the Beta milestone Jul 15, 2024
@nilmerg nilmerg requested a review from oxzi July 15, 2024 14:20
@nilmerg nilmerg self-assigned this Jul 15, 2024
@cla-bot cla-bot bot added the cla/signed CLA is signed by all contributors of a PR label Jul 15, 2024
@nilmerg nilmerg removed this from the Beta milestone Jul 15, 2024
oxzi added a commit to Icinga/icinga-notifications that referenced this pull request Jul 15, 2024
In a nutshell, the newly introduced plugin.PopulateDefaults function
populates all fields of a Plugin-implementing struct with those fields
from Info.ConfigAttributes where ConfigOption.Default is set. Thus, a
single function call before parsing the user-submitted configuration
within the Plugin.SetConfig method sets default values.

As a result of the discussion between the Go and the Web team,
summarized in #205, Web does not store key-value pairs to be omitted.

Prior, an already JSON-encoded version of the ConfigOption slice was
present in plugin.Info. Thus, this data wasn't easily available anymore.
As the new code now needs to access this field, it was changed and a
custom sql driver.Valuer was implemented for a slice type.

While working on this, all ConfigOptions were put in the same order as
the struct fields.

Requires <Icinga/icinga-notifications-web#230>.

Closes #205.
Copy link
Member

@oxzi oxzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested this PR together with the current version of Icinga/icinga-notifications#206 and they worked perfectly together. Thanks!

@nilmerg nilmerg merged commit b377ae1 into main Jul 15, 2024
22 checks passed
@nilmerg nilmerg deleted the do-not-store-null-for-channel-options branch July 15, 2024 14:58
julianbrost pushed a commit to Icinga/icinga-notifications that referenced this pull request Jul 16, 2024
In a nutshell, the newly introduced plugin.PopulateDefaults function
populates all fields of a Plugin-implementing struct with those fields
from Info.ConfigAttributes where ConfigOption.Default is set. Thus, a
single function call before parsing the user-submitted configuration
within the Plugin.SetConfig method sets default values.

As a result of the discussion between the Go and the Web team,
summarized in #205, Web does not store key-value pairs to be omitted.

Prior, an already JSON-encoded version of the ConfigOption slice was
present in plugin.Info. Thus, this data wasn't easily available anymore.
As the new code now needs to access this field, it was changed and a
custom sql driver.Valuer was implemented for a slice type.

While working on this, all ConfigOptions were put in the same order as
the struct fields.

Requires <Icinga/icinga-notifications-web#230>.

Closes #205.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla/signed CLA is signed by all contributors of a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants