order.e2e-spec.ts 101 KB

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