Add UserHasBeenDeactivated plugin hook (#20894)

Co-authored-by: Ben Schumacher <ben.schumacher@mattermost.com>

server/channels/app/plugin_hooks_test.go

@@ -775,6 +775,55 @@ func TestUserHasLoggedIn(t *testing.T) {
 	assert.Equal(t, user.FirstName, "plugin-callback-success", "Expected firstname overwrite, got default")
 }
 
+func TestUserHasBeenDeactivated(t *testing.T) {
+	th := Setup(t)
+	defer th.TearDown()
+
+	tearDown, _, _ := SetAppEnvironmentWithPlugins(t,
+		[]string{
+			`
+		package main
+
+		import (
+			"github.com/mattermost/mattermost/server/public/plugin"
+			"github.com/mattermost/mattermost/server/public/model"
+		)
+
+		type MyPlugin struct {
+			plugin.MattermostPlugin
+		}
+
+		func (p *MyPlugin) UserHasBeenDeactivated(c *plugin.Context, user *model.User) {
+			user.Nickname = "plugin-callback-success"
+			p.API.UpdateUser(user)
+		}
+
+		func main() {
+			plugin.ClientMain(&MyPlugin{})
+		}
+	`}, th.App, th.NewPluginAPI)
+	defer tearDown()
+
+	user := &model.User{
+		Email:    "success+test@example.com",
+		Nickname: "testnickname",
+		Username: "testusername",
+		Password: "testpassword",
+	}
+
+	_, err := th.App.CreateUser(th.Context, user)
+	require.Nil(t, err)
+
+	_, err = th.App.UpdateActive(th.Context, user, false)
+	require.Nil(t, err)
+
+	time.Sleep(1 * time.Second)
+	user, err = th.App.GetUser(user.Id)
+
+	require.Nil(t, err)
+	require.Equal(t, "plugin-callback-success", user.Nickname)
+}
+
 func TestUserHasBeenCreated(t *testing.T) {
 	th := Setup(t)
 	defer th.TearDown()
@@ -805,11 +854,10 @@ func TestUserHasBeenCreated(t *testing.T) {
 	defer tearDown()
 
 	user := &model.User{
-		Email:       model.NewId() + "success+test@example.com",
-		Nickname:    "Darth Vader",
-		Username:    "vader" + model.NewId(),
-		Password:    "passwd1",
-		AuthService: "",
+		Email:    "success+test@example.com",
+		Nickname: "testnickname",
+		Username: "testusername",
+		Password: "testpassword",
 	}
 	_, err := th.App.CreateUser(th.Context, user)
 	require.Nil(t, err)
@@ -991,11 +1039,10 @@ func TestActiveHooks(t *testing.T) {
 
 		require.True(t, th.App.GetPluginsEnvironment().IsActive(pluginID))
 		user1 := &model.User{
-			Email:       model.NewId() + "success+test@example.com",
-			Nickname:    "Darth Vader1",
-			Username:    "vader" + model.NewId(),
-			Password:    "passwd1",
-			AuthService: "",
+			Email:    "success+test@example.com",
+			Nickname: "testnickname",
+			Username: "testusername",
+			Password: "testpassword",
 		}
 		_, appErr := th.App.CreateUser(th.Context, user1)
 		require.Nil(t, appErr)
@@ -1097,10 +1144,10 @@ func TestHookMetrics(t *testing.T) {
 		require.True(t, th.App.GetPluginsEnvironment().IsActive(pluginID))
 
 		user1 := &model.User{
-			Email:       model.NewId() + "success+test@example.com",
-			Nickname:    "Darth Vader1",
-			Username:    "vader" + model.NewId(),
-			Password:    "passwd1",
+			Email:       "success+test@example.com",
+			Nickname:    "testnickname",
+			Username:    "testusername",
+			Password:    "testpassword",
 			AuthService: "",
 		}
 		_, appErr := th.App.CreateUser(th.Context, user1)

server/channels/app/user.go

@@ -1003,6 +1003,16 @@ func (a *App) UpdateActive(c request.CTX, user *model.User, active bool) (*model
 
 	a.sendUpdatedUserEvent(*ruser)
 
+	if pluginsEnvironment := a.GetPluginsEnvironment(); pluginsEnvironment != nil && !active && user.DeleteAt != 0 {
+		a.Srv().Go(func() {
+			pluginContext := pluginContext(c)
+			pluginsEnvironment.RunMultiPluginHook(func(hooks plugin.Hooks) bool {
+				hooks.UserHasBeenDeactivated(pluginContext, user)
+				return true
+			}, plugin.UserHasBeenDeactivatedID)
+		})
+	}
+
 	return ruser, nil
 }