1
0

order.e2e-spec.ts 89 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410
  1. /* tslint:disable:no-non-null-assertion */
  2. import { omit } from '@vendure/common/lib/omit';
  3. import { pick } from '@vendure/common/lib/pick';
  4. import {
  5. defaultShippingCalculator,
  6. defaultShippingEligibilityChecker,
  7. manualFulfillmentHandler,
  8. mergeConfig,
  9. } from '@vendure/core';
  10. import {
  11. createErrorResultGuard,
  12. createTestEnvironment,
  13. ErrorResultGuard,
  14. SimpleGraphQLClient,
  15. } from '@vendure/testing';
  16. import gql from 'graphql-tag';
  17. import path from 'path';
  18. import { initialData } from '../../../e2e-common/e2e-initial-data';
  19. import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';
  20. import {
  21. failsToSettlePaymentMethod,
  22. onTransitionSpy,
  23. partialPaymentMethod,
  24. singleStageRefundablePaymentMethod,
  25. singleStageRefundFailingPaymentMethod,
  26. twoStagePaymentMethod,
  27. } from './fixtures/test-payment-methods';
  28. import { FULFILLMENT_FRAGMENT } from './graphql/fragments';
  29. import {
  30. AddNoteToOrder,
  31. CanceledOrderFragment,
  32. CancelOrder,
  33. CreateFulfillment,
  34. CreateShippingMethod,
  35. DeleteOrderNote,
  36. DeleteShippingMethod,
  37. ErrorCode,
  38. FulfillmentFragment,
  39. GetCustomerList,
  40. GetOrder,
  41. GetOrderFulfillmentItems,
  42. GetOrderFulfillments,
  43. GetOrderHistory,
  44. GetOrderList,
  45. GetOrderListFulfillments,
  46. GetOrderListWithQty,
  47. GetOrderWithPayments,
  48. GetProductWithVariants,
  49. GetStockMovement,
  50. GlobalFlag,
  51. HistoryEntryType,
  52. LanguageCode,
  53. OrderLineInput,
  54. PaymentFragment,
  55. RefundFragment,
  56. RefundOrder,
  57. SettlePayment,
  58. SettleRefund,
  59. SortOrder,
  60. StockMovementType,
  61. TransitFulfillment,
  62. UpdateOrderNote,
  63. UpdateProductVariants,
  64. } from './graphql/generated-e2e-admin-types';
  65. import {
  66. AddItemToOrder,
  67. AddPaymentToOrder,
  68. ApplyCouponCode,
  69. DeletionResult,
  70. GetActiveOrder,
  71. GetOrderByCodeWithPayments,
  72. SetShippingAddress,
  73. SetShippingMethod,
  74. TestOrderFragmentFragment,
  75. UpdatedOrder,
  76. UpdatedOrderFragment,
  77. } from './graphql/generated-e2e-shop-types';
  78. import {
  79. CANCEL_ORDER,
  80. CREATE_FULFILLMENT,
  81. CREATE_SHIPPING_METHOD,
  82. DELETE_SHIPPING_METHOD,
  83. GET_CUSTOMER_LIST,
  84. GET_ORDER,
  85. GET_ORDERS_LIST,
  86. GET_ORDER_FULFILLMENTS,
  87. GET_ORDER_HISTORY,
  88. GET_PRODUCT_WITH_VARIANTS,
  89. GET_STOCK_MOVEMENT,
  90. SETTLE_PAYMENT,
  91. TRANSIT_FULFILLMENT,
  92. UPDATE_PRODUCT_VARIANTS,
  93. } from './graphql/shared-definitions';
  94. import {
  95. ADD_ITEM_TO_ORDER,
  96. ADD_PAYMENT,
  97. APPLY_COUPON_CODE,
  98. GET_ACTIVE_ORDER,
  99. GET_ORDER_BY_CODE_WITH_PAYMENTS,
  100. SET_SHIPPING_ADDRESS,
  101. SET_SHIPPING_METHOD,
  102. } from './graphql/shop-definitions';
  103. import { assertThrowsWithMessage } from './utils/assert-throws-with-message';
  104. import { addPaymentToOrder, proceedToArrangingPayment, sortById } from './utils/test-order-utils';
  105. describe('Orders resolver', () => {
  106. const { server, adminClient, shopClient } = createTestEnvironment(
  107. mergeConfig(testConfig, {
  108. paymentOptions: {
  109. paymentMethodHandlers: [
  110. twoStagePaymentMethod,
  111. failsToSettlePaymentMethod,
  112. singleStageRefundablePaymentMethod,
  113. partialPaymentMethod,
  114. singleStageRefundFailingPaymentMethod,
  115. ],
  116. },
  117. }),
  118. );
  119. let customers: GetCustomerList.Items[];
  120. const password = 'test';
  121. const orderGuard: ErrorResultGuard<
  122. TestOrderFragmentFragment | CanceledOrderFragment | UpdatedOrderFragment
  123. > = createErrorResultGuard(input => !!input.lines);
  124. const paymentGuard: ErrorResultGuard<PaymentFragment> = createErrorResultGuard(input => !!input.state);
  125. const fulfillmentGuard: ErrorResultGuard<FulfillmentFragment> = createErrorResultGuard(
  126. input => !!input.method,
  127. );
  128. const refundGuard: ErrorResultGuard<RefundFragment> = createErrorResultGuard(input => !!input.items);
  129. beforeAll(async () => {
  130. await server.init({
  131. initialData: {
  132. ...initialData,
  133. paymentMethods: [
  134. {
  135. name: twoStagePaymentMethod.code,
  136. handler: { code: twoStagePaymentMethod.code, arguments: [] },
  137. },
  138. {
  139. name: failsToSettlePaymentMethod.code,
  140. handler: { code: failsToSettlePaymentMethod.code, arguments: [] },
  141. },
  142. {
  143. name: singleStageRefundablePaymentMethod.code,
  144. handler: { code: singleStageRefundablePaymentMethod.code, arguments: [] },
  145. },
  146. {
  147. name: singleStageRefundFailingPaymentMethod.code,
  148. handler: { code: singleStageRefundFailingPaymentMethod.code, arguments: [] },
  149. },
  150. {
  151. name: partialPaymentMethod.code,
  152. handler: { code: partialPaymentMethod.code, arguments: [] },
  153. },
  154. ],
  155. },
  156. productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-full.csv'),
  157. customerCount: 3,
  158. });
  159. await adminClient.asSuperAdmin();
  160. // Create a couple of orders to be queried
  161. const result = await adminClient.query<GetCustomerList.Query, GetCustomerList.Variables>(
  162. GET_CUSTOMER_LIST,
  163. {
  164. options: {
  165. take: 3,
  166. },
  167. },
  168. );
  169. customers = result.customers.items;
  170. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  171. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  172. productVariantId: 'T_1',
  173. quantity: 1,
  174. });
  175. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  176. productVariantId: 'T_2',
  177. quantity: 1,
  178. });
  179. await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
  180. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  181. productVariantId: 'T_2',
  182. quantity: 1,
  183. });
  184. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  185. productVariantId: 'T_3',
  186. quantity: 3,
  187. });
  188. }, TEST_SETUP_TIMEOUT_MS);
  189. afterAll(async () => {
  190. await server.destroy();
  191. });
  192. it('order history initially contains Created -> AddingItems transition', async () => {
  193. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  194. GET_ORDER_HISTORY,
  195. { id: 'T_1' },
  196. );
  197. expect(order!.history.totalItems).toBe(1);
  198. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  199. {
  200. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  201. data: {
  202. from: 'Created',
  203. to: 'AddingItems',
  204. },
  205. },
  206. ]);
  207. });
  208. describe('querying', () => {
  209. it('orders', async () => {
  210. const result = await adminClient.query<GetOrderList.Query>(GET_ORDERS_LIST);
  211. expect(result.orders.items.map(o => o.id).sort()).toEqual(['T_1', 'T_2']);
  212. });
  213. it('order', async () => {
  214. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  215. id: 'T_2',
  216. });
  217. expect(result.order!.id).toBe('T_2');
  218. });
  219. it('sort by total', async () => {
  220. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  221. GET_ORDERS_LIST,
  222. {
  223. options: {
  224. sort: {
  225. total: SortOrder.DESC,
  226. },
  227. take: 10,
  228. },
  229. },
  230. );
  231. expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
  232. { id: 'T_2', total: 799600 },
  233. { id: 'T_1', total: 269800 },
  234. ]);
  235. });
  236. it('sort by totalWithTax', async () => {
  237. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  238. GET_ORDERS_LIST,
  239. {
  240. options: {
  241. sort: {
  242. totalWithTax: SortOrder.DESC,
  243. },
  244. take: 10,
  245. },
  246. },
  247. );
  248. expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
  249. { id: 'T_2', totalWithTax: 959520 },
  250. { id: 'T_1', totalWithTax: 323760 },
  251. ]);
  252. });
  253. it('sort by totalQuantity', async () => {
  254. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  255. GET_ORDERS_LIST,
  256. {
  257. options: {
  258. sort: {
  259. totalQuantity: SortOrder.DESC,
  260. },
  261. take: 10,
  262. },
  263. },
  264. );
  265. expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
  266. { id: 'T_2', totalQuantity: 4 },
  267. { id: 'T_1', totalQuantity: 2 },
  268. ]);
  269. });
  270. it('sort by customerLastName', async () => {
  271. async function sortOrdersByLastName(sortOrder: SortOrder) {
  272. const { orders } = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  273. GET_ORDERS_LIST,
  274. {
  275. options: {
  276. sort: {
  277. customerLastName: sortOrder,
  278. },
  279. },
  280. },
  281. );
  282. return orders;
  283. }
  284. const result1 = await sortOrdersByLastName(SortOrder.ASC);
  285. expect(result1.totalItems).toEqual(2);
  286. expect(result1.items.map(order => order.customer?.lastName)).toEqual(['Donnelly', 'Zieme']);
  287. const result2 = await sortOrdersByLastName(SortOrder.DESC);
  288. expect(result2.totalItems).toEqual(2);
  289. expect(result2.items.map(order => order.customer?.lastName)).toEqual(['Zieme', 'Donnelly']);
  290. });
  291. it('filter by total', async () => {
  292. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  293. GET_ORDERS_LIST,
  294. {
  295. options: {
  296. filter: {
  297. total: { gt: 323760 },
  298. },
  299. take: 10,
  300. },
  301. },
  302. );
  303. expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
  304. { id: 'T_2', total: 799600 },
  305. ]);
  306. });
  307. it('filter by totalWithTax', async () => {
  308. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  309. GET_ORDERS_LIST,
  310. {
  311. options: {
  312. filter: {
  313. totalWithTax: { gt: 323760 },
  314. },
  315. take: 10,
  316. },
  317. },
  318. );
  319. expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
  320. { id: 'T_2', totalWithTax: 959520 },
  321. ]);
  322. });
  323. it('filter by totalQuantity', async () => {
  324. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  325. GET_ORDERS_LIST,
  326. {
  327. options: {
  328. filter: {
  329. totalQuantity: { eq: 4 },
  330. },
  331. },
  332. },
  333. );
  334. expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
  335. { id: 'T_2', totalQuantity: 4 },
  336. ]);
  337. });
  338. it('filter by customerLastName', async () => {
  339. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  340. GET_ORDERS_LIST,
  341. {
  342. options: {
  343. filter: {
  344. customerLastName: {
  345. eq: customers[1].lastName,
  346. },
  347. },
  348. },
  349. },
  350. );
  351. expect(result.orders.totalItems).toEqual(1);
  352. expect(result.orders.items[0].customer?.lastName).toEqual(customers[1].lastName);
  353. });
  354. });
  355. describe('payments', () => {
  356. let firstOrderCode: string;
  357. let firstOrderId: string;
  358. it('settlePayment fails', async () => {
  359. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  360. await proceedToArrangingPayment(shopClient);
  361. const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
  362. orderGuard.assertSuccess(order);
  363. expect(order.state).toBe('PaymentAuthorized');
  364. const payment = order.payments![0];
  365. const { settlePayment } = await adminClient.query<
  366. SettlePayment.Mutation,
  367. SettlePayment.Variables
  368. >(SETTLE_PAYMENT, {
  369. id: payment.id,
  370. });
  371. paymentGuard.assertErrorResult(settlePayment);
  372. expect(settlePayment.message).toBe('Settling the payment failed');
  373. expect(settlePayment.errorCode).toBe(ErrorCode.SETTLE_PAYMENT_ERROR);
  374. expect((settlePayment as any).paymentErrorMessage).toBe('Something went horribly wrong');
  375. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  376. id: order.id,
  377. });
  378. expect(result.order!.state).toBe('PaymentAuthorized');
  379. expect(result.order!.payments![0].state).toBe('Cancelled');
  380. firstOrderCode = order.code;
  381. firstOrderId = order.id;
  382. });
  383. it('public payment metadata available in Shop API', async () => {
  384. const { orderByCode } = await shopClient.query<
  385. GetOrderByCodeWithPayments.Query,
  386. GetOrderByCodeWithPayments.Variables
  387. >(GET_ORDER_BY_CODE_WITH_PAYMENTS, { code: firstOrderCode });
  388. expect(orderByCode?.payments?.[0].metadata).toEqual({
  389. public: {
  390. publicCreatePaymentData: 'public',
  391. publicSettlePaymentData: 'public',
  392. },
  393. });
  394. });
  395. it('public and private payment metadata available in Admin API', async () => {
  396. const { order } = await adminClient.query<
  397. GetOrderWithPayments.Query,
  398. GetOrderWithPayments.Variables
  399. >(GET_ORDER_WITH_PAYMENTS, { id: firstOrderId });
  400. expect(order?.payments?.[0].metadata).toEqual({
  401. privateCreatePaymentData: 'secret',
  402. privateSettlePaymentData: 'secret',
  403. public: {
  404. publicCreatePaymentData: 'public',
  405. publicSettlePaymentData: 'public',
  406. },
  407. });
  408. });
  409. it('settlePayment succeeds, onStateTransitionStart called', async () => {
  410. onTransitionSpy.mockClear();
  411. await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
  412. await proceedToArrangingPayment(shopClient);
  413. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  414. orderGuard.assertSuccess(order);
  415. expect(order.state).toBe('PaymentAuthorized');
  416. expect(onTransitionSpy).toHaveBeenCalledTimes(1);
  417. expect(onTransitionSpy.mock.calls[0][0]).toBe('Created');
  418. expect(onTransitionSpy.mock.calls[0][1]).toBe('Authorized');
  419. const payment = order.payments![0];
  420. const { settlePayment } = await adminClient.query<
  421. SettlePayment.Mutation,
  422. SettlePayment.Variables
  423. >(SETTLE_PAYMENT, {
  424. id: payment.id,
  425. });
  426. paymentGuard.assertSuccess(settlePayment);
  427. expect(settlePayment!.id).toBe(payment.id);
  428. expect(settlePayment!.state).toBe('Settled');
  429. // further metadata is combined into existing object
  430. expect(settlePayment!.metadata).toEqual({
  431. moreData: 42,
  432. public: {
  433. baz: 'quux',
  434. },
  435. });
  436. expect(onTransitionSpy).toHaveBeenCalledTimes(2);
  437. expect(onTransitionSpy.mock.calls[1][0]).toBe('Authorized');
  438. expect(onTransitionSpy.mock.calls[1][1]).toBe('Settled');
  439. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  440. id: order.id,
  441. });
  442. expect(result.order!.state).toBe('PaymentSettled');
  443. expect(result.order!.payments![0].state).toBe('Settled');
  444. });
  445. it('order history contains expected entries', async () => {
  446. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  447. GET_ORDER_HISTORY,
  448. { id: 'T_2', options: { sort: { id: SortOrder.ASC } } },
  449. );
  450. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  451. {
  452. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  453. data: {
  454. from: 'Created',
  455. to: 'AddingItems',
  456. },
  457. },
  458. {
  459. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  460. data: {
  461. from: 'AddingItems',
  462. to: 'ArrangingPayment',
  463. },
  464. },
  465. {
  466. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  467. data: {
  468. paymentId: 'T_2',
  469. from: 'Created',
  470. to: 'Authorized',
  471. },
  472. },
  473. {
  474. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  475. data: {
  476. from: 'ArrangingPayment',
  477. to: 'PaymentAuthorized',
  478. },
  479. },
  480. {
  481. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  482. data: {
  483. paymentId: 'T_2',
  484. from: 'Authorized',
  485. to: 'Settled',
  486. },
  487. },
  488. {
  489. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  490. data: {
  491. from: 'PaymentAuthorized',
  492. to: 'PaymentSettled',
  493. },
  494. },
  495. ]);
  496. });
  497. });
  498. describe('fulfillment', () => {
  499. const orderId = 'T_2';
  500. let f1Id: string;
  501. let f2Id: string;
  502. let f3Id: string;
  503. it('return error result if lines is empty', async () => {
  504. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  505. id: orderId,
  506. });
  507. expect(order!.state).toBe('PaymentSettled');
  508. const { addFulfillmentToOrder } = await adminClient.query<
  509. CreateFulfillment.Mutation,
  510. CreateFulfillment.Variables
  511. >(CREATE_FULFILLMENT, {
  512. input: {
  513. lines: [],
  514. handler: {
  515. code: manualFulfillmentHandler.code,
  516. arguments: [{ name: 'method', value: 'Test' }],
  517. },
  518. },
  519. });
  520. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  521. expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
  522. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  523. });
  524. it('returns error result if all quantities are zero', async () => {
  525. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  526. id: orderId,
  527. });
  528. expect(order!.state).toBe('PaymentSettled');
  529. const { addFulfillmentToOrder } = await adminClient.query<
  530. CreateFulfillment.Mutation,
  531. CreateFulfillment.Variables
  532. >(CREATE_FULFILLMENT, {
  533. input: {
  534. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  535. handler: {
  536. code: manualFulfillmentHandler.code,
  537. arguments: [{ name: 'method', value: 'Test' }],
  538. },
  539. },
  540. });
  541. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  542. expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
  543. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  544. });
  545. it('creates the first fulfillment', async () => {
  546. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  547. id: orderId,
  548. });
  549. expect(order!.state).toBe('PaymentSettled');
  550. const lines = order!.lines;
  551. const { addFulfillmentToOrder } = await adminClient.query<
  552. CreateFulfillment.Mutation,
  553. CreateFulfillment.Variables
  554. >(CREATE_FULFILLMENT, {
  555. input: {
  556. lines: [{ orderLineId: lines[0].id, quantity: lines[0].quantity }],
  557. handler: {
  558. code: manualFulfillmentHandler.code,
  559. arguments: [
  560. { name: 'method', value: 'Test1' },
  561. { name: 'trackingCode', value: '111' },
  562. ],
  563. },
  564. },
  565. });
  566. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  567. expect(addFulfillmentToOrder.id).toBe('T_1');
  568. expect(addFulfillmentToOrder.method).toBe('Test1');
  569. expect(addFulfillmentToOrder.trackingCode).toBe('111');
  570. expect(addFulfillmentToOrder.state).toBe('Pending');
  571. expect(addFulfillmentToOrder.orderItems).toEqual([{ id: lines[0].items[0].id }]);
  572. f1Id = addFulfillmentToOrder.id;
  573. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  574. id: orderId,
  575. });
  576. expect(result.order!.lines[0].items[0].fulfillment!.id).toBe(addFulfillmentToOrder!.id);
  577. expect(
  578. result.order!.lines[1].items.filter(
  579. i => i.fulfillment && i.fulfillment.id === addFulfillmentToOrder.id,
  580. ).length,
  581. ).toBe(0);
  582. expect(result.order!.lines[1].items.filter(i => i.fulfillment == null).length).toBe(3);
  583. });
  584. it('creates the second fulfillment', async () => {
  585. const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
  586. const { addFulfillmentToOrder } = await adminClient.query<
  587. CreateFulfillment.Mutation,
  588. CreateFulfillment.Variables
  589. >(CREATE_FULFILLMENT, {
  590. input: {
  591. lines,
  592. handler: {
  593. code: manualFulfillmentHandler.code,
  594. arguments: [
  595. { name: 'method', value: 'Test2' },
  596. { name: 'trackingCode', value: '222' },
  597. ],
  598. },
  599. },
  600. });
  601. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  602. expect(addFulfillmentToOrder.id).toBe('T_2');
  603. expect(addFulfillmentToOrder.method).toBe('Test2');
  604. expect(addFulfillmentToOrder.trackingCode).toBe('222');
  605. expect(addFulfillmentToOrder.state).toBe('Pending');
  606. f2Id = addFulfillmentToOrder.id;
  607. });
  608. it('cancels second fulfillment', async () => {
  609. const { transitionFulfillmentToState } = await adminClient.query<
  610. TransitFulfillment.Mutation,
  611. TransitFulfillment.Variables
  612. >(TRANSIT_FULFILLMENT, {
  613. id: f2Id,
  614. state: 'Cancelled',
  615. });
  616. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  617. expect(transitionFulfillmentToState.id).toBe('T_2');
  618. expect(transitionFulfillmentToState.state).toBe('Cancelled');
  619. });
  620. it('order.fulfillments still lists second (cancelled) fulfillment', async () => {
  621. const { order } = await adminClient.query<
  622. GetOrderFulfillments.Query,
  623. GetOrderFulfillments.Variables
  624. >(GET_ORDER_FULFILLMENTS, {
  625. id: orderId,
  626. });
  627. expect(order?.fulfillments?.map(pick(['id', 'state']))).toEqual([
  628. { id: f1Id, state: 'Pending' },
  629. { id: f2Id, state: 'Cancelled' },
  630. ]);
  631. });
  632. it('creates third fulfillment with same items from second fulfillment', async () => {
  633. const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
  634. const { addFulfillmentToOrder } = await adminClient.query<
  635. CreateFulfillment.Mutation,
  636. CreateFulfillment.Variables
  637. >(CREATE_FULFILLMENT, {
  638. input: {
  639. lines,
  640. handler: {
  641. code: manualFulfillmentHandler.code,
  642. arguments: [
  643. { name: 'method', value: 'Test3' },
  644. { name: 'trackingCode', value: '333' },
  645. ],
  646. },
  647. },
  648. });
  649. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  650. expect(addFulfillmentToOrder.id).toBe('T_3');
  651. expect(addFulfillmentToOrder.method).toBe('Test3');
  652. expect(addFulfillmentToOrder.trackingCode).toBe('333');
  653. expect(addFulfillmentToOrder.state).toBe('Pending');
  654. f3Id = addFulfillmentToOrder.id;
  655. });
  656. it('returns error result if an OrderItem already part of a Fulfillment', async () => {
  657. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  658. id: orderId,
  659. });
  660. const { addFulfillmentToOrder } = await adminClient.query<
  661. CreateFulfillment.Mutation,
  662. CreateFulfillment.Variables
  663. >(CREATE_FULFILLMENT, {
  664. input: {
  665. lines: [
  666. {
  667. orderLineId: order!.lines[0].id,
  668. quantity: 1,
  669. },
  670. ],
  671. handler: {
  672. code: manualFulfillmentHandler.code,
  673. arguments: [{ name: 'method', value: 'Test' }],
  674. },
  675. },
  676. });
  677. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  678. expect(addFulfillmentToOrder.message).toBe(
  679. 'One or more OrderItems are already part of a Fulfillment',
  680. );
  681. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.ITEMS_ALREADY_FULFILLED_ERROR);
  682. });
  683. it('transitions the first fulfillment from created to Shipped and automatically change the order state to PartiallyShipped', async () => {
  684. const { transitionFulfillmentToState } = await adminClient.query<
  685. TransitFulfillment.Mutation,
  686. TransitFulfillment.Variables
  687. >(TRANSIT_FULFILLMENT, {
  688. id: f1Id,
  689. state: 'Shipped',
  690. });
  691. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  692. expect(transitionFulfillmentToState.id).toBe(f1Id);
  693. expect(transitionFulfillmentToState.state).toBe('Shipped');
  694. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  695. id: orderId,
  696. });
  697. expect(order?.state).toBe('PartiallyShipped');
  698. });
  699. it('transitions the third fulfillment from created to Shipped and automatically change the order state to Shipped', async () => {
  700. const { transitionFulfillmentToState } = await adminClient.query<
  701. TransitFulfillment.Mutation,
  702. TransitFulfillment.Variables
  703. >(TRANSIT_FULFILLMENT, {
  704. id: f3Id,
  705. state: 'Shipped',
  706. });
  707. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  708. expect(transitionFulfillmentToState.id).toBe(f3Id);
  709. expect(transitionFulfillmentToState.state).toBe('Shipped');
  710. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  711. id: orderId,
  712. });
  713. expect(order?.state).toBe('Shipped');
  714. });
  715. it('transitions the first fulfillment from Shipped to Delivered and change the order state to PartiallyDelivered', async () => {
  716. const { transitionFulfillmentToState } = await adminClient.query<
  717. TransitFulfillment.Mutation,
  718. TransitFulfillment.Variables
  719. >(TRANSIT_FULFILLMENT, {
  720. id: f1Id,
  721. state: 'Delivered',
  722. });
  723. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  724. expect(transitionFulfillmentToState.id).toBe(f1Id);
  725. expect(transitionFulfillmentToState.state).toBe('Delivered');
  726. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  727. id: orderId,
  728. });
  729. expect(order?.state).toBe('PartiallyDelivered');
  730. });
  731. it('transitions the third fulfillment from Shipped to Delivered and change the order state to Delivered', async () => {
  732. const { transitionFulfillmentToState } = await adminClient.query<
  733. TransitFulfillment.Mutation,
  734. TransitFulfillment.Variables
  735. >(TRANSIT_FULFILLMENT, {
  736. id: f3Id,
  737. state: 'Delivered',
  738. });
  739. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  740. expect(transitionFulfillmentToState.id).toBe(f3Id);
  741. expect(transitionFulfillmentToState.state).toBe('Delivered');
  742. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  743. id: orderId,
  744. });
  745. expect(order?.state).toBe('Delivered');
  746. });
  747. it('order history contains expected entries', async () => {
  748. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  749. GET_ORDER_HISTORY,
  750. {
  751. id: orderId,
  752. options: {
  753. skip: 6,
  754. },
  755. },
  756. );
  757. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  758. {
  759. data: {
  760. fulfillmentId: f1Id,
  761. },
  762. type: HistoryEntryType.ORDER_FULFILLMENT,
  763. },
  764. {
  765. data: {
  766. from: 'Created',
  767. fulfillmentId: f1Id,
  768. to: 'Pending',
  769. },
  770. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  771. },
  772. {
  773. data: {
  774. fulfillmentId: f2Id,
  775. },
  776. type: HistoryEntryType.ORDER_FULFILLMENT,
  777. },
  778. {
  779. data: {
  780. from: 'Created',
  781. fulfillmentId: f2Id,
  782. to: 'Pending',
  783. },
  784. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  785. },
  786. {
  787. data: {
  788. from: 'Pending',
  789. fulfillmentId: f2Id,
  790. to: 'Cancelled',
  791. },
  792. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  793. },
  794. {
  795. data: {
  796. fulfillmentId: f3Id,
  797. },
  798. type: HistoryEntryType.ORDER_FULFILLMENT,
  799. },
  800. {
  801. data: {
  802. from: 'Created',
  803. fulfillmentId: f3Id,
  804. to: 'Pending',
  805. },
  806. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  807. },
  808. {
  809. data: {
  810. from: 'Pending',
  811. fulfillmentId: f1Id,
  812. to: 'Shipped',
  813. },
  814. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  815. },
  816. {
  817. data: {
  818. from: 'PaymentSettled',
  819. to: 'PartiallyShipped',
  820. },
  821. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  822. },
  823. {
  824. data: {
  825. from: 'Pending',
  826. fulfillmentId: f3Id,
  827. to: 'Shipped',
  828. },
  829. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  830. },
  831. {
  832. data: {
  833. from: 'PartiallyShipped',
  834. to: 'Shipped',
  835. },
  836. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  837. },
  838. {
  839. data: {
  840. from: 'Shipped',
  841. fulfillmentId: f1Id,
  842. to: 'Delivered',
  843. },
  844. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  845. },
  846. {
  847. data: {
  848. from: 'Shipped',
  849. to: 'PartiallyDelivered',
  850. },
  851. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  852. },
  853. {
  854. data: {
  855. from: 'Shipped',
  856. fulfillmentId: f3Id,
  857. to: 'Delivered',
  858. },
  859. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  860. },
  861. {
  862. data: {
  863. from: 'PartiallyDelivered',
  864. to: 'Delivered',
  865. },
  866. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  867. },
  868. ]);
  869. });
  870. it('order.fulfillments resolver for single order', async () => {
  871. const { order } = await adminClient.query<
  872. GetOrderFulfillments.Query,
  873. GetOrderFulfillments.Variables
  874. >(GET_ORDER_FULFILLMENTS, {
  875. id: orderId,
  876. });
  877. expect(order!.fulfillments?.sort(sortById)).toEqual([
  878. { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
  879. { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
  880. { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
  881. ]);
  882. });
  883. it('order.fulfillments resolver for order list', async () => {
  884. const { orders } = await adminClient.query<GetOrderListFulfillments.Query>(
  885. GET_ORDER_LIST_FULFILLMENTS,
  886. );
  887. expect(orders.items[0].fulfillments).toEqual([]);
  888. expect(orders.items[1].fulfillments).toEqual([
  889. { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
  890. { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
  891. { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
  892. ]);
  893. });
  894. it('order.fulfillments.orderItems resolver', async () => {
  895. const { order } = await adminClient.query<
  896. GetOrderFulfillmentItems.Query,
  897. GetOrderFulfillmentItems.Variables
  898. >(GET_ORDER_FULFILLMENT_ITEMS, {
  899. id: orderId,
  900. });
  901. expect(order!.fulfillments![0].orderItems).toEqual([{ id: 'T_3' }]);
  902. expect(order!.fulfillments![1].orderItems).toEqual([{ id: 'T_4' }, { id: 'T_5' }, { id: 'T_6' }]);
  903. expect(order!.fulfillments![2].orderItems).toEqual([{ id: 'T_4' }, { id: 'T_5' }, { id: 'T_6' }]);
  904. });
  905. });
  906. describe('cancellation by orderId', () => {
  907. it('cancel from AddingItems state', async () => {
  908. const testOrder = await createTestOrder(
  909. adminClient,
  910. shopClient,
  911. customers[0].emailAddress,
  912. password,
  913. );
  914. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  915. id: testOrder.orderId,
  916. });
  917. expect(order!.state).toBe('AddingItems');
  918. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  919. CANCEL_ORDER,
  920. {
  921. input: {
  922. orderId: testOrder.orderId,
  923. },
  924. },
  925. );
  926. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  927. id: testOrder.orderId,
  928. });
  929. expect(order2!.state).toBe('Cancelled');
  930. expect(order2!.active).toBe(false);
  931. await assertNoStockMovementsCreated(testOrder.product.id);
  932. });
  933. it('cancel from ArrangingPayment state', async () => {
  934. const testOrder = await createTestOrder(
  935. adminClient,
  936. shopClient,
  937. customers[0].emailAddress,
  938. password,
  939. );
  940. await proceedToArrangingPayment(shopClient);
  941. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  942. id: testOrder.orderId,
  943. });
  944. expect(order!.state).toBe('ArrangingPayment');
  945. await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(CANCEL_ORDER, {
  946. input: {
  947. orderId: testOrder.orderId,
  948. },
  949. });
  950. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  951. id: testOrder.orderId,
  952. });
  953. expect(order2!.state).toBe('Cancelled');
  954. expect(order2!.active).toBe(false);
  955. await assertNoStockMovementsCreated(testOrder.product.id);
  956. });
  957. it('cancel from PaymentAuthorized state', async () => {
  958. const testOrder = await createTestOrder(
  959. adminClient,
  960. shopClient,
  961. customers[0].emailAddress,
  962. password,
  963. );
  964. await proceedToArrangingPayment(shopClient);
  965. const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
  966. orderGuard.assertSuccess(order);
  967. expect(order.state).toBe('PaymentAuthorized');
  968. const result1 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  969. GET_STOCK_MOVEMENT,
  970. {
  971. id: 'T_3',
  972. },
  973. );
  974. let variant1 = result1.product!.variants[0];
  975. expect(variant1.stockOnHand).toBe(100);
  976. expect(variant1.stockAllocated).toBe(2);
  977. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  978. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  979. { type: StockMovementType.ALLOCATION, quantity: 2 },
  980. ]);
  981. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  982. CANCEL_ORDER,
  983. {
  984. input: {
  985. orderId: testOrder.orderId,
  986. },
  987. },
  988. );
  989. orderGuard.assertSuccess(cancelOrder);
  990. expect(
  991. cancelOrder.lines.map(l =>
  992. l.items.map(pick(['id', 'cancelled'])).sort((a, b) => (a.id > b.id ? 1 : -1)),
  993. ),
  994. ).toEqual([
  995. [
  996. { id: 'T_11', cancelled: true },
  997. { id: 'T_12', cancelled: true },
  998. ],
  999. ]);
  1000. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1001. id: testOrder.orderId,
  1002. });
  1003. expect(order2!.active).toBe(false);
  1004. expect(order2!.state).toBe('Cancelled');
  1005. const result2 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1006. GET_STOCK_MOVEMENT,
  1007. {
  1008. id: 'T_3',
  1009. },
  1010. );
  1011. variant1 = result2.product!.variants[0];
  1012. expect(variant1.stockOnHand).toBe(100);
  1013. expect(variant1.stockAllocated).toBe(0);
  1014. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1015. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1016. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1017. { type: StockMovementType.RELEASE, quantity: 1 },
  1018. { type: StockMovementType.RELEASE, quantity: 1 },
  1019. ]);
  1020. });
  1021. async function assertNoStockMovementsCreated(productId: string) {
  1022. const result = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1023. GET_STOCK_MOVEMENT,
  1024. {
  1025. id: productId,
  1026. },
  1027. );
  1028. const variant2 = result.product!.variants[0];
  1029. expect(variant2.stockOnHand).toBe(100);
  1030. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1031. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1032. ]);
  1033. }
  1034. });
  1035. describe('cancellation by OrderLine', () => {
  1036. let orderId: string;
  1037. let product: GetProductWithVariants.Product;
  1038. let productVariantId: string;
  1039. beforeAll(async () => {
  1040. const result = await createTestOrder(
  1041. adminClient,
  1042. shopClient,
  1043. customers[0].emailAddress,
  1044. password,
  1045. );
  1046. orderId = result.orderId;
  1047. product = result.product;
  1048. productVariantId = result.productVariantId;
  1049. });
  1050. it('cannot cancel from AddingItems state', async () => {
  1051. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1052. id: orderId,
  1053. });
  1054. expect(order!.state).toBe('AddingItems');
  1055. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1056. CANCEL_ORDER,
  1057. {
  1058. input: {
  1059. orderId,
  1060. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1061. },
  1062. },
  1063. );
  1064. orderGuard.assertErrorResult(cancelOrder);
  1065. expect(cancelOrder.message).toBe(
  1066. 'Cannot cancel OrderLines from an Order in the "AddingItems" state',
  1067. );
  1068. expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
  1069. });
  1070. it('cannot cancel from ArrangingPayment state', async () => {
  1071. await proceedToArrangingPayment(shopClient);
  1072. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1073. id: orderId,
  1074. });
  1075. expect(order!.state).toBe('ArrangingPayment');
  1076. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1077. CANCEL_ORDER,
  1078. {
  1079. input: {
  1080. orderId,
  1081. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1082. },
  1083. },
  1084. );
  1085. orderGuard.assertErrorResult(cancelOrder);
  1086. expect(cancelOrder.message).toBe(
  1087. 'Cannot cancel OrderLines from an Order in the "ArrangingPayment" state',
  1088. );
  1089. expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
  1090. });
  1091. it('returns error result if lines are empty', async () => {
  1092. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1093. orderGuard.assertSuccess(order);
  1094. expect(order.state).toBe('PaymentAuthorized');
  1095. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1096. CANCEL_ORDER,
  1097. {
  1098. input: {
  1099. orderId,
  1100. lines: [],
  1101. },
  1102. },
  1103. );
  1104. orderGuard.assertErrorResult(cancelOrder);
  1105. expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
  1106. expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  1107. });
  1108. it('returns error result if all quantities zero', async () => {
  1109. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1110. id: orderId,
  1111. });
  1112. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1113. CANCEL_ORDER,
  1114. {
  1115. input: {
  1116. orderId,
  1117. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  1118. },
  1119. },
  1120. );
  1121. orderGuard.assertErrorResult(cancelOrder);
  1122. expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
  1123. expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  1124. });
  1125. it('partial cancellation', async () => {
  1126. const result1 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1127. GET_STOCK_MOVEMENT,
  1128. {
  1129. id: product.id,
  1130. },
  1131. );
  1132. const variant1 = result1.product!.variants[0];
  1133. expect(variant1.stockOnHand).toBe(100);
  1134. expect(variant1.stockAllocated).toBe(2);
  1135. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1136. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1137. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1138. { type: StockMovementType.RELEASE, quantity: 1 },
  1139. { type: StockMovementType.RELEASE, quantity: 1 },
  1140. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1141. ]);
  1142. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1143. id: orderId,
  1144. });
  1145. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1146. CANCEL_ORDER,
  1147. {
  1148. input: {
  1149. orderId,
  1150. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1151. reason: 'cancel reason 1',
  1152. },
  1153. },
  1154. );
  1155. orderGuard.assertSuccess(cancelOrder);
  1156. expect(cancelOrder.lines[0].quantity).toBe(1);
  1157. expect(cancelOrder.lines[0].items.sort((a, b) => (a.id < b.id ? -1 : 1))).toEqual([
  1158. { id: 'T_13', cancelled: true },
  1159. { id: 'T_14', cancelled: false },
  1160. ]);
  1161. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1162. id: orderId,
  1163. });
  1164. expect(order2!.state).toBe('PaymentAuthorized');
  1165. expect(order2!.lines[0].quantity).toBe(1);
  1166. const result2 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1167. GET_STOCK_MOVEMENT,
  1168. {
  1169. id: product.id,
  1170. },
  1171. );
  1172. const variant2 = result2.product!.variants[0];
  1173. expect(variant2.stockOnHand).toBe(100);
  1174. expect(variant2.stockAllocated).toBe(1);
  1175. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1176. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1177. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1178. { type: StockMovementType.RELEASE, quantity: 1 },
  1179. { type: StockMovementType.RELEASE, quantity: 1 },
  1180. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1181. { type: StockMovementType.RELEASE, quantity: 1 },
  1182. ]);
  1183. });
  1184. it('returns error result if attempting to cancel already cancelled item', async () => {
  1185. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1186. id: orderId,
  1187. });
  1188. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1189. CANCEL_ORDER,
  1190. {
  1191. input: {
  1192. orderId,
  1193. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 2 })),
  1194. },
  1195. },
  1196. );
  1197. orderGuard.assertErrorResult(cancelOrder);
  1198. expect(cancelOrder.message).toBe(
  1199. 'The specified quantity is greater than the available OrderItems',
  1200. );
  1201. expect(cancelOrder.errorCode).toBe(ErrorCode.QUANTITY_TOO_GREAT_ERROR);
  1202. });
  1203. it('complete cancellation', async () => {
  1204. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1205. id: orderId,
  1206. });
  1207. await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(CANCEL_ORDER, {
  1208. input: {
  1209. orderId,
  1210. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1211. reason: 'cancel reason 2',
  1212. },
  1213. });
  1214. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1215. id: orderId,
  1216. });
  1217. expect(order2!.state).toBe('Cancelled');
  1218. const result = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1219. GET_STOCK_MOVEMENT,
  1220. {
  1221. id: product.id,
  1222. },
  1223. );
  1224. const variant2 = result.product!.variants[0];
  1225. expect(variant2.stockOnHand).toBe(100);
  1226. expect(variant2.stockAllocated).toBe(0);
  1227. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1228. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1229. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1230. { type: StockMovementType.RELEASE, quantity: 1 },
  1231. { type: StockMovementType.RELEASE, quantity: 1 },
  1232. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1233. { type: StockMovementType.RELEASE, quantity: 1 },
  1234. { type: StockMovementType.RELEASE, quantity: 1 },
  1235. ]);
  1236. });
  1237. it('order history contains expected entries', async () => {
  1238. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1239. GET_ORDER_HISTORY,
  1240. {
  1241. id: orderId,
  1242. options: {
  1243. skip: 0,
  1244. },
  1245. },
  1246. );
  1247. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1248. {
  1249. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1250. data: {
  1251. from: 'Created',
  1252. to: 'AddingItems',
  1253. },
  1254. },
  1255. {
  1256. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1257. data: {
  1258. from: 'AddingItems',
  1259. to: 'ArrangingPayment',
  1260. },
  1261. },
  1262. {
  1263. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1264. data: {
  1265. paymentId: 'T_4',
  1266. from: 'Created',
  1267. to: 'Authorized',
  1268. },
  1269. },
  1270. {
  1271. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1272. data: {
  1273. from: 'ArrangingPayment',
  1274. to: 'PaymentAuthorized',
  1275. },
  1276. },
  1277. {
  1278. type: HistoryEntryType.ORDER_CANCELLATION,
  1279. data: {
  1280. orderItemIds: ['T_13'],
  1281. reason: 'cancel reason 1',
  1282. },
  1283. },
  1284. {
  1285. type: HistoryEntryType.ORDER_CANCELLATION,
  1286. data: {
  1287. orderItemIds: ['T_14'],
  1288. reason: 'cancel reason 2',
  1289. },
  1290. },
  1291. {
  1292. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1293. data: {
  1294. from: 'PaymentAuthorized',
  1295. to: 'Cancelled',
  1296. },
  1297. },
  1298. ]);
  1299. });
  1300. });
  1301. describe('refunds', () => {
  1302. let orderId: string;
  1303. let product: GetProductWithVariants.Product;
  1304. let productVariantId: string;
  1305. let paymentId: string;
  1306. let refundId: string;
  1307. beforeAll(async () => {
  1308. const result = await createTestOrder(
  1309. adminClient,
  1310. shopClient,
  1311. customers[0].emailAddress,
  1312. password,
  1313. );
  1314. orderId = result.orderId;
  1315. product = result.product;
  1316. productVariantId = result.productVariantId;
  1317. });
  1318. it('cannot refund from PaymentAuthorized state', async () => {
  1319. await proceedToArrangingPayment(shopClient);
  1320. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1321. orderGuard.assertSuccess(order);
  1322. expect(order.state).toBe('PaymentAuthorized');
  1323. paymentId = order.payments![0].id;
  1324. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1325. REFUND_ORDER,
  1326. {
  1327. input: {
  1328. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1329. shipping: 0,
  1330. adjustment: 0,
  1331. paymentId,
  1332. },
  1333. },
  1334. );
  1335. refundGuard.assertErrorResult(refundOrder);
  1336. expect(refundOrder.message).toBe('Cannot refund an Order in the "PaymentAuthorized" state');
  1337. expect(refundOrder.errorCode).toBe(ErrorCode.REFUND_ORDER_STATE_ERROR);
  1338. });
  1339. it('returns error result if no lines and no shipping', async () => {
  1340. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1341. id: orderId,
  1342. });
  1343. const { settlePayment } = await adminClient.query<
  1344. SettlePayment.Mutation,
  1345. SettlePayment.Variables
  1346. >(SETTLE_PAYMENT, {
  1347. id: order!.payments![0].id,
  1348. });
  1349. paymentGuard.assertSuccess(settlePayment);
  1350. expect(settlePayment!.state).toBe('Settled');
  1351. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1352. REFUND_ORDER,
  1353. {
  1354. input: {
  1355. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  1356. shipping: 0,
  1357. adjustment: 0,
  1358. paymentId,
  1359. },
  1360. },
  1361. );
  1362. refundGuard.assertErrorResult(refundOrder);
  1363. expect(refundOrder.message).toBe('Nothing to refund');
  1364. expect(refundOrder.errorCode).toBe(ErrorCode.NOTHING_TO_REFUND_ERROR);
  1365. });
  1366. it(
  1367. 'throws if paymentId not valid',
  1368. assertThrowsWithMessage(async () => {
  1369. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1370. id: orderId,
  1371. });
  1372. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1373. REFUND_ORDER,
  1374. {
  1375. input: {
  1376. lines: [],
  1377. shipping: 100,
  1378. adjustment: 0,
  1379. paymentId: 'T_999',
  1380. },
  1381. },
  1382. );
  1383. }, `No Payment with the id '999' could be found`),
  1384. );
  1385. it('returns error result if payment and order lines do not belong to the same Order', async () => {
  1386. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1387. id: orderId,
  1388. });
  1389. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1390. REFUND_ORDER,
  1391. {
  1392. input: {
  1393. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1394. shipping: 100,
  1395. adjustment: 0,
  1396. paymentId: 'T_1',
  1397. },
  1398. },
  1399. );
  1400. refundGuard.assertErrorResult(refundOrder);
  1401. expect(refundOrder.message).toBe('The Payment and OrderLines do not belong to the same Order');
  1402. expect(refundOrder.errorCode).toBe(ErrorCode.PAYMENT_ORDER_MISMATCH_ERROR);
  1403. });
  1404. it('creates a Refund to be manually settled', async () => {
  1405. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1406. id: orderId,
  1407. });
  1408. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1409. REFUND_ORDER,
  1410. {
  1411. input: {
  1412. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1413. shipping: order!.shipping,
  1414. adjustment: 0,
  1415. reason: 'foo',
  1416. paymentId,
  1417. },
  1418. },
  1419. );
  1420. refundGuard.assertSuccess(refundOrder);
  1421. expect(refundOrder.shipping).toBe(order!.shipping);
  1422. expect(refundOrder.items).toBe(order!.subTotalWithTax);
  1423. expect(refundOrder.total).toBe(order!.totalWithTax);
  1424. expect(refundOrder.transactionId).toBe(null);
  1425. expect(refundOrder.state).toBe('Pending');
  1426. refundId = refundOrder.id;
  1427. });
  1428. it('manually settle a Refund', async () => {
  1429. const { settleRefund } = await adminClient.query<SettleRefund.Mutation, SettleRefund.Variables>(
  1430. SETTLE_REFUND,
  1431. {
  1432. input: {
  1433. id: refundId,
  1434. transactionId: 'aaabbb',
  1435. },
  1436. },
  1437. );
  1438. refundGuard.assertSuccess(settleRefund);
  1439. expect(settleRefund.state).toBe('Settled');
  1440. expect(settleRefund.transactionId).toBe('aaabbb');
  1441. });
  1442. it('returns error result if attempting to refund the same item more than once', async () => {
  1443. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1444. id: orderId,
  1445. });
  1446. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1447. REFUND_ORDER,
  1448. {
  1449. input: {
  1450. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1451. shipping: order!.shipping,
  1452. adjustment: 0,
  1453. paymentId,
  1454. },
  1455. },
  1456. );
  1457. refundGuard.assertErrorResult(refundOrder);
  1458. expect(refundOrder.message).toBe(
  1459. 'The specified quantity is greater than the available OrderItems',
  1460. );
  1461. expect(refundOrder.errorCode).toBe(ErrorCode.QUANTITY_TOO_GREAT_ERROR);
  1462. });
  1463. it('order history contains expected entries', async () => {
  1464. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1465. GET_ORDER_HISTORY,
  1466. {
  1467. id: orderId,
  1468. options: {
  1469. skip: 0,
  1470. },
  1471. },
  1472. );
  1473. expect(order!.history.items.sort(sortById).map(pick(['type', 'data']))).toEqual([
  1474. {
  1475. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1476. data: {
  1477. from: 'Created',
  1478. to: 'AddingItems',
  1479. },
  1480. },
  1481. {
  1482. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1483. data: {
  1484. from: 'AddingItems',
  1485. to: 'ArrangingPayment',
  1486. },
  1487. },
  1488. {
  1489. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1490. data: {
  1491. paymentId: 'T_5',
  1492. from: 'Created',
  1493. to: 'Authorized',
  1494. },
  1495. },
  1496. {
  1497. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1498. data: {
  1499. from: 'ArrangingPayment',
  1500. to: 'PaymentAuthorized',
  1501. },
  1502. },
  1503. {
  1504. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1505. data: {
  1506. paymentId: 'T_5',
  1507. from: 'Authorized',
  1508. to: 'Settled',
  1509. },
  1510. },
  1511. {
  1512. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1513. data: {
  1514. from: 'PaymentAuthorized',
  1515. to: 'PaymentSettled',
  1516. },
  1517. },
  1518. {
  1519. type: HistoryEntryType.ORDER_REFUND_TRANSITION,
  1520. data: {
  1521. refundId: 'T_1',
  1522. reason: 'foo',
  1523. from: 'Pending',
  1524. to: 'Settled',
  1525. },
  1526. },
  1527. ]);
  1528. });
  1529. // https://github.com/vendure-ecommerce/vendure/issues/873
  1530. it('can add another refund if the first one fails', async () => {
  1531. const orderResult = await createTestOrder(
  1532. adminClient,
  1533. shopClient,
  1534. customers[0].emailAddress,
  1535. password,
  1536. );
  1537. await proceedToArrangingPayment(shopClient);
  1538. const order = await addPaymentToOrder(shopClient, singleStageRefundFailingPaymentMethod);
  1539. orderGuard.assertSuccess(order);
  1540. expect(order.state).toBe('PaymentSettled');
  1541. const { refundOrder: refund1 } = await adminClient.query<
  1542. RefundOrder.Mutation,
  1543. RefundOrder.Variables
  1544. >(REFUND_ORDER, {
  1545. input: {
  1546. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1547. shipping: order!.shipping,
  1548. adjustment: 0,
  1549. reason: 'foo',
  1550. paymentId: order.payments![0].id,
  1551. },
  1552. });
  1553. refundGuard.assertSuccess(refund1);
  1554. expect(refund1.state).toBe('Failed');
  1555. expect(refund1.total).toBe(order.totalWithTax);
  1556. const { refundOrder: refund2 } = await adminClient.query<
  1557. RefundOrder.Mutation,
  1558. RefundOrder.Variables
  1559. >(REFUND_ORDER, {
  1560. input: {
  1561. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1562. shipping: order!.shipping,
  1563. adjustment: 0,
  1564. reason: 'foo',
  1565. paymentId: order.payments![0].id,
  1566. },
  1567. });
  1568. refundGuard.assertSuccess(refund2);
  1569. expect(refund2.state).toBe('Settled');
  1570. expect(refund2.total).toBe(order.totalWithTax);
  1571. });
  1572. });
  1573. describe('order notes', () => {
  1574. let orderId: string;
  1575. let firstNoteId: string;
  1576. beforeAll(async () => {
  1577. const result = await createTestOrder(
  1578. adminClient,
  1579. shopClient,
  1580. customers[2].emailAddress,
  1581. password,
  1582. );
  1583. orderId = result.orderId;
  1584. });
  1585. it('private note', async () => {
  1586. const { addNoteToOrder } = await adminClient.query<
  1587. AddNoteToOrder.Mutation,
  1588. AddNoteToOrder.Variables
  1589. >(ADD_NOTE_TO_ORDER, {
  1590. input: {
  1591. id: orderId,
  1592. note: 'A private note',
  1593. isPublic: false,
  1594. },
  1595. });
  1596. expect(addNoteToOrder.id).toBe(orderId);
  1597. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1598. GET_ORDER_HISTORY,
  1599. {
  1600. id: orderId,
  1601. options: {
  1602. skip: 1,
  1603. },
  1604. },
  1605. );
  1606. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1607. {
  1608. type: HistoryEntryType.ORDER_NOTE,
  1609. data: {
  1610. note: 'A private note',
  1611. },
  1612. },
  1613. ]);
  1614. firstNoteId = order!.history.items[0].id;
  1615. const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
  1616. expect(activeOrder!.history.items.map(pick(['type']))).toEqual([
  1617. { type: HistoryEntryType.ORDER_STATE_TRANSITION },
  1618. ]);
  1619. });
  1620. it('public note', async () => {
  1621. const { addNoteToOrder } = await adminClient.query<
  1622. AddNoteToOrder.Mutation,
  1623. AddNoteToOrder.Variables
  1624. >(ADD_NOTE_TO_ORDER, {
  1625. input: {
  1626. id: orderId,
  1627. note: 'A public note',
  1628. isPublic: true,
  1629. },
  1630. });
  1631. expect(addNoteToOrder.id).toBe(orderId);
  1632. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1633. GET_ORDER_HISTORY,
  1634. {
  1635. id: orderId,
  1636. options: {
  1637. skip: 2,
  1638. },
  1639. },
  1640. );
  1641. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1642. {
  1643. type: HistoryEntryType.ORDER_NOTE,
  1644. data: {
  1645. note: 'A public note',
  1646. },
  1647. },
  1648. ]);
  1649. const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
  1650. expect(activeOrder!.history.items.map(pick(['type', 'data']))).toEqual([
  1651. {
  1652. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1653. data: {
  1654. from: 'Created',
  1655. to: 'AddingItems',
  1656. },
  1657. },
  1658. {
  1659. type: HistoryEntryType.ORDER_NOTE,
  1660. data: {
  1661. note: 'A public note',
  1662. },
  1663. },
  1664. ]);
  1665. });
  1666. it('update note', async () => {
  1667. const { updateOrderNote } = await adminClient.query<
  1668. UpdateOrderNote.Mutation,
  1669. UpdateOrderNote.Variables
  1670. >(UPDATE_ORDER_NOTE, {
  1671. input: {
  1672. noteId: firstNoteId,
  1673. note: 'An updated note',
  1674. },
  1675. });
  1676. expect(updateOrderNote.data).toEqual({
  1677. note: 'An updated note',
  1678. });
  1679. });
  1680. it('delete note', async () => {
  1681. const { order: before } = await adminClient.query<
  1682. GetOrderHistory.Query,
  1683. GetOrderHistory.Variables
  1684. >(GET_ORDER_HISTORY, { id: orderId });
  1685. expect(before?.history.totalItems).toBe(3);
  1686. const { deleteOrderNote } = await adminClient.query<
  1687. DeleteOrderNote.Mutation,
  1688. DeleteOrderNote.Variables
  1689. >(DELETE_ORDER_NOTE, {
  1690. id: firstNoteId,
  1691. });
  1692. expect(deleteOrderNote.result).toBe(DeletionResult.DELETED);
  1693. const { order: after } = await adminClient.query<
  1694. GetOrderHistory.Query,
  1695. GetOrderHistory.Variables
  1696. >(GET_ORDER_HISTORY, { id: orderId });
  1697. expect(after?.history.totalItems).toBe(2);
  1698. });
  1699. });
  1700. describe('multiple payments', () => {
  1701. const PARTIAL_PAYMENT_AMOUNT = 1000;
  1702. let orderId: string;
  1703. let orderTotalWithTax: number;
  1704. let payment1Id: string;
  1705. let payment2Id: string;
  1706. let productInOrder: GetProductWithVariants.Product;
  1707. beforeAll(async () => {
  1708. const result = await createTestOrder(
  1709. adminClient,
  1710. shopClient,
  1711. customers[1].emailAddress,
  1712. password,
  1713. );
  1714. orderId = result.orderId;
  1715. productInOrder = result.product;
  1716. });
  1717. it('adds a partial payment', async () => {
  1718. await proceedToArrangingPayment(shopClient);
  1719. const { addPaymentToOrder: order } = await shopClient.query<
  1720. AddPaymentToOrder.Mutation,
  1721. AddPaymentToOrder.Variables
  1722. >(ADD_PAYMENT, {
  1723. input: {
  1724. method: partialPaymentMethod.code,
  1725. metadata: {
  1726. amount: PARTIAL_PAYMENT_AMOUNT,
  1727. },
  1728. },
  1729. });
  1730. orderGuard.assertSuccess(order);
  1731. orderTotalWithTax = order.totalWithTax;
  1732. expect(order.state).toBe('ArrangingPayment');
  1733. expect(order.payments?.length).toBe(1);
  1734. expect(omit(order.payments![0], ['id'])).toEqual({
  1735. amount: PARTIAL_PAYMENT_AMOUNT,
  1736. metadata: {
  1737. public: {
  1738. amount: PARTIAL_PAYMENT_AMOUNT,
  1739. },
  1740. },
  1741. method: partialPaymentMethod.code,
  1742. state: 'Settled',
  1743. transactionId: '12345',
  1744. });
  1745. payment1Id = order.payments![0].id;
  1746. });
  1747. it('adds another payment to make up order totalWithTax', async () => {
  1748. const { addPaymentToOrder: order } = await shopClient.query<
  1749. AddPaymentToOrder.Mutation,
  1750. AddPaymentToOrder.Variables
  1751. >(ADD_PAYMENT, {
  1752. input: {
  1753. method: singleStageRefundablePaymentMethod.code,
  1754. metadata: {},
  1755. },
  1756. });
  1757. orderGuard.assertSuccess(order);
  1758. expect(order.state).toBe('PaymentSettled');
  1759. expect(order.payments?.length).toBe(2);
  1760. expect(
  1761. omit(order.payments?.find(p => p.method === singleStageRefundablePaymentMethod.code)!, [
  1762. 'id',
  1763. ]),
  1764. ).toEqual({
  1765. amount: orderTotalWithTax - PARTIAL_PAYMENT_AMOUNT,
  1766. metadata: {},
  1767. method: singleStageRefundablePaymentMethod.code,
  1768. state: 'Settled',
  1769. transactionId: '12345',
  1770. });
  1771. payment2Id = order.payments![1].id;
  1772. });
  1773. it('partial refunding of order with multiple payments', async () => {
  1774. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1775. id: orderId,
  1776. });
  1777. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1778. REFUND_ORDER,
  1779. {
  1780. input: {
  1781. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1782. shipping: 0,
  1783. adjustment: 0,
  1784. reason: 'foo',
  1785. paymentId: payment1Id,
  1786. },
  1787. },
  1788. );
  1789. refundGuard.assertSuccess(refundOrder);
  1790. expect(refundOrder.total).toBe(PARTIAL_PAYMENT_AMOUNT);
  1791. const { order: orderWithPayments } = await adminClient.query<
  1792. GetOrderWithPayments.Query,
  1793. GetOrderWithPayments.Variables
  1794. >(GET_ORDER_WITH_PAYMENTS, {
  1795. id: orderId,
  1796. });
  1797. expect(orderWithPayments?.payments![0].refunds.length).toBe(1);
  1798. expect(orderWithPayments?.payments![0].refunds[0].total).toBe(PARTIAL_PAYMENT_AMOUNT);
  1799. expect(orderWithPayments?.payments![1].refunds.length).toBe(1);
  1800. expect(orderWithPayments?.payments![1].refunds[0].total).toBe(
  1801. productInOrder.variants[0].priceWithTax - PARTIAL_PAYMENT_AMOUNT,
  1802. );
  1803. });
  1804. it('refunding remaining amount of order with multiple payments', async () => {
  1805. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1806. id: orderId,
  1807. });
  1808. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1809. REFUND_ORDER,
  1810. {
  1811. input: {
  1812. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1813. shipping: order!.shippingWithTax,
  1814. adjustment: 0,
  1815. reason: 'foo',
  1816. paymentId: payment1Id,
  1817. },
  1818. },
  1819. );
  1820. refundGuard.assertSuccess(refundOrder);
  1821. expect(refundOrder.total).toBe(order!.totalWithTax - order!.lines[0].unitPriceWithTax);
  1822. const { order: orderWithPayments } = await adminClient.query<
  1823. GetOrderWithPayments.Query,
  1824. GetOrderWithPayments.Variables
  1825. >(GET_ORDER_WITH_PAYMENTS, {
  1826. id: orderId,
  1827. });
  1828. expect(orderWithPayments?.payments![0].refunds.length).toBe(1);
  1829. expect(orderWithPayments?.payments![0].refunds[0].total).toBe(PARTIAL_PAYMENT_AMOUNT);
  1830. expect(orderWithPayments?.payments![1].refunds.length).toBe(2);
  1831. expect(orderWithPayments?.payments![1].refunds[0].total).toBe(
  1832. productInOrder.variants[0].priceWithTax - PARTIAL_PAYMENT_AMOUNT,
  1833. );
  1834. expect(orderWithPayments?.payments![1].refunds[1].total).toBe(
  1835. productInOrder.variants[0].priceWithTax + order!.shippingWithTax,
  1836. );
  1837. });
  1838. // https://github.com/vendure-ecommerce/vendure/issues/847
  1839. it('manual call to settlePayment works with multiple payments', async () => {
  1840. const result = await createTestOrder(
  1841. adminClient,
  1842. shopClient,
  1843. customers[1].emailAddress,
  1844. password,
  1845. );
  1846. await proceedToArrangingPayment(shopClient);
  1847. await shopClient.query<AddPaymentToOrder.Mutation, AddPaymentToOrder.Variables>(ADD_PAYMENT, {
  1848. input: {
  1849. method: partialPaymentMethod.code,
  1850. metadata: {
  1851. amount: PARTIAL_PAYMENT_AMOUNT,
  1852. authorizeOnly: true,
  1853. },
  1854. },
  1855. });
  1856. const { addPaymentToOrder: order } = await shopClient.query<
  1857. AddPaymentToOrder.Mutation,
  1858. AddPaymentToOrder.Variables
  1859. >(ADD_PAYMENT, {
  1860. input: {
  1861. method: singleStageRefundablePaymentMethod.code,
  1862. metadata: {},
  1863. },
  1864. });
  1865. orderGuard.assertSuccess(order);
  1866. expect(order.state).toBe('PaymentAuthorized');
  1867. const { settlePayment } = await adminClient.query<
  1868. SettlePayment.Mutation,
  1869. SettlePayment.Variables
  1870. >(SETTLE_PAYMENT, {
  1871. id: order.payments!.find(p => p.method === partialPaymentMethod.code)!.id,
  1872. });
  1873. paymentGuard.assertSuccess(settlePayment);
  1874. expect(settlePayment.state).toBe('Settled');
  1875. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1876. id: order.id,
  1877. });
  1878. expect(order2?.state).toBe('PaymentSettled');
  1879. });
  1880. });
  1881. describe('issues', () => {
  1882. // https://github.com/vendure-ecommerce/vendure/issues/639
  1883. it('returns fulfillments for Order with no lines', async () => {
  1884. await shopClient.asAnonymousUser();
  1885. // Apply a coupon code just to create an active order with no OrderLines
  1886. await shopClient.query<ApplyCouponCode.Mutation, ApplyCouponCode.Variables>(APPLY_COUPON_CODE, {
  1887. couponCode: 'TEST',
  1888. });
  1889. const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
  1890. const { order } = await adminClient.query<
  1891. GetOrderFulfillments.Query,
  1892. GetOrderFulfillments.Variables
  1893. >(GET_ORDER_FULFILLMENTS, {
  1894. id: activeOrder!.id,
  1895. });
  1896. expect(order?.fulfillments).toEqual([]);
  1897. });
  1898. // https://github.com/vendure-ecommerce/vendure/issues/603
  1899. it('orders correctly resolves quantities and OrderItems', async () => {
  1900. await shopClient.asAnonymousUser();
  1901. const { addItemToOrder } = await shopClient.query<
  1902. AddItemToOrder.Mutation,
  1903. AddItemToOrder.Variables
  1904. >(ADD_ITEM_TO_ORDER, {
  1905. productVariantId: 'T_1',
  1906. quantity: 2,
  1907. });
  1908. orderGuard.assertSuccess(addItemToOrder);
  1909. const { orders } = await adminClient.query<
  1910. GetOrderListWithQty.Query,
  1911. GetOrderListWithQty.Variables
  1912. >(GET_ORDERS_LIST_WITH_QUANTITIES, {
  1913. options: {
  1914. filter: {
  1915. code: { eq: addItemToOrder.code },
  1916. },
  1917. },
  1918. });
  1919. expect(orders.items[0].totalQuantity).toBe(2);
  1920. expect(orders.items[0].lines[0].quantity).toBe(2);
  1921. });
  1922. // https://github.com/vendure-ecommerce/vendure/issues/716
  1923. it('get an Order with a deleted ShippingMethod', async () => {
  1924. const { createShippingMethod: shippingMethod } = await adminClient.query<
  1925. CreateShippingMethod.Mutation,
  1926. CreateShippingMethod.Variables
  1927. >(CREATE_SHIPPING_METHOD, {
  1928. input: {
  1929. code: 'royal-mail',
  1930. translations: [{ languageCode: LanguageCode.en, name: 'Royal Mail', description: '' }],
  1931. fulfillmentHandler: manualFulfillmentHandler.code,
  1932. checker: {
  1933. code: defaultShippingEligibilityChecker.code,
  1934. arguments: [{ name: 'orderMinimum', value: '0' }],
  1935. },
  1936. calculator: {
  1937. code: defaultShippingCalculator.code,
  1938. arguments: [
  1939. { name: 'rate', value: '500' },
  1940. { name: 'taxRate', value: '0' },
  1941. ],
  1942. },
  1943. },
  1944. });
  1945. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  1946. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  1947. productVariantId: 'T_1',
  1948. quantity: 2,
  1949. });
  1950. await shopClient.query<SetShippingAddress.Mutation, SetShippingAddress.Variables>(
  1951. SET_SHIPPING_ADDRESS,
  1952. {
  1953. input: {
  1954. fullName: 'name',
  1955. streetLine1: '12 the street',
  1956. city: 'foo',
  1957. postalCode: '123456',
  1958. countryCode: 'US',
  1959. },
  1960. },
  1961. );
  1962. const { setOrderShippingMethod: order } = await shopClient.query<
  1963. SetShippingMethod.Mutation,
  1964. SetShippingMethod.Variables
  1965. >(SET_SHIPPING_METHOD, {
  1966. id: shippingMethod.id,
  1967. });
  1968. orderGuard.assertSuccess(order);
  1969. await adminClient.query<DeleteShippingMethod.Mutation, DeleteShippingMethod.Variables>(
  1970. DELETE_SHIPPING_METHOD,
  1971. {
  1972. id: shippingMethod.id,
  1973. },
  1974. );
  1975. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1976. id: order.id,
  1977. });
  1978. expect(order2?.shippingLines[0]).toEqual({
  1979. priceWithTax: 500,
  1980. shippingMethod: pick(shippingMethod, ['id', 'name', 'code', 'description']),
  1981. });
  1982. });
  1983. // https://github.com/vendure-ecommerce/vendure/issues/868
  1984. it('allows multiple refunds of same OrderLine', async () => {
  1985. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  1986. const { addItemToOrder } = await shopClient.query<
  1987. AddItemToOrder.Mutation,
  1988. AddItemToOrder.Variables
  1989. >(ADD_ITEM_TO_ORDER, {
  1990. productVariantId: 'T_1',
  1991. quantity: 2,
  1992. });
  1993. await proceedToArrangingPayment(shopClient);
  1994. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  1995. orderGuard.assertSuccess(order);
  1996. const { refundOrder: refund1 } = await adminClient.query<
  1997. RefundOrder.Mutation,
  1998. RefundOrder.Variables
  1999. >(REFUND_ORDER, {
  2000. input: {
  2001. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2002. shipping: 0,
  2003. adjustment: 0,
  2004. reason: 'foo',
  2005. paymentId: order.payments![0].id,
  2006. },
  2007. });
  2008. refundGuard.assertSuccess(refund1);
  2009. const { refundOrder: refund2 } = await adminClient.query<
  2010. RefundOrder.Mutation,
  2011. RefundOrder.Variables
  2012. >(REFUND_ORDER, {
  2013. input: {
  2014. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2015. shipping: 0,
  2016. adjustment: 0,
  2017. reason: 'foo',
  2018. paymentId: order.payments![0].id,
  2019. },
  2020. });
  2021. refundGuard.assertSuccess(refund2);
  2022. });
  2023. });
  2024. });
  2025. async function createTestOrder(
  2026. adminClient: SimpleGraphQLClient,
  2027. shopClient: SimpleGraphQLClient,
  2028. emailAddress: string,
  2029. password: string,
  2030. ): Promise<{
  2031. orderId: string;
  2032. product: GetProductWithVariants.Product;
  2033. productVariantId: string;
  2034. }> {
  2035. const result = await adminClient.query<GetProductWithVariants.Query, GetProductWithVariants.Variables>(
  2036. GET_PRODUCT_WITH_VARIANTS,
  2037. {
  2038. id: 'T_3',
  2039. },
  2040. );
  2041. const product = result.product!;
  2042. const productVariantId = product.variants[0].id;
  2043. // Set the ProductVariant to trackInventory
  2044. const { updateProductVariants } = await adminClient.query<
  2045. UpdateProductVariants.Mutation,
  2046. UpdateProductVariants.Variables
  2047. >(UPDATE_PRODUCT_VARIANTS, {
  2048. input: [
  2049. {
  2050. id: productVariantId,
  2051. trackInventory: GlobalFlag.TRUE,
  2052. },
  2053. ],
  2054. });
  2055. // Add the ProductVariant to the Order
  2056. await shopClient.asUserWithCredentials(emailAddress, password);
  2057. const { addItemToOrder } = await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(
  2058. ADD_ITEM_TO_ORDER,
  2059. {
  2060. productVariantId,
  2061. quantity: 2,
  2062. },
  2063. );
  2064. const orderId = (addItemToOrder as UpdatedOrder.Fragment).id;
  2065. return { product, productVariantId, orderId };
  2066. }
  2067. async function getUnfulfilledOrderLineInput(
  2068. client: SimpleGraphQLClient,
  2069. id: string,
  2070. ): Promise<OrderLineInput[]> {
  2071. const { order } = await client.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  2072. id,
  2073. });
  2074. const unfulfilledItems =
  2075. order?.lines.filter(l => {
  2076. const items = l.items.filter(i => i.fulfillment === null);
  2077. return items.length > 0 ? true : false;
  2078. }) || [];
  2079. return unfulfilledItems.map(l => ({
  2080. orderLineId: l.id,
  2081. quantity: l.items.length,
  2082. }));
  2083. }
  2084. export const GET_ORDER_LIST_FULFILLMENTS = gql`
  2085. query GetOrderListFulfillments {
  2086. orders {
  2087. items {
  2088. id
  2089. state
  2090. fulfillments {
  2091. id
  2092. state
  2093. nextStates
  2094. method
  2095. }
  2096. }
  2097. }
  2098. }
  2099. `;
  2100. export const GET_ORDER_FULFILLMENT_ITEMS = gql`
  2101. query GetOrderFulfillmentItems($id: ID!) {
  2102. order(id: $id) {
  2103. id
  2104. state
  2105. fulfillments {
  2106. ...Fulfillment
  2107. }
  2108. }
  2109. }
  2110. ${FULFILLMENT_FRAGMENT}
  2111. `;
  2112. const REFUND_FRAGMENT = gql`
  2113. fragment Refund on Refund {
  2114. id
  2115. state
  2116. items
  2117. transactionId
  2118. shipping
  2119. total
  2120. metadata
  2121. }
  2122. `;
  2123. export const REFUND_ORDER = gql`
  2124. mutation RefundOrder($input: RefundOrderInput!) {
  2125. refundOrder(input: $input) {
  2126. ...Refund
  2127. ... on ErrorResult {
  2128. errorCode
  2129. message
  2130. }
  2131. }
  2132. }
  2133. ${REFUND_FRAGMENT}
  2134. `;
  2135. export const SETTLE_REFUND = gql`
  2136. mutation SettleRefund($input: SettleRefundInput!) {
  2137. settleRefund(input: $input) {
  2138. ...Refund
  2139. ... on ErrorResult {
  2140. errorCode
  2141. message
  2142. }
  2143. }
  2144. }
  2145. ${REFUND_FRAGMENT}
  2146. `;
  2147. export const ADD_NOTE_TO_ORDER = gql`
  2148. mutation AddNoteToOrder($input: AddNoteToOrderInput!) {
  2149. addNoteToOrder(input: $input) {
  2150. id
  2151. }
  2152. }
  2153. `;
  2154. export const UPDATE_ORDER_NOTE = gql`
  2155. mutation UpdateOrderNote($input: UpdateOrderNoteInput!) {
  2156. updateOrderNote(input: $input) {
  2157. id
  2158. data
  2159. isPublic
  2160. }
  2161. }
  2162. `;
  2163. export const DELETE_ORDER_NOTE = gql`
  2164. mutation DeleteOrderNote($id: ID!) {
  2165. deleteOrderNote(id: $id) {
  2166. result
  2167. message
  2168. }
  2169. }
  2170. `;
  2171. const GET_ORDER_WITH_PAYMENTS = gql`
  2172. query GetOrderWithPayments($id: ID!) {
  2173. order(id: $id) {
  2174. id
  2175. payments {
  2176. id
  2177. errorMessage
  2178. metadata
  2179. refunds {
  2180. id
  2181. total
  2182. }
  2183. }
  2184. }
  2185. }
  2186. `;
  2187. const GET_ORDERS_LIST_WITH_QUANTITIES = gql`
  2188. query GetOrderListWithQty($options: OrderListOptions) {
  2189. orders(options: $options) {
  2190. items {
  2191. id
  2192. code
  2193. totalQuantity
  2194. lines {
  2195. id
  2196. quantity
  2197. }
  2198. }
  2199. }
  2200. }
  2201. `;