const {agentProvider, mockManager, fixtureManager, matchers} = require('../../utils/e2e-framework'); const {anyEtag, anyObjectId, anyUuid, anyISODateTime, anyISODate, anyString, anyArray, anyLocationFor, anyErrorId} = matchers; const assert = require('assert'); const nock = require('nock'); const should = require('should'); const sinon = require('sinon'); const testUtils = require('../../utils'); const Papa = require('papaparse'); const models = require('../../../core/server/models'); async function assertEvents({eventType, eventName, quantity, asserts}) { const events = await models[eventType].findAll(); assert.equal(events.models.length, quantity, `Only one ${eventType} should have been added after ${eventName}.`); const event = events.models[events.models.length - 1].toJSON(); for (const attribute of Object.keys(assert)) { const value = asserts[attribute]; assert.equal(event[attribute], value, `The ${attribute} attribute of ${eventType} should have been ${value}`); } } const memberMatcherNoIncludes = { id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime }; const memberMatcherShallowIncludes = { id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, subscriptions: anyArray, labels: anyArray }; let agent; describe('Members API without Stripe', function () { before(async function () { agent = await agentProvider.getAdminAPIAgent(); await fixtureManager.init(); await agent.loginAsOwner(); }); before(async function () { await agent .delete('/settings/stripe/connect/') .expectStatus(200); }); beforeEach(function () { mockManager.mockLabsEnabled('membersLastSeenFilter'); mockManager.mockMail(); }); afterEach(function () { mockManager.restore(); }); it('Add should fail when comped flag is passed in but Stripe is not enabled', async function () { const newMember = { email: 'memberTestAdd@test.com', comped: true }; await agent .post(`members/`) .body({members: [newMember]}) .expectStatus(422) .matchHeaderSnapshot({ etag: anyEtag }) .matchBodySnapshot({ errors: [{ id: anyErrorId }] }); }); }); describe('Members API', function () { before(async function () { agent = await agentProvider.getAdminAPIAgent(); await fixtureManager.init('members'); await agent.loginAsOwner(); }); beforeEach(function () { mockManager.mockLabsEnabled('multipleProducts'); mockManager.mockLabsEnabled('membersLastSeenFilter'); mockManager.mockStripe(); mockManager.mockMail(); }); afterEach(function () { mockManager.restore(); }); // List Members it('Can browse', async function () { await agent .get('/members/') .expectStatus(200) .matchBodySnapshot({ members: new Array(8).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Can browse with filter', async function () { await agent .get('/members/?filter=label:label-1') .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Can browse with search', async function () { await agent .get('/members/?search=member1') .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Can filter by paid status', async function () { await agent .get('/members/?filter=status:paid') .expectStatus(200) .matchBodySnapshot({ members: new Array(5).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Can order by email_open_rate', async function () { await agent .get('members/?order=email_open_rate%20desc') .expectStatus(200) .matchHeaderSnapshot({ etag: anyEtag, 'content-length': anyString }) .matchBodySnapshot({ members: new Array(8).fill(memberMatcherShallowIncludes) }) .expect(({body}) => { const {members} = body; assert.equal(members[0].email_open_rate > members[1].email_open_rate, true, 'Expected the first member to have a greater open rate than the second.'); }); await agent .get('members/?order=email_open_rate%20asc') .expectStatus(200) .matchHeaderSnapshot({ etag: anyEtag, 'content-length': anyString }) .matchBodySnapshot({ members: new Array(8).fill(memberMatcherShallowIncludes) }) .expect(({body}) => { const {members} = body; assert.equal(members[0].email_open_rate < members[1].email_open_rate, true, 'Expected the first member to have a smaller open rate than the second.'); }); }); it('Search by case-insensitive name egg receives member with name Mr Egg', async function () { await agent .get('members/?search=egg') .expectStatus(200) .matchBodySnapshot({ members: [memberMatcherShallowIncludes] }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Search by case-insensitive email MEMBER2 receives member with email member2@test.com', async function () { await agent .get('members/?search=MEMBER2') .expectStatus(200) .matchBodySnapshot({ members: [memberMatcherShallowIncludes] }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Search for paid members retrieves member with email paid@test.com', async function () { await agent .get('members/?search=egon&paid=true') .expectStatus(200) .matchBodySnapshot({ members: [memberMatcherShallowIncludes] }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Search for non existing member returns empty result set', async function () { await agent .get('members/?search=do_not_exist') .expectStatus(200) .matchHeaderSnapshot({ etag: anyEtag }) .matchBodySnapshot({ members: [] }); }); // Read a member it('Can read', async function () { await agent .get(`/members/${testUtils.DataGenerator.Content.members[0].id}/`) .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Can read and include email_recipients', async function () { await agent .get(`/members/${testUtils.DataGenerator.Content.members[0].id}/?include=email_recipients`) .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); // Create a member it('Can add', async function () { const member = { name: 'test', email: 'memberTestAdd@test.com', note: 'test note', subscribed: false, labels: ['test-label'] }; await agent .post(`/members/`) .body({members: [member]}) .expectStatus(201) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag, location: anyLocationFor('members') }); await agent .post(`/members/`) .body({members: [member]}) .expectStatus(422); await assertEvents({ eventName: 'creating a subscription', eventType: 'MemberStatusEvent', quantity: 1, asserts: {from_status: null, to_status: 'free'} }); }); it('Can add and send a signup confirmation email', async function () { const member = { name: 'Send Me Confirmation', email: 'member_getting_confirmation@test.com', subscribed: true }; const queryParams = { send_email: true, email_type: 'signup' }; const {body} = await agent .post('/members/?send_email=true&email_type=signup') .body({members: [member]}) .expectStatus(201) .matchBodySnapshot({ members: [memberMatcherNoIncludes] }) .matchHeaderSnapshot({ etag: anyEtag, location: anyString }); mockManager.assert.sentEmail({ subject: '🙌 Complete your sign up to Ghost!', to: 'member_getting_confirmation@test.com' }); await assertEvents({ eventName: 'creating a subscription', eventType: 'MemberStatusEvent', quantity: 2, asserts: { from_status: null, to_status: 'free' } }); await assertEvents({ eventName: 'creating a subscription', eventType: 'MemberSubscribeEvent', quantity: 1, asserts: { subscribed: true, source: 'admin' } }); // @TODO: do we really need to delete this member here? await agent .delete(`members/${body.members[0].id}/`) .matchHeaderSnapshot({ etag: anyEtag }) .expectStatus(204); const events = await models.MemberSubscribeEvent.findAll(); assert.equal(events.models.length, 0, 'There should be no MemberSubscribeEvent remaining.'); }); it('Add should fail when passing incorrect email_type query parameter', async function () { const newMember = { name: 'test', email: 'memberTestAdd@test.com' }; await agent .post(`members/?send_email=true&email_type=lel`) .body({members: [newMember]}) .expectStatus(422) .matchHeaderSnapshot({ etag: anyEtag }) .matchBodySnapshot({ errors: [{ id: anyErrorId }] }); const statusEvents = await models.MemberStatusEvent.findAll(); assert.equal(statusEvents.models.length, 1, 'No MemberStatusEvent should have been added after failing to create a subscription.'); }); // Edit a member it('Can add complimentary subscription', async function () { const stripeService = require('../../../core/server/services/stripe'); const fakePrice = { id: 'price_1', product: '', active: true, nickname: 'Complimentary', unit_amount: 0, currency: 'USD', type: 'recurring', recurring: { interval: 'year' } }; const fakeSubscription = { id: 'sub_1', customer: 'cus_1', status: 'active', cancel_at_period_end: false, metadata: {}, current_period_end: Date.now() / 1000, start_date: Date.now() / 1000, plan: fakePrice, items: { data: [{ price: fakePrice }] } }; sinon.stub(stripeService.api, 'createCustomer').callsFake(async function (data) { return { id: 'cus_1', email: data.email }; }); sinon.stub(stripeService.api, 'createPrice').resolves(fakePrice); sinon.stub(stripeService.api, 'createSubscription').resolves(fakeSubscription); sinon.stub(stripeService.api, 'getSubscription').resolves(fakeSubscription); const initialMember = { name: 'Name', email: 'compedtest@test.com', subscribed: true }; const compedPayload = { comped: true }; const {body} = await agent .post(`/members/`) .body({members: [initialMember]}) .expectStatus(201) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag, location: anyLocationFor('members') }); const newMember = body.members[0]; const {body: body2} = await agent .put(`/members/${newMember.id}/`) .body({members: [compedPayload]}) .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); await assertEvents({ eventName: 'creating a subscription', eventType: 'MemberStatusEvent', quantity: 2, asserts: { from_status: null, to_status: 'free' } }); await assertEvents({ eventName: 'creating a subscription', eventType: 'MemberSubscribeEvent', quantity: 1, asserts: { subscribed: true, source: 'admin' } }); }); it('Can edit by id', async function () { const memberToChange = { name: 'change me', email: 'member2Change@test.com', note: 'initial note', subscribed: true }; const memberChanged = { name: 'changed', email: 'cantChangeMe@test.com', note: 'edited note', subscribed: false }; const {body} = await agent .post(`/members/`) .body({members: [memberToChange]}) .expectStatus(201) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag, location: anyLocationFor('members') }); await assertEvents({ eventName: 'creating a subscription', eventType: 'MemberSubscribeEvent', quantity: 2, asserts: { subscribed: true, source: 'admin' } }); await assertEvents({ eventName: 'updating a memer', eventType: 'MemberStatusEvent', quantity: 3, asserts: { from_status: null, to_status: 'free' } }); const newMember = body.members[0]; await agent .put(`/members/${newMember.id}/`) .body({members: [memberChanged]}) .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag }); await assertEvents({ eventName: 'updating a member email', eventType: 'MemberEmailChangeEvent', quantity: 1, asserts: { from_email: memberToChange.email, to_email: memberChanged.email } }); await assertEvents({ eventName: 'removing a subscription', eventType: 'MemberSubscribeEvent', quantity: 3, asserts: { subscribed: false, source: 'admin' } }); }); it('Can add a subscription', async function () { const memberId = testUtils.DataGenerator.Content.members[0].id; const price = testUtils.DataGenerator.Content.stripe_prices[0]; function nockCallback(method, uri, body) { const [match, resource, id] = uri.match(/\/?v1\/(\w+)(?:\/(\w+))?/) || [null]; if (!match) { return [500]; } if (resource === 'customers') { return [200, {id: 'cus_123', email: 'member1@test.com'}]; } if (resource === 'subscriptions') { const now = Math.floor(Date.now() / 1000); return [200, {id: 'sub_123', customer: 'cus_123', cancel_at_period_end: false, items: { data: [{price: { id: price.stripe_price_id, recurring: { interval: price.interval }, unit_amount: price.amount, currency: price.currency.toLowerCase() }}] }, status: 'active', current_period_end: now + 24 * 3600, start_date: now}]; } } nock('https://api.stripe.com:443') .persist() .post(/v1\/.*/) .reply((uri, body) => nockCallback('POST', uri, body)); nock('https://api.stripe.com:443') .persist() .get(/v1\/.*/) .reply((uri, body) => nockCallback('GET', uri, body)); await agent .post(`/members/${memberId}/subscriptions/`) .body({ stripe_price_id: price.id }) .expectStatus(200) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: [{ start_date: anyString, current_period_end: anyString, price: { price_id: anyObjectId, product: { product_id: anyObjectId } } }] }) }) .matchHeaderSnapshot({ etag: anyEtag }); }); // Delete a member it('Can destroy', async function () { const member = { name: 'test', email: 'memberTestDestroy@test.com' }; const {body} = await agent .post(`/members/`) .body({members: [member]}) .expectStatus(201) .matchBodySnapshot({ members: new Array(1).fill({ id: anyObjectId, uuid: anyUuid, created_at: anyISODateTime, updated_at: anyISODateTime, labels: anyArray, subscriptions: anyArray }) }) .matchHeaderSnapshot({ etag: anyEtag, location: anyLocationFor('members') }); const newMember = body.members[0]; await agent .delete(`/members/${newMember.id}`) .expectStatus(204) .matchBodySnapshot() .matchHeaderSnapshot({ etag: anyEtag }); await agent .get(`/members/${newMember.id}/`) .expectStatus(404) .matchBodySnapshot({ errors: [{ id: anyUuid }] }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Can delete a member without cancelling Stripe Subscription', async function () { let subscriptionCanceled = false; nock('https://api.stripe.com') .persist() .delete(/v1\/.*/) .reply((uri) => { const [match, resource, id] = uri.match(/\/?v1\/(\w+)(?:\/(\w+))/) || [null]; if (match && resource === 'subscriptions') { subscriptionCanceled = true; return [200, { id, status: 'canceled' }]; } return [500]; }); // TODO This is wrong because it changes the state for teh rest of the tests // We need to add a member via a fixture and then remove them OR work out how // to reapply fixtures before each test const memberToDelete = fixtureManager.get('members', 2); await agent .delete(`members/${memberToDelete.id}/`) .expectStatus(204) .matchHeaderSnapshot({ etag: anyEtag }) .matchBodySnapshot(); assert.equal(subscriptionCanceled, false, 'expected subscription not to be canceled'); }); // Export members to CSV it('Can export CSV', async function () { const res = await agent .get(`/members/upload/`) .expectStatus(200) .matchBodySnapshot() .matchHeaderSnapshot({ etag: anyEtag, 'content-length': anyString, //For some reason the content-length changes between 1220 and 1317 'content-disposition': anyString }); res.text.should.match(/id,email,name,note,subscribed_to_emails,complimentary_plan,stripe_customer_id,created_at,deleted_at/); const csv = Papa.parse(res.text, {header: true}); should.exist(csv.data.find(row => row.name === 'Mr Egg')); should.exist(csv.data.find(row => row.name === 'Winston Zeddemore')); should.exist(csv.data.find(row => row.name === 'Ray Stantz')); should.exist(csv.data.find(row => row.email === 'member2@test.com')); }); it('Can export a filtered CSV', async function () { const res = await agent .get(`/members/upload/?search=Egg`) .expectStatus(200) .matchBodySnapshot() .matchHeaderSnapshot({ etag: anyEtag, 'content-disposition': anyString }); res.text.should.match(/id,email,name,note,subscribed_to_emails,complimentary_plan,stripe_customer_id,created_at,deleted_at/); const csv = Papa.parse(res.text, {header: true}); should.exist(csv.data.find(row => row.name === 'Mr Egg')); should.not.exist(csv.data.find(row => row.name === 'Egon Spengler')); should.not.exist(csv.data.find(row => row.name === 'Ray Stantz')); should.not.exist(csv.data.find(row => row.email === 'member2@test.com')); }); // Get stats it('Can fetch member counts stats', async function () { await agent .get(`/members/stats/count/`) .expectStatus(200) .matchBodySnapshot({ data: [{ date: anyISODate }] }) .matchHeaderSnapshot({ etag: anyEtag }); }); it('Errors when fetching stats with unknown days param value', async function () { await agent .get('members/stats/?days=nope') .expectStatus(422) .matchHeaderSnapshot({ etag: anyEtag }) .matchBodySnapshot({ errors: [{ id: anyErrorId }] }); }); });