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.

Sign up for GitHub

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

Jump to bottom

Refactor getTTLFromAnnotations() to not return error #3939

Merged
merged 2 commits into from
Oct 2, 2023
Merged

Refactor getTTLFromAnnotations() to not return error #3939

merged 2 commits into from
Oct 2, 2023

Conversation

johngmyers
Copy link
Contributor

Description

Refactors getTTLFromAnnotations() to not return an error. The only correct thing to do is to log the parsing failure and continue with a default TTL.

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 17, 2023
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Sep 17, 2023
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 20, 2023
mloiseleur
mloiseleur reviewed Sep 26, 2023
View reviewed changes
source/source.go Outdated
}
ttlValue, err := parseTTL(ttlAnnotation)
if err != nil {
return ttlNotConfigured, fmt.Errorf("\"%v\" is not a valid TTL value", ttlAnnotation)
log.Warnf("\"%v\" is not a valid TTL value", ttlAnnotation)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
log.Warnf("\"%v\" is not a valid TTL value", ttlAnnotation)
log.Warnf("\"%v\" is not a valid TTL value. It should follow Go duration like \"10m\" or \"3h\". Fraction is omitted.", ttlAnnotation)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It also accepts an integer number of seconds.

This isn't really the place to be giving detailed documentation, such as the rounding down of fractional seconds. At a more fundamental level, the log line omits important context: the name of the resource containing the ignored annotation. The previous code also omitted this context.

I could possibly see logging the error returned from the time.ParseDuration() call.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah yes. Providing the resource reference and the error of time.ParseDuration() seems a better idea.

@johngmyers
Copy link
Contributor Author

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Sep 28, 2023
@mloiseleur
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 28, 2023
@johngmyers
Copy link
Contributor Author

/approve

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 28, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johngmyers

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 28, 2023
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Sep 28, 2023
@mloiseleur
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 2, 2023
@k8s-ci-robot k8s-ci-robot merged commit 17e9637 into kubernetes-sigs:master Oct 2, 2023
@johngmyers johngmyers deleted the refactor-ttl branch October 2, 2023 17:12
This was referenced Jul 22, 2024
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mloiseleur mloiseleur mloiseleur left review comments

@njuettner njuettner Awaiting requested review from njuettner

@szuecs szuecs Awaiting requested review from szuecs

Assignees

@mloiseleur mloiseleur

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@johngmyers @mloiseleur @k8s-ci-robot