order.e2e-spec.ts 82 KB

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