order.e2e-spec.ts 99 KB

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