@mediarithmics/plugins-nodejs-sdk/src/tests/AudienceFeedConnector.ts

This is the mediarithmics nodejs to help plugin developers bootstrapping their plugin without having to deal with most of the plugin boilerplate

import { expect } from "chai";
import "mocha";
import { core } from "../";
import * as request from "supertest";
import * as sinon from "sinon";
import * as mockery from "mockery";
import * as rp from "request-promise-native";

class MyFakeAudienceFeedConnector extends core.AudienceFeedConnectorBasePlugin {
  protected onExternalSegmentCreation(
    request: core.ExternalSegmentCreationRequest,
    instanceContext: core.AudienceFeedConnectorBaseInstanceContext
  ): Promise<core.ExternalSegmentCreationPluginResponse> {
    const response: core.ExternalSegmentCreationPluginResponse = {
      status: "ok"
    };
    return Promise.resolve(response);
  }

  protected onExternalSegmentConnection(
    request: core.ExternalSegmentConnectionRequest,
    instanceContext: core.AudienceFeedConnectorBaseInstanceContext
  ): Promise<core.ExternalSegmentConnectionPluginResponse> {
    const response: core.ExternalSegmentConnectionPluginResponse = {
      status: "ok"
    };
    return Promise.resolve(response);
  }

  protected onUserSegmentUpdate(
    request: core.UserSegmentUpdateRequest,
    instanceContext: core.AudienceFeedConnectorBaseInstanceContext
  ): Promise<core.UserSegmentUpdatePluginResponse> {
    const response: core.UserSegmentUpdatePluginResponse = {
      status: "ok"
    };
    return Promise.resolve(response);
  }
}

const rpMockup: sinon.SinonStub = sinon.stub().returns(
  new Promise((resolve, reject) => {
    resolve("Yolo");
  })
);

describe("Fetch Audience Feed Gateway API", () => {
  // All the magic is here
  const plugin = new MyFakeAudienceFeedConnector();
  const runner = new core.TestingPluginRunner(plugin, rpMockup);

  it("Check that feed_id is passed correctly in fetchAudienceFeedProperties", function(
    done
  ) {
    const fakeId = "42000000";

    // We try a call to the Gateway
    (runner.plugin as MyFakeAudienceFeedConnector)
      .fetchAudienceFeedProperties(fakeId)
      .then(() => {
        expect(rpMockup.args[0][0].uri).to.be.eq(
          `${runner.plugin
            .outboundPlatformUrl}/v1/audience_segment_external_feeds/${fakeId}/properties`
        );
        done();
      });
  });

  it("Check that feed_id is passed correctly in fetchAudienceSegment", function(
    done
  ) {
    const fakeId = "42000000";

    // We try a call to the Gateway
    (runner.plugin as MyFakeAudienceFeedConnector)
      .fetchAudienceSegment(fakeId)
      .then(() => {
        expect(rpMockup.args[1][0].uri).to.be.eq(
          `${runner.plugin
            .outboundPlatformUrl}/v1/audience_segment_external_feeds/${fakeId}/audience_segment`
        );
        done();
      });
  });
});

describe("External Audience Feed API test", function() {
  // All the magic is here
  const plugin = new MyFakeAudienceFeedConnector();

  it("Check that the plugin is giving good results with a simple handler", function(
    done
  ) {
    const rpMockup: sinon.SinonStub = sinon.stub();

    const audienceFeed: core.ResponseData<core.AudienceFeed> = {
      status: "ok",
      data: {
        id: "74",
        plugin_id: "984",
        organisation_id: "95",
        group_id: "com.mediarithmics.audience-feed",
        artifact_id: "awesome-audience-feed",
        version_id: "1254"
      }
    };

    rpMockup
    .withArgs(
      sinon.match.has(
        "uri",
        sinon.match(function(value: string) {
          return (
            value.match(/\/v1\/audience_segment_external_feeds\/(.){1,10}/) !==
            null
          );
        })
      )
    )
    .returns(audienceFeed);

    const properties: core.ResponseListOfData<core.PluginProperty> = {
      status: "ok",
      count: 1,
      data: [
        {
          technical_name: "hello_world",
          value: {
            value: "Yay"
          },
          property_type: "STRING",
          origin: "PLUGIN",
          writable: true,
          deletable: false
        }
      ]
    };

    rpMockup
      .withArgs(
        sinon.match.has(
          "uri",
          sinon.match(function(value: string) {
            return (
              value.match(/\/v1\/audience_segment_external_feeds\/(.){1,10}\/properties/) !==
              null
            );
          })
        )
      )
      .returns(properties);

    const runner = new core.TestingPluginRunner(plugin, rpMockup);

    // We init the plugin
    request(runner.plugin.app)
      .post("/v1/init")
      .send({ authentication_token: "Manny", worker_id: "Calavera" })
      .end((err, res) => {
        expect(res.status).to.equal(200);
      });

    const externalSegmentCreation: core.ExternalSegmentCreationRequest = {
      feed_id: "42",
      datamart_id: "1023",
      segment_id: "451256"
    };

    const externalSegmentConnection: core.ExternalSegmentConnectionRequest = {
      feed_id: "42",
      datamart_id: "1023",
      segment_id: "451256"
    };

    const userSegmentUpdateRequest: core.UserSegmentUpdateRequest = {
      feed_id: "42",
      session_id: "43",
      datamart_id: "1023",
      segment_id: "451256",
      ts: 1254412,
      operation: "UPSERT",
      user_identifiers: [
        {
          type: "USER_POINT",
          user_point_id: "26340584-f777-404c-82c5-56220667464b"
        } as core.UserPointIdentifierInfo,
        {
          type: "USER_ACCOUNT",
          user_account_id: "914eb2aa50cef7f3a8705b6bb54e50bb",
          creation_ts: 1493118667529
        } as core.UserAccountIdentifierInfo,
        {
          type: "USER_EMAIL",
          hash: "e2749f6f4d8104ec385a75490b587c86",
          email: undefined,
          operator: undefined,
          creation_ts: 1493118667529,
          last_activity_ts: 1493127642622,
          providers: []
        } as core.UserEmailIdentifierInfo,
        {
          type: "USER_AGENT",
          vector_id: "vec:886742516",
          device: {
            form_factor: "PERSONAL_COMPUTER",
            os_family: "MAC_OS",
            browser_family: "CHROME",
            brand: undefined,
            model: undefined,
            os_version: undefined,
            carrier: undefined
          },
          creation_ts: 1493118667529,
          last_activity_ts: 1493126966889,
          providers: [],
          mappings: []
        } as core.UserAgentIdentifierInfo
      ]
    };

    request(runner.plugin.app)
      .post("/v1/external_segment_creation")
      .send(externalSegmentCreation)
      .end(function(err, res) {
        expect(res.status).to.equal(200);

        expect(JSON.parse(res.text).status).to.be.eq("ok");
      });

    request(runner.plugin.app)
      .post("/v1/external_segment_connection")
      .send(externalSegmentConnection)
      .end(function(err, res) {
        expect(res.status).to.equal(200);

        expect(JSON.parse(res.text).status).to.be.eq("ok");
      });

    request(runner.plugin.app)
      .post("/v1/user_segment_update")
      .send(userSegmentUpdateRequest)
      .end(function(err, res) {
        expect(res.status).to.equal(200);

        expect(JSON.parse(res.text).status).to.be.eq("ok");

        done();
      });
  });
});