feat: allow excluding public channels from a legal hold

server/legalhold/legal_hold.go

@@ -87,7 +87,7 @@ func (ex *Execution) GetChannels() error {
 			return appErr
 		}
 
-		channelIDs, err := ex.store.GetChannelIDsForUserDuring(userID, ex.ExecutionStartTime, ex.ExecutionEndTime)
+		channelIDs, err := ex.store.GetChannelIDsForUserDuring(userID, ex.ExecutionStartTime, ex.ExecutionEndTime, ex.LegalHold.ExcludePublicChannels)
 		if err != nil {
 			return err
 		}

server/model/legal_hold.go

@@ -11,17 +11,18 @@ import (
 
 // LegalHold represents one legal hold.
 type LegalHold struct {
-	ID                   string   `json:"id"`
-	Name                 string   `json:"name"`
-	DisplayName          string   `json:"display_name"`
-	CreateAt             int64    `json:"create_at"`
-	UpdateAt             int64    `json:"update_at"`
-	UserIDs              []string `json:"user_ids"`
-	StartsAt             int64    `json:"starts_at"`
-	EndsAt               int64    `json:"ends_at"`
-	LastExecutionEndedAt int64    `json:"last_execution_ended_at"`
-	ExecutionLength      int64    `json:"execution_length"`
-	Secret               string   `json:"secret"`
+	ID                    string   `json:"id"`
+	Name                  string   `json:"name"`
+	DisplayName           string   `json:"display_name"`
+	CreateAt              int64    `json:"create_at"`
+	UpdateAt              int64    `json:"update_at"`
+	UserIDs               []string `json:"user_ids"`
+	StartsAt              int64    `json:"starts_at"`
+	EndsAt                int64    `json:"ends_at"`
+	ExcludePublicChannels bool     `json:"exclude_public_channels"`
+	LastExecutionEndedAt  int64    `json:"last_execution_ended_at"`
+	ExecutionLength       int64    `json:"execution_length"`
+	Secret                string   `json:"secret"`
 }
 
 // DeepCopy creates a deep copy of the LegalHold.
@@ -31,16 +32,17 @@ func (lh *LegalHold) DeepCopy() LegalHold {
 	}
 
 	newLegalHold := LegalHold{
-		ID:                   lh.ID,
-		Name:                 lh.Name,
-		DisplayName:          lh.DisplayName,
-		CreateAt:             lh.CreateAt,
-		UpdateAt:             lh.UpdateAt,
-		StartsAt:             lh.StartsAt,
-		EndsAt:               lh.EndsAt,
-		LastExecutionEndedAt: lh.LastExecutionEndedAt,
-		ExecutionLength:      lh.ExecutionLength,
-		Secret:               lh.Secret,
+		ID:                    lh.ID,
+		Name:                  lh.Name,
+		DisplayName:           lh.DisplayName,
+		CreateAt:              lh.CreateAt,
+		UpdateAt:              lh.UpdateAt,
+		StartsAt:              lh.StartsAt,
+		EndsAt:                lh.EndsAt,
+		ExcludePublicChannels: lh.ExcludePublicChannels,
+		LastExecutionEndedAt:  lh.LastExecutionEndedAt,
+		ExecutionLength:       lh.ExecutionLength,
+		Secret:                lh.Secret,
 	}
 
 	if len(lh.UserIDs) > 0 {
@@ -131,25 +133,27 @@ func (lh *LegalHold) BasePath() string {
 
 // CreateLegalHold holds the data that is specified in the API call to create a LegalHold.
 type CreateLegalHold struct {
-	Name        string   `json:"name"`
-	DisplayName string   `json:"display_name"`
-	UserIDs     []string `json:"user_ids"`
-	StartsAt    int64    `json:"starts_at"`
-	EndsAt      int64    `json:"ends_at"`
+	Name                  string   `json:"name"`
+	DisplayName           string   `json:"display_name"`
+	UserIDs               []string `json:"user_ids"`
+	StartsAt              int64    `json:"starts_at"`
+	EndsAt                int64    `json:"ends_at"`
+	ExcludePublicChannels bool     `json:"exclude_public_channels"`
 }
 
 // NewLegalHoldFromCreate creates and populates a new LegalHold instance from
 // the provided CreateLegalHold instance.
 func NewLegalHoldFromCreate(lhc CreateLegalHold) LegalHold {
 	return LegalHold{
-		ID:                   mattermostModel.NewId(),
-		Name:                 lhc.Name,
-		DisplayName:          lhc.DisplayName,
-		UserIDs:              lhc.UserIDs,
-		StartsAt:             lhc.StartsAt,
-		EndsAt:               lhc.EndsAt,
-		LastExecutionEndedAt: 0,
-		ExecutionLength:      86400000,
+		ID:                    mattermostModel.NewId(),
+		Name:                  lhc.Name,
+		DisplayName:           lhc.DisplayName,
+		UserIDs:               lhc.UserIDs,
+		StartsAt:              lhc.StartsAt,
+		EndsAt:                lhc.EndsAt,
+		ExcludePublicChannels: lhc.ExcludePublicChannels,
+		LastExecutionEndedAt:  0,
+		ExecutionLength:       86400000,
 	}
 }
 

server/store/sqlstore/legal_hold.go

@@ -110,14 +110,24 @@ func (ss SQLStore) GetPostsBatch(channelID string, endTime int64, cursor model.L
 // GetChannelIDsForUserDuring gets the channel IDs for all channels that the user indicated by userID is
 // a member of during the time period from (and including) the startTime up until (but not including) the
 // endTime.
-func (ss SQLStore) GetChannelIDsForUserDuring(userID string, startTime int64, endTime int64) ([]string, error) {
+func (ss SQLStore) GetChannelIDsForUserDuring(userID string, startTime int64, endTime int64, excludePublic bool) ([]string, error) {
 	query := ss.replicaBuilder.
 		Select("distinct(cmh.channelid)").
-		From("channelmemberhistory as cmh").
+		From("channelmemberhistory as cmh")
+
+	query = query.
 		Where(sq.Lt{"cmh.jointime": endTime}).
 		Where(sq.Or{sq.Eq{"cmh.leavetime": nil}, sq.GtOrEq{"cmh.leavetime": startTime}}).
 		Where(sq.Eq{"cmh.userid": userID})
 
+	// Exclude all public channels from the results
+	if excludePublic {
+		query = query.Join("channels on cmh.channelid = channels.id").
+			Where(sq.NotEq{"channels.type": mattermostModel.ChannelTypeOpen})
+	}
+
+	ss.logger.Error(query.ToSql())
+
 	rows, err := query.Query()
 	if err != nil {
 		ss.logger.Error("error fetching channels for user during time period", "err", err)

server/store/sqlstore/legal_hold_test.go

@@ -19,7 +19,7 @@ func TestSQLStore_GetPostsBatch(t *testing.T) {
 	// Test with an open channel first
 
 	// create an open channel
-	channel, err := th.CreateChannel("stale-test", th.User1.Id, th.Team1.Id)
+	channel, err := th.CreateOpenChannel("stale-test", th.User1.Id, th.Team1.Id)
 	require.NoError(t, err)
 
 	var posts []*mattermostModel.Post
@@ -119,7 +119,7 @@ func TestSQLStore_LegalHold_GetChannelIDsForUserDuring(t *testing.T) {
 	require.NoError(t, th.mmStore.ChannelMemberHistory().LogLeaveEvent(th.User1.Id, channels[9].Id, endTwo-1000))
 
 	// Check channel IDs for first window.
-	firstWindowChannelIDs, err := th.Store.GetChannelIDsForUserDuring(th.User1.Id, startOne, endOne)
+	firstWindowChannelIDs, err := th.Store.GetChannelIDsForUserDuring(th.User1.Id, startOne, endOne, false)
 	expectedOne := []string{
 		channels[1].Id,
 		channels[2].Id,
@@ -133,7 +133,7 @@ func TestSQLStore_LegalHold_GetChannelIDsForUserDuring(t *testing.T) {
 	require.ElementsMatch(t, firstWindowChannelIDs, expectedOne)
 
 	// Check channel IDs for second window.
-	secondWindowChannelIDs, err := th.Store.GetChannelIDsForUserDuring(th.User1.Id, startTwo, endTwo)
+	secondWindowChannelIDs, err := th.Store.GetChannelIDsForUserDuring(th.User1.Id, startTwo, endTwo, false)
 	expectedTwo := []string{
 		channels[3].Id,
 		channels[4].Id,
@@ -145,6 +145,28 @@ func TestSQLStore_LegalHold_GetChannelIDsForUserDuring(t *testing.T) {
 	require.ElementsMatch(t, secondWindowChannelIDs, expectedTwo)
 }
 
+func TestLegalHold_GetChannelIDsForUserDuring_ExcludePublic(t *testing.T) {
+	th := SetupHelper(t).SetupBasic(t)
+	defer th.TearDown(t)
+
+	timeReference := mattermostModel.GetMillis()
+	start := timeReference + 1000000
+	end := start + 10000
+
+	openChannel, err := th.CreateChannel("public-channel", th.User1.Id, th.Team1.Id, mattermostModel.ChannelTypeOpen)
+	require.NoError(t, err)
+	privateChannel, err := th.CreateChannel("private-channel", th.User1.Id, th.Team1.Id, mattermostModel.ChannelTypePrivate)
+	require.NoError(t, err)
+
+	require.NoError(t, th.mmStore.ChannelMemberHistory().LogJoinEvent(th.User1.Id, openChannel.Id, start+1000))
+	require.NoError(t, th.mmStore.ChannelMemberHistory().LogJoinEvent(th.User1.Id, privateChannel.Id, start+1000))
+
+	// Check channel IDs
+	channelIDs, err := th.Store.GetChannelIDsForUserDuring(th.User1.Id, start, end, true)
+	require.NoError(t, err)
+	require.ElementsMatch(t, channelIDs, []string{privateChannel.Id})
+}
+
 func TestSQLStore_LegalHold_GetFileInfosByIDs(t *testing.T) {
 	// TODO: Implement me!
 	_ = t

server/store/sqlstore/testhelper.go

@@ -131,11 +131,15 @@ func (th *TestHelper) CreateTeams(num int, namePrefix string) ([]*model.Team, er
 	return teams, nil
 }
 
-func (th *TestHelper) CreateChannel(name string, userID string, teamID string) (*model.Channel, error) {
+func (th *TestHelper) CreateOpenChannel(name string, userID string, teamID string) (*model.Channel, error) {
+	return th.CreateChannel(name, userID, teamID, model.ChannelTypeOpen)
+}
+
+func (th *TestHelper) CreateChannel(name, userID, teamID string, channelType model.ChannelType) (*model.Channel, error) {
 	channel := &model.Channel{
 		Name:        name,
 		DisplayName: name,
-		Type:        model.ChannelTypeOpen,
+		Type:        channelType,
 		CreatorId:   userID,
 		TeamId:      teamID,
 	}

webapp/src/components/create_legal_hold_form.scss

@@ -2,5 +2,15 @@
     border: none !important;
 }
 
+.create-legal-hold-checkbox {
+    float: left;
+    width: 1em;
+    height: 1em;
+}
+
+.create-legal-hold-checkbox-wrapper, .create-legal-hold-checkbox-wrapper:focus {
+    border: 0px !important;
+}
+
 .create-legal-hold-container {
 }

webapp/src/components/create_legal_hold_form.tsx

@@ -5,14 +5,16 @@
 import UsersInput from '@/components/users_input';
 import {CreateLegalHold} from '@/types';
 import {GenericModal} from '@/components/mattermost-webapp/generic_modal/generic_modal';
 import Input from '@/components/mattermost-webapp/input/input';
+import Select from 'react-select';
 
 import './create_legal_hold_form.scss';
 
 interface CreateLegalHoldFormProps {
     createLegalHold: (data: CreateLegalHold) => Promise<any>;
     onExited: () => void;
     visible: boolean;
+    excludePublicChannels: boolean;
 }
 
 const CreateLegalHoldForm = (props: CreateLegalHoldFormProps) => {
@@ -21,6 +23,7 @@
     const [startsAt, setStartsAt] = useState('');
     const [endsAt, setEndsAt] = useState('');
     const [saving, setSaving] = useState(false);
+    const [excludePublicChannels, setExcludePublicChannels] = useState(props.excludePublicChannels);
     const [serverError, setServerError] = useState('');
 
     const displayNameChanged = (e: React.ChangeEvent<HTMLInputElement>) => {
@@ -35,6 +38,10 @@
         setEndsAt(e.target.value);
     };
 
+    const excludePublicChannelsChanged: (e: React.ChangeEvent<HTMLInputElement>) => void = (e) => {
+        setExcludePublicChannels(e.target.checked);
+    };
+
     const resetForm = () => {
         setDisplayName('');
         setStartsAt('');
@@ -55,6 +62,7 @@
             ends_at: (new Date(endsAt)).getTime(),
             starts_at: (new Date(startsAt)).getTime(),
             display_name: displayName,
+            exclude_public_channels: excludePublicChannels,
             name: slugify(displayName),
         };
 
@@ -138,6 +146,24 @@
                             onChange={setUsers}
                         />
                     </div>
+                    <div
+                        style={{
+                            display: 'flex',
+                            columnGap: '20px',
+                        }}
+                    >
+                        <label htmlFor={'legal-hold-exclude-public-channels'}>
+                            {'Exclude public channels'}
+                            <Input
+                                type='checkbox'
+                                id='legal-hold-exclude-public-channels'
+                                checked={excludePublicChannels}
+                                onChange={excludePublicChannelsChanged}
+                                inputClassName={'create-legal-hold-checkbox'}
+                                wrapperClassName={'create-legal-hold-checkbox-wrapper'}
+                            />
+                        </label>
+                    </div>
                     <div
                         style={{
                             display: 'flex',
@@ -189,4 +215,3 @@
 };
 
 export default CreateLegalHoldForm;
-