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

set ExpiresAt in confirmations that support expiration #139

Merged
merged 1 commit into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions models/confirmation.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ type (
Created time.Time `json:"created" bson:"created"`
Modified time.Time `json:"modified" bson:"modified"`
Status Status `json:"status" bson:"status"`
ExpiresAt *time.Time `json:"expiresAt,omitempty" bson:"expiresAt,omitempty"`

Restrictions *Restrictions `json:"restrictions" bson:"-"`
TemplateName TemplateName `json:"-" bson:"templateName"`
Expand Down Expand Up @@ -110,6 +111,10 @@ func NewConfirmation(theType Type, templateName TemplateName, creatorId string)
Created: time.Now(),
}

if timeout, ok := Timeouts[theType]; ok {
expiresAt := conf.Created.Add(timeout)
conf.ExpiresAt = &expiresAt
}
return conf, nil
}
}
Expand Down Expand Up @@ -232,12 +237,10 @@ func (c *Confirmation) ValidateType(expectedType Type, validationErrors *[]error
}

func (c *Confirmation) IsExpired() bool {
timeout, ok := Timeouts[c.Type]
if !ok {
if c.ExpiresAt == nil || c.ExpiresAt.IsZero() {
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] Do we have zero time ExpiresAt in the the data currently? If not, then I'd remove the || c.ExpiresAt.IsZero() clause as not needed.

return false
}

return time.Now().After(c.Created.Add(timeout))
return time.Now().After(*c.ExpiresAt)
}

func (c *Confirmation) ResetKey() error {
Expand Down
46 changes: 46 additions & 0 deletions models/confirmation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"encoding/json"
"fmt"
"testing"
"time"
)

const (
Expand Down Expand Up @@ -67,6 +68,10 @@ func Test_NewConfirmation(t *testing.T) {
t.Fail()
}

if confirmation.ExpiresAt.IsZero() {
ewollesen marked this conversation as resolved.
Show resolved Hide resolved
t.Errorf("expected expiresAt to be non-Zero")
}

confirmation.UpdateStatus(StatusCompleted)

if confirmation.Status != StatusCompleted {
Expand Down Expand Up @@ -229,6 +234,47 @@ func TestConfirmationContextCustomUnmarshaler(s *testing.T) {
})
}

func TestConfirmationCalculatesExpiresAt(t *testing.T) {
for cType := range Timeouts {
invite, err := NewConfirmation(cType, TemplateNamePasswordReset, USERID)
if err != nil {
t.Fatalf("expected nil, got %+v", err)
}
if invite.ExpiresAt == nil || invite.ExpiresAt.IsZero() {
t.Errorf("expected non-Zero ExiresAt")
ewollesen marked this conversation as resolved.
Show resolved Hide resolved
}
}
}

func TestConfirmationIsExpired(t *testing.T) {
for cType := range Timeouts {
invite, err := NewConfirmation(cType, TemplateNameCareteamInvite, USERID)
if err != nil {
t.Fatalf("expected nil error, got %s", err)
}
if invite.IsExpired() {
t.Errorf("expected false, got true")
ewollesen marked this conversation as resolved.
Show resolved Hide resolved
}
*invite.ExpiresAt = time.Unix(0, 0)
ewollesen marked this conversation as resolved.
Show resolved Hide resolved
if !invite.IsExpired() {
t.Errorf("expected true, got false")
ewollesen marked this conversation as resolved.
Show resolved Hide resolved
}
}

// These types don't have timeouts, so don't get an expires at. They're
// never expired.
for _, cType := range []Type{TypeClinicianInvite, TypeNoAccount} {
nonExpiringInviting, err := NewConfirmation(cType, TemplateNameCareteamInvite, USERID)
if err != nil {
t.Fatalf("expected nil error, got %s", err)
}
if nonExpiringInviting.IsExpired() {
t.Errorf("expected invitation type %q to never expire", cType)
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, much more self-explanatory than "expected false, got true". 👍

}
}

}

// buff is a helper for generating a JSON []byte representation.
func buff(format string, args ...interface{}) *bytes.Buffer {
return bytes.NewBufferString(fmt.Sprintf(format, args...))
Expand Down