Conference call initiation flag for personal accounts (#1811)

* New behavior of `GET /feature-configs*`.

* Cassandra migration: personal account feature "conf call init".

* Clean up after ormolu.

* Add optSettings.featureFlags.conferenceCalling to brig.yaml.

With default for NULL and default for new records.

* Internal brig PUT/GET/DELETE end-points for account features.

* Move brig's internal servant api to wire-api.

* Integration tests.

* Hard-wired default for all account features should be "enabled".

Author: fisx

changelog.d/2-features/pr-1811

@@ -0,0 +1 @@
+Per-account configuration of conference call initiation (details: /docs/reference/config-options.md#conference-calling-1)

docs/reference/cassandra-schema.cql

@@ -1058,6 +1058,7 @@ CREATE TABLE brig_test.user (
     country ascii,
     email text,
     expires timestamp,
+    feature_conference_calling int,
     handle text,
     language ascii,
     managed_by int,

docs/reference/config-options.md

@@ -5,7 +5,7 @@ Fragment.
 This page is about the yaml files that determine the configuration of
 the Wire backend services.
 
-## Settings
+## Settings in galley
 
 ```
 # [galley.yaml]
@@ -141,6 +141,8 @@ conferenceCalling:
 
 The `conferenceCalling` section is optional in `featureFlags`. If it is omitted then it is assumed to be `enabled`.
 
+See also: conference falling for personal accounts (below).
+
 ### File Sharing
 
 File sharing is enabled by default.  If you want to disable it for all teams, add this to your feature config settings:
@@ -270,3 +272,40 @@ federator:
     clientCertificate: client.pem
     clientPrivateKey: client-key.pem
 ```
+
+## Settings in brig
+
+Some features (as of the time of writing this: only
+`conferenceCalling`) allow to set defaults for personal accounts in
+brig.  Those are taken into account in galley's end-points `GET
+/feature-configs*`.
+
+To be specific:
+
+### Conference Calling
+
+Two values can be configured for personal accounts: a default for when
+the user record contains `null` as feature config, and default that
+should be inserted into the user record when creating new users:
+
+```
+# [brig.yaml]
+settings:
+  setFeatureFlags:
+    conferenceCalling:
+      defaultForNew:
+        status: disabled
+      defaultForNull:
+        status: enabled
+```
+
+You can omit the entire `conferenceCalling` block, but not parts of
+it.  Built-in defaults are as above.
+
+When new users are created, their config will be initialized with
+what's in `defaultForNew`.
+
+When a `null` value is encountered, it is assumed to be
+`defaultForNull`.
+
+(Introduced in https://github.com/wireapp/wire-server/pull/1811.)

libs/brig-types/brig-types.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 2b3c91a37e09e61ca32cf32ab80c46e8f019926c78165bec82d9c84a5b8d20a6
+-- hash: 42d648b07cd5a5d45e2ca36fd4631c37047fc74aea88fce77073a3efa99327a2
 
 name:           brig-types
 version:        1.35.0
@@ -40,7 +40,6 @@ library
       Brig.Types.Test.Arbitrary
       Brig.Types.User
       Brig.Types.User.Auth
-      Brig.Types.User.EJPD
       Brig.Types.User.Event
   other-modules:
       Paths_brig_types

libs/brig-types/test/unit/Test/Brig/Types/User.hs

@@ -30,11 +30,11 @@ module Test.Brig.Types.User where
 import Brig.Types.Connection (UpdateConnectionsInternal (..))
 import Brig.Types.Intra (NewUserScimInvitation (..), ReAuthUser (..))
 import Brig.Types.User (ManagedByUpdate (..), RichInfoUpdate (..))
-import Brig.Types.User.EJPD (EJPDRequestBody (..), EJPDResponseBody (..))
 import Imports
 import Test.Brig.Roundtrip (testRoundTrip, testRoundTripWithSwagger)
 import Test.QuickCheck (Arbitrary (arbitrary))
 import Test.Tasty
+import Wire.API.Routes.Internal.Brig.EJPD (EJPDRequestBody (..), EJPDResponseBody (..))
 
 tests :: TestTree
 tests = testGroup "User (types vs. aeson)" $ roundtripTests

libs/wire-api/package.yaml

@@ -13,6 +13,7 @@ dependencies:
 - containers >=0.5
 - imports
 - types-common >=0.16
+- servant-swagger-ui
 - case-insensitive
 - hscim
 library:

libs/wire-api/src/Wire/API/Routes/Internal/Brig.hs

@@ -0,0 +1,97 @@
+-- This file is part of the Wire Server implementation.
+--
+-- Copyright (C) 2020 Wire Swiss GmbH <[email protected]>
+--
+-- 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 Wire.API.Routes.Internal.Brig
+  ( API,
+    SwaggerDocsAPI,
+    swaggerDoc,
+    module Wire.API.Routes.Internal.Brig.EJPD,
+  )
+where
+
+import Control.Lens ((.~))
+import Data.Id as Id
+import Data.Swagger (HasInfo (info), HasTitle (title), Swagger)
+import Imports hiding (head)
+import Servant hiding (Handler, JSON, addHeader, respond)
+import qualified Servant
+import Servant.Swagger (HasSwagger (toSwagger))
+import Servant.Swagger.Internal.Orphans ()
+import Servant.Swagger.UI
+import Wire.API.Routes.Internal.Brig.EJPD
+import qualified Wire.API.Team.Feature as ApiFt
+
+type EJPDRequest =
+  Summary
+    "Identify users for law enforcement.  Wire has legal requirements to cooperate \
+    \with the authorities.  The wire backend operations team uses this to answer \
+    \identification requests manually.  It is our best-effort representation of the \
+    \minimum required information we need to hand over about targets and (in some \
+    \cases) their communication peers.  For more information, consult ejpd.admin.ch."
+    :> "ejpd-request"
+    :> QueryParam'
+         [ Optional,
+           Strict,
+           Description "Also provide information about all contacts of the identified users"
+         ]
+         "include_contacts"
+         Bool
+    :> Servant.ReqBody '[Servant.JSON] EJPDRequestBody
+    :> Post '[Servant.JSON] EJPDResponseBody
+
+type GetAccountFeatureConfig =
+  Summary
+    "Read cassandra field 'brig.user.feature_conference_calling'"
+    :> "users"
+    :> Capture "uid" UserId
+    :> "features"
+    :> "conferenceCalling"
+    :> Get '[Servant.JSON] (ApiFt.TeamFeatureStatus 'ApiFt.TeamFeatureConferenceCalling)
+
+type PutAccountFeatureConfig =
+  Summary
+    "Write to cassandra field 'brig.user.feature_conference_calling'"
+    :> "users"
+    :> Capture "uid" UserId
+    :> "features"
+    :> "conferenceCalling"
+    :> Servant.ReqBody '[Servant.JSON] (ApiFt.TeamFeatureStatus 'ApiFt.TeamFeatureConferenceCalling)
+    :> Put '[Servant.JSON] NoContent
+
+type DeleteAccountFeatureConfig =
+  Summary
+    "Reset cassandra field 'brig.user.feature_conference_calling' to 'null'"
+    :> "users"
+    :> Capture "uid" UserId
+    :> "features"
+    :> "conferenceCalling"
+    :> Delete '[Servant.JSON] NoContent
+
+type API =
+  "i"
+    :> ( EJPDRequest
+           :<|> GetAccountFeatureConfig
+           :<|> PutAccountFeatureConfig
+           :<|> DeleteAccountFeatureConfig
+       )
+
+type SwaggerDocsAPI = "api" :> "internal" :> SwaggerSchemaUI "swagger-ui" "swagger.json"
+
+swaggerDoc :: Swagger
+swaggerDoc =
+  toSwagger (Proxy @API)
+    & info . title .~ "Wire-Server API as Swagger 2.0 (internal end-points; incomplete) "

libs/brig-types/src/Brig/Types/User/EJPD.hs renamed to libs/wire-api/src/Wire/API/Routes/Internal/Brig/EJPD.hs

@@ -18,7 +18,7 @@
 -- | Identify users for law enforcement.  (Wire has legal requirements to cooperate with the
 -- authorities.  The wire backend operations team uses this to answer identification requests
 -- manually.)
-module Brig.Types.User.EJPD
+module Wire.API.Routes.Internal.Brig.EJPD
   ( EJPDRequestBody (EJPDRequestBody, ejpdRequestBody),
     EJPDResponseBody (EJPDResponseBody, ejpdResponseBody),
     EJPDResponseItem (EJPDResponseItem, ejpdResponseHandle, ejpdResponsePushTokens, ejpdResponseContacts),

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

@@ -45,6 +45,7 @@ module Wire.API.Team.Feature
   )
 where
 
+import qualified Cassandra.CQL as Cass
 import Control.Lens.Combinators (dimap)
 import qualified Data.Aeson as Aeson
 import qualified Data.Attoparsec.ByteString as Parser
@@ -254,6 +255,18 @@ instance FromByteString TeamFeatureStatusValue where
         Right t -> fail $ "Invalid TeamFeatureStatusValue: " <> T.unpack t
         Left e -> fail $ "Invalid TeamFeatureStatusValue: " <> show e
 
+instance Cass.Cql TeamFeatureStatusValue where
+  ctype = Cass.Tagged Cass.IntColumn
+
+  fromCql (Cass.CqlInt n) = case n of
+    0 -> pure $ TeamFeatureDisabled
+    1 -> pure $ TeamFeatureEnabled
+    _ -> Left "fromCql: Invalid TeamFeatureStatusValue"
+  fromCql _ = Left "fromCql: TeamFeatureStatusValue: CqlInt expected"
+
+  toCql TeamFeatureDisabled = Cass.CqlInt 0
+  toCql TeamFeatureEnabled = Cass.CqlInt 1
+
 ----------------------------------------------------------------------
 -- TeamFeatureStatus
 

libs/wire-api/wire-api.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: ec0f1e0e3e31d5771b93db6b6ee37ad444f98c3213696e98bbedbb4b1bb56c8c
+-- hash: 9d49a92f6ad563b050a6e3e6ae7f68b8abda7fa71e1986573cd81edf97d7b508
 
 name:           wire-api
 version:        0.1.0
@@ -49,6 +49,8 @@ library
       Wire.API.Provider.Service.Tag
       Wire.API.Push.Token
       Wire.API.Push.V2.Token
+      Wire.API.Routes.Internal.Brig
+      Wire.API.Routes.Internal.Brig.EJPD
       Wire.API.Routes.MultiTablePaging
       Wire.API.Routes.MultiTablePaging.State
       Wire.API.Routes.MultiVerb
@@ -152,6 +154,7 @@ library
     , servant-multipart
     , servant-server
     , servant-swagger
+    , servant-swagger-ui
     , singletons
     , sop-core
     , string-conversions
@@ -450,6 +453,7 @@ test-suite wire-api-tests
     , pem
     , pretty
     , proto-lens
+    , servant-swagger-ui
     , string-conversions
     , swagger2
     , tasty