order.e2e-spec.ts 97 KB

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