Add ClientState and tests

server/mscalendar/notification.go

@@ -131,7 +131,7 @@ func (processor *notificationProcessor) processNotification(n *remote.Notificati
 	n.SubscriptionCreator = creator.Remote
 
 	var client remote.Client
-	if !n.RecommendRenew || n.IsBare {
+	if n.RecommendRenew || n.IsBare {
 		client = processor.Remote.MakeClient(context.Background(), creator.OAuth2Token)
 	}
 
@@ -153,7 +153,7 @@ func (processor *notificationProcessor) processNotification(n *remote.Notificati
 		}
 		processor.Logger.With(bot.LogContext{
 			"MattermostUserID": creator.MattermostUserID,
-			"SubsriptionID":    n.SubscriptionID,
+			"SubscriptionID":   n.SubscriptionID,
 		}).Debugf("webhook notification: renewed user subscription.")
 	}
 
@@ -175,7 +175,7 @@ func (processor *notificationProcessor) processNotification(n *remote.Notificati
 		if !changed {
 			processor.Logger.With(bot.LogContext{
 				"MattermostUserID": creator.MattermostUserID,
-				"SubsriptionID":    n.SubscriptionID,
+				"SubscriptionID":   n.SubscriptionID,
 				"ChangeType":       n.ChangeType,
 				"EventID":          n.Event.ID,
 			}).Debugf("webhook notification: no changes detected in event.")
@@ -199,7 +199,7 @@ func (processor *notificationProcessor) processNotification(n *remote.Notificati
 
 	processor.Logger.With(bot.LogContext{
 		"MattermostUserID": creator.MattermostUserID,
-		"SubsriptionID":    n.SubscriptionID,
+		"SubscriptionID":   n.SubscriptionID,
 	}).Debugf("Notified: %s.", sa.Title)
 
 	return nil

server/mscalendar/notification_test.go

@@ -0,0 +1,188 @@
+// Copyright (c) 2019-present Mattermost, Inc. All Rights Reserved.
+// See License for license information.
+
+package mscalendar
+
+import (
+	"context"
+	"github.com/stretchr/testify/require"
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	"golang.org/x/oauth2"
+
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/config"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/mscalendar/mock_plugin_api"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/remote"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/remote/mock_remote"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/store"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/store/mock_store"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/utils/bot"
+	"github.com/mattermost/mattermost-plugin-mscalendar/server/utils/bot/mock_bot"
+)
+
+func newTestNotificationProcessor(env Env) NotificationProcessor {
+	processor := &notificationProcessor{
+		Env: env,
+	}
+	return processor
+}
+
+func newTestEvent(locationDisplayName string) *remote.Event {
+	return &remote.Event{
+		ID: "remote_event_id",
+		Organizer: &remote.Attendee{
+			EmailAddress: &remote.EmailAddress{
+				Address: "event_organizer_email",
+				Name:    "event_organizer_name",
+			},
+		},
+		Location: &remote.Location{
+			DisplayName: locationDisplayName,
+		},
+		ResponseStatus: &remote.EventResponseStatus{
+			Response: "event_response",
+		},
+		Weblink:           "event_weblink",
+		Subject:           "event_subject",
+		BodyPreview:       "event_body_preview",
+		ResponseRequested: true,
+	}
+}
+
+func newTestSubscription() *store.Subscription {
+	return &store.Subscription{
+		PluginVersion: "x.x.x",
+		Remote: &remote.Subscription{
+			ID:          "remote_subscription_id",
+			ClientState: "stored_client_state",
+		},
+		MattermostCreatorID: "creator_mm_id",
+	}
+}
+
+func newTestUser() *store.User {
+	return &store.User{
+		Settings: store.Settings{
+			EventSubscriptionID: "remote_subscription_id",
+		},
+		Remote: &remote.User{},
+		OAuth2Token: &oauth2.Token{
+			AccessToken: "creator_oauth_token",
+		},
+		MattermostUserID: "creator_mm_id",
+	}
+}
+
+func newTestNotification(clientState string, recommendRenew bool) *remote.Notification {
+	n := &remote.Notification{
+		SubscriptionID:      "remote_subscription_id",
+		IsBare:              true,
+		SubscriptionCreator: &remote.User{},
+		Event:               newTestEvent("event_location_display_name"),
+		Subscription:        &remote.Subscription{},
+		ClientState:         clientState,
+		RecommendRenew:      recommendRenew,
+	}
+	return n
+}
+
+func TestProcessNotification(t *testing.T) {
+	tcs := []struct {
+		name          string
+		expectedError string
+		notification  *remote.Notification
+		priorEvent    *remote.Event
+	}{
+		{
+			name:          "incoming ClientState matches stored ClientState",
+			expectedError: "",
+			notification:  newTestNotification("stored_client_state", false),
+			priorEvent:    nil,
+		}, {
+			name:          "incoming ClientState doesn't match stored ClientState",
+			expectedError: "Unauthorized webhook",
+			notification:  newTestNotification("wrong_client_state", false),
+			priorEvent:    nil,
+		}, {
+			name:          "prior event exists",
+			expectedError: "",
+			notification:  newTestNotification("stored_client_state", false),
+			priorEvent:    newTestEvent("prior_event_location_display_name"),
+		}, {
+			name:          "sub renewal recommended",
+			expectedError: "",
+			notification:  newTestNotification("stored_client_state", true),
+			priorEvent:    nil,
+		},
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.name, func(t *testing.T) {
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+
+			mockStore := mock_store.NewMockStore(ctrl)
+			mockPoster := mock_bot.NewMockPoster(ctrl)
+			mockRemote := mock_remote.NewMockRemote(ctrl)
+			mockPluginAPI := mock_plugin_api.NewMockPluginAPI(ctrl)
+			mockClient := mock_remote.NewMockClient(ctrl)
+
+			conf := &config.Config{BotUserID: "bot_mm_id", PluginVersion: "x.x.x"}
+			env := Env{
+				Config: conf,
+				Dependencies: &Dependencies{
+					Store:     mockStore,
+					Logger:    &bot.NilLogger{},
+					Poster:    mockPoster,
+					Remote:    mockRemote,
+					PluginAPI: mockPluginAPI,
+				},
+			}
+
+			subscription := newTestSubscription()
+			user := newTestUser()
+
+			mockStore.EXPECT().LoadSubscription("remote_subscription_id").Return(subscription, nil).Times(1)
+			mockStore.EXPECT().LoadUser("creator_mm_id").Return(user, nil).Times(1)
+
+			if tc.notification.ClientState == subscription.Remote.ClientState {
+				mockRemote.EXPECT().MakeClient(context.Background(), &oauth2.Token{
+					AccessToken: "creator_oauth_token",
+				}).Return(mockClient).Times(1)
+
+				if tc.notification.RecommendRenew {
+					mockClient.EXPECT().RenewSubscription("remote_subscription_id").Return(&remote.Subscription{}, nil).Times(1)
+					mockStore.EXPECT().StoreUserSubscription(user, &store.Subscription{
+						Remote:              &remote.Subscription{},
+						MattermostCreatorID: "creator_mm_id",
+						PluginVersion:       "x.x.x",
+					}).Return(nil).Times(1)
+				}
+
+				mockClient.EXPECT().GetNotificationData(tc.notification).Return(tc.notification, nil).Times(1)
+
+				if tc.priorEvent != nil {
+					mockStore.EXPECT().LoadUserEvent("creator_mm_id", "remote_event_id").Return(&store.Event{
+						Remote: tc.priorEvent,
+					}, nil).Times(1)
+				} else {
+					mockStore.EXPECT().LoadUserEvent("creator_mm_id", "remote_event_id").Return(nil, store.ErrNotFound).Times(1)
+				}
+
+				mockPoster.EXPECT().DMWithAttachments("creator_mm_id", gomock.Any()).Return(nil).Times(1)
+				mockStore.EXPECT().StoreUserEvent("creator_mm_id", gomock.Any()).Return(nil).Times(1)
+			}
+
+			p := newTestNotificationProcessor(env)
+			processor := p.(*notificationProcessor)
+			err := processor.processNotification(tc.notification)
+
+			if tc.expectedError != "" {
+				require.Equal(t, tc.expectedError, err.Error())
+			} else {
+				require.Nil(t, err)
+			}
+		})
+	}
+}

server/remote/msgraph/subscription.go

@@ -4,6 +4,8 @@
 package msgraph
 
 import (
+	"crypto/rand"
+	"encoding/base64"
 	"net/http"
 	"time"
 
@@ -13,12 +15,19 @@ import (
 
 const subscribeTTL = 10 * time.Minute
 
+func newRandomString() string {
+	b := make([]byte, 96)
+	rand.Read(b)
+	return base64.URLEncoding.EncodeToString(b)
+}
+
 func (c *client) CreateMySubscription(notificationURL string) (*remote.Subscription, error) {
 	sub := &remote.Subscription{
 		Resource:           "me/events",
 		ChangeType:         "created,updated,deleted",
 		NotificationURL:    notificationURL,
 		ExpirationDateTime: time.Now().Add(subscribeTTL).Format(time.RFC3339),
+		ClientState:        newRandomString(),
 	}
 	err := c.rbuilder.Subscriptions().Request().JSONRequest(c.ctx, http.MethodPost, "", sub, sub)
 	if err != nil {