feat: add update-subscription writer

Author: wa0x6e

src/writer/index.ts

@@ -12,6 +12,7 @@ import * as subscribe from './subscribe';
 import * as unfollow from './unfollow';
 import * as unsubscribe from './unsubscribe';
 import * as updateProposal from './update-proposal';
+import * as updateSubscription from './update-subscription';
 import * as vote from './vote';
 
 export default {
@@ -26,6 +27,7 @@ export default {
   unfollow,
   subscribe,
   unsubscribe,
+  'update-subscription': updateSubscription,
   'delete-subscription': deleteSubscription,
   alias,
   profile,

src/writer/update-subscription.ts

@@ -0,0 +1,54 @@
+import { envelopDB } from '../helpers/mysql';
+import { jsonParse } from '../helpers/utils';
+
+type Message = { msg: string; address: string };
+type Payload = {
+  type: string;
+  value: string;
+  metadata: { subscriptions: string[] };
+};
+
+const VALID_SUBSCRIPTIONS = ['summary', 'newProposal', 'closedProposal'];
+
+function extractPayload(message: Message): Payload {
+  const payload = jsonParse(message.msg).payload;
+
+  return {
+    ...payload,
+    metadata: jsonParse(payload.metadata)
+  };
+}
+
+export async function verify(message: Message): Promise<any> {
+  const result = await envelopDB.queryAsync(`SELECT * FROM subscribers WHERE address = ? LIMIT 1`, [
+    message.address
+  ]);
+
+  if (!result[0]) {
+    return Promise.reject('user not subscribed');
+  }
+
+  if (!result[0].verified) {
+    return Promise.reject('email not verified');
+  }
+
+  const {
+    metadata: { subscriptions }
+  } = extractPayload(message);
+  if ((subscriptions || []).some(s => !VALID_SUBSCRIPTIONS.includes(s))) {
+    return Promise.reject('invalid subscription value');
+  }
+
+  return result[0];
+}
+
+export async function action(message: Message): Promise<void> {
+  const {
+    metadata: { subscriptions }
+  } = extractPayload(message);
+
+  await envelopDB.queryAsync(
+    `UPDATE subscribers SET subscriptions = ? WHERE address = ? AND verified > 0 LIMIT 1`,
+    [JSON.stringify(subscriptions), message.address]
+  );
+}

test/integration/writer/update-subscription.test.ts

@@ -0,0 +1,81 @@
+import db, { envelopDB, sequencerDB } from '../../../src/helpers/mysql';
+import { action, verify } from '../../../src/writer/update-subscription';
+
+describe('writer/update-subscription', () => {
+  const TEST_PREFIX = 'test-update-subscription';
+
+  afterAll(async () => {
+    await envelopDB.queryAsync('DELETE FROM subscribers');
+    await envelopDB.endAsync();
+    await db.endAsync();
+    await sequencerDB.endAsync();
+  });
+
+  describe('verify()', () => {
+    const msg = JSON.stringify({ payload: { subscriptions: ['closedProposal'] } });
+    const msgWithInvalidSubscriptions = JSON.stringify({
+      payload: { subscriptions: ['test'] }
+    });
+
+    beforeAll(async () => {
+      await Promise.all([
+        envelopDB.queryAsync(
+          'INSERT INTO subscribers SET address = ?, email = ?, subscriptions = ?, created = ?, verified = ?',
+          [`${TEST_PREFIX}-0x0`, '[email protected]', '[]', 0, 0]
+        ),
+        envelopDB.queryAsync(
+          'INSERT INTO subscribers SET address = ?, email = ?, subscriptions = ?, created = ?, verified = ?',
+          [`${TEST_PREFIX}-0x1`, '[email protected]', '[]', 0, 1]
+        )
+      ]);
+    });
+
+    it('rejects when the address is not subscribed', () => {
+      return expect(verify({ address: '0x0', msg })).rejects.toEqual(`user not subscribed`);
+    });
+
+    it('rejects when the address is not verified', () => {
+      return expect(verify({ address: `${TEST_PREFIX}-0x0`, msg })).rejects.toEqual(
+        `email not verified`
+      );
+    });
+
+    it('rejects when subscription values are not valid', () => {
+      return expect(
+        verify({ address: `${TEST_PREFIX}-0x1`, msg: msgWithInvalidSubscriptions })
+      ).rejects.toEqual(`invalid subscription value`);
+    });
+
+    it('resolves when all args are valid', () => {
+      return expect(verify({ address: `${TEST_PREFIX}-0x1`, msg })).resolves.toHaveProperty(
+        'address'
+      );
+    });
+  });
+
+  describe('action()', () => {
+    const address = `${TEST_PREFIX}-0x3`;
+    const subscriptions = ['newProposal', 'closedProposal'];
+
+    beforeAll(async () => {
+      await envelopDB.queryAsync(
+        'INSERT INTO subscribers SET address = ?, email = ?, subscriptions = ?, created = ?, verified = ?',
+        [address, '[email protected]', '["summary"]', 0, 1]
+      );
+    });
+
+    it('updates the subscription', async () => {
+      await action({
+        address: address,
+        msg: JSON.stringify({ payload: { subscriptions } })
+      });
+
+      const result = await envelopDB.queryAsync(
+        `SELECT subscriptions FROM subscribers WHERE address = ? LIMIT 1`,
+        [address]
+      );
+
+      expect(JSON.parse(result[0].subscriptions)).toEqual(subscriptions);
+    });
+  });
+});