[feature config] self-deleting messages

changelog.d/0-release-notes/pr-1857

@@ -0,0 +1 @@
+Deploy galley before brig.

changelog.d/2-features/pr-1857-self-deleting-messages-feature

@@ -0,0 +1 @@
+End-points for configuring self-deleting messages.

docs/reference/cassandra-schema.cql

@@ -422,6 +422,8 @@ CREATE TABLE galley_test.team_features (
     file_sharing int,
     legalhold_status int,
     search_visibility_status int,
+    self_deleting_messages_status int,
+    self_deleting_messages_ttl int,
     sso_status int,
     validate_saml_emails int
 ) WITH bloom_filter_fp_chance = 0.1

libs/galley-types/src/Galley/Types/Teams.hs

@@ -31,6 +31,7 @@ module Galley.Types.Teams
     flagAppLockDefaults,
     flagClassifiedDomains,
     flagConferenceCalling,
+    flagSelfDeletingMessages,
     Defaults (..),
     unDefaults,
     FeatureSSO (..),
@@ -214,7 +215,8 @@ data FeatureFlags = FeatureFlags
     _flagAppLockDefaults :: !(Defaults (TeamFeatureStatus 'TeamFeatureAppLock)),
     _flagClassifiedDomains :: !(TeamFeatureStatus 'TeamFeatureClassifiedDomains),
     _flagFileSharing :: !(Defaults (TeamFeatureStatus 'TeamFeatureFileSharing)),
-    _flagConferenceCalling :: !(Defaults (TeamFeatureStatus 'TeamFeatureConferenceCalling))
+    _flagConferenceCalling :: !(Defaults (TeamFeatureStatus 'TeamFeatureConferenceCalling)),
+    _flagSelfDeletingMessages :: !(Defaults (TeamFeatureStatus 'TeamFeatureSelfDeletingMessages))
   }
   deriving (Eq, Show, Generic)
 
@@ -260,17 +262,19 @@ instance FromJSON FeatureFlags where
       <*> (fromMaybe defaultClassifiedDomains <$> (obj .:? "classifiedDomains"))
       <*> (fromMaybe (Defaults (TeamFeatureStatusNoConfig TeamFeatureEnabled)) <$> (obj .:? "fileSharing"))
       <*> (fromMaybe (Defaults (TeamFeatureStatusNoConfig TeamFeatureEnabled)) <$> (obj .:? "conferenceCalling"))
+      <*> (fromMaybe (Defaults defaultSelfDeletingMessagesStatus) <$> (obj .:? "selfDeletingMessages"))
 
 instance ToJSON FeatureFlags where
-  toJSON (FeatureFlags sso legalhold searchVisibility appLock classifiedDomains fileSharing conferenceCalling) =
+  toJSON (FeatureFlags sso legalhold searchVisibility appLock classifiedDomains fileSharing conferenceCalling selfDeletingMessages) =
     object $
       [ "sso" .= sso,
         "legalhold" .= legalhold,
         "teamSearchVisibility" .= searchVisibility,
         "appLock" .= appLock,
         "classifiedDomains" .= classifiedDomains,
         "fileSharing" .= fileSharing,
-        "conferenceCalling" .= conferenceCalling
+        "conferenceCalling" .= conferenceCalling,
+        "selfDeletingMessages" .= selfDeletingMessages
       ]
 
 instance FromJSON FeatureSSO where
@@ -362,6 +366,7 @@ roleHiddenPermissions role = HiddenPermissions p p
             ChangeTeamFeature TeamFeatureAppLock,
             ChangeTeamFeature TeamFeatureFileSharing,
             ChangeTeamFeature TeamFeatureClassifiedDomains {- the features not listed here can only be changed in stern -},
+            ChangeTeamFeature TeamFeatureSelfDeletingMessages,
             ReadIdp,
             CreateUpdateDeleteIdp,
             CreateReadDeleteScimToken,
@@ -381,6 +386,7 @@ roleHiddenPermissions role = HiddenPermissions p p
           ViewTeamFeature TeamFeatureFileSharing,
           ViewTeamFeature TeamFeatureClassifiedDomains,
           ViewTeamFeature TeamFeatureConferenceCalling,
+          ViewTeamFeature TeamFeatureSelfDeletingMessages,
           ViewLegalHoldUserSettings,
           ViewTeamSearchVisibility
         ]

libs/galley-types/test/unit/Test/Galley/Types.hs

@@ -96,3 +96,4 @@ instance Arbitrary FeatureFlags where
       <*> arbitrary
       <*> arbitrary
       <*> arbitrary
+      <*> arbitrary

libs/wire-api/src/Wire/API/Event/FeatureConfig.hs

@@ -30,7 +30,7 @@ import Data.Json.Util (ToJSONObject (..))
 import Data.Schema
 import qualified Data.Swagger as S
 import Imports
-import Wire.API.Team.Feature (TeamFeatureAppLockConfig, TeamFeatureClassifiedDomainsConfig, TeamFeatureName (..), TeamFeatureStatusNoConfig, TeamFeatureStatusWithConfig)
+import Wire.API.Team.Feature (TeamFeatureAppLockConfig, TeamFeatureClassifiedDomainsConfig, TeamFeatureName (..), TeamFeatureSelfDeletingMessagesConfig, TeamFeatureStatusNoConfig, TeamFeatureStatusWithConfig)
 
 data Event = Event
   { _eventType :: EventType,
@@ -53,6 +53,7 @@ data EventData
   = EdFeatureWithoutConfigChanged TeamFeatureStatusNoConfig
   | EdFeatureApplockChanged (TeamFeatureStatusWithConfig TeamFeatureAppLockConfig)
   | EdFeatureClassifiedDomainsChanged (TeamFeatureStatusWithConfig TeamFeatureClassifiedDomainsConfig)
+  | EdFeatureSelfDeletingMessagesChanged (TeamFeatureStatusWithConfig TeamFeatureSelfDeletingMessagesConfig)
   deriving (Eq, Show, Generic)
 
 makePrisms ''EventData
@@ -73,6 +74,7 @@ taggedEventDataSchema =
       TeamFeatureFileSharing -> tag _EdFeatureWithoutConfigChanged (unnamed schema)
       TeamFeatureClassifiedDomains -> tag _EdFeatureClassifiedDomainsChanged (unnamed schema)
       TeamFeatureConferenceCalling -> tag _EdFeatureWithoutConfigChanged (unnamed schema)
+      TeamFeatureSelfDeletingMessages -> tag _EdFeatureSelfDeletingMessagesChanged (unnamed schema)
 
 eventObjectSchema :: ObjectSchema SwaggerDoc Event
 eventObjectSchema =

libs/wire-api/src/Wire/API/Routes/Public/Galley.hs

@@ -601,6 +601,7 @@ data Api routes = Api
              '[Servant.JSON]
              (PostOtrResponses MessageSendingStatus)
              (Either (MessageNotSent MessageSendingStatus) MessageSendingStatus),
+    -- team features
     teamFeatureStatusSSOGet ::
       routes
         :- FeatureStatusGet 'TeamFeatureSSO,
@@ -652,6 +653,12 @@ data Api routes = Api
     teamFeatureStatusConferenceCallingGet ::
       routes
         :- FeatureStatusGet 'TeamFeatureConferenceCalling,
+    teamFeatureStatusSelfDeletingMessagesGet ::
+      routes
+        :- FeatureStatusGet 'TeamFeatureSelfDeletingMessages,
+    teamFeatureStatusSelfDeletingMessagesPut ::
+      routes
+        :- FeatureStatusPut 'TeamFeatureSelfDeletingMessages,
     featureAllFeatureConfigsGet ::
       routes
         :- AllFeatureConfigsGet,
@@ -681,7 +688,10 @@ data Api routes = Api
         :- FeatureConfigGet 'TeamFeatureClassifiedDomains,
     featureConfigConferenceCallingGet ::
       routes
-        :- FeatureConfigGet 'TeamFeatureConferenceCalling
+        :- FeatureConfigGet 'TeamFeatureConferenceCalling,
+    featureConfigSelfDeletingMessagesGet ::
+      routes
+        :- FeatureConfigGet 'TeamFeatureSelfDeletingMessages
   }
   deriving (Generic)
 

libs/wire-api/src/Wire/API/Swagger.hs

@@ -128,6 +128,7 @@ models =
     Team.Feature.modelForTeamFeature Team.Feature.TeamFeatureClassifiedDomains,
     Team.Feature.modelTeamFeatureAppLockConfig,
     Team.Feature.modelTeamFeatureClassifiedDomainsConfig,
+    Team.Feature.modelTeamFeatureSelfDeletingMessagesConfig,
     Team.Invitation.modelTeamInvitation,
     Team.Invitation.modelTeamInvitationList,
     Team.Invitation.modelTeamInvitationRequest,

libs/wire-api/src/Wire/API/Team/Feature.hs

@@ -22,6 +22,7 @@ module Wire.API.Team.Feature
   ( TeamFeatureName (..),
     TeamFeatureStatus,
     TeamFeatureAppLockConfig (..),
+    TeamFeatureSelfDeletingMessagesConfig (..),
     TeamFeatureClassifiedDomainsConfig (..),
     TeamFeatureStatusValue (..),
     FeatureHasNoConfig,
@@ -33,6 +34,7 @@ module Wire.API.Team.Feature
     AllFeatureConfigs (..),
     defaultAppLockStatus,
     defaultClassifiedDomains,
+    defaultSelfDeletingMessagesStatus,
 
     -- * Swagger
     typeTeamFeatureName,
@@ -41,6 +43,7 @@ module Wire.API.Team.Feature
     modelTeamFeatureStatusWithConfig,
     modelTeamFeatureAppLockConfig,
     modelTeamFeatureClassifiedDomainsConfig,
+    modelTeamFeatureSelfDeletingMessagesConfig,
     modelForTeamFeature,
   )
 where
@@ -90,10 +93,13 @@ import Wire.API.Arbitrary (Arbitrary, GenericUniform (..))
 -- * services/galley/test/integration/API/Teams/Feature.hs
 --   * add an integration test for the feature
 --   * extend testAllFeatures
+-- * consider personal-account configurability (like for `conferenceCalling`, see
+--     eg. https://github.com/wireapp/wire-server/pull/1811,
+--     https://github.com/wireapp/wire-server/pull/1818)
 --
---
--- An overview of places to change (including compiler errors and failing tests) can be found
--- in eg. https://github.com/wireapp/wire-server/pull/1652.
+-- An example of all the places to change (including compiler errors and failing tests) can be found
+-- in eg. https://github.com/wireapp/wire-server/pull/1652.  (applock and conference calling also
+-- add interesting aspects, though.)
 --
 -- Using something like '[minBound..]' on those expressions would require dependent types.  We
 -- could generate exhaustive lists of those calls using TH, along the lines of:
@@ -119,6 +125,7 @@ data TeamFeatureName
   | TeamFeatureFileSharing
   | TeamFeatureClassifiedDomains
   | TeamFeatureConferenceCalling
+  | TeamFeatureSelfDeletingMessages
   deriving stock (Eq, Show, Ord, Generic, Enum, Bounded, Typeable)
   deriving (Arbitrary) via (GenericUniform TeamFeatureName)
 
@@ -162,6 +169,10 @@ instance KnownTeamFeatureName 'TeamFeatureConferenceCalling where
   type KnownTeamFeatureNameSymbol 'TeamFeatureConferenceCalling = "conferenceCalling"
   knownTeamFeatureName = TeamFeatureConferenceCalling
 
+instance KnownTeamFeatureName 'TeamFeatureSelfDeletingMessages where
+  type KnownTeamFeatureNameSymbol 'TeamFeatureSelfDeletingMessages = "selfDeletingMessages"
+  knownTeamFeatureName = TeamFeatureSelfDeletingMessages
+
 instance FromByteString TeamFeatureName where
   parser =
     Parser.takeByteString >>= \b ->
@@ -179,6 +190,7 @@ instance FromByteString TeamFeatureName where
         Right "fileSharing" -> pure TeamFeatureFileSharing
         Right "classifiedDomains" -> pure TeamFeatureClassifiedDomains
         Right "conferenceCalling" -> pure TeamFeatureConferenceCalling
+        Right "selfDeletingMessages" -> pure TeamFeatureSelfDeletingMessages
         Right t -> fail $ "Invalid TeamFeatureName: " <> T.unpack t
 
 -- TODO: how do we make this consistent with 'KnownTeamFeatureNameSymbol'?  add a test for
@@ -193,6 +205,7 @@ instance ToByteString TeamFeatureName where
   builder TeamFeatureFileSharing = "fileSharing"
   builder TeamFeatureClassifiedDomains = "classifiedDomains"
   builder TeamFeatureConferenceCalling = "conferenceCalling"
+  builder TeamFeatureSelfDeletingMessages = "selfDeletingMessages"
 
 instance ToSchema TeamFeatureName where
   schema =
@@ -280,6 +293,7 @@ type family TeamFeatureStatus (a :: TeamFeatureName) :: * where
   TeamFeatureStatus 'TeamFeatureFileSharing = TeamFeatureStatusNoConfig
   TeamFeatureStatus 'TeamFeatureClassifiedDomains = TeamFeatureStatusWithConfig TeamFeatureClassifiedDomainsConfig
   TeamFeatureStatus 'TeamFeatureConferenceCalling = TeamFeatureStatusNoConfig
+  TeamFeatureStatus 'TeamFeatureSelfDeletingMessages = TeamFeatureStatusWithConfig TeamFeatureSelfDeletingMessagesConfig
 
 type FeatureHasNoConfig (a :: TeamFeatureName) = (TeamFeatureStatus a ~ TeamFeatureStatusNoConfig) :: Constraint
 
@@ -294,6 +308,7 @@ modelForTeamFeature name@TeamFeatureAppLock = modelTeamFeatureStatusWithConfig n
 modelForTeamFeature TeamFeatureFileSharing = modelTeamFeatureStatusNoConfig
 modelForTeamFeature name@TeamFeatureClassifiedDomains = modelTeamFeatureStatusWithConfig name modelTeamFeatureClassifiedDomainsConfig
 modelForTeamFeature TeamFeatureConferenceCalling = modelTeamFeatureStatusNoConfig
+modelForTeamFeature name@TeamFeatureSelfDeletingMessages = modelTeamFeatureStatusWithConfig name modelTeamFeatureSelfDeletingMessagesConfig
 
 ----------------------------------------------------------------------
 -- TeamFeatureStatusNoConfig
@@ -409,6 +424,33 @@ defaultAppLockStatus =
     TeamFeatureEnabled
     (TeamFeatureAppLockConfig (EnforceAppLock False) 60)
 
+----------------------------------------------------------------------
+-- TeamFeatureSelfDeletingMessagesConfig
+
+data TeamFeatureSelfDeletingMessagesConfig = TeamFeatureSelfDeletingMessagesConfig
+  { sdmEnforcedTimeoutSeconds :: Int32
+  }
+  deriving stock (Eq, Show, Generic)
+  deriving (FromJSON, ToJSON, S.ToSchema) via (Schema TeamFeatureSelfDeletingMessagesConfig)
+  deriving (Arbitrary) via (GenericUniform TeamFeatureSelfDeletingMessagesConfig)
+
+instance ToSchema TeamFeatureSelfDeletingMessagesConfig where
+  schema =
+    object "TeamFeatureSelfDeletingMessagesConfig" $
+      TeamFeatureSelfDeletingMessagesConfig
+        <$> sdmEnforcedTimeoutSeconds .= field "enforcedTimeoutSeconds" schema
+
+modelTeamFeatureSelfDeletingMessagesConfig :: Doc.Model
+modelTeamFeatureSelfDeletingMessagesConfig =
+  Doc.defineModel "TeamFeatureSelfDeletingMessagesConfig" $ do
+    Doc.property "enforcedTimeoutSeconds" Doc.int32' $ Doc.description "optional; default: `0` (no enforcement)"
+
+defaultSelfDeletingMessagesStatus :: TeamFeatureStatusWithConfig TeamFeatureSelfDeletingMessagesConfig
+defaultSelfDeletingMessagesStatus =
+  TeamFeatureStatusWithConfig
+    TeamFeatureEnabled
+    (TeamFeatureSelfDeletingMessagesConfig 0)
+
 ----------------------------------------------------------------------
 -- internal
 

libs/wire-api/test/unit/Test/Wire/API/Roundtrip/Aeson.hs

@@ -204,6 +204,7 @@ tests =
       testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureFileSharing),
       testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureClassifiedDomains),
       testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureConferenceCalling),
+      testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureSelfDeletingMessages),
       testRoundTrip @Team.Feature.TeamFeatureStatusValue,
       testRoundTrip @Team.Invitation.InvitationRequest,
       testRoundTrip @Team.Invitation.Invitation,

services/galley/galley.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 8bf007e90cc28a7b92252e0fccfb998d850e30df040205e1bc7316b9008a0c9f
+-- hash: 503d71d65ade51f149de711b6c0b958b0d7de6c3472c4831fc5549c20410b37a
 
 name:           galley
 version:        0.83.0
@@ -385,6 +385,7 @@ executable galley-schema
       V51_FeatureFileSharing
       V52_FeatureConferenceCalling
       V53_AddRemoteConvStatus
+      V54_TeamFeatureSelfDeletingMessages
       Paths_galley
   hs-source-dirs:
       schema/src

services/galley/schema/src/Main.hs

@@ -56,6 +56,7 @@ import qualified V50_AddLegalholdWhitelisted
 import qualified V51_FeatureFileSharing
 import qualified V52_FeatureConferenceCalling
 import qualified V53_AddRemoteConvStatus
+import qualified V54_TeamFeatureSelfDeletingMessages
 
 main :: IO ()
 main = do
@@ -97,7 +98,8 @@ main = do
       V50_AddLegalholdWhitelisted.migration,
       V51_FeatureFileSharing.migration,
       V52_FeatureConferenceCalling.migration,
-      V53_AddRemoteConvStatus.migration
+      V53_AddRemoteConvStatus.migration,
+      V54_TeamFeatureSelfDeletingMessages.migration
       -- When adding migrations here, don't forget to update
       -- 'schemaVersion' in Galley.Data
       -- (see also docs/developer/cassandra-interaction.md)

services/galley/schema/src/V54_TeamFeatureSelfDeletingMessages.hs

@@ -0,0 +1,34 @@
+-- This file is part of the Wire Server implementation.
+--
+-- Copyright (C) 2020 Wire Swiss GmbH <opensource@wire.com>
+--
+-- This program is free software: you can redistribute it and/or modify it under
+-- the terms of the GNU Affero General Public License as published by the Free
+-- Software Foundation, either version 3 of the License, or (at your option) any
+-- later version.
+--
+-- This program is distributed in the hope that it will be useful, but WITHOUT
+-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+-- FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+-- details.
+--
+-- You should have received a copy of the GNU Affero General Public License along
+-- with this program. If not, see <https://www.gnu.org/licenses/>.
+
+module V54_TeamFeatureSelfDeletingMessages
+  ( migration,
+  )
+where
+
+import Cassandra.Schema
+import Imports
+import Text.RawString.QQ
+
+migration :: Migration
+migration = Migration 54 "Add feature config for self-deleting messages" $ do
+  schema'
+    [r| ALTER TABLE team_features ADD (
+          self_deleting_messages_status int,
+          self_deleting_messages_ttl int
+        )
+     |]

services/galley/src/Galley/API/Internal.hs

@@ -174,6 +174,12 @@ data InternalApi routes = InternalApi
     iTeamFeatureStatusConferenceCallingGet ::
       routes
         :- IFeatureStatusGet 'Public.TeamFeatureConferenceCalling,
+    iTeamFeatureStatusSelfDeletingMessagesPut ::
+      routes
+        :- IFeatureStatusPut 'Public.TeamFeatureSelfDeletingMessages,
+    iTeamFeatureStatusSelfDeletingMessagesGet ::
+      routes
+        :- IFeatureStatusGet 'Public.TeamFeatureSelfDeletingMessages,
     -- This endpoint can lead to the following events being sent:
     -- - MemberLeave event to members for all conversations the user was in
     iDeleteUser ::
@@ -281,6 +287,8 @@ servantSitemap =
         iTeamFeatureStatusClassifiedDomainsGet = iGetTeamFeature @'Public.TeamFeatureClassifiedDomains Features.getClassifiedDomainsInternal,
         iTeamFeatureStatusConferenceCallingPut = iPutTeamFeature @'Public.TeamFeatureConferenceCalling Features.setConferenceCallingInternal,
         iTeamFeatureStatusConferenceCallingGet = iGetTeamFeature @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal,
+        iTeamFeatureStatusSelfDeletingMessagesPut = iPutTeamFeature @'Public.TeamFeatureSelfDeletingMessages Features.setSelfDeletingMessagesInternal,
+        iTeamFeatureStatusSelfDeletingMessagesGet = iGetTeamFeature @'Public.TeamFeatureSelfDeletingMessages Features.getSelfDeletingMessagesInternal,
         iDeleteUser = rmUser,
         iConnect = Create.createConnectConversation,
         iUpsertOne2OneConversation = One2One.iUpsertOne2OneConversation

services/galley/src/Galley/API/Public.hs

@@ -162,6 +162,12 @@ servantSitemap =
         GalleyAPI.teamFeatureStatusConferenceCallingGet =
           getFeatureStatus @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal
             . DoAuth,
+        GalleyAPI.teamFeatureStatusSelfDeletingMessagesGet =
+          getFeatureStatus @'Public.TeamFeatureSelfDeletingMessages Features.getSelfDeletingMessagesInternal
+            . DoAuth,
+        GalleyAPI.teamFeatureStatusSelfDeletingMessagesPut =
+          setFeatureStatus @'Public.TeamFeatureSelfDeletingMessages Features.setSelfDeletingMessagesInternal
+            . DoAuth,
         GalleyAPI.featureAllFeatureConfigsGet = Features.getAllFeatureConfigs,
         GalleyAPI.featureConfigLegalHoldGet = Features.getFeatureConfig @'Public.TeamFeatureLegalHold Features.getLegalholdStatusInternal,
         GalleyAPI.featureConfigSSOGet = Features.getFeatureConfig @'Public.TeamFeatureSSO Features.getSSOStatusInternal,
@@ -171,7 +177,8 @@ servantSitemap =
         GalleyAPI.featureConfigAppLockGet = Features.getFeatureConfig @'Public.TeamFeatureAppLock Features.getAppLockInternal,
         GalleyAPI.featureConfigFileSharingGet = Features.getFeatureConfig @'Public.TeamFeatureFileSharing Features.getFileSharingInternal,
         GalleyAPI.featureConfigClassifiedDomainsGet = Features.getFeatureConfig @'Public.TeamFeatureClassifiedDomains Features.getClassifiedDomainsInternal,
-        GalleyAPI.featureConfigConferenceCallingGet = Features.getFeatureConfig @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal
+        GalleyAPI.featureConfigConferenceCallingGet = Features.getFeatureConfig @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal,
+        GalleyAPI.featureConfigSelfDeletingMessagesGet = Features.getFeatureConfig @'Public.TeamFeatureSelfDeletingMessages Features.getSelfDeletingMessagesInternal
       }
 
 sitemap :: Routes ApiBuilder (Galley GalleyEffects) ()