Deprecate debug mode for APNS

* Debug mode was introduced for demo purposes before push notifications
services was integrated to the apps.
* This was a workaround for the fact that production was supposed to use
silent notifications but we needed a way to verify that notifications
are sent for development purposes.
* It showed a visible debug alert with a timestamp for specific topics only.
* iOS app is not going to use silent notifications in production because
they don't work as planned but instead override the alert message of the
apns payload

Change-Id: I337ed591be40703931ee151fa18229490893909c
Bug: T287897

Author: johngian

config.dev.yaml

@@ -82,9 +82,6 @@ services:
       # Apple Push Notification Service configuration
       apns:
         mock: true
-        # Topics for which user-visible notifications should be displayed
-        # debug_topics:
-        #   - org.wikimedia.Notifications-Utility
       # Queueing options. If defined, requests will be enqueued according to the specified options
       # rather than immediately sent.
       queueing:

config.test.yaml

@@ -82,9 +82,6 @@ services:
       # Apple Push Notification Service configuration
       apns:
         mock: true
-        # Topics for which user-visible notifications should be displayed
-        # debug_topics:
-        #   - org.wikimedia.Notifications-Utility
       # Queueing options. If defined, requests will be enqueued according to the specified options
       # rather than immediately sent.
       queueing:

src/outgoing/apns/apns.ts

@@ -129,11 +129,8 @@ export async function sendMessage(app: Application, message: MultiDeviceMessage)
     notification.payload = { data: { type: message.type } };
     notification.threadId = message.type;
     notification.topic = message.meta.topic;
-    const hasDebugTopics = app.conf.apns.debug_topics && app.conf.apns.debug_topics.length;
-    if (hasDebugTopics && app.conf.apns.debug_topics.includes(notification.topic)) {
-        notification.mutableContent = true;
-        notification.alert = `Message sent at ${transactionStart}`;
-    }
+    notification.alert = message.type;
+    notification.mutableContent = true;
     const response: Responses = await apn.send(notification, [...message.deviceTokens]);
     apn.shutdown();
     app.logger.log('debug/apns', `Successfully sent ${(response.sent.length)} messages; ` +

src/outgoing/apns/readme.md

@@ -73,23 +73,6 @@ This is targeting push notifications on Safari desktop. To send an APNS notifica
 * Visit `/?doc#/Push notifications/post_v1_message_apns` on `push-notifications` service and trigger
   an API request after replacing the token under `deviceTokens`.
 
-#### iOS demo app
-
-A demo iOS app is available at https://github.com/wikimedia/notifications-utility-ios. The app
-can be installed on a testing device either directly via XCode or using TestFlight. The app will
-display a token which can be used to send messages through the service.
-
-To have the demo app display user-visible notifications, update the service `apns` configuration to
-include the app identifier in the list of `debug_topics`:
-
-```
-apns:
-  debug_topics:
-    - org.wikimedia.Notifications-Utility
-```
-This will modify the message payload so that the demo app displays a notification rather than
-silently processing the message.
-
 ### Production
 
 The app is expecting the `.p8` token key named `apns.p8` to exist under

test/unit/outgoing/apns/apns.spec.ts

@@ -17,7 +17,7 @@ const apnsRewired = rewire('../../../../src/outgoing/apns/apns.ts');
 describe('unit:APNS', () => {
     const logger = new Logger();
     const app: any = {
-        conf: { apns: { mock: true, debug_topics: ['debug_client'] } },
+        conf: { apns: { mock: true } },
         logger
     };
     let sandbox;
@@ -73,40 +73,6 @@ describe('unit:APNS', () => {
         assert.deepEqual(spy.firstCall.args[0].headers, expectedHeaders);
     });
 
-    it('send APNS message with debug topic', async () => {
-        const meta = {
-            topic: 'debug_client'
-        };
-        const spy = sandbox.spy(MockClient.prototype, 'write');
-        await sendMessage(app, new MultiDeviceMessage(
-            new Set(['TOKEN']),
-            PushProvider.APNS,
-            MessageType.CheckEchoV1,
-            meta,
-            false
-        ));
-        sinon.assert.calledOnce(spy);
-        const body = JSON.parse(spy.firstCall.args[0].body);
-        assert.deepEqual(body.aps.alert.startsWith('Message sent at'), true);
-    });
-
-    it('send APNS message without debug topic', async () => {
-        const meta = {
-            topic: 'not_debug_client'
-        };
-        const spy = sandbox.spy(MockClient.prototype, 'write');
-        await sendMessage(app, new MultiDeviceMessage(
-            new Set(['TOKEN']),
-            PushProvider.APNS,
-            MessageType.CheckEchoV1,
-            meta,
-            false
-        ));
-        sinon.assert.calledOnce(spy);
-        const body = JSON.parse(spy.firstCall.args[0].body);
-        assert.deepEqual('alerts' in body, false);
-    });
-
     it('send APNS message with undefined topic', async () => {
         const meta = {};
         const spy = sandbox.spy(MockClient.prototype, 'write');