Add feature flag "conferenceCalling" (#1683)

* wire-api: Add TeamFeatureConferenceCalling

* galley-types: add default flag & permissions

* Add getFeatureStatusWithDefaultConfig

* setFeatureStatusNoConfig: Add push event hook

* Add migration for feature flags

* implement galley endpoints

* internal endpoints and fix

* extend test

* add simple test

* correct a comment

* merge event testing into simple flag

* update CHANGELOG

* update schema

* update galley.integration.yaml for doc

* galley-types: fix unit test

* Add docs to config options

* fix typo

CHANGELOG.md

@@ -44,6 +44,7 @@ Upgrade nginz (#1658)
 
 * Extend feature config API (#1658)
 * `fileSharing` feature config (#1652, #1654, #1655)
+* `conferenceCalling` feature flag (#1683)
 * Add user_id to csv export (#1663)
 * Validate server TLS certificate between federators (#1662)
 

docs/reference/cassandra-schema.cql

@@ -411,6 +411,7 @@ CREATE TABLE galley_test.team_features (
     app_lock_enforce int,
     app_lock_inactivity_timeout_secs int,
     app_lock_status int,
+    conference_calling int,
     digital_signatures int,
     file_sharing int,
     legalhold_status int,

docs/reference/config-options.md

@@ -124,6 +124,23 @@ classifiedDomains:
     domains: []
 ```
 
+### Conference Calling
+
+The `conferenceCalling` feature flag controls whether a user can initiate a conference call. The flag can be toggled between its states `enabled` and `disabled` per team via an internal endpoint. 
+
+The `conferenceCalling` section in `featureFlags` defines the state of the `conferenceCalling` feature flag for all personal users (users that don't belong to a team). For personal users there is no way to toggle the flag, so the setting of the config section wholly defines the state of `conferenceCalling` flag for all personal users.
+
+The `conferenceCalling` section in `featureFlags` also defines the _initial_ state of the `conferenceCalling` flag for all teams. After the flag is set for the first time for a team via the internal endpoint the value from the config section will be ignored.
+
+Example value for the config section:
+```yaml
+conferenceCalling:
+  defaults:
+    status: enabled
+```
+
+The `conferenceCalling` section is optional in `featureFlags`. If it is omitted then it is assumed to be `enabled`.
+
 ### Federation Domain
 
 Regardless of whether a backend wants to enable federation or not, the operator

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

@@ -30,6 +30,7 @@ module Galley.Types.Teams
     flagFileSharing,
     flagAppLockDefaults,
     flagClassifiedDomains,
+    flagConferenceCalling,
     Defaults (..),
     unDefaults,
     FeatureSSO (..),
@@ -199,7 +200,8 @@ data FeatureFlags = FeatureFlags
     _flagTeamSearchVisibility :: !FeatureTeamSearchVisibility,
     _flagAppLockDefaults :: !(Defaults (TeamFeatureStatus 'TeamFeatureAppLock)),
     _flagClassifiedDomains :: !(TeamFeatureStatus 'TeamFeatureClassifiedDomains),
-    _flagFileSharing :: !(Defaults (TeamFeatureStatus 'TeamFeatureFileSharing))
+    _flagFileSharing :: !(Defaults (TeamFeatureStatus 'TeamFeatureFileSharing)),
+    _flagConferenceCalling :: !(Defaults (TeamFeatureStatus 'TeamFeatureConferenceCalling))
   }
   deriving (Eq, Show, Generic)
 
@@ -244,16 +246,18 @@ instance FromJSON FeatureFlags where
       <*> (fromMaybe (Defaults defaultAppLockStatus) <$> (obj .:? "appLock"))
       <*> (fromMaybe defaultClassifiedDomains <$> (obj .:? "classifiedDomains"))
       <*> (fromMaybe (Defaults (TeamFeatureStatusNoConfig TeamFeatureEnabled)) <$> (obj .:? "fileSharing"))
+      <*> (fromMaybe (Defaults (TeamFeatureStatusNoConfig TeamFeatureEnabled)) <$> (obj .:? "conferenceCalling"))
 
 instance ToJSON FeatureFlags where
-  toJSON (FeatureFlags sso legalhold searchVisibility appLock classifiedDomains fileSharing) =
+  toJSON (FeatureFlags sso legalhold searchVisibility appLock classifiedDomains fileSharing conferenceCalling) =
     object $
       [ "sso" .= sso,
         "legalhold" .= legalhold,
         "teamSearchVisibility" .= searchVisibility,
         "appLock" .= appLock,
         "classifiedDomains" .= classifiedDomains,
-        "fileSharing" .= fileSharing
+        "fileSharing" .= fileSharing,
+        "conferenceCalling" .= conferenceCalling
       ]
 
 instance FromJSON FeatureSSO where
@@ -363,6 +367,7 @@ roleHiddenPermissions role = HiddenPermissions p p
           ViewTeamFeature TeamFeatureAppLock,
           ViewTeamFeature TeamFeatureFileSharing,
           ViewTeamFeature TeamFeatureClassifiedDomains,
+          ViewTeamFeature TeamFeatureConferenceCalling,
           ViewLegalHoldUserSettings,
           ViewTeamSearchVisibility
         ]

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

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

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

@@ -72,6 +72,7 @@ taggedEventDataSchema =
       TeamFeatureAppLock -> tag _EdFeatureApplockChanged (unnamed schema)
       TeamFeatureFileSharing -> tag _EdFeatureWithoutConfigChanged (unnamed schema)
       TeamFeatureClassifiedDomains -> tag _EdFeatureClassifiedDomainsChanged (unnamed schema)
+      TeamFeatureConferenceCalling -> tag _EdFeatureWithoutConfigChanged (unnamed schema)
 
 eventObjectSchema :: ObjectSchema SwaggerDoc Event
 eventObjectSchema =

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

@@ -372,6 +372,9 @@ data Api routes = Api
     teamFeatureStatusClassifiedDomainsGet ::
       routes
         :- FeatureStatusGet 'TeamFeatureClassifiedDomains,
+    teamFeatureStatusConferenceCallingGet ::
+      routes
+        :- FeatureStatusGet 'TeamFeatureConferenceCalling,
     featureAllFeatureConfigsGet ::
       routes
         :- AllFeatureConfigsGet,
@@ -398,7 +401,10 @@ data Api routes = Api
         :- FeatureConfigGet 'TeamFeatureFileSharing,
     featureConfigClassifiedDomainsGet ::
       routes
-        :- FeatureConfigGet 'TeamFeatureClassifiedDomains
+        :- FeatureConfigGet 'TeamFeatureClassifiedDomains,
+    featureConfigConferenceCallingGet ::
+      routes
+        :- FeatureConfigGet 'TeamFeatureConferenceCalling
   }
   deriving (Generic)
 

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

@@ -73,11 +73,14 @@ import Wire.API.Arbitrary (Arbitrary, GenericUniform (..))
 --
 -- * libs/wire-api/test/unit/Test/Wire/API/Roundtrip/Aeson.hs
 --   * add call to 'testRoundTrip'
--- * services/galley/src/Galley/API/Internal.hs
---   * add a field to the 'InternalApi routes' record)
 -- * libs/wire-api/src/Wire/API/Routes/Public/Galley.hs
 --   * add a GET (and possible PUT) route with name prefix teamFeature<FEATURE_NAME>
 --   * add a GET route with name prefix featureConfig<FEATURE_NAME>
+-- * services/galley/src/Galley/API/Internal.hs
+--   * add a field to the 'InternalApi routes' record)
+-- * libs/galley-types/src/Galley/Types/Teams.hs
+--   * FeatureFlags for server config file
+--   * roleHiddenPermissions ChangeTeamFeature and ViewTeamFeature
 -- * services/galley/src/Galley/API/Teams/Features.hs
 --   * extend getAllFeatureConfigs
 --   * extend getAllFeatures
@@ -114,6 +117,7 @@ data TeamFeatureName
   | TeamFeatureAppLock
   | TeamFeatureFileSharing
   | TeamFeatureClassifiedDomains
+  | TeamFeatureConferenceCalling
   deriving stock (Eq, Show, Ord, Generic, Enum, Bounded, Typeable)
   deriving (Arbitrary) via (GenericUniform TeamFeatureName)
 
@@ -153,6 +157,10 @@ instance KnownTeamFeatureName 'TeamFeatureClassifiedDomains where
   type KnownTeamFeatureNameSymbol 'TeamFeatureClassifiedDomains = "classifiedDomains"
   knownTeamFeatureName = TeamFeatureClassifiedDomains
 
+instance KnownTeamFeatureName 'TeamFeatureConferenceCalling where
+  type KnownTeamFeatureNameSymbol 'TeamFeatureConferenceCalling = "conferenceCalling"
+  knownTeamFeatureName = TeamFeatureConferenceCalling
+
 instance FromByteString TeamFeatureName where
   parser =
     Parser.takeByteString >>= \b ->
@@ -169,6 +177,7 @@ instance FromByteString TeamFeatureName where
         Right "appLock" -> pure TeamFeatureAppLock
         Right "fileSharing" -> pure TeamFeatureFileSharing
         Right "classifiedDomains" -> pure TeamFeatureClassifiedDomains
+        Right "conferenceCalling" -> pure TeamFeatureConferenceCalling
         Right t -> fail $ "Invalid TeamFeatureName: " <> T.unpack t
 
 -- TODO: how do we make this consistent with 'KnownTeamFeatureNameSymbol'?  add a test for
@@ -182,6 +191,7 @@ instance ToByteString TeamFeatureName where
   builder TeamFeatureAppLock = "appLock"
   builder TeamFeatureFileSharing = "fileSharing"
   builder TeamFeatureClassifiedDomains = "classifiedDomains"
+  builder TeamFeatureConferenceCalling = "conferenceCalling"
 
 instance ToSchema TeamFeatureName where
   schema =
@@ -256,6 +266,7 @@ type family TeamFeatureStatus (a :: TeamFeatureName) :: * where
   TeamFeatureStatus 'TeamFeatureAppLock = TeamFeatureStatusWithConfig TeamFeatureAppLockConfig
   TeamFeatureStatus 'TeamFeatureFileSharing = TeamFeatureStatusNoConfig
   TeamFeatureStatus 'TeamFeatureClassifiedDomains = TeamFeatureStatusWithConfig TeamFeatureClassifiedDomainsConfig
+  TeamFeatureStatus 'TeamFeatureConferenceCalling = TeamFeatureStatusNoConfig
 
 type FeatureHasNoConfig (a :: TeamFeatureName) = (TeamFeatureStatus a ~ TeamFeatureStatusNoConfig) :: Constraint
 
@@ -269,6 +280,7 @@ modelForTeamFeature TeamFeatureDigitalSignatures = modelTeamFeatureStatusNoConfi
 modelForTeamFeature name@TeamFeatureAppLock = modelTeamFeatureStatusWithConfig name modelTeamFeatureAppLockConfig
 modelForTeamFeature TeamFeatureFileSharing = modelTeamFeatureStatusNoConfig
 modelForTeamFeature name@TeamFeatureClassifiedDomains = modelTeamFeatureStatusWithConfig name modelTeamFeatureClassifiedDomainsConfig
+modelForTeamFeature TeamFeatureConferenceCalling = modelTeamFeatureStatusNoConfig
 
 ----------------------------------------------------------------------
 -- TeamFeatureStatusNoConfig

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

@@ -204,6 +204,7 @@ tests =
       testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureAppLock),
       testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureFileSharing),
       testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureClassifiedDomains),
+      testRoundTrip @(Team.Feature.TeamFeatureStatus 'Team.Feature.TeamFeatureConferenceCalling),
       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: bb7dc649f5fc67c5e449f5b5984e8d7ae01caa5833ba0fa6a5db4f45cd5b1b42
+-- hash: 8728b07d9aff8cd747ea5ca33259f9168c966ae28ca76825e0a073e166d43213
 
 name:           galley
 version:        0.83.0
@@ -357,6 +357,7 @@ executable galley-schema
       V49_ReAddRemoteIdentifiers
       V50_AddLegalholdWhitelisted
       V51_FeatureFileSharing
+      V52_FeatureConferenceCalling
       Paths_galley
   hs-source-dirs:
       schema/src

services/galley/galley.integration.yaml

@@ -59,6 +59,9 @@ settings:
     fileSharing:
       defaults:
         status: enabled
+    conferenceCalling:
+      defaults:
+        status: enabled
 
 logLevel: Info
 logNetStrings: false

services/galley/schema/src/Main.hs

@@ -54,6 +54,7 @@ import qualified V48_DeleteRemoteIdentifiers
 import qualified V49_ReAddRemoteIdentifiers
 import qualified V50_AddLegalholdWhitelisted
 import qualified V51_FeatureFileSharing
+import qualified V52_FeatureConferenceCalling
 
 main :: IO ()
 main = do
@@ -93,7 +94,8 @@ main = do
       V48_DeleteRemoteIdentifiers.migration,
       V49_ReAddRemoteIdentifiers.migration,
       V50_AddLegalholdWhitelisted.migration,
-      V51_FeatureFileSharing.migration
+      V51_FeatureFileSharing.migration,
+      V52_FeatureConferenceCalling.migration
       -- When adding migrations here, don't forget to update
       -- 'schemaVersion' in Galley.Data
     ]

services/galley/schema/src/V52_FeatureConferenceCalling.hs

@@ -0,0 +1,29 @@
+-- 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 V52_FeatureConferenceCalling
+  ( migration,
+  )
+where
+
+import Cassandra.Schema
+import Imports
+import Text.RawString.QQ
+
+migration :: Migration
+migration = Migration 52 "Add feature flag \"conferenceCalling\"." $ do
+  schema' [r| ALTER TABLE team_features ADD conference_calling int; |]

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

@@ -150,7 +150,13 @@ data InternalApi routes = InternalApi
         :- IFeatureStatusPut 'Public.TeamFeatureFileSharing,
     iTeamFeatureStatusClassifiedDomainsGet ::
       routes
-        :- IFeatureStatusGet 'Public.TeamFeatureClassifiedDomains
+        :- IFeatureStatusGet 'Public.TeamFeatureClassifiedDomains,
+    iTeamFeatureStatusConferenceCallingPut ::
+      routes
+        :- IFeatureStatusPut 'Public.TeamFeatureConferenceCalling,
+    iTeamFeatureStatusConferenceCallingGet ::
+      routes
+        :- IFeatureStatusGet 'Public.TeamFeatureConferenceCalling
   }
   deriving (Generic)
 
@@ -222,7 +228,9 @@ servantSitemap =
         iTeamFeatureStatusAppLockPut = iPutTeamFeature @'Public.TeamFeatureAppLock Features.setAppLockInternal,
         iTeamFeatureStatusFileSharingGet = iGetTeamFeature @'Public.TeamFeatureFileSharing Features.getFileSharingInternal,
         iTeamFeatureStatusFileSharingPut = iPutTeamFeature @'Public.TeamFeatureFileSharing Features.setFileSharingInternal,
-        iTeamFeatureStatusClassifiedDomainsGet = iGetTeamFeature @'Public.TeamFeatureClassifiedDomains Features.getClassifiedDomainsInternal
+        iTeamFeatureStatusClassifiedDomainsGet = iGetTeamFeature @'Public.TeamFeatureClassifiedDomains Features.getClassifiedDomainsInternal,
+        iTeamFeatureStatusConferenceCallingPut = iPutTeamFeature @'Public.TeamFeatureConferenceCalling Features.setConferenceCallingInternal,
+        iTeamFeatureStatusConferenceCallingGet = iGetTeamFeature @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal
       }
 
 iGetTeamFeature ::

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

@@ -139,6 +139,9 @@ servantSitemap =
         GalleyAPI.teamFeatureStatusClassifiedDomainsGet =
           getFeatureStatus @'Public.TeamFeatureClassifiedDomains Features.getClassifiedDomainsInternal
             . DoAuth,
+        GalleyAPI.teamFeatureStatusConferenceCallingGet =
+          getFeatureStatus @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal
+            . DoAuth,
         GalleyAPI.featureAllFeatureConfigsGet = Features.getAllFeatureConfigs,
         GalleyAPI.featureConfigLegalHoldGet = Features.getFeatureConfig @'Public.TeamFeatureLegalHold Features.getLegalholdStatusInternal,
         GalleyAPI.featureConfigSSOGet = Features.getFeatureConfig @'Public.TeamFeatureSSO Features.getSSOStatusInternal,
@@ -147,7 +150,8 @@ servantSitemap =
         GalleyAPI.featureConfigDigitalSignaturesGet = Features.getFeatureConfig @'Public.TeamFeatureDigitalSignatures Features.getDigitalSignaturesInternal,
         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.featureConfigClassifiedDomainsGet = Features.getFeatureConfig @'Public.TeamFeatureClassifiedDomains Features.getClassifiedDomainsInternal,
+        GalleyAPI.featureConfigConferenceCallingGet = Features.getFeatureConfig @'Public.TeamFeatureConferenceCalling Features.getConferenceCallingInternal
       }
 
 sitemap :: Routes ApiBuilder Galley ()