feat: add subscription writer

Author: wa0x6e

src/writer/index.ts

@@ -9,6 +9,7 @@ import * as proposal from './proposal';
 import * as settings from './settings';
 import * as statement from './statement';
 import * as subscribe from './subscribe';
+import * as subscription from './subscription';
 import * as unfollow from './unfollow';
 import * as unsubscribe from './unsubscribe';
 import * as updateProposal from './update-proposal';
@@ -27,6 +28,7 @@ export default {
   unfollow,
   subscribe,
   unsubscribe,
+  subscription,
   'update-subscription': updateSubscription,
   'delete-subscription': deleteSubscription,
   alias,

src/writer/subscription.ts

@@ -0,0 +1,39 @@
+import { envelopDB } from '../helpers/mysql';
+import { jsonParse } from '../helpers/utils';
+
+type Message = { msg: string; address: string };
+
+const VALID_TYPES = ['email'];
+
+function extractPayload(message: Message) {
+  return jsonParse(message.msg).payload;
+}
+
+export async function verify(message: Message): Promise<any> {
+  const payload = extractPayload(message);
+
+  if (!VALID_TYPES.includes(payload.type)) {
+    return Promise.reject('invalid type');
+  }
+
+  const result = await envelopDB.queryAsync(
+    `SELECT * FROM subscribers WHERE address = ? AND email = ? LIMIT 1`,
+    [message.address, payload.value]
+  );
+
+  if (result[0]) {
+    return Promise.reject('user already subscribed');
+  }
+
+  return true;
+}
+
+export async function action(message: Message): Promise<void> {
+  const payload = extractPayload(message);
+
+  await envelopDB.queryAsync(`INSERT INTO subscribers (email, address, created) VALUES(?, ?, ?)`, [
+    payload.value,
+    message.address,
+    (Date.now() / 1e3).toFixed()
+  ]);
+}

test/integration/writer/subscription.test.ts

@@ -0,0 +1,59 @@
+import db, { envelopDB, sequencerDB } from '../../../src/helpers/mysql';
+import { action, verify } from '../../../src/writer/subscription';
+
+describe('writer/subscription', () => {
+  const TEST_PREFIX = 'test-subscription';
+  const msg = JSON.stringify({ payload: { value: '[email protected]', type: 'email' } });
+
+  afterAll(async () => {
+    await envelopDB.queryAsync('DELETE FROM subscribers');
+    await envelopDB.endAsync();
+    await db.endAsync();
+    await sequencerDB.endAsync();
+  });
+
+  describe('verify()', () => {
+    const address = `${TEST_PREFIX}-0x0`;
+    const invalidMsg = JSON.stringify({
+      payload: { type: 'hello', value: '[email protected]' }
+    });
+
+    beforeAll(async () => {
+      await envelopDB.queryAsync(
+        'INSERT INTO subscribers SET address = ?, email = ?, subscriptions = ?, created = ?, verified = ?',
+        [address, '[email protected]', '[]', 0, 0]
+      );
+    });
+
+    it('rejects when the address is already subscribed', () => {
+      return expect(verify({ address: address, msg })).rejects.toEqual(`user already subscribed`);
+    });
+
+    it('rejects when the subscription type is not valid', () => {
+      return expect(verify({ address: address, msg: invalidMsg })).rejects.toEqual('invalid type');
+    });
+
+    it('resolves when all args are valid', () => {
+      return expect(verify({ address: `${TEST_PREFIX}-0x1`, msg })).resolves.toBe(true);
+    });
+  });
+
+  describe('action()', () => {
+    const address = `${TEST_PREFIX}-0x1`;
+
+    it('creates a subscription', async () => {
+      await action({
+        address: address,
+        msg
+      });
+
+      const result = await envelopDB.queryAsync(
+        `SELECT * FROM subscribers WHERE address = ? LIMIT 1`,
+        [address]
+      );
+
+      expect(result[0].email).toEqual('[email protected]');
+      expect(result[0].verified).toEqual(0);
+    });
+  });
+});