order.e2e-spec.ts 97 KB

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