PrintModalSeparateJobsQueue.test.ts 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. /**
  2. * Queue loop for "Separate jobs" when several sliced files are selected (#3462).
  3. */
  4. import { describe, it, expect } from 'vitest';
  5. import { fileHasQueuedPair, queueSeparateJobs, runAsapTail } from '../../components/PrintModal/separateJobs';
  6. import type { VariantCandidate } from '../../components/PrintModal/VariantCandidates';
  7. import type { PrintQueueItemCreate } from '../../api/client';
  8. const file = (id: number): VariantCandidate => ({
  9. id,
  10. filename: `f${id}.gcode.3mf`,
  11. sliced_for_model: 'A1',
  12. });
  13. const buildItem = (f: VariantCandidate, _plate: number | null, printerId: number | null) =>
  14. ({ library_file_id: f.id, printer_id: printerId }) as PrintQueueItemCreate;
  15. function setup(failOnFileId?: number) {
  16. const calls: PrintQueueItemCreate[] = [];
  17. const addToQueue = async (data: PrintQueueItemCreate) => {
  18. if (failOnFileId !== undefined && data.library_file_id === failOnFileId) {
  19. throw new Error('nope');
  20. }
  21. calls.push(data);
  22. };
  23. return { calls, addToQueue };
  24. }
  25. describe('queueSeparateJobs', () => {
  26. it('queues files outside, printers inside', async () => {
  27. const { calls, addToQueue } = setup();
  28. const result = await queueSeparateJobs({
  29. files: [file(11), file(12)],
  30. plateByFile: {},
  31. printerIds: [1, 2],
  32. quantity: 1,
  33. asap: false,
  34. buildItem,
  35. addToQueue,
  36. });
  37. expect(calls.map((c) => [c.library_file_id, c.printer_id])).toEqual([
  38. [11, 1],
  39. [11, 2],
  40. [12, 1],
  41. [12, 2],
  42. ]);
  43. expect(result).toEqual({
  44. itemsCreated: 4,
  45. asapInserted: 0,
  46. queuedFileIds: [11, 12],
  47. queuedPairs: ['11:1', '11:2', '12:1', '12:2'],
  48. // The test's addToQueue returns nothing, so there are no ids to keep.
  49. queuedItemIds: [],
  50. queuedBatchIds: [],
  51. failure: null,
  52. });
  53. });
  54. it('skips file and printer pairs a previous submit already queued', async () => {
  55. const { calls, addToQueue } = setup();
  56. const progress: Array<[number, number]> = [];
  57. const result = await queueSeparateJobs({
  58. files: [file(11), file(12)],
  59. plateByFile: {},
  60. printerIds: [1, 2],
  61. alreadyQueued: new Set(['11:1']),
  62. quantity: 1,
  63. asap: false,
  64. buildItem,
  65. addToQueue,
  66. onProgress: (c, t) => progress.push([c, t]),
  67. });
  68. expect(calls.map((c) => [c.library_file_id, c.printer_id])).toEqual([
  69. [11, 2],
  70. [12, 1],
  71. [12, 2],
  72. ]);
  73. expect(result.itemsCreated).toBe(3);
  74. expect(result.queuedFileIds).toEqual([11, 12]);
  75. expect(result.queuedPairs).toEqual(['11:2', '12:1', '12:2']);
  76. expect(progress).toEqual([[1, 3], [2, 3], [3, 3]]);
  77. });
  78. it('reports the pairs queued before a refusal', async () => {
  79. const calls: PrintQueueItemCreate[] = [];
  80. const result = await queueSeparateJobs({
  81. files: [file(11), file(12)],
  82. plateByFile: {},
  83. printerIds: [1, 2],
  84. quantity: 1,
  85. asap: false,
  86. buildItem,
  87. addToQueue: async (data) => {
  88. if (data.library_file_id === 11 && data.printer_id === 2) throw new Error('nope');
  89. calls.push(data);
  90. },
  91. });
  92. expect(result.queuedPairs).toEqual(['11:1']);
  93. expect(result.queuedFileIds).toEqual([]);
  94. expect(result.failure?.file.id).toBe(11);
  95. });
  96. it('passes the chosen plate, null when the file has none', async () => {
  97. const plates: Array<number | null> = [];
  98. const { addToQueue } = setup();
  99. await queueSeparateJobs({
  100. files: [file(11), file(12)],
  101. plateByFile: { 11: 3 },
  102. printerIds: [null],
  103. quantity: 1,
  104. asap: false,
  105. buildItem: (f, plateId, printerId) => {
  106. plates.push(plateId);
  107. return buildItem(f, plateId, printerId);
  108. },
  109. addToQueue,
  110. });
  111. expect(plates).toEqual([3, null]);
  112. });
  113. it('sets quantity only above 1', async () => {
  114. const two = setup();
  115. await queueSeparateJobs({
  116. files: [file(11)], plateByFile: {}, printerIds: [1], quantity: 2, asap: false,
  117. buildItem, addToQueue: two.addToQueue,
  118. });
  119. expect(two.calls[0].quantity).toBe(2);
  120. const one = setup();
  121. await queueSeparateJobs({
  122. files: [file(11)], plateByFile: {}, printerIds: [1], quantity: 1, asap: false,
  123. buildItem, addToQueue: one.addToQueue,
  124. });
  125. expect('quantity' in one.calls[0]).toBe(false);
  126. });
  127. it('numbers ASAP positions by quantity, and omits them otherwise', async () => {
  128. const asap = setup();
  129. await queueSeparateJobs({
  130. files: [file(11), file(12)], plateByFile: {}, printerIds: [1], quantity: 2, asap: true,
  131. buildItem, addToQueue: asap.addToQueue,
  132. });
  133. expect(asap.calls.map((c) => [c.insert_at_top, c.insert_position])).toEqual([
  134. [true, 1],
  135. [true, 3],
  136. ]);
  137. const plain = setup();
  138. await queueSeparateJobs({
  139. files: [file(11), file(12)], plateByFile: {}, printerIds: [1], quantity: 2, asap: false,
  140. buildItem, addToQueue: plain.addToQueue,
  141. });
  142. for (const c of plain.calls) {
  143. expect('insert_at_top' in c).toBe(false);
  144. expect('insert_position' in c).toBe(false);
  145. }
  146. });
  147. it('continues the ASAP positions of an earlier submit and reports the new count', async () => {
  148. // Two items went in at 1 and 2 before a refusal; the rest must follow
  149. // them, not jump ahead at 1.
  150. const { calls, addToQueue } = setup();
  151. const result = await queueSeparateJobs({
  152. files: [file(13)], plateByFile: {}, printerIds: [1], quantity: 1, asap: true,
  153. asapInsertedBefore: 2,
  154. buildItem, addToQueue,
  155. });
  156. expect(calls[0].insert_position).toBe(3);
  157. expect(result.asapInserted).toBe(3);
  158. });
  159. it('reports the ASAP count reached before a refusal', async () => {
  160. const { addToQueue } = setup(12);
  161. const result = await queueSeparateJobs({
  162. files: [file(11), file(12)], plateByFile: {}, printerIds: [1], quantity: 2, asap: true,
  163. buildItem, addToQueue,
  164. });
  165. expect(result.asapInserted).toBe(2);
  166. });
  167. it('stops at the first refusal and reports it', async () => {
  168. const { calls, addToQueue } = setup(12);
  169. const result = await queueSeparateJobs({
  170. files: [file(11), file(12), file(13)],
  171. plateByFile: {},
  172. printerIds: [1],
  173. quantity: 1,
  174. asap: false,
  175. buildItem,
  176. addToQueue,
  177. });
  178. expect(result.itemsCreated).toBe(1);
  179. expect(result.queuedFileIds).toEqual([11]);
  180. expect(result.failure?.file.id).toBe(12);
  181. expect(result.failure?.message).toBe('nope');
  182. expect(calls.map((c) => c.library_file_id)).toEqual([11]);
  183. });
  184. it('reports progress as current/total', async () => {
  185. const { addToQueue } = setup();
  186. const progress: Array<[number, number]> = [];
  187. await queueSeparateJobs({
  188. files: [file(11), file(12)],
  189. plateByFile: {},
  190. printerIds: [1, 2],
  191. quantity: 1,
  192. asap: false,
  193. buildItem,
  194. addToQueue,
  195. onProgress: (c, t) => progress.push([c, t]),
  196. });
  197. expect(progress).toEqual([[1, 4], [2, 4], [3, 4], [4, 4]]);
  198. });
  199. });
  200. describe('fileHasQueuedPair', () => {
  201. it('finds a file on any printer, and only that file', () => {
  202. const pairs = new Set(['11:2', '112:1']);
  203. expect(fileHasQueuedPair(pairs, 11)).toBe(true);
  204. expect(fileHasQueuedPair(pairs, 1)).toBe(false);
  205. expect(fileHasQueuedPair(pairs, 12)).toBe(false);
  206. expect(fileHasQueuedPair(new Set(['13:null']), 13)).toBe(true);
  207. });
  208. });
  209. describe('runAsapTail (#3471 review)', () => {
  210. const queue = [
  211. { id: 1, position: 1, batch_id: null },
  212. { id: 2, position: 2, batch_id: 40 },
  213. { id: 3, position: 3, batch_id: 40 },
  214. { id: 4, position: 4, batch_id: null },
  215. ];
  216. it("is the last position of the run's own items", () => {
  217. expect(runAsapTail(queue, [1], [])).toBe(1);
  218. });
  219. it('counts the copies of a batch the run created', () => {
  220. expect(runAsapTail(queue, [2], [40])).toBe(3);
  221. });
  222. it('is 0 when none of them is pending any more', () => {
  223. expect(runAsapTail(queue, [99], [77])).toBe(0);
  224. });
  225. });
  226. describe('queueSeparateJobs records what it created (#3471 review)', () => {
  227. it("keeps each POST's item id and batch", async () => {
  228. let next = 0;
  229. const result = await queueSeparateJobs({
  230. files: [file(11), file(12)],
  231. plateByFile: {},
  232. printerIds: [1],
  233. quantity: 2,
  234. asap: false,
  235. buildItem,
  236. addToQueue: async () => {
  237. next++;
  238. return { id: 100 + next, batch_id: 200 + next };
  239. },
  240. });
  241. expect(result.queuedItemIds).toEqual([101, 102]);
  242. expect(result.queuedBatchIds).toEqual([201, 202]);
  243. });
  244. });