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

fix: remove redundant map access #775

Merged
merged 2 commits into from
Nov 13, 2023
Merged

Conversation

dtam-cybozu
Copy link
Contributor

@dtam-cybozu dtam-cybozu commented Nov 10, 2023

Remove a redundant check for whether an element is present in a map. Since we return the zero value of a time.Time anyway, it's simpler to use the single return value version to access the map.

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.sh) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

I have not added any documentation or tests for this since it is such a small fix.

@dtam-cybozu dtam-cybozu requested a review from aeneasr as a code owner November 10, 2023 07:10
@dtam-cybozu dtam-cybozu changed the title Remove redundant map access fix: remove redundant map access Nov 10, 2023
Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

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

I believe that this will panic if the key does not exist

@dtam-cybozu
Copy link
Contributor Author

I believe that this will panic if the key does not exist

I don't think this is right. See https://go.dev/ref/spec#Index_expressions

For a of map type M:

  • x's type must be assignable to the key type of M
  • if the map contains an entry with key x, a[x] is the map element with key x and the type of a[x] is the element type of M
  • if the map is nil or does not contain such an entry, a[x] is the zero value for the element type of M

Here is a Go Playground example https://go.dev/play/p/udUlbIUWIfq

@james-d-elliott
Copy link
Contributor

Yeah this will not panic and will return exactly the same output. I would imagine there is a test in this scenario or one could be easily added to prove unchanged function.

@dtam-cybozu
Copy link
Contributor Author

BTW @aeneasr if the session itself is nil then a call to GetExpiresAt will panic but this is a separate discussion.

Anyway, I've added a test to show this does not panic.

@dtam-cybozu dtam-cybozu requested a review from aeneasr November 13, 2023 02:09
@aeneasr
Copy link
Member

aeneasr commented Nov 13, 2023

Thank you for the follow up - I think I was confused because it would panic if we had a pointer and would try to access it. Since we don't have either, this is fine! :)

@aeneasr aeneasr merged commit dfa2c0a into ory:master Nov 13, 2023
4 checks passed
@dtam-cybozu dtam-cybozu deleted the useless-map-access branch November 14, 2023 01:05
shipperizer pushed a commit to shipperizer/fosite that referenced this pull request Jan 3, 2024
james-d-elliott pushed a commit to james-d-elliott/fosite that referenced this pull request Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants