messaging-api-line/src/__tests__/LineClient-narrowcast.spec.ts

Messaging API client for LINE

import MockAdapter from 'axios-mock-adapter';

import LineClient from '../LineClient';
import * as Types from '../LineTypes';

const ACCESS_TOKEN = '1234567890';
const CHANNEL_SECRET = 'so-secret';

const createMock = (): {
  client: LineClient;
  mock: MockAdapter;
  headers: {
    Accept: string;
    'Content-Type': string;
    Authorization: string;
  };
} => {
  const client = new LineClient({
    accessToken: ACCESS_TOKEN,
    channelSecret: CHANNEL_SECRET,
  });
  const mock = new MockAdapter(client.axios);
  const headers = {
    Accept: 'application/json, text/plain, */*',
    'Content-Type': 'application/json',
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  };
  return { client, mock, headers };
};

describe('Narrowcast', () => {
  const messages: Types.Message[] = [
    {
      type: 'text',
      text: 'test message',
    },
  ];

  const recipient: Types.RecipientObject = {
    type: 'operator',
    and: [
      {
        type: 'audience',
        audienceGroupId: 5614991017776,
      },
      {
        type: 'operator',
        not: {
          type: 'audience',
          audienceGroupId: 4389303728991,
        },
      },
    ],
  };

  const demographic: Types.DemographicFilterObject = {
    type: 'operator' as const,
    or: [
      {
        type: 'operator' as const,
        and: [
          {
            type: 'gender',
            oneOf: ['male', 'female'],
          },
          {
            type: 'age',
            gte: 'age_20',
            lt: 'age_25',
          },
          {
            type: 'appType',
            oneOf: ['android', 'ios'],
          },
          {
            type: 'area',
            oneOf: ['jp_23', 'jp_05'],
          },
          {
            type: 'subscriptionPeriod',
            gte: 'day_7',
            lt: 'day_30',
          },
        ],
      },
      {
        type: 'operator' as const,
        and: [
          {
            type: 'age',
            gte: 'age_35',
            lt: 'age_40',
          },
          {
            type: 'operator' as const,
            not: {
              type: 'gender',
              oneOf: ['male'],
            },
          },
        ],
      },
    ],
  };

  const rawBody = {
    messages,
    recipient,
    filter: {
      demographic,
    },
    limit: {
      max: 100,
    },
  };

  describe('#narrowcastRawBody', () => {
    const reply = { requestId: 'abc' };

    it('should call narrowcast api', async () => {
      expect.assertions(4);

      const { client, mock, headers } = createMock();

      mock.onPost().reply((config) => {
        expect(config.url).toEqual('/v2/bot/message/narrowcast');
        expect(JSON.parse(config.data)).toEqual(rawBody);
        expect(config.headers).toEqual(headers);
        return [200, reply, { 'x-line-request-id': 'abc' }];
      });

      const res = await client.narrowcastRawBody(rawBody);

      expect(res).toEqual(reply);
    });
  });

  describe('#narrowcast', () => {
    const reply = { requestId: 'abc' };

    it('should call narrowcast api', async () => {
      expect.assertions(4);

      const { client, mock, headers } = createMock();

      mock.onPost().reply((config) => {
        expect(config.url).toEqual('/v2/bot/message/narrowcast');
        expect(JSON.parse(config.data)).toEqual(rawBody);
        expect(config.headers).toEqual(headers);
        return [200, reply, { 'x-line-request-id': 'abc' }];
      });

      const res = await client.narrowcast(messages, {
        recipient,
        demographic,
        max: 100,
      });

      expect(res).toEqual(reply);
    });
  });

  describe('#narrowcastMessages', () => {
    const reply = { requestId: 'abc' };

    it('should call narrowcast api', async () => {
      expect.assertions(4);

      const { client, mock, headers } = createMock();

      mock.onPost().reply((config) => {
        expect(config.url).toEqual('/v2/bot/message/narrowcast');
        expect(JSON.parse(config.data)).toEqual(rawBody);
        expect(config.headers).toEqual(headers);
        return [200, reply, { 'x-line-request-id': 'abc' }];
      });

      const res = await client.narrowcastMessages(messages, {
        recipient,
        demographic,
        max: 100,
      });

      expect(res).toEqual(reply);
    });
  });

  describe('#getNarrowcastProgress', () => {
    const requestId = '123';
    const reply = {
      phase: 'succeeded',
      successCount: 1,
      failureCount: 1,
      targetCount: 2,
    };

    it('should call getNarrowcastProgress api', async () => {
      expect.assertions(3);

      const { client, mock, headers } = createMock();

      mock.onGet().reply((config) => {
        expect(config.url).toEqual(
          `/v2/bot/message/progress/narrowcast?requestId=${requestId}`
        );
        expect(config.headers).toEqual(headers);
        return [200, reply];
      });

      const res = await client.getNarrowcastProgress(requestId);

      expect(res).toEqual(reply);
    });
  });
});