| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937 |
- /* tslint:disable:no-non-null-assertion */
- import { pick } from '@vendure/common/lib/pick';
- import { manualFulfillmentHandler } from '@vendure/core';
- import {
- createErrorResultGuard,
- createTestEnvironment,
- ErrorResultGuard,
- SimpleGraphQLClient,
- } from '@vendure/testing';
- import gql from 'graphql-tag';
- import path from 'path';
- import { initialData } from '../../../e2e-common/e2e-initial-data';
- import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';
- import {
- failsToSettlePaymentMethod,
- onTransitionSpy,
- singleStageRefundablePaymentMethod,
- twoStagePaymentMethod,
- } from './fixtures/test-payment-methods';
- import { FULFILLMENT_FRAGMENT } from './graphql/fragments';
- import {
- AddNoteToOrder,
- CanceledOrderFragment,
- CancelOrder,
- CreateFulfillment,
- DeleteOrderNote,
- ErrorCode,
- FulfillmentFragment,
- GetCustomerList,
- GetOrder,
- GetOrderFulfillmentItems,
- GetOrderFulfillments,
- GetOrderHistory,
- GetOrderList,
- GetOrderListFulfillments,
- GetOrderListWithQty,
- GetOrderWithPayments,
- GetProductWithVariants,
- GetStockMovement,
- GlobalFlag,
- HistoryEntryType,
- OrderLineInput,
- PaymentFragment,
- RefundFragment,
- RefundOrder,
- SettlePayment,
- SettleRefund,
- SortOrder,
- StockMovementType,
- TransitFulfillment,
- UpdateOrderNote,
- UpdateProductVariants,
- } from './graphql/generated-e2e-admin-types';
- import {
- AddItemToOrder,
- ApplyCouponCode,
- DeletionResult,
- GetActiveOrder,
- GetOrderByCodeWithPayments,
- TestOrderFragmentFragment,
- UpdatedOrder,
- UpdatedOrderFragment,
- } from './graphql/generated-e2e-shop-types';
- import {
- CANCEL_ORDER,
- CREATE_FULFILLMENT,
- GET_CUSTOMER_LIST,
- GET_ORDER,
- GET_ORDERS_LIST,
- GET_ORDER_FULFILLMENTS,
- GET_ORDER_HISTORY,
- GET_PRODUCT_WITH_VARIANTS,
- GET_STOCK_MOVEMENT,
- SETTLE_PAYMENT,
- TRANSIT_FULFILLMENT,
- UPDATE_PRODUCT_VARIANTS,
- } from './graphql/shared-definitions';
- import {
- ADD_ITEM_TO_ORDER,
- APPLY_COUPON_CODE,
- GET_ACTIVE_ORDER,
- GET_ORDER_BY_CODE_WITH_PAYMENTS,
- } from './graphql/shop-definitions';
- import { assertThrowsWithMessage } from './utils/assert-throws-with-message';
- import { addPaymentToOrder, proceedToArrangingPayment, sortById } from './utils/test-order-utils';
- describe('Orders resolver', () => {
- const { server, adminClient, shopClient } = createTestEnvironment({
- ...testConfig,
- paymentOptions: {
- paymentMethodHandlers: [
- twoStagePaymentMethod,
- failsToSettlePaymentMethod,
- singleStageRefundablePaymentMethod,
- ],
- },
- });
- let customers: GetCustomerList.Items[];
- const password = 'test';
- const orderGuard: ErrorResultGuard<
- TestOrderFragmentFragment | CanceledOrderFragment | UpdatedOrderFragment
- > = createErrorResultGuard(input => !!input.lines);
- const paymentGuard: ErrorResultGuard<PaymentFragment> = createErrorResultGuard(input => !!input.state);
- const fulfillmentGuard: ErrorResultGuard<FulfillmentFragment> = createErrorResultGuard(
- input => !!input.method,
- );
- const refundGuard: ErrorResultGuard<RefundFragment> = createErrorResultGuard(input => !!input.items);
- beforeAll(async () => {
- await server.init({
- initialData: {
- ...initialData,
- paymentMethods: [
- {
- name: twoStagePaymentMethod.code,
- handler: { code: twoStagePaymentMethod.code, arguments: [] },
- },
- {
- name: failsToSettlePaymentMethod.code,
- handler: { code: failsToSettlePaymentMethod.code, arguments: [] },
- },
- {
- name: singleStageRefundablePaymentMethod.code,
- handler: { code: singleStageRefundablePaymentMethod.code, arguments: [] },
- },
- ],
- },
- productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-full.csv'),
- customerCount: 3,
- });
- await adminClient.asSuperAdmin();
- // Create a couple of orders to be queried
- const result = await adminClient.query<GetCustomerList.Query, GetCustomerList.Variables>(
- GET_CUSTOMER_LIST,
- {
- options: {
- take: 3,
- },
- },
- );
- customers = result.customers.items;
- await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
- await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
- productVariantId: 'T_1',
- quantity: 1,
- });
- await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
- productVariantId: 'T_2',
- quantity: 1,
- });
- await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
- await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
- productVariantId: 'T_2',
- quantity: 1,
- });
- await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
- productVariantId: 'T_3',
- quantity: 3,
- });
- }, TEST_SETUP_TIMEOUT_MS);
- afterAll(async () => {
- await server.destroy();
- });
- it('order history initially contains Created -> AddingItems transition', async () => {
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- { id: 'T_1' },
- );
- expect(order!.history.totalItems).toBe(1);
- expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'Created',
- to: 'AddingItems',
- },
- },
- ]);
- });
- describe('querying', () => {
- it('orders', async () => {
- const result = await adminClient.query<GetOrderList.Query>(GET_ORDERS_LIST);
- expect(result.orders.items.map(o => o.id).sort()).toEqual(['T_1', 'T_2']);
- });
- it('order', async () => {
- const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: 'T_2',
- });
- expect(result.order!.id).toBe('T_2');
- });
- it('sort by total', async () => {
- const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
- GET_ORDERS_LIST,
- {
- options: {
- sort: {
- total: SortOrder.DESC,
- },
- },
- },
- );
- expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
- { id: 'T_2', total: 799600 },
- { id: 'T_1', total: 269800 },
- ]);
- });
- it('filter by totalWithTax', async () => {
- const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
- GET_ORDERS_LIST,
- {
- options: {
- filter: {
- totalWithTax: { gt: 323760 },
- },
- },
- },
- );
- expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
- { id: 'T_2', totalWithTax: 959520 },
- ]);
- });
- it('sort by totalQuantity', async () => {
- const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
- GET_ORDERS_LIST,
- {
- options: {
- sort: {
- totalQuantity: SortOrder.DESC,
- },
- },
- },
- );
- expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
- { id: 'T_2', totalQuantity: 4 },
- { id: 'T_1', totalQuantity: 2 },
- ]);
- });
- it('filter by totalQuantity', async () => {
- const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
- GET_ORDERS_LIST,
- {
- options: {
- filter: {
- totalQuantity: { eq: 4 },
- },
- },
- },
- );
- expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
- { id: 'T_2', totalQuantity: 4 },
- ]);
- });
- });
- describe('payments', () => {
- let firstOrderCode: string;
- let firstOrderId: string;
- it('settlePayment fails', async () => {
- await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
- await proceedToArrangingPayment(shopClient);
- const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
- orderGuard.assertSuccess(order);
- expect(order.state).toBe('PaymentAuthorized');
- const payment = order.payments![0];
- const { settlePayment } = await adminClient.query<
- SettlePayment.Mutation,
- SettlePayment.Variables
- >(SETTLE_PAYMENT, {
- id: payment.id,
- });
- paymentGuard.assertErrorResult(settlePayment);
- expect(settlePayment.message).toBe('Settling the payment failed');
- expect(settlePayment.errorCode).toBe(ErrorCode.SETTLE_PAYMENT_ERROR);
- expect((settlePayment as any).paymentErrorMessage).toBe('Something went horribly wrong');
- const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: order.id,
- });
- expect(result.order!.state).toBe('PaymentAuthorized');
- firstOrderCode = order.code;
- firstOrderId = order.id;
- });
- it('public payment metadata available in Shop API', async () => {
- const { orderByCode } = await shopClient.query<
- GetOrderByCodeWithPayments.Query,
- GetOrderByCodeWithPayments.Variables
- >(GET_ORDER_BY_CODE_WITH_PAYMENTS, { code: firstOrderCode });
- expect(orderByCode?.payments?.[0].metadata).toEqual({
- public: {
- publicCreatePaymentData: 'public',
- publicSettlePaymentData: 'public',
- },
- });
- });
- it('public and private payment metadata available in Admin API', async () => {
- const { order } = await adminClient.query<
- GetOrderWithPayments.Query,
- GetOrderWithPayments.Variables
- >(GET_ORDER_WITH_PAYMENTS, { id: firstOrderId });
- expect(order?.payments?.[0].metadata).toEqual({
- privateCreatePaymentData: 'secret',
- privateSettlePaymentData: 'secret',
- public: {
- publicCreatePaymentData: 'public',
- publicSettlePaymentData: 'public',
- },
- });
- });
- it('settlePayment succeeds, onStateTransitionStart called', async () => {
- onTransitionSpy.mockClear();
- await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
- await proceedToArrangingPayment(shopClient);
- const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
- orderGuard.assertSuccess(order);
- expect(order.state).toBe('PaymentAuthorized');
- expect(onTransitionSpy).toHaveBeenCalledTimes(1);
- expect(onTransitionSpy.mock.calls[0][0]).toBe('Created');
- expect(onTransitionSpy.mock.calls[0][1]).toBe('Authorized');
- const payment = order.payments![0];
- const { settlePayment } = await adminClient.query<
- SettlePayment.Mutation,
- SettlePayment.Variables
- >(SETTLE_PAYMENT, {
- id: payment.id,
- });
- paymentGuard.assertSuccess(settlePayment);
- expect(settlePayment!.id).toBe(payment.id);
- expect(settlePayment!.state).toBe('Settled');
- // further metadata is combined into existing object
- expect(settlePayment!.metadata).toEqual({
- moreData: 42,
- public: {
- baz: 'quux',
- },
- });
- expect(onTransitionSpy).toHaveBeenCalledTimes(2);
- expect(onTransitionSpy.mock.calls[1][0]).toBe('Authorized');
- expect(onTransitionSpy.mock.calls[1][1]).toBe('Settled');
- const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: order.id,
- });
- expect(result.order!.state).toBe('PaymentSettled');
- expect(result.order!.payments![0].state).toBe('Settled');
- });
- it('order history contains expected entries', async () => {
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- { id: 'T_2', options: { sort: { id: SortOrder.ASC } } },
- );
- expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'Created',
- to: 'AddingItems',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'AddingItems',
- to: 'ArrangingPayment',
- },
- },
- {
- type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
- data: {
- paymentId: 'T_2',
- from: 'Created',
- to: 'Authorized',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'ArrangingPayment',
- to: 'PaymentAuthorized',
- },
- },
- {
- type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
- data: {
- paymentId: 'T_2',
- from: 'Authorized',
- to: 'Settled',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'PaymentAuthorized',
- to: 'PaymentSettled',
- },
- },
- ]);
- });
- });
- describe('fulfillment', () => {
- const orderId = 'T_2';
- let f1Id: string;
- let f2Id: string;
- let f3Id: string;
- it('return error result if lines is empty', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order!.state).toBe('PaymentSettled');
- const { addFulfillmentToOrder } = await adminClient.query<
- CreateFulfillment.Mutation,
- CreateFulfillment.Variables
- >(CREATE_FULFILLMENT, {
- input: {
- lines: [],
- handler: {
- code: manualFulfillmentHandler.code,
- arguments: [{ name: 'method', value: 'Test' }],
- },
- },
- });
- fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
- expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
- expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
- });
- it('returns error result if all quantities are zero', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order!.state).toBe('PaymentSettled');
- const { addFulfillmentToOrder } = await adminClient.query<
- CreateFulfillment.Mutation,
- CreateFulfillment.Variables
- >(CREATE_FULFILLMENT, {
- input: {
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
- handler: {
- code: manualFulfillmentHandler.code,
- arguments: [{ name: 'method', value: 'Test' }],
- },
- },
- });
- fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
- expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
- expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
- });
- it('creates the first fulfillment', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order!.state).toBe('PaymentSettled');
- const lines = order!.lines;
- const { addFulfillmentToOrder } = await adminClient.query<
- CreateFulfillment.Mutation,
- CreateFulfillment.Variables
- >(CREATE_FULFILLMENT, {
- input: {
- lines: [{ orderLineId: lines[0].id, quantity: lines[0].quantity }],
- handler: {
- code: manualFulfillmentHandler.code,
- arguments: [
- { name: 'method', value: 'Test1' },
- { name: 'trackingCode', value: '111' },
- ],
- },
- },
- });
- fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
- expect(addFulfillmentToOrder.id).toBe('T_1');
- expect(addFulfillmentToOrder.method).toBe('Test1');
- expect(addFulfillmentToOrder.trackingCode).toBe('111');
- expect(addFulfillmentToOrder.state).toBe('Pending');
- expect(addFulfillmentToOrder.orderItems).toEqual([{ id: lines[0].items[0].id }]);
- f1Id = addFulfillmentToOrder.id;
- const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(result.order!.lines[0].items[0].fulfillment!.id).toBe(addFulfillmentToOrder!.id);
- expect(
- result.order!.lines[1].items.filter(
- i => i.fulfillment && i.fulfillment.id === addFulfillmentToOrder.id,
- ).length,
- ).toBe(0);
- expect(result.order!.lines[1].items.filter(i => i.fulfillment == null).length).toBe(3);
- });
- it('creates the second fulfillment', async () => {
- const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
- const { addFulfillmentToOrder } = await adminClient.query<
- CreateFulfillment.Mutation,
- CreateFulfillment.Variables
- >(CREATE_FULFILLMENT, {
- input: {
- lines,
- handler: {
- code: manualFulfillmentHandler.code,
- arguments: [
- { name: 'method', value: 'Test2' },
- { name: 'trackingCode', value: '222' },
- ],
- },
- },
- });
- fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
- expect(addFulfillmentToOrder.id).toBe('T_2');
- expect(addFulfillmentToOrder.method).toBe('Test2');
- expect(addFulfillmentToOrder.trackingCode).toBe('222');
- expect(addFulfillmentToOrder.state).toBe('Pending');
- f2Id = addFulfillmentToOrder.id;
- });
- it('cancels second fulfillment', async () => {
- const { transitionFulfillmentToState } = await adminClient.query<
- TransitFulfillment.Mutation,
- TransitFulfillment.Variables
- >(TRANSIT_FULFILLMENT, {
- id: f2Id,
- state: 'Cancelled',
- });
- fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
- expect(transitionFulfillmentToState.id).toBe('T_2');
- expect(transitionFulfillmentToState.state).toBe('Cancelled');
- });
- it('order.fulfillments still lists second (cancelled) fulfillment', async () => {
- const { order } = await adminClient.query<
- GetOrderFulfillments.Query,
- GetOrderFulfillments.Variables
- >(GET_ORDER_FULFILLMENTS, {
- id: orderId,
- });
- expect(order?.fulfillments?.map(pick(['id', 'state']))).toEqual([
- { id: f1Id, state: 'Pending' },
- { id: f2Id, state: 'Cancelled' },
- ]);
- });
- it('creates third fulfillment with same items from second fulfillment', async () => {
- const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
- const { addFulfillmentToOrder } = await adminClient.query<
- CreateFulfillment.Mutation,
- CreateFulfillment.Variables
- >(CREATE_FULFILLMENT, {
- input: {
- lines,
- handler: {
- code: manualFulfillmentHandler.code,
- arguments: [
- { name: 'method', value: 'Test3' },
- { name: 'trackingCode', value: '333' },
- ],
- },
- },
- });
- fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
- expect(addFulfillmentToOrder.id).toBe('T_3');
- expect(addFulfillmentToOrder.method).toBe('Test3');
- expect(addFulfillmentToOrder.trackingCode).toBe('333');
- expect(addFulfillmentToOrder.state).toBe('Pending');
- f3Id = addFulfillmentToOrder.id;
- });
- it('returns error result if an OrderItem already part of a Fulfillment', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { addFulfillmentToOrder } = await adminClient.query<
- CreateFulfillment.Mutation,
- CreateFulfillment.Variables
- >(CREATE_FULFILLMENT, {
- input: {
- lines: [
- {
- orderLineId: order!.lines[0].id,
- quantity: 1,
- },
- ],
- handler: {
- code: manualFulfillmentHandler.code,
- arguments: [{ name: 'method', value: 'Test' }],
- },
- },
- });
- fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
- expect(addFulfillmentToOrder.message).toBe(
- 'One or more OrderItems are already part of a Fulfillment',
- );
- expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.ITEMS_ALREADY_FULFILLED_ERROR);
- });
- it('transitions the first fulfillment from created to Shipped and automatically change the order state to PartiallyShipped', async () => {
- const { transitionFulfillmentToState } = await adminClient.query<
- TransitFulfillment.Mutation,
- TransitFulfillment.Variables
- >(TRANSIT_FULFILLMENT, {
- id: f1Id,
- state: 'Shipped',
- });
- fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
- expect(transitionFulfillmentToState.id).toBe(f1Id);
- expect(transitionFulfillmentToState.state).toBe('Shipped');
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order?.state).toBe('PartiallyShipped');
- });
- it('transitions the third fulfillment from created to Shipped and automatically change the order state to Shipped', async () => {
- const { transitionFulfillmentToState } = await adminClient.query<
- TransitFulfillment.Mutation,
- TransitFulfillment.Variables
- >(TRANSIT_FULFILLMENT, {
- id: f3Id,
- state: 'Shipped',
- });
- fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
- expect(transitionFulfillmentToState.id).toBe(f3Id);
- expect(transitionFulfillmentToState.state).toBe('Shipped');
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order?.state).toBe('Shipped');
- });
- it('transitions the first fulfillment from Shipped to Delivered and change the order state to PartiallyDelivered', async () => {
- const { transitionFulfillmentToState } = await adminClient.query<
- TransitFulfillment.Mutation,
- TransitFulfillment.Variables
- >(TRANSIT_FULFILLMENT, {
- id: f1Id,
- state: 'Delivered',
- });
- fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
- expect(transitionFulfillmentToState.id).toBe(f1Id);
- expect(transitionFulfillmentToState.state).toBe('Delivered');
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order?.state).toBe('PartiallyDelivered');
- });
- it('transitions the third fulfillment from Shipped to Delivered and change the order state to Delivered', async () => {
- const { transitionFulfillmentToState } = await adminClient.query<
- TransitFulfillment.Mutation,
- TransitFulfillment.Variables
- >(TRANSIT_FULFILLMENT, {
- id: f3Id,
- state: 'Delivered',
- });
- fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
- expect(transitionFulfillmentToState.id).toBe(f3Id);
- expect(transitionFulfillmentToState.state).toBe('Delivered');
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order?.state).toBe('Delivered');
- });
- it('order history contains expected entries', async () => {
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- {
- id: orderId,
- options: {
- skip: 6,
- },
- },
- );
- expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- data: {
- fulfillmentId: f1Id,
- },
- type: HistoryEntryType.ORDER_FULFILLMENT,
- },
- {
- data: {
- from: 'Created',
- fulfillmentId: f1Id,
- to: 'Pending',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- fulfillmentId: f2Id,
- },
- type: HistoryEntryType.ORDER_FULFILLMENT,
- },
- {
- data: {
- from: 'Created',
- fulfillmentId: f2Id,
- to: 'Pending',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- from: 'Pending',
- fulfillmentId: f2Id,
- to: 'Cancelled',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- fulfillmentId: f3Id,
- },
- type: HistoryEntryType.ORDER_FULFILLMENT,
- },
- {
- data: {
- from: 'Created',
- fulfillmentId: f3Id,
- to: 'Pending',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- from: 'Pending',
- fulfillmentId: f1Id,
- to: 'Shipped',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- from: 'PaymentSettled',
- to: 'PartiallyShipped',
- },
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- },
- {
- data: {
- from: 'Pending',
- fulfillmentId: f3Id,
- to: 'Shipped',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- from: 'PartiallyShipped',
- to: 'Shipped',
- },
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- },
- {
- data: {
- from: 'Shipped',
- fulfillmentId: f1Id,
- to: 'Delivered',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- from: 'Shipped',
- to: 'PartiallyDelivered',
- },
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- },
- {
- data: {
- from: 'Shipped',
- fulfillmentId: f3Id,
- to: 'Delivered',
- },
- type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
- },
- {
- data: {
- from: 'PartiallyDelivered',
- to: 'Delivered',
- },
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- },
- ]);
- });
- it('order.fulfillments resolver for single order', async () => {
- const { order } = await adminClient.query<
- GetOrderFulfillments.Query,
- GetOrderFulfillments.Variables
- >(GET_ORDER_FULFILLMENTS, {
- id: orderId,
- });
- expect(order!.fulfillments?.sort(sortById)).toEqual([
- { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
- { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
- { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
- ]);
- });
- it('order.fulfillments resolver for order list', async () => {
- const { orders } = await adminClient.query<GetOrderListFulfillments.Query>(
- GET_ORDER_LIST_FULFILLMENTS,
- );
- expect(orders.items[0].fulfillments).toEqual([]);
- expect(orders.items[1].fulfillments).toEqual([
- { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
- { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
- { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
- ]);
- });
- it('order.fulfillments.orderItems resolver', async () => {
- const { order } = await adminClient.query<
- GetOrderFulfillmentItems.Query,
- GetOrderFulfillmentItems.Variables
- >(GET_ORDER_FULFILLMENT_ITEMS, {
- id: orderId,
- });
- expect(order!.fulfillments![0].orderItems).toEqual([{ id: 'T_3' }]);
- expect(order!.fulfillments![1].orderItems).toEqual([{ id: 'T_4' }, { id: 'T_5' }, { id: 'T_6' }]);
- expect(order!.fulfillments![2].orderItems).toEqual([{ id: 'T_4' }, { id: 'T_5' }, { id: 'T_6' }]);
- });
- });
- describe('cancellation by orderId', () => {
- it('cancel from AddingItems state', async () => {
- const testOrder = await createTestOrder(
- adminClient,
- shopClient,
- customers[0].emailAddress,
- password,
- );
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: testOrder.orderId,
- });
- expect(order!.state).toBe('AddingItems');
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId: testOrder.orderId,
- },
- },
- );
- const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: testOrder.orderId,
- });
- expect(order2!.state).toBe('Cancelled');
- expect(order2!.active).toBe(false);
- await assertNoStockMovementsCreated(testOrder.product.id);
- });
- it('cancel from ArrangingPayment state', async () => {
- const testOrder = await createTestOrder(
- adminClient,
- shopClient,
- customers[0].emailAddress,
- password,
- );
- await proceedToArrangingPayment(shopClient);
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: testOrder.orderId,
- });
- expect(order!.state).toBe('ArrangingPayment');
- await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(CANCEL_ORDER, {
- input: {
- orderId: testOrder.orderId,
- },
- });
- const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: testOrder.orderId,
- });
- expect(order2!.state).toBe('Cancelled');
- expect(order2!.active).toBe(false);
- await assertNoStockMovementsCreated(testOrder.product.id);
- });
- it('cancel from PaymentAuthorized state', async () => {
- const testOrder = await createTestOrder(
- adminClient,
- shopClient,
- customers[0].emailAddress,
- password,
- );
- await proceedToArrangingPayment(shopClient);
- const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
- orderGuard.assertSuccess(order);
- expect(order.state).toBe('PaymentAuthorized');
- const result1 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
- GET_STOCK_MOVEMENT,
- {
- id: 'T_3',
- },
- );
- let variant1 = result1.product!.variants[0];
- expect(variant1.stockOnHand).toBe(100);
- expect(variant1.stockAllocated).toBe(2);
- expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
- { type: StockMovementType.ADJUSTMENT, quantity: 100 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- ]);
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId: testOrder.orderId,
- },
- },
- );
- orderGuard.assertSuccess(cancelOrder);
- expect(
- cancelOrder.lines.map(l =>
- l.items.map(pick(['id', 'cancelled'])).sort((a, b) => (a.id > b.id ? 1 : -1)),
- ),
- ).toEqual([
- [
- { id: 'T_11', cancelled: true },
- { id: 'T_12', cancelled: true },
- ],
- ]);
- const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: testOrder.orderId,
- });
- expect(order2!.active).toBe(false);
- expect(order2!.state).toBe('Cancelled');
- const result2 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
- GET_STOCK_MOVEMENT,
- {
- id: 'T_3',
- },
- );
- variant1 = result2.product!.variants[0];
- expect(variant1.stockOnHand).toBe(100);
- expect(variant1.stockAllocated).toBe(0);
- expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
- { type: StockMovementType.ADJUSTMENT, quantity: 100 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- ]);
- });
- async function assertNoStockMovementsCreated(productId: string) {
- const result = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
- GET_STOCK_MOVEMENT,
- {
- id: productId,
- },
- );
- const variant2 = result.product!.variants[0];
- expect(variant2.stockOnHand).toBe(100);
- expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
- { type: StockMovementType.ADJUSTMENT, quantity: 100 },
- ]);
- }
- });
- describe('cancellation by OrderLine', () => {
- let orderId: string;
- let product: GetProductWithVariants.Product;
- let productVariantId: string;
- beforeAll(async () => {
- const result = await createTestOrder(
- adminClient,
- shopClient,
- customers[0].emailAddress,
- password,
- );
- orderId = result.orderId;
- product = result.product;
- productVariantId = result.productVariantId;
- });
- it('cannot cancel from AddingItems state', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order!.state).toBe('AddingItems');
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId,
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
- },
- },
- );
- orderGuard.assertErrorResult(cancelOrder);
- expect(cancelOrder.message).toBe(
- 'Cannot cancel OrderLines from an Order in the "AddingItems" state',
- );
- expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
- });
- it('cannot cancel from ArrangingPayment state', async () => {
- await proceedToArrangingPayment(shopClient);
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order!.state).toBe('ArrangingPayment');
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId,
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
- },
- },
- );
- orderGuard.assertErrorResult(cancelOrder);
- expect(cancelOrder.message).toBe(
- 'Cannot cancel OrderLines from an Order in the "ArrangingPayment" state',
- );
- expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
- });
- it('returns error result if lines are empty', async () => {
- const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
- orderGuard.assertSuccess(order);
- expect(order.state).toBe('PaymentAuthorized');
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId,
- lines: [],
- },
- },
- );
- orderGuard.assertErrorResult(cancelOrder);
- expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
- expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
- });
- it('returns error result if all quantities zero', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId,
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
- },
- },
- );
- orderGuard.assertErrorResult(cancelOrder);
- expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
- expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
- });
- it('partial cancellation', async () => {
- const result1 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
- GET_STOCK_MOVEMENT,
- {
- id: product.id,
- },
- );
- const variant1 = result1.product!.variants[0];
- expect(variant1.stockOnHand).toBe(100);
- expect(variant1.stockAllocated).toBe(2);
- expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
- { type: StockMovementType.ADJUSTMENT, quantity: 100 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- ]);
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId,
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
- reason: 'cancel reason 1',
- },
- },
- );
- orderGuard.assertSuccess(cancelOrder);
- expect(cancelOrder.lines[0].quantity).toBe(1);
- expect(cancelOrder.lines[0].items.sort((a, b) => (a.id < b.id ? -1 : 1))).toEqual([
- { id: 'T_13', cancelled: true },
- { id: 'T_14', cancelled: false },
- ]);
- const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order2!.state).toBe('PaymentAuthorized');
- expect(order2!.lines[0].quantity).toBe(1);
- const result2 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
- GET_STOCK_MOVEMENT,
- {
- id: product.id,
- },
- );
- const variant2 = result2.product!.variants[0];
- expect(variant2.stockOnHand).toBe(100);
- expect(variant2.stockAllocated).toBe(1);
- expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
- { type: StockMovementType.ADJUSTMENT, quantity: 100 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- ]);
- });
- it('returns error result if attempting to cancel already cancelled item', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
- CANCEL_ORDER,
- {
- input: {
- orderId,
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 2 })),
- },
- },
- );
- orderGuard.assertErrorResult(cancelOrder);
- expect(cancelOrder.message).toBe(
- 'The specified quantity is greater than the available OrderItems',
- );
- expect(cancelOrder.errorCode).toBe(ErrorCode.QUANTITY_TOO_GREAT_ERROR);
- });
- it('complete cancellation', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(CANCEL_ORDER, {
- input: {
- orderId,
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
- reason: 'cancel reason 2',
- },
- });
- const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- expect(order2!.state).toBe('Cancelled');
- const result = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
- GET_STOCK_MOVEMENT,
- {
- id: product.id,
- },
- );
- const variant2 = result.product!.variants[0];
- expect(variant2.stockOnHand).toBe(100);
- expect(variant2.stockAllocated).toBe(0);
- expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
- { type: StockMovementType.ADJUSTMENT, quantity: 100 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.ALLOCATION, quantity: 2 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- { type: StockMovementType.RELEASE, quantity: 1 },
- ]);
- });
- it('order history contains expected entries', async () => {
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- {
- id: orderId,
- options: {
- skip: 0,
- },
- },
- );
- expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'Created',
- to: 'AddingItems',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'AddingItems',
- to: 'ArrangingPayment',
- },
- },
- {
- type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
- data: {
- paymentId: 'T_4',
- from: 'Created',
- to: 'Authorized',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'ArrangingPayment',
- to: 'PaymentAuthorized',
- },
- },
- {
- type: HistoryEntryType.ORDER_CANCELLATION,
- data: {
- orderItemIds: ['T_13'],
- reason: 'cancel reason 1',
- },
- },
- {
- type: HistoryEntryType.ORDER_CANCELLATION,
- data: {
- orderItemIds: ['T_14'],
- reason: 'cancel reason 2',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'PaymentAuthorized',
- to: 'Cancelled',
- },
- },
- ]);
- });
- });
- describe('refunds', () => {
- let orderId: string;
- let product: GetProductWithVariants.Product;
- let productVariantId: string;
- let paymentId: string;
- let refundId: string;
- beforeAll(async () => {
- const result = await createTestOrder(
- adminClient,
- shopClient,
- customers[0].emailAddress,
- password,
- );
- orderId = result.orderId;
- product = result.product;
- productVariantId = result.productVariantId;
- });
- it('cannot refund from PaymentAuthorized state', async () => {
- await proceedToArrangingPayment(shopClient);
- const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
- orderGuard.assertSuccess(order);
- expect(order.state).toBe('PaymentAuthorized');
- paymentId = order.payments![0].id;
- const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
- REFUND_ORDER,
- {
- input: {
- lines: order.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
- shipping: 0,
- adjustment: 0,
- paymentId,
- },
- },
- );
- refundGuard.assertErrorResult(refundOrder);
- expect(refundOrder.message).toBe('Cannot refund an Order in the "PaymentAuthorized" state');
- expect(refundOrder.errorCode).toBe(ErrorCode.REFUND_ORDER_STATE_ERROR);
- });
- it('returns error result if no lines and no shipping', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { settlePayment } = await adminClient.query<
- SettlePayment.Mutation,
- SettlePayment.Variables
- >(SETTLE_PAYMENT, {
- id: order!.payments![0].id,
- });
- paymentGuard.assertSuccess(settlePayment);
- expect(settlePayment!.state).toBe('Settled');
- const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
- REFUND_ORDER,
- {
- input: {
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
- shipping: 0,
- adjustment: 0,
- paymentId,
- },
- },
- );
- refundGuard.assertErrorResult(refundOrder);
- expect(refundOrder.message).toBe('Nothing to refund');
- expect(refundOrder.errorCode).toBe(ErrorCode.NOTHING_TO_REFUND_ERROR);
- });
- it(
- 'throws if paymentId not valid',
- assertThrowsWithMessage(async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
- REFUND_ORDER,
- {
- input: {
- lines: [],
- shipping: 100,
- adjustment: 0,
- paymentId: 'T_999',
- },
- },
- );
- }, `No Payment with the id '999' could be found`),
- );
- it('returns error result if payment and order lines do not belong to the same Order', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
- REFUND_ORDER,
- {
- input: {
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
- shipping: 100,
- adjustment: 0,
- paymentId: 'T_1',
- },
- },
- );
- refundGuard.assertErrorResult(refundOrder);
- expect(refundOrder.message).toBe('The Payment and OrderLines do not belong to the same Order');
- expect(refundOrder.errorCode).toBe(ErrorCode.PAYMENT_ORDER_MISMATCH_ERROR);
- });
- it('creates a Refund to be manually settled', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
- REFUND_ORDER,
- {
- input: {
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
- shipping: order!.shipping,
- adjustment: 0,
- reason: 'foo',
- paymentId,
- },
- },
- );
- refundGuard.assertSuccess(refundOrder);
- expect(refundOrder.shipping).toBe(order!.shipping);
- expect(refundOrder.items).toBe(order!.subTotalWithTax);
- expect(refundOrder.total).toBe(order!.totalWithTax);
- expect(refundOrder.transactionId).toBe(null);
- expect(refundOrder.state).toBe('Pending');
- refundId = refundOrder.id;
- });
- it('returns error result if attempting to refund the same item more than once', async () => {
- const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id: orderId,
- });
- const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
- REFUND_ORDER,
- {
- input: {
- lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
- shipping: order!.shipping,
- adjustment: 0,
- paymentId,
- },
- },
- );
- refundGuard.assertErrorResult(refundOrder);
- expect(refundOrder.message).toBe('Cannot refund an OrderItem which has already been refunded');
- expect(refundOrder.errorCode).toBe(ErrorCode.ALREADY_REFUNDED_ERROR);
- });
- it('manually settle a Refund', async () => {
- const { settleRefund } = await adminClient.query<SettleRefund.Mutation, SettleRefund.Variables>(
- SETTLE_REFUND,
- {
- input: {
- id: refundId,
- transactionId: 'aaabbb',
- },
- },
- );
- refundGuard.assertSuccess(settleRefund);
- expect(settleRefund.state).toBe('Settled');
- expect(settleRefund.transactionId).toBe('aaabbb');
- });
- it('order history contains expected entries', async () => {
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- {
- id: orderId,
- options: {
- skip: 0,
- },
- },
- );
- expect(order!.history.items.sort(sortById).map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'Created',
- to: 'AddingItems',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'AddingItems',
- to: 'ArrangingPayment',
- },
- },
- {
- type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
- data: {
- paymentId: 'T_5',
- from: 'Created',
- to: 'Authorized',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'ArrangingPayment',
- to: 'PaymentAuthorized',
- },
- },
- {
- type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
- data: {
- paymentId: 'T_5',
- from: 'Authorized',
- to: 'Settled',
- },
- },
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'PaymentAuthorized',
- to: 'PaymentSettled',
- },
- },
- {
- type: HistoryEntryType.ORDER_REFUND_TRANSITION,
- data: {
- refundId: 'T_1',
- reason: 'foo',
- from: 'Pending',
- to: 'Settled',
- },
- },
- ]);
- });
- });
- describe('order notes', () => {
- let orderId: string;
- let firstNoteId: string;
- beforeAll(async () => {
- const result = await createTestOrder(
- adminClient,
- shopClient,
- customers[2].emailAddress,
- password,
- );
- orderId = result.orderId;
- });
- it('private note', async () => {
- const { addNoteToOrder } = await adminClient.query<
- AddNoteToOrder.Mutation,
- AddNoteToOrder.Variables
- >(ADD_NOTE_TO_ORDER, {
- input: {
- id: orderId,
- note: 'A private note',
- isPublic: false,
- },
- });
- expect(addNoteToOrder.id).toBe(orderId);
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- {
- id: orderId,
- options: {
- skip: 1,
- },
- },
- );
- expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_NOTE,
- data: {
- note: 'A private note',
- },
- },
- ]);
- firstNoteId = order!.history.items[0].id;
- const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
- expect(activeOrder!.history.items.map(pick(['type']))).toEqual([
- { type: HistoryEntryType.ORDER_STATE_TRANSITION },
- ]);
- });
- it('public note', async () => {
- const { addNoteToOrder } = await adminClient.query<
- AddNoteToOrder.Mutation,
- AddNoteToOrder.Variables
- >(ADD_NOTE_TO_ORDER, {
- input: {
- id: orderId,
- note: 'A public note',
- isPublic: true,
- },
- });
- expect(addNoteToOrder.id).toBe(orderId);
- const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
- GET_ORDER_HISTORY,
- {
- id: orderId,
- options: {
- skip: 2,
- },
- },
- );
- expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_NOTE,
- data: {
- note: 'A public note',
- },
- },
- ]);
- const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
- expect(activeOrder!.history.items.map(pick(['type', 'data']))).toEqual([
- {
- type: HistoryEntryType.ORDER_STATE_TRANSITION,
- data: {
- from: 'Created',
- to: 'AddingItems',
- },
- },
- {
- type: HistoryEntryType.ORDER_NOTE,
- data: {
- note: 'A public note',
- },
- },
- ]);
- });
- it('update note', async () => {
- const { updateOrderNote } = await adminClient.query<
- UpdateOrderNote.Mutation,
- UpdateOrderNote.Variables
- >(UPDATE_ORDER_NOTE, {
- input: {
- noteId: firstNoteId,
- note: 'An updated note',
- },
- });
- expect(updateOrderNote.data).toEqual({
- note: 'An updated note',
- });
- });
- it('delete note', async () => {
- const { order: before } = await adminClient.query<
- GetOrderHistory.Query,
- GetOrderHistory.Variables
- >(GET_ORDER_HISTORY, { id: orderId });
- expect(before?.history.totalItems).toBe(3);
- const { deleteOrderNote } = await adminClient.query<
- DeleteOrderNote.Mutation,
- DeleteOrderNote.Variables
- >(DELETE_ORDER_NOTE, {
- id: firstNoteId,
- });
- expect(deleteOrderNote.result).toBe(DeletionResult.DELETED);
- const { order: after } = await adminClient.query<
- GetOrderHistory.Query,
- GetOrderHistory.Variables
- >(GET_ORDER_HISTORY, { id: orderId });
- expect(after?.history.totalItems).toBe(2);
- });
- });
- describe('issues', () => {
- // https://github.com/vendure-ecommerce/vendure/issues/639
- it('returns fulfillments for Order with no lines', async () => {
- // Apply a coupon code just to create an active order with no OrderLines
- await shopClient.query<ApplyCouponCode.Mutation, ApplyCouponCode.Variables>(APPLY_COUPON_CODE, {
- couponCode: 'TEST',
- });
- const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
- const { order } = await adminClient.query<
- GetOrderFulfillments.Query,
- GetOrderFulfillments.Variables
- >(GET_ORDER_FULFILLMENTS, {
- id: activeOrder!.id,
- });
- expect(order?.fulfillments).toEqual([]);
- });
- // https://github.com/vendure-ecommerce/vendure/issues/603
- it('orders correctly resolves quantities and OrderItems', async () => {
- await shopClient.asAnonymousUser();
- const { addItemToOrder } = await shopClient.query<
- AddItemToOrder.Mutation,
- AddItemToOrder.Variables
- >(ADD_ITEM_TO_ORDER, {
- productVariantId: 'T_1',
- quantity: 2,
- });
- orderGuard.assertSuccess(addItemToOrder);
- const { orders } = await adminClient.query<
- GetOrderListWithQty.Query,
- GetOrderListWithQty.Variables
- >(GET_ORDERS_LIST_WITH_QUANTITIES, {
- options: {
- filter: {
- code: { eq: addItemToOrder.code },
- },
- },
- });
- expect(orders.items[0].totalQuantity).toBe(2);
- expect(orders.items[0].lines[0].quantity).toBe(2);
- });
- });
- });
- async function createTestOrder(
- adminClient: SimpleGraphQLClient,
- shopClient: SimpleGraphQLClient,
- emailAddress: string,
- password: string,
- ): Promise<{
- orderId: string;
- product: GetProductWithVariants.Product;
- productVariantId: string;
- }> {
- const result = await adminClient.query<GetProductWithVariants.Query, GetProductWithVariants.Variables>(
- GET_PRODUCT_WITH_VARIANTS,
- {
- id: 'T_3',
- },
- );
- const product = result.product!;
- const productVariantId = product.variants[0].id;
- // Set the ProductVariant to trackInventory
- const { updateProductVariants } = await adminClient.query<
- UpdateProductVariants.Mutation,
- UpdateProductVariants.Variables
- >(UPDATE_PRODUCT_VARIANTS, {
- input: [
- {
- id: productVariantId,
- trackInventory: GlobalFlag.TRUE,
- },
- ],
- });
- // Add the ProductVariant to the Order
- await shopClient.asUserWithCredentials(emailAddress, password);
- const { addItemToOrder } = await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(
- ADD_ITEM_TO_ORDER,
- {
- productVariantId,
- quantity: 2,
- },
- );
- const orderId = (addItemToOrder as UpdatedOrder.Fragment).id;
- return { product, productVariantId, orderId };
- }
- async function getUnfulfilledOrderLineInput(
- client: SimpleGraphQLClient,
- id: string,
- ): Promise<OrderLineInput[]> {
- const { order } = await client.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
- id,
- });
- const unfulfilledItems =
- order?.lines.filter(l => {
- const items = l.items.filter(i => i.fulfillment === null);
- return items.length > 0 ? true : false;
- }) || [];
- return unfulfilledItems.map(l => ({
- orderLineId: l.id,
- quantity: l.items.length,
- }));
- }
- export const GET_ORDER_LIST_FULFILLMENTS = gql`
- query GetOrderListFulfillments {
- orders {
- items {
- id
- state
- fulfillments {
- id
- state
- nextStates
- method
- }
- }
- }
- }
- `;
- export const GET_ORDER_FULFILLMENT_ITEMS = gql`
- query GetOrderFulfillmentItems($id: ID!) {
- order(id: $id) {
- id
- state
- fulfillments {
- ...Fulfillment
- }
- }
- }
- ${FULFILLMENT_FRAGMENT}
- `;
- const REFUND_FRAGMENT = gql`
- fragment Refund on Refund {
- id
- state
- items
- transactionId
- shipping
- total
- metadata
- }
- `;
- export const REFUND_ORDER = gql`
- mutation RefundOrder($input: RefundOrderInput!) {
- refundOrder(input: $input) {
- ...Refund
- ... on ErrorResult {
- errorCode
- message
- }
- }
- }
- ${REFUND_FRAGMENT}
- `;
- export const SETTLE_REFUND = gql`
- mutation SettleRefund($input: SettleRefundInput!) {
- settleRefund(input: $input) {
- ...Refund
- ... on ErrorResult {
- errorCode
- message
- }
- }
- }
- ${REFUND_FRAGMENT}
- `;
- export const ADD_NOTE_TO_ORDER = gql`
- mutation AddNoteToOrder($input: AddNoteToOrderInput!) {
- addNoteToOrder(input: $input) {
- id
- }
- }
- `;
- export const UPDATE_ORDER_NOTE = gql`
- mutation UpdateOrderNote($input: UpdateOrderNoteInput!) {
- updateOrderNote(input: $input) {
- id
- data
- isPublic
- }
- }
- `;
- export const DELETE_ORDER_NOTE = gql`
- mutation DeleteOrderNote($id: ID!) {
- deleteOrderNote(id: $id) {
- result
- message
- }
- }
- `;
- const GET_ORDER_WITH_PAYMENTS = gql`
- query GetOrderWithPayments($id: ID!) {
- order(id: $id) {
- id
- payments {
- id
- errorMessage
- metadata
- }
- }
- }
- `;
- const GET_ORDERS_LIST_WITH_QUANTITIES = gql`
- query GetOrderListWithQty($options: OrderListOptions) {
- orders(options: $options) {
- items {
- id
- code
- totalQuantity
- lines {
- id
- quantity
- }
- }
- }
- }
- `;
|