Uppy.test.ts 69 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570
  1. /* eslint-disable @typescript-eslint/no-non-null-assertion */
  2. /* eslint-disable @typescript-eslint/ban-ts-comment */
  3. /* eslint no-console: "off", no-restricted-syntax: "off" */
  4. import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
  5. import assert from 'node:assert'
  6. import fs from 'node:fs'
  7. import path from 'node:path'
  8. import prettierBytes from '@transloadit/prettier-bytes'
  9. import type { Body, Meta } from '@uppy/utils/lib/UppyFile'
  10. import Core from './index.ts'
  11. import UIPlugin from './UIPlugin.ts'
  12. import BasePlugin, { type PluginOpts } from './BasePlugin.ts'
  13. import { debugLogger } from './loggers.ts'
  14. import AcquirerPlugin1 from './mocks/acquirerPlugin1.ts'
  15. import AcquirerPlugin2 from './mocks/acquirerPlugin2.ts'
  16. import InvalidPlugin from './mocks/invalidPlugin.ts'
  17. import InvalidPluginWithoutId from './mocks/invalidPluginWithoutId.ts'
  18. import InvalidPluginWithoutType from './mocks/invalidPluginWithoutType.ts'
  19. // @ts-expect-error trying to import a file from outside the package
  20. import DeepFrozenStore from '../../../../e2e/cypress/fixtures/DeepFrozenStore.mjs'
  21. import type { State } from './Uppy.ts'
  22. // eslint-disable-next-line no-restricted-globals
  23. const sampleImage = fs.readFileSync(
  24. path.join(__dirname, '../../../../e2e/cypress/fixtures/images/image.jpg'),
  25. )
  26. // @ts-expect-error type object can be second argument
  27. const testImage = new File([sampleImage], { type: 'image/jpeg' })
  28. describe('src/Core', () => {
  29. const RealCreateObjectUrl = globalThis.URL.createObjectURL
  30. beforeEach(() => {
  31. globalThis.URL.createObjectURL = vi.fn().mockReturnValue('newUrl')
  32. })
  33. afterEach(() => {
  34. globalThis.URL.createObjectURL = RealCreateObjectUrl
  35. })
  36. it('should expose a class', () => {
  37. const core = new Core()
  38. expect(core.constructor.name).toEqual('Uppy')
  39. })
  40. it('should have a string `id` option that defaults to "uppy"', () => {
  41. const core = new Core()
  42. expect(core.getID()).toEqual('uppy')
  43. const core2 = new Core({ id: 'profile' })
  44. expect(core2.getID()).toEqual('profile')
  45. })
  46. describe('plugins', () => {
  47. it('should add a plugin to the plugin stack', () => {
  48. const core = new Core()
  49. core.use(AcquirerPlugin1)
  50. expect(
  51. // @ts-expect-error untyped
  52. Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
  53. .length,
  54. ).toEqual(1)
  55. })
  56. it('should be able to .use() without passing generics again', () => {
  57. interface TestOpts extends PluginOpts {
  58. foo?: string
  59. bar: string
  60. }
  61. class TestPlugin<M extends Meta, B extends Body> extends BasePlugin<
  62. TestOpts,
  63. M,
  64. B
  65. > {
  66. foo: string
  67. constructor(uppy: Core<M, B>, opts: TestOpts) {
  68. super(uppy, opts)
  69. this.id = 'Test'
  70. this.type = 'acquirer'
  71. this.foo = opts?.foo ?? 'bar'
  72. }
  73. }
  74. new Core().use(TestPlugin)
  75. new Core().use(TestPlugin, { foo: '', bar: '' })
  76. // @ts-expect-error boolean not allowed
  77. new Core().use(TestPlugin, { foo: false })
  78. // @ts-expect-error missing option
  79. new Core().use(TestPlugin, { foo: '' })
  80. })
  81. it('should prevent the same plugin from being added more than once', () => {
  82. const core = new Core()
  83. core.use(AcquirerPlugin1)
  84. expect(() => {
  85. core.use(AcquirerPlugin1)
  86. }).toThrowErrorMatchingSnapshot()
  87. })
  88. it('should not be able to add an invalid plugin', () => {
  89. const core = new Core()
  90. expect(() => {
  91. // @ts-expect-error expected
  92. core.use(InvalidPlugin)
  93. }).toThrowErrorMatchingSnapshot()
  94. })
  95. it('should not be able to add a plugin that has no id', () => {
  96. const core = new Core()
  97. expect(() =>
  98. core.use(InvalidPluginWithoutId),
  99. ).toThrowErrorMatchingSnapshot()
  100. })
  101. it('should not be able to add a plugin that has no type', () => {
  102. const core = new Core()
  103. expect(() =>
  104. core.use(InvalidPluginWithoutType),
  105. ).toThrowErrorMatchingSnapshot()
  106. })
  107. it('should return the plugin that matches the specified name', () => {
  108. const core = new Core()
  109. expect(core.getPlugin('foo')).toEqual(undefined)
  110. core.use(AcquirerPlugin1)
  111. const plugin = core.getPlugin('TestSelector1')
  112. // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
  113. expect(plugin!.id).toEqual('TestSelector1')
  114. expect(plugin instanceof UIPlugin)
  115. })
  116. it('should call the specified method on all the plugins', () => {
  117. const core = new Core()
  118. core.use(AcquirerPlugin1)
  119. core.use(AcquirerPlugin2)
  120. core.iteratePlugins((plugin) => {
  121. // @ts-ignore
  122. plugin.run('hello')
  123. })
  124. expect(
  125. // @ts-ignore
  126. core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
  127. .calls.length,
  128. ).toEqual(1)
  129. expect(
  130. // @ts-ignore
  131. core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
  132. .calls[0],
  133. ).toEqual(['hello'])
  134. expect(
  135. // @ts-ignore
  136. core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.run.mock
  137. .calls.length,
  138. ).toEqual(1)
  139. expect(
  140. // @ts-ignore
  141. core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.run.mock
  142. .calls[0],
  143. ).toEqual(['hello'])
  144. })
  145. it('should uninstall and the remove the specified plugin', () => {
  146. const core = new Core()
  147. core.use(AcquirerPlugin1)
  148. core.use(AcquirerPlugin2)
  149. expect(
  150. // @ts-ignore
  151. Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
  152. .length,
  153. ).toEqual(2)
  154. const plugin = core.getPlugin('TestSelector1')
  155. core.removePlugin(plugin!)
  156. expect(
  157. // @ts-ignore
  158. Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
  159. .length,
  160. ).toEqual(1)
  161. // @ts-ignore
  162. expect(plugin.mocks.uninstall.mock.calls.length).toEqual(1)
  163. expect(
  164. // @ts-ignore
  165. core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
  166. .calls.length,
  167. ).toEqual(0)
  168. })
  169. })
  170. describe('state', () => {
  171. it('should update all the plugins with the new state when the updateAll method is called', () => {
  172. const core = new Core()
  173. core.use(AcquirerPlugin1)
  174. core.use(AcquirerPlugin2)
  175. core.updateAll({ foo: 'bar' })
  176. expect(
  177. // @ts-ignore
  178. core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
  179. .mock.calls.length,
  180. ).toEqual(1)
  181. expect(
  182. // @ts-ignore
  183. core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
  184. .mock.calls[0],
  185. ).toEqual([{ foo: 'bar' }])
  186. expect(
  187. // @ts-ignore
  188. core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
  189. .mock.calls.length,
  190. ).toEqual(1)
  191. expect(
  192. // @ts-ignore
  193. core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
  194. .mock.calls[0],
  195. ).toEqual([{ foo: 'bar' }])
  196. })
  197. it('should update the state', () => {
  198. const core = new Core()
  199. const stateUpdateEventMock = vi.fn()
  200. core.on('state-update', stateUpdateEventMock)
  201. core.use(AcquirerPlugin1)
  202. core.use(AcquirerPlugin2)
  203. core.setState({ foo: 'bar', bee: 'boo' })
  204. core.setState({ foo: 'baar' })
  205. const newState = {
  206. bee: 'boo',
  207. capabilities: {
  208. individualCancellation: true,
  209. uploadProgress: true,
  210. resumableUploads: false,
  211. },
  212. files: {},
  213. currentUploads: {},
  214. error: null,
  215. allowNewUpload: true,
  216. foo: 'baar',
  217. info: [],
  218. meta: {},
  219. plugins: {},
  220. totalProgress: 0,
  221. recoveredState: null,
  222. }
  223. expect(core.getState()).toEqual(newState)
  224. expect(
  225. // @ts-ignore
  226. core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
  227. .mock.calls[1],
  228. ).toEqual([newState])
  229. expect(
  230. // @ts-ignore
  231. core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
  232. .mock.calls[1],
  233. ).toEqual([newState])
  234. expect(stateUpdateEventMock.mock.calls.length).toEqual(2)
  235. // current state
  236. expect(stateUpdateEventMock.mock.calls[1][0]).toEqual({
  237. bee: 'boo',
  238. capabilities: {
  239. individualCancellation: true,
  240. uploadProgress: true,
  241. resumableUploads: false,
  242. },
  243. files: {},
  244. currentUploads: {},
  245. error: null,
  246. allowNewUpload: true,
  247. foo: 'bar',
  248. info: [],
  249. meta: {},
  250. plugins: {},
  251. totalProgress: 0,
  252. recoveredState: null,
  253. })
  254. // new state
  255. expect(stateUpdateEventMock.mock.calls[1][1]).toEqual({
  256. bee: 'boo',
  257. capabilities: {
  258. individualCancellation: true,
  259. uploadProgress: true,
  260. resumableUploads: false,
  261. },
  262. files: {},
  263. currentUploads: {},
  264. error: null,
  265. allowNewUpload: true,
  266. foo: 'baar',
  267. info: [],
  268. meta: {},
  269. plugins: {},
  270. totalProgress: 0,
  271. recoveredState: null,
  272. })
  273. })
  274. it('should get the state', () => {
  275. const core = new Core()
  276. core.setState({ foo: 'bar' })
  277. expect(core.getState()).toMatchObject({ foo: 'bar' })
  278. })
  279. })
  280. it('should cancel all when the `cancelAll` method is called', () => {
  281. // use DeepFrozenStore in some tests to make sure we are not mutating things
  282. const core = new Core({
  283. store: DeepFrozenStore(),
  284. })
  285. // const corePauseEventMock = vi.fn()
  286. const coreCancelEventMock = vi.fn()
  287. const coreStateUpdateEventMock = vi.fn()
  288. core.on('cancel-all', coreCancelEventMock)
  289. core.on('state-update', coreStateUpdateEventMock)
  290. core.setState({ foo: 'bar', totalProgress: 30 })
  291. core.cancelAll()
  292. expect(coreCancelEventMock).toHaveBeenCalledWith(
  293. { reason: 'user' },
  294. undefined,
  295. undefined,
  296. undefined,
  297. undefined,
  298. undefined,
  299. )
  300. expect(coreStateUpdateEventMock.mock.calls.length).toEqual(2)
  301. expect(coreStateUpdateEventMock.mock.calls[1][1]).toEqual({
  302. capabilities: {
  303. individualCancellation: true,
  304. uploadProgress: true,
  305. resumableUploads: false,
  306. },
  307. files: {},
  308. currentUploads: {},
  309. allowNewUpload: true,
  310. error: null,
  311. foo: 'bar',
  312. info: [],
  313. meta: {},
  314. plugins: {},
  315. totalProgress: 0,
  316. recoveredState: null,
  317. })
  318. })
  319. it('should clear all uploads and files on cancelAll()', () => {
  320. const core = new Core()
  321. core.addFile({
  322. source: 'vi',
  323. name: 'foo1.jpg',
  324. type: 'image/jpeg',
  325. data: testImage,
  326. })
  327. core.addFile({
  328. source: 'vi',
  329. name: 'foo2.jpg',
  330. type: 'image/jpeg',
  331. data: testImage,
  332. })
  333. const fileIDs = Object.keys(core.getState().files)
  334. // @ts-ignore
  335. const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
  336. expect(core.getState().currentUploads[id]).toBeDefined()
  337. expect(Object.keys(core.getState().files).length).toEqual(2)
  338. core.cancelAll()
  339. expect(core.getState().currentUploads[id]).toBeUndefined()
  340. expect(Object.keys(core.getState().files).length).toEqual(0)
  341. })
  342. it('should allow remove all uploads when individualCancellation is disabled', () => {
  343. const core = new Core()
  344. const { capabilities } = core.getState()
  345. core.setState({
  346. capabilities: {
  347. ...capabilities,
  348. individualCancellation: false,
  349. },
  350. })
  351. core.addFile({
  352. source: 'vi',
  353. name: 'foo1.jpg',
  354. type: 'image/jpeg',
  355. data: testImage,
  356. })
  357. core.addFile({
  358. source: 'vi',
  359. name: 'foo2.jpg',
  360. type: 'image/jpeg',
  361. data: testImage,
  362. })
  363. const fileIDs = Object.keys(core.getState().files)
  364. // @ts-ignore
  365. const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
  366. expect(core.getState().currentUploads[id]).toBeDefined()
  367. expect(Object.keys(core.getState().files).length).toEqual(2)
  368. core.removeFiles(fileIDs)
  369. expect(core.getState().currentUploads[id]).toBeUndefined()
  370. expect(Object.keys(core.getState().files).length).toEqual(0)
  371. })
  372. it('should disallow remove one upload when individualCancellation is disabled', () => {
  373. const core = new Core()
  374. const { capabilities } = core.getState()
  375. core.setState({
  376. capabilities: {
  377. ...capabilities,
  378. individualCancellation: false,
  379. },
  380. })
  381. core.addFile({
  382. source: 'vi',
  383. name: 'foo1.jpg',
  384. type: 'image/jpeg',
  385. data: testImage,
  386. })
  387. core.addFile({
  388. source: 'vi',
  389. name: 'foo2.jpg',
  390. type: 'image/jpeg',
  391. data: testImage,
  392. })
  393. const fileIDs = Object.keys(core.getState().files)
  394. // @ts-ignore
  395. const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
  396. expect(core.getState().currentUploads[id]).toBeDefined()
  397. expect(Object.keys(core.getState().files).length).toEqual(2)
  398. assert.throws(
  399. () => core.removeFile(fileIDs[0]),
  400. /individualCancellation is disabled/,
  401. )
  402. expect(core.getState().currentUploads[id]).toBeDefined()
  403. expect(Object.keys(core.getState().files).length).toEqual(2)
  404. })
  405. it('should allow remove one upload when individualCancellation is enabled', () => {
  406. const core = new Core()
  407. const { capabilities } = core.getState()
  408. core.setState({
  409. capabilities: {
  410. ...capabilities,
  411. individualCancellation: true,
  412. },
  413. })
  414. core.addFile({
  415. source: 'vi',
  416. name: 'foo1.jpg',
  417. type: 'image/jpeg',
  418. data: testImage,
  419. })
  420. core.addFile({
  421. source: 'vi',
  422. name: 'foo2.jpg',
  423. type: 'image/jpeg',
  424. data: testImage,
  425. })
  426. const fileIDs = Object.keys(core.getState().files)
  427. // @ts-ignore
  428. const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
  429. expect(core.getState().currentUploads[id]).toBeDefined()
  430. expect(Object.keys(core.getState().files).length).toEqual(2)
  431. core.removeFile(fileIDs[0])
  432. expect(core.getState().currentUploads[id]).toBeDefined()
  433. expect(Object.keys(core.getState().files).length).toEqual(1)
  434. })
  435. it('should close, reset and uninstall when the close method is called', () => {
  436. // use DeepFrozenStore in some tests to make sure we are not mutating things
  437. const core = new Core({
  438. store: DeepFrozenStore(),
  439. })
  440. core.use(AcquirerPlugin1)
  441. const coreCancelEventMock = vi.fn()
  442. const coreStateUpdateEventMock = vi.fn()
  443. // @ts-ignore
  444. const plugin = core[Symbol.for('uppy test: getPlugins')]('acquirer')[0]
  445. core.on('cancel-all', coreCancelEventMock)
  446. core.on('state-update', coreStateUpdateEventMock)
  447. core.close()
  448. expect(coreCancelEventMock).toHaveBeenCalledWith(
  449. { reason: 'user' },
  450. undefined,
  451. undefined,
  452. undefined,
  453. undefined,
  454. undefined,
  455. )
  456. expect(coreStateUpdateEventMock.mock.calls.length).toEqual(1)
  457. expect(coreStateUpdateEventMock.mock.calls[0][1]).toEqual({
  458. capabilities: {
  459. individualCancellation: true,
  460. uploadProgress: true,
  461. resumableUploads: false,
  462. },
  463. files: {},
  464. currentUploads: {},
  465. allowNewUpload: true,
  466. error: null,
  467. info: [],
  468. meta: {},
  469. plugins: {},
  470. totalProgress: 0,
  471. recoveredState: null,
  472. })
  473. expect(plugin.mocks.uninstall.mock.calls.length).toEqual(1)
  474. const pluginIteration = vi.fn()
  475. core.iteratePlugins(pluginIteration)
  476. expect(pluginIteration.mock.calls.length).toEqual(0)
  477. })
  478. describe('upload hooks', () => {
  479. it('should add data returned from upload hooks to the .upload() result', () => {
  480. const core = new Core()
  481. core.addPreProcessor((_, uploadID) => {
  482. core.addResultData(uploadID, { pre: 'ok' })
  483. })
  484. core.addPostProcessor((_, uploadID) => {
  485. core.addResultData(uploadID, { post: 'ok' })
  486. })
  487. core.addUploader((_, uploadID) => {
  488. core.addResultData(uploadID, { upload: 'ok' })
  489. })
  490. return core.upload().then((result) => {
  491. if (result) {
  492. expect(result.pre).toBe('ok')
  493. expect(result.upload).toBe('ok')
  494. expect(result.post).toBe('ok')
  495. }
  496. })
  497. })
  498. })
  499. describe('preprocessors', () => {
  500. it('should add and remove preprocessor', () => {
  501. const core = new Core()
  502. // eslint-disable-next-line @typescript-eslint/no-empty-function
  503. const preprocessor = () => {}
  504. expect(core.removePreProcessor(preprocessor)).toBe(false)
  505. core.addPreProcessor(preprocessor)
  506. expect(core.removePreProcessor(preprocessor)).toBe(true)
  507. expect(core.removePreProcessor(preprocessor)).toBe(false)
  508. })
  509. it('should execute all the preprocessors when uploading a file', () => {
  510. const core = new Core()
  511. const preprocessor1 = vi.fn()
  512. const preprocessor2 = vi.fn()
  513. core.addPreProcessor(preprocessor1)
  514. core.addPreProcessor(preprocessor2)
  515. core.addFile({
  516. source: 'vi',
  517. name: 'foo.jpg',
  518. type: 'image/jpeg',
  519. data: testImage,
  520. })
  521. return core.upload().then(() => {
  522. const fileId = Object.keys(core.getState().files)[0]
  523. expect(preprocessor1.mock.calls.length).toEqual(1)
  524. expect(preprocessor1.mock.calls[0][0].length).toEqual(1)
  525. expect(preprocessor1.mock.calls[0][0][0]).toEqual(fileId)
  526. expect(preprocessor2.mock.calls[0][0].length).toEqual(1)
  527. expect(preprocessor2.mock.calls[0][0][0]).toEqual(fileId)
  528. })
  529. })
  530. it('should not pass removed file IDs to next step', async () => {
  531. const core = new Core()
  532. const uploader = vi.fn()
  533. core.addPreProcessor((fileIDs) => {
  534. core.removeFile(fileIDs[0])
  535. })
  536. core.addUploader(uploader)
  537. core.addFile({
  538. source: 'vi',
  539. name: 'rmd.jpg',
  540. type: 'image/jpeg',
  541. data: testImage,
  542. })
  543. core.addFile({
  544. source: 'vi',
  545. name: 'kept.jpg',
  546. type: 'image/jpeg',
  547. data: testImage,
  548. })
  549. await core.upload()
  550. expect(uploader.mock.calls.length).toEqual(1)
  551. expect(uploader.mock.calls[0][0].length).toEqual(1)
  552. expect(core.getFile(uploader.mock.calls[0][0][0]).name).toEqual(
  553. 'kept.jpg',
  554. )
  555. })
  556. it('should update the file progress state when preprocess-progress event is fired', () => {
  557. const core = new Core()
  558. core.addFile({
  559. source: 'vi',
  560. name: 'foo.jpg',
  561. type: 'image/jpeg',
  562. data: testImage,
  563. })
  564. const fileId = Object.keys(core.getState().files)[0]
  565. const file = core.getFile(fileId)
  566. core.emit('preprocess-progress', file, {
  567. mode: 'determinate',
  568. message: 'something',
  569. value: 0,
  570. })
  571. expect(core.getFile(fileId).progress).toEqual({
  572. percentage: 0,
  573. bytesUploaded: 0,
  574. bytesTotal: 17175,
  575. uploadComplete: false,
  576. uploadStarted: null,
  577. preprocess: { mode: 'determinate', message: 'something', value: 0 },
  578. })
  579. })
  580. it('should update the file progress state when preprocess-complete event is fired', () => {
  581. const core = new Core()
  582. core.addFile({
  583. source: 'vi',
  584. name: 'foo.jpg',
  585. type: 'image/jpeg',
  586. data: testImage,
  587. })
  588. const fileID = Object.keys(core.getState().files)[0]
  589. const file = core.getFile(fileID)
  590. core.emit('preprocess-complete', file, {
  591. mode: 'determinate',
  592. message: 'something',
  593. value: 0,
  594. })
  595. expect(core.getFile(fileID).progress).toEqual({
  596. percentage: 0,
  597. bytesUploaded: 0,
  598. bytesTotal: 17175,
  599. uploadComplete: false,
  600. uploadStarted: null,
  601. })
  602. })
  603. })
  604. describe('postprocessors', () => {
  605. it('should add and remove postprocessor', () => {
  606. const core = new Core()
  607. // eslint-disable-next-line @typescript-eslint/no-empty-function
  608. const postprocessor = () => {}
  609. expect(core.removePostProcessor(postprocessor)).toBe(false)
  610. core.addPostProcessor(postprocessor)
  611. expect(core.removePostProcessor(postprocessor)).toBe(true)
  612. expect(core.removePostProcessor(postprocessor)).toBe(false)
  613. })
  614. it('should execute all the postprocessors when uploading a file', () => {
  615. const core = new Core()
  616. const postprocessor1 = vi.fn()
  617. const postprocessor2 = vi.fn()
  618. core.addPostProcessor(postprocessor1)
  619. core.addPostProcessor(postprocessor2)
  620. core.addFile({
  621. source: 'vi',
  622. name: 'foo.jpg',
  623. type: 'image/jpeg',
  624. data: testImage,
  625. })
  626. return core.upload().then(() => {
  627. expect(postprocessor1.mock.calls.length).toEqual(1)
  628. // const lastModifiedTime = new Date()
  629. // const fileId = 'foojpg' + lastModifiedTime.getTime()
  630. const fileId = 'uppy-foo/jpg-1e-image'
  631. expect(postprocessor1.mock.calls[0][0].length).toEqual(1)
  632. expect(postprocessor1.mock.calls[0][0][0].substring(0, 17)).toEqual(
  633. fileId.substring(0, 17),
  634. )
  635. expect(postprocessor2.mock.calls[0][0].length).toEqual(1)
  636. expect(postprocessor2.mock.calls[0][0][0].substring(0, 17)).toEqual(
  637. fileId.substring(0, 17),
  638. )
  639. })
  640. })
  641. it('should update the file progress state when postprocess-progress event is fired', () => {
  642. const core = new Core()
  643. core.addFile({
  644. source: 'vi',
  645. name: 'foo.jpg',
  646. type: 'image/jpeg',
  647. data: testImage,
  648. })
  649. const fileId = Object.keys(core.getState().files)[0]
  650. const file = core.getFile(fileId)
  651. core.emit('postprocess-progress', file, {
  652. mode: 'determinate',
  653. message: 'something',
  654. value: 0,
  655. })
  656. expect(core.getFile(fileId).progress).toEqual({
  657. percentage: 0,
  658. bytesUploaded: 0,
  659. bytesTotal: 17175,
  660. uploadComplete: false,
  661. uploadStarted: null,
  662. postprocess: { mode: 'determinate', message: 'something', value: 0 },
  663. })
  664. })
  665. it('should update the file progress state when postprocess-complete event is fired', () => {
  666. const core = new Core()
  667. core.addFile({
  668. source: 'vi',
  669. name: 'foo.jpg',
  670. type: 'image/jpeg',
  671. data: testImage,
  672. })
  673. const fileId = Object.keys(core.getState().files)[0]
  674. const file = core.getFile(fileId)
  675. core.emit('postprocess-complete', file, {
  676. mode: 'determinate',
  677. message: 'something',
  678. value: 0,
  679. })
  680. expect(core.getFile(fileId).progress).toEqual({
  681. percentage: 0,
  682. bytesUploaded: 0,
  683. bytesTotal: 17175,
  684. uploadComplete: false,
  685. uploadStarted: null,
  686. })
  687. })
  688. it('should report an error if post-processing a file fails', () => {
  689. const core = new Core()
  690. core.addFile({
  691. source: 'vi',
  692. name: 'foo.jpg',
  693. type: 'image/jpeg',
  694. data: testImage,
  695. })
  696. const fileId = Object.keys(core.getState().files)[0]
  697. const file = core.getFile(fileId)
  698. core.emit('error', new Error('foooooo'), file)
  699. expect(core.getState().error).toEqual('foooooo')
  700. expect(core.upload()).resolves.toMatchObject({
  701. failed: [{ name: 'foo.jpg' }],
  702. })
  703. })
  704. })
  705. describe('uploaders', () => {
  706. it('should add and remove uploader', () => {
  707. const core = new Core()
  708. // eslint-disable-next-line @typescript-eslint/no-empty-function
  709. const uploader = () => {}
  710. expect(core.removeUploader(uploader)).toBe(false)
  711. core.addUploader(uploader)
  712. expect(core.removeUploader(uploader)).toBe(true)
  713. expect(core.removeUploader(uploader)).toBe(false)
  714. })
  715. })
  716. describe('adding a file', () => {
  717. it('should call onBeforeFileAdded if it was specified in the options when initialising the class', () => {
  718. const onBeforeFileAdded = vi.fn()
  719. const core = new Core({
  720. // need to capture a snapshot of files, because files will change in the next tick, thus failing the expect below
  721. onBeforeFileAdded: (file, files) =>
  722. onBeforeFileAdded(file, { ...files }),
  723. })
  724. core.addFile({
  725. source: 'vi',
  726. name: 'foo.jpg',
  727. type: 'image/jpeg',
  728. data: testImage,
  729. })
  730. expect(onBeforeFileAdded.mock.calls.length).toEqual(1)
  731. expect(onBeforeFileAdded.mock.calls[0][0].name).toEqual('foo.jpg')
  732. expect(onBeforeFileAdded.mock.calls[0][1]).toEqual({})
  733. })
  734. it('should allow uploading duplicate file if explicitly allowed in onBeforeFileAdded', async () => {
  735. const core = new Core({ onBeforeFileAdded: () => true })
  736. const sameFileBlob = testImage
  737. core.addFile({
  738. source: 'vi',
  739. name: 'foo.jpg',
  740. type: 'image/jpeg',
  741. data: sameFileBlob,
  742. })
  743. core.addFile({
  744. source: 'vi',
  745. name: 'foo.jpg',
  746. type: 'image/jpeg',
  747. data: sameFileBlob,
  748. })
  749. })
  750. it('should add a file', () => {
  751. const fileData = testImage
  752. const fileAddedEventMock = vi.fn()
  753. const core = new Core()
  754. core.on('file-added', fileAddedEventMock)
  755. const fileId = core.addFile({
  756. source: 'vi',
  757. name: 'foo.jpg',
  758. type: 'image/jpeg',
  759. data: fileData,
  760. })
  761. const newFile = {
  762. extension: 'jpg',
  763. id: fileId,
  764. isRemote: false,
  765. meta: { name: 'foo.jpg', type: 'image/jpeg' },
  766. name: 'foo.jpg',
  767. preview: undefined,
  768. data: fileData,
  769. isGhost: false,
  770. progress: {
  771. bytesTotal: 17175,
  772. bytesUploaded: 0,
  773. percentage: 0,
  774. uploadComplete: false,
  775. uploadStarted: null,
  776. },
  777. remote: '',
  778. size: 17175,
  779. source: 'vi',
  780. type: 'image/jpeg',
  781. }
  782. expect(core.getFile(fileId)).toEqual(newFile)
  783. expect(fileAddedEventMock.mock.calls[0][0]).toEqual(newFile)
  784. })
  785. it('should add a file from a File object', () => {
  786. const fileData = testImage
  787. const core = new Core()
  788. const fileId = core.addFile(fileData)
  789. expect(core.getFile(fileId).id).toEqual(fileId)
  790. })
  791. it('should not allow a file that does not meet the restrictions', () => {
  792. const core = new Core({
  793. restrictions: {
  794. allowedFileTypes: ['image/gif', 'video/webm'],
  795. },
  796. })
  797. expect(() => {
  798. core.addFile({
  799. source: 'vi',
  800. name: 'foo.jpg',
  801. type: 'image/jpeg',
  802. data: testImage,
  803. })
  804. }).toThrow('You can only upload: image/gif, video/webm')
  805. expect(() => {
  806. core.addFile({
  807. source: 'vi',
  808. name: 'foo.webm',
  809. type: 'video/webm; codecs="vp8, opus"',
  810. // @ts-ignore
  811. data: new File([sampleImage], {
  812. type: 'video/webm; codecs="vp8, opus"',
  813. }),
  814. })
  815. }).not.toThrow()
  816. })
  817. it('should not allow a dupicate file, a file with the same id', () => {
  818. const core = new Core()
  819. const sameFileBlob = testImage
  820. core.addFile({
  821. source: 'vi',
  822. name: 'foo.jpg',
  823. type: 'image/jpeg',
  824. data: sameFileBlob,
  825. })
  826. expect(() => {
  827. core.addFile({
  828. source: 'vi',
  829. name: 'foo.jpg',
  830. type: 'image/jpeg',
  831. data: sameFileBlob,
  832. meta: {
  833. notARelativePath: 'folder/a',
  834. },
  835. })
  836. }).toThrow("Cannot add the duplicate file 'foo.jpg', it already exists")
  837. expect(core.getFiles().length).toEqual(1)
  838. })
  839. it('should allow a duplicate file if its relativePath is different, thus the id is different', () => {
  840. const core = new Core()
  841. core.addFile({
  842. source: 'vi',
  843. name: 'foo.jpg',
  844. type: 'image/jpeg',
  845. data: testImage,
  846. })
  847. core.addFile({
  848. source: 'vi',
  849. name: 'foo.jpg',
  850. type: 'image/jpeg',
  851. data: testImage,
  852. meta: {
  853. relativePath: 'folder/a',
  854. },
  855. })
  856. expect(core.getFiles().length).toEqual(2)
  857. })
  858. it('should not allow a file if onBeforeFileAdded returned false', () => {
  859. const core = new Core({
  860. onBeforeFileAdded: (file) => {
  861. if (file.source === 'vi') {
  862. return false
  863. }
  864. return undefined
  865. },
  866. })
  867. expect(() => {
  868. core.addFile({
  869. source: 'vi',
  870. name: 'foo.jpg',
  871. type: 'image/jpeg',
  872. data: testImage,
  873. })
  874. }).toThrow(
  875. 'Cannot add the file because onBeforeFileAdded returned false.',
  876. )
  877. expect(core.getFiles().length).toEqual(0)
  878. })
  879. describe('with allowMultipleUploadBatches: false', () => {
  880. it('allows no new files after upload', async () => {
  881. const core = new Core({ allowMultipleUploadBatches: false })
  882. core.addFile({
  883. source: 'vi',
  884. name: 'foo.jpg',
  885. type: 'image/jpeg',
  886. data: testImage,
  887. })
  888. await core.upload()
  889. expect(() => {
  890. core.addFile({
  891. source: 'vi',
  892. name: '123.foo',
  893. type: 'image/jpeg',
  894. data: testImage,
  895. })
  896. }).toThrow(/Cannot add more files/)
  897. })
  898. it('allows no new files after upload with legacy allowMultipleUploads option', async () => {
  899. const core = new Core({ allowMultipleUploads: false })
  900. core.addFile({
  901. source: 'vi',
  902. name: 'foo.jpg',
  903. type: 'image/jpeg',
  904. data: testImage,
  905. })
  906. await core.upload()
  907. expect(() => {
  908. core.addFile({
  909. source: 'vi',
  910. name: '123.foo',
  911. type: 'image/jpeg',
  912. data: testImage,
  913. })
  914. }).toThrow(/Cannot add more files/)
  915. })
  916. it('does not allow new files after the removeFile() if some file is still present', async () => {
  917. const core = new Core({ allowMultipleUploadBatches: false })
  918. // adding 2 files
  919. const fileId1 = core.addFile({
  920. source: 'vi',
  921. name: '1.jpg',
  922. type: 'image/jpeg',
  923. data: testImage,
  924. })
  925. core.addFile({
  926. source: 'vi',
  927. name: '2.jpg',
  928. type: 'image/jpeg',
  929. data: testImage,
  930. })
  931. // removing 1 file
  932. core.removeFile(fileId1)
  933. await expect(core.upload()).resolves.toBeDefined()
  934. })
  935. it('allows new files after the last removeFile()', async () => {
  936. const core = new Core({ allowMultipleUploadBatches: false })
  937. // adding 2 files
  938. const fileId1 = core.addFile({
  939. source: 'vi',
  940. name: '1.jpg',
  941. type: 'image/jpeg',
  942. data: testImage,
  943. })
  944. const fileId2 = core.addFile({
  945. source: 'vi',
  946. name: '2.jpg',
  947. type: 'image/jpeg',
  948. data: testImage,
  949. })
  950. // removing 2 files
  951. core.removeFile(fileId1)
  952. core.removeFile(fileId2)
  953. await expect(core.upload()).resolves.toBeDefined()
  954. })
  955. })
  956. it('does not dedupe different files', async () => {
  957. const core = new Core()
  958. const data = new Blob([sampleImage], { type: 'image/jpeg' })
  959. // @ts-ignore
  960. data.lastModified = 1562770350937
  961. core.addFile({
  962. source: 'vi',
  963. name: 'foo.jpg',
  964. type: 'image/jpeg',
  965. data,
  966. })
  967. core.addFile({
  968. source: 'vi',
  969. name: 'foo푸.jpg',
  970. type: 'image/jpeg',
  971. data,
  972. })
  973. expect(core.getFiles()).toHaveLength(2)
  974. expect(
  975. core.getFile('uppy-foo/jpg-1e-image/jpeg-17175-1562770350937'),
  976. ).toBeDefined()
  977. expect(
  978. core.getFile('uppy-foo//jpg-1l3o-1e-image/jpeg-17175-1562770350937'),
  979. ).toBeDefined()
  980. })
  981. })
  982. describe('uploading a file', () => {
  983. it('should return a { successful, failed } pair containing file objects', () => {
  984. const core = new Core()
  985. core.addUploader(() => Promise.resolve())
  986. core.addFile({
  987. source: 'vi',
  988. name: 'foo.jpg',
  989. type: 'image/jpeg',
  990. data: testImage,
  991. })
  992. core.addFile({
  993. source: 'vi',
  994. name: 'bar.jpg',
  995. type: 'image/jpeg',
  996. data: testImage,
  997. })
  998. return expect(core.upload()).resolves.toMatchObject({
  999. successful: [{ name: 'foo.jpg' }, { name: 'bar.jpg' }],
  1000. failed: [],
  1001. })
  1002. })
  1003. it('should return files with errors in the { failed } key', () => {
  1004. // use DeepFrozenStore in some tests to make sure we are not mutating things
  1005. const core = new Core({
  1006. store: DeepFrozenStore(),
  1007. })
  1008. core.addUploader((fileIDs) => {
  1009. fileIDs.forEach((fileID) => {
  1010. const file = core.getFile(fileID)
  1011. if (/bar/.test(file.name)) {
  1012. // @ts-ignore
  1013. core.emit(
  1014. 'upload-error',
  1015. file,
  1016. new Error('This is bar and I do not like bar'),
  1017. )
  1018. }
  1019. })
  1020. return Promise.resolve()
  1021. })
  1022. core.addFile({
  1023. source: 'vi',
  1024. name: 'foo.jpg',
  1025. type: 'image/jpeg',
  1026. data: testImage,
  1027. })
  1028. core.addFile({
  1029. source: 'vi',
  1030. name: 'bar.jpg',
  1031. type: 'image/jpeg',
  1032. data: testImage,
  1033. })
  1034. return expect(core.upload()).resolves.toMatchObject({
  1035. successful: [{ name: 'foo.jpg' }],
  1036. failed: [
  1037. { name: 'bar.jpg', error: 'This is bar and I do not like bar' },
  1038. ],
  1039. })
  1040. })
  1041. it('should only upload files that are not already assigned to another upload id', () => {
  1042. const core = new Core()
  1043. // @ts-ignore
  1044. core.store.state.currentUploads = {
  1045. // @ts-ignore
  1046. upload1: {
  1047. fileIDs: [
  1048. 'uppy-file1/jpg-1e-image/jpeg',
  1049. 'uppy-file2/jpg-1e-image/jpeg',
  1050. 'uppy-file3/jpg-1e-image/jpeg',
  1051. ],
  1052. },
  1053. // @ts-ignore
  1054. upload2: {
  1055. fileIDs: [
  1056. 'uppy-file4/jpg-1e-image/jpeg',
  1057. 'uppy-file5/jpg-1e-image/jpeg',
  1058. 'uppy-file6/jpg-1e-image/jpeg',
  1059. ],
  1060. },
  1061. }
  1062. core.addUploader(() => Promise.resolve())
  1063. core.addFile({
  1064. source: 'vi',
  1065. name: 'foo.jpg',
  1066. type: 'image/jpeg',
  1067. // @ts-ignore
  1068. data: new Uint8Array(),
  1069. })
  1070. core.addFile({
  1071. source: 'vi',
  1072. name: 'bar.jpg',
  1073. type: 'image/jpeg',
  1074. // @ts-ignore
  1075. data: new Uint8Array(),
  1076. })
  1077. core.addFile({
  1078. source: 'file3',
  1079. name: 'file3.jpg',
  1080. type: 'image/jpeg',
  1081. // @ts-ignore
  1082. data: new Uint8Array(),
  1083. })
  1084. // uploadID is random, we don't want randomness in the snapshot
  1085. return expect(
  1086. core
  1087. .upload()
  1088. .then((r) =>
  1089. typeof r!.uploadID === 'string' && r!.uploadID.length === 21
  1090. ? { ...r, uploadID: 'cjd09qwxb000dlql4tp4doz8h' }
  1091. : r,
  1092. ),
  1093. ).resolves.toMatchSnapshot()
  1094. })
  1095. it('should not upload if onBeforeUpload returned false', () => {
  1096. const core = new Core({
  1097. onBeforeUpload: (files) => {
  1098. for (const fileId in files) {
  1099. if (files[fileId].name === '123.foo') {
  1100. return false
  1101. }
  1102. }
  1103. return files
  1104. },
  1105. })
  1106. core.addFile({
  1107. source: 'vi',
  1108. name: 'foo.jpg',
  1109. type: 'image/jpeg',
  1110. data: testImage,
  1111. })
  1112. core.addFile({
  1113. source: 'vi',
  1114. name: 'bar.jpg',
  1115. type: 'image/jpeg',
  1116. data: testImage,
  1117. })
  1118. core.addFile({
  1119. source: 'vi',
  1120. name: '123.foo',
  1121. type: 'image/jpeg',
  1122. data: testImage,
  1123. })
  1124. return core.upload().catch((err) => {
  1125. expect(err).toMatchObject(
  1126. new Error(
  1127. 'Not starting the upload because onBeforeUpload returned false',
  1128. ),
  1129. )
  1130. })
  1131. })
  1132. it('only allows a single upload() batch when allowMultipleUploadBatches: false', async () => {
  1133. const core = new Core({ allowMultipleUploadBatches: false })
  1134. core.addFile({
  1135. source: 'vi',
  1136. name: 'foo.jpg',
  1137. type: 'image/jpeg',
  1138. data: testImage,
  1139. })
  1140. core.addFile({
  1141. source: 'vi',
  1142. name: 'bar.jpg',
  1143. type: 'image/jpeg',
  1144. data: testImage,
  1145. })
  1146. await expect(core.upload()).resolves.toBeDefined()
  1147. await expect(core.upload()).rejects.toThrow(
  1148. /Cannot create a new upload: already uploading\./,
  1149. )
  1150. })
  1151. it('allows new files again with allowMultipleUploadBatches: false after cancelAll() was called', async () => {
  1152. const core = new Core({ allowMultipleUploadBatches: false })
  1153. core.addFile({
  1154. source: 'vi',
  1155. name: 'bar.jpg',
  1156. type: 'image/jpeg',
  1157. data: testImage,
  1158. })
  1159. await expect(core.upload()).resolves.toBeDefined()
  1160. core.cancelAll()
  1161. core.addFile({
  1162. source: 'vi',
  1163. name: '123.foo',
  1164. type: 'image/jpeg',
  1165. data: testImage,
  1166. })
  1167. await expect(core.upload()).resolves.toBeDefined()
  1168. })
  1169. })
  1170. describe('removing a file', () => {
  1171. it('should remove the file', () => {
  1172. const fileRemovedEventMock = vi.fn()
  1173. const core = new Core()
  1174. core.on('file-removed', fileRemovedEventMock)
  1175. core.addFile({
  1176. source: 'vi',
  1177. name: 'foo.jpg',
  1178. type: 'image/jpeg',
  1179. data: testImage,
  1180. })
  1181. const fileId = Object.keys(core.getState().files)[0]
  1182. expect(core.getFiles().length).toEqual(1)
  1183. core.setState({
  1184. totalProgress: 50,
  1185. })
  1186. const file = core.getFile(fileId)
  1187. core.removeFile(fileId)
  1188. expect(core.getFiles().length).toEqual(0)
  1189. expect(fileRemovedEventMock.mock.calls[0][0]).toEqual(file)
  1190. expect(core.getState().totalProgress).toEqual(0)
  1191. })
  1192. })
  1193. describe('retries', () => {
  1194. it('should start a new upload with failed files', async () => {
  1195. const onUpload = vi.fn()
  1196. const onRetryAll = vi.fn()
  1197. const core = new Core()
  1198. core.on('upload', onUpload)
  1199. core.on('retry-all', onRetryAll)
  1200. const id = core.addFile({
  1201. source: 'vi',
  1202. name: 'foo.jpg',
  1203. type: 'image/jpeg',
  1204. data: testImage,
  1205. })
  1206. core.setFileState(id, {
  1207. error: 'something went wrong',
  1208. })
  1209. await core.retryAll()
  1210. expect(onRetryAll).toHaveBeenCalled()
  1211. expect(onUpload).toHaveBeenCalled()
  1212. })
  1213. it('should not start a new upload if there are no failed files', async () => {
  1214. const onUpload = vi.fn()
  1215. const core = new Core()
  1216. core.on('upload', onUpload)
  1217. core.addFile({
  1218. source: 'vi',
  1219. name: 'foo.jpg',
  1220. type: 'image/jpeg',
  1221. data: testImage,
  1222. })
  1223. await core.retryAll()
  1224. expect(onUpload).not.toHaveBeenCalled()
  1225. })
  1226. })
  1227. describe('restoring a file', () => {
  1228. it.skip('should restore a file')
  1229. it.skip("should fail to restore a file if it doesn't exist")
  1230. })
  1231. describe('get a file', () => {
  1232. it('should get the specified file', () => {
  1233. const core = new Core()
  1234. core.addFile({
  1235. source: 'vi',
  1236. name: 'foo.jpg',
  1237. type: 'image/jpeg',
  1238. data: testImage,
  1239. })
  1240. const fileId = Object.keys(core.getState().files)[0]
  1241. expect(core.getFile(fileId).name).toEqual('foo.jpg')
  1242. expect(core.getFile('non existent file')).toEqual(undefined)
  1243. })
  1244. })
  1245. describe('getFiles', () => {
  1246. it('should return an empty array if there are no files', () => {
  1247. const core = new Core()
  1248. expect(core.getFiles()).toEqual([])
  1249. })
  1250. it('should return all files as an array', () => {
  1251. const core = new Core()
  1252. core.addFile({
  1253. source: 'vi',
  1254. name: 'foo.jpg',
  1255. type: 'image/jpeg',
  1256. data: testImage,
  1257. })
  1258. core.addFile({
  1259. source: 'vi',
  1260. name: 'empty.dat',
  1261. type: 'application/octet-stream',
  1262. // @ts-ignore
  1263. data: new File([new Uint8Array(1000)], {
  1264. type: 'application/octet-stream',
  1265. }),
  1266. })
  1267. expect(core.getFiles()).toHaveLength(2)
  1268. expect(
  1269. core
  1270. .getFiles()
  1271. .map((file) => file.name)
  1272. .sort(),
  1273. ).toEqual(['empty.dat', 'foo.jpg'])
  1274. })
  1275. })
  1276. describe('setOptions', () => {
  1277. it('should change options on the fly', () => {
  1278. const core = new Core()
  1279. core.setOptions({
  1280. id: 'lolUppy',
  1281. autoProceed: true,
  1282. allowMultipleUploadBatches: true,
  1283. })
  1284. expect(core.opts.id).toEqual('lolUppy')
  1285. expect(core.opts.autoProceed).toEqual(true)
  1286. expect(core.opts.allowMultipleUploadBatches).toEqual(true)
  1287. })
  1288. it('should change locale on the fly', () => {
  1289. const core = new Core()
  1290. expect(core.i18n('cancel')).toEqual('Cancel')
  1291. core.setOptions({
  1292. locale: {
  1293. strings: {
  1294. cancel: 'Отмена',
  1295. },
  1296. },
  1297. })
  1298. expect(core.i18n('cancel')).toEqual('Отмена')
  1299. expect(core.i18n('logOut')).toEqual('Log out')
  1300. })
  1301. it('should change meta on the fly', () => {
  1302. const core = new Core<{ foo: string; beep: string }, any>({
  1303. meta: { foo: 'bar', beep: '' },
  1304. })
  1305. expect(core.getState().meta).toMatchObject({
  1306. foo: 'bar',
  1307. })
  1308. core.setOptions({
  1309. meta: {
  1310. beep: 'boop',
  1311. },
  1312. })
  1313. expect(core.getState().meta).toMatchObject({
  1314. foo: 'bar',
  1315. beep: 'boop',
  1316. })
  1317. })
  1318. it('should change restrictions on the fly', () => {
  1319. const core = new Core({
  1320. restrictions: {
  1321. allowedFileTypes: ['image/jpeg'],
  1322. maxNumberOfFiles: 2,
  1323. },
  1324. })
  1325. try {
  1326. core.addFile({
  1327. source: 'vi',
  1328. name: 'foo1.png',
  1329. type: 'image/png',
  1330. // @ts-ignore
  1331. data: new File([sampleImage], { type: 'image/png' }),
  1332. })
  1333. } catch (err) {
  1334. expect(err).toMatchObject(new Error('You can only upload: image/jpeg'))
  1335. }
  1336. core.setOptions({
  1337. restrictions: {
  1338. allowedFileTypes: ['image/png'],
  1339. },
  1340. })
  1341. expect(core.opts.restrictions.allowedFileTypes).toMatchObject([
  1342. 'image/png',
  1343. ])
  1344. expect(() => {
  1345. core.addFile({
  1346. source: 'vi',
  1347. name: 'foo1.png',
  1348. type: 'image/png',
  1349. // @ts-ignore
  1350. data: new File([sampleImage], { type: 'image/png' }),
  1351. })
  1352. }).not.toThrow()
  1353. expect(core.getFiles().length).toEqual(1)
  1354. })
  1355. })
  1356. describe('meta data', () => {
  1357. it('should set meta data by calling setMeta', () => {
  1358. // use DeepFrozenStore in some tests to make sure we are not mutating things
  1359. const core = new Core<
  1360. {
  1361. foo: string
  1362. boo: string
  1363. foo2: string
  1364. bur: string
  1365. },
  1366. any
  1367. >({
  1368. store: DeepFrozenStore(),
  1369. // @ts-ignore
  1370. meta: { foo2: 'bar2' },
  1371. })
  1372. core.setMeta({ foo: 'bar', bur: 'mur' })
  1373. core.setMeta({ boo: 'moo', bur: 'fur' })
  1374. expect(core.getState().meta).toEqual({
  1375. foo: 'bar',
  1376. foo2: 'bar2',
  1377. boo: 'moo',
  1378. bur: 'fur',
  1379. })
  1380. })
  1381. it('should update meta data for a file by calling updateMeta', () => {
  1382. const core = new Core()
  1383. core.addFile({
  1384. source: 'vi',
  1385. name: 'foo.jpg',
  1386. type: 'image/jpeg',
  1387. data: testImage,
  1388. })
  1389. const fileId = Object.keys(core.getState().files)[0]
  1390. core.setFileMeta(fileId, { foo: 'bar', bur: 'mur' })
  1391. core.setFileMeta(fileId, { boo: 'moo', bur: 'fur' })
  1392. expect(core.getFile(fileId).meta).toEqual({
  1393. name: 'foo.jpg',
  1394. type: 'image/jpeg',
  1395. foo: 'bar',
  1396. bur: 'fur',
  1397. boo: 'moo',
  1398. })
  1399. })
  1400. it('should merge meta data when add file', () => {
  1401. const core = new Core({
  1402. meta: { foo2: 'bar2' },
  1403. })
  1404. core.addFile({
  1405. source: 'vi',
  1406. name: 'foo.jpg',
  1407. type: 'image/jpeg',
  1408. meta: {
  1409. // @ts-ignore
  1410. resize: 5000,
  1411. },
  1412. data: testImage,
  1413. })
  1414. const fileId = Object.keys(core.getState().files)[0]
  1415. expect(core.getFile(fileId).meta).toEqual({
  1416. name: 'foo.jpg',
  1417. type: 'image/jpeg',
  1418. foo2: 'bar2',
  1419. resize: 5000,
  1420. })
  1421. })
  1422. })
  1423. describe('progress', () => {
  1424. it('should calculate the progress of a file upload', () => {
  1425. const core = new Core()
  1426. core.addFile({
  1427. source: 'vi',
  1428. name: 'foo.jpg',
  1429. type: 'image/jpeg',
  1430. data: testImage,
  1431. })
  1432. const fileId = Object.keys(core.getState().files)[0]
  1433. const file = core.getFile(fileId)
  1434. // @ts-ignore
  1435. core.emit('upload-progress', file, {
  1436. bytesUploaded: 12345,
  1437. bytesTotal: 17175,
  1438. })
  1439. expect(core.getFile(fileId).progress).toEqual({
  1440. percentage: 72,
  1441. bytesUploaded: 12345,
  1442. bytesTotal: 17175,
  1443. uploadComplete: false,
  1444. uploadStarted: null,
  1445. })
  1446. // @ts-ignore
  1447. core.emit('upload-progress', file, {
  1448. bytesUploaded: 17175,
  1449. bytesTotal: 17175,
  1450. })
  1451. core.calculateProgress.flush()
  1452. expect(core.getFile(fileId).progress).toEqual({
  1453. percentage: 100,
  1454. bytesUploaded: 17175,
  1455. bytesTotal: 17175,
  1456. uploadComplete: false,
  1457. uploadStarted: null,
  1458. })
  1459. })
  1460. it('should work with unsized files', async () => {
  1461. const core = new Core()
  1462. let proceedUpload
  1463. let finishUpload
  1464. const promise = new Promise((resolve) => {
  1465. proceedUpload = resolve
  1466. })
  1467. const finishPromise = new Promise((resolve) => {
  1468. finishUpload = resolve
  1469. })
  1470. core.addUploader(async ([id]) => {
  1471. core.emit('upload-start', [core.getFile(id)])
  1472. await promise
  1473. // @ts-ignore deprecated
  1474. core.emit('upload-progress', core.getFile(id), {
  1475. bytesTotal: 3456,
  1476. bytesUploaded: 1234,
  1477. })
  1478. await finishPromise
  1479. // @ts-ignore deprecated
  1480. core.emit('upload-success', core.getFile(id), { uploadURL: 'lol' })
  1481. })
  1482. core.addFile({
  1483. source: 'instagram',
  1484. name: 'foo.jpg',
  1485. type: 'image/jpeg',
  1486. // @ts-ignore
  1487. data: {},
  1488. })
  1489. core.calculateTotalProgress()
  1490. const uploadPromise = core.upload()
  1491. await Promise.all([
  1492. // @ts-ignore deprecated
  1493. new Promise((resolve) => core.once('upload-start', resolve)),
  1494. // todo backward compat: remove in next major
  1495. new Promise((resolve) => core.once('upload-started', resolve)),
  1496. ])
  1497. expect(core.getFiles()[0].size).toBeNull()
  1498. expect(core.getFiles()[0].progress).toMatchObject({
  1499. bytesUploaded: 0,
  1500. // null indicates unsized
  1501. bytesTotal: null,
  1502. percentage: 0,
  1503. })
  1504. // @ts-ignore
  1505. proceedUpload()
  1506. // wait for progress event
  1507. await promise
  1508. expect(core.getFiles()[0].size).toBeNull()
  1509. expect(core.getFiles()[0].progress).toMatchObject({
  1510. bytesUploaded: 1234,
  1511. bytesTotal: 3456,
  1512. percentage: 36,
  1513. })
  1514. expect(core.getState().totalProgress).toBe(36)
  1515. // @ts-ignore
  1516. finishUpload()
  1517. // wait for success event
  1518. await finishPromise
  1519. expect(core.getFiles()[0].size).toBe(3456)
  1520. expect(core.getFiles()[0].progress).toMatchObject({
  1521. bytesUploaded: 3456,
  1522. bytesTotal: 3456,
  1523. percentage: 100,
  1524. })
  1525. await uploadPromise
  1526. core.close()
  1527. })
  1528. it('should estimate progress for unsized files', () => {
  1529. const core = new Core()
  1530. core.once('file-added', (file) => {
  1531. core.emit('upload-start', [file])
  1532. // @ts-ignore
  1533. core.emit('upload-progress', file, {
  1534. bytesTotal: 3456,
  1535. bytesUploaded: 1234,
  1536. })
  1537. })
  1538. core.addFile({
  1539. source: 'instagram',
  1540. name: 'foo.jpg',
  1541. type: 'image/jpeg',
  1542. // @ts-ignore
  1543. data: {},
  1544. })
  1545. core.once('file-added', (file) => {
  1546. core.emit('upload-start', [file])
  1547. core.emit('upload-progress', file, {
  1548. // @ts-ignore
  1549. bytesTotal: null,
  1550. // @ts-ignore
  1551. bytesUploaded: null,
  1552. })
  1553. })
  1554. core.addFile({
  1555. source: 'instagram',
  1556. name: 'bar.jpg',
  1557. type: 'image/jpeg',
  1558. // @ts-ignore
  1559. data: {},
  1560. })
  1561. core.calculateTotalProgress()
  1562. // foo.jpg at 35%, bar.jpg at 0%
  1563. expect(core.getState().totalProgress).toBe(18)
  1564. core.close()
  1565. })
  1566. it('should calculate the total progress of all file uploads', () => {
  1567. // use DeepFrozenStore in some tests to make sure we are not mutating things
  1568. const core = new Core({
  1569. store: DeepFrozenStore(),
  1570. })
  1571. core.addFile({
  1572. source: 'vi',
  1573. name: 'foo.jpg',
  1574. type: 'image/jpeg',
  1575. data: testImage,
  1576. })
  1577. core.addFile({
  1578. source: 'vi',
  1579. name: 'foo2.jpg',
  1580. type: 'image/jpeg',
  1581. data: testImage,
  1582. })
  1583. const [file1, file2] = core.getFiles()
  1584. core.setFileState(file1.id, {
  1585. // @ts-ignore suddenly dates??
  1586. progress: { ...file1.progress, uploadStarted: new Date() },
  1587. })
  1588. core.setFileState(file2.id, {
  1589. // @ts-ignore suddenly dates??
  1590. progress: { ...file2.progress, uploadStarted: new Date() },
  1591. })
  1592. // @ts-ignore test does not care about missing properties
  1593. core.emit('upload-progress', core.getFile(file1.id), {
  1594. bytesUploaded: 12345,
  1595. bytesTotal: 17175,
  1596. })
  1597. // @ts-ignore test does not care about missing properties
  1598. core.emit('upload-progress', core.getFile(file2.id), {
  1599. bytesUploaded: 10201,
  1600. bytesTotal: 17175,
  1601. })
  1602. core.calculateTotalProgress()
  1603. core.calculateProgress.flush()
  1604. expect(core.getState().totalProgress).toEqual(66)
  1605. })
  1606. it('should reset the progress', () => {
  1607. const resetProgressEvent = vi.fn()
  1608. const core = new Core()
  1609. core.on('reset-progress', resetProgressEvent)
  1610. core.addFile({
  1611. source: 'vi',
  1612. name: 'foo.jpg',
  1613. type: 'image/jpeg',
  1614. data: testImage,
  1615. })
  1616. core.addFile({
  1617. source: 'vi',
  1618. name: 'foo2.jpg',
  1619. type: 'image/jpeg',
  1620. data: testImage,
  1621. })
  1622. const [file1, file2] = core.getFiles()
  1623. core.setFileState(file1.id, {
  1624. // @ts-ignore suddenly dates??
  1625. progress: { ...file1.progress, uploadStarted: new Date() },
  1626. })
  1627. core.setFileState(file2.id, {
  1628. // @ts-ignore suddenly dates??
  1629. progress: { ...file2.progress, uploadStarted: new Date() },
  1630. })
  1631. // @ts-ignore test does not care about missing properties
  1632. core.emit('upload-progress', core.getFile(file1.id), {
  1633. bytesUploaded: 12345,
  1634. bytesTotal: 17175,
  1635. })
  1636. // @ts-ignore test does not care about missing properties
  1637. core.emit('upload-progress', core.getFile(file2.id), {
  1638. bytesUploaded: 10201,
  1639. bytesTotal: 17175,
  1640. })
  1641. core.calculateTotalProgress()
  1642. core.calculateProgress.flush()
  1643. expect(core.getState().totalProgress).toEqual(66)
  1644. core.resetProgress()
  1645. expect(core.getFile(file1.id).progress).toEqual({
  1646. percentage: 0,
  1647. bytesUploaded: 0,
  1648. bytesTotal: 17175,
  1649. uploadComplete: false,
  1650. uploadStarted: null,
  1651. })
  1652. expect(core.getFile(file2.id).progress).toEqual({
  1653. percentage: 0,
  1654. bytesUploaded: 0,
  1655. bytesTotal: 17175,
  1656. uploadComplete: false,
  1657. uploadStarted: null,
  1658. })
  1659. expect(core.getState().totalProgress).toEqual(0)
  1660. expect(core.getState().allowNewUpload).toEqual(true)
  1661. expect(core.getState().error).toEqual(null)
  1662. expect(core.getState().recoveredState).toEqual(null)
  1663. expect(resetProgressEvent.mock.calls.length).toEqual(1)
  1664. })
  1665. })
  1666. describe('checkRestrictions', () => {
  1667. it('should enforce the maxNumberOfFiles rule', () => {
  1668. const core = new Core({
  1669. restrictions: {
  1670. maxNumberOfFiles: 1,
  1671. },
  1672. })
  1673. // add 2 files
  1674. core.addFile({
  1675. source: 'vi',
  1676. name: 'foo1.jpg',
  1677. type: 'image/jpeg',
  1678. data: testImage,
  1679. })
  1680. try {
  1681. core.addFile({
  1682. source: 'vi',
  1683. name: 'foo2.jpg',
  1684. type: 'image/jpeg',
  1685. data: testImage,
  1686. })
  1687. throw new Error('should have thrown')
  1688. } catch (err) {
  1689. expect(err).toMatchObject(new Error('You can only upload 1 file'))
  1690. expect(core.getState().info[0].message).toEqual(
  1691. 'You can only upload 1 file',
  1692. )
  1693. }
  1694. })
  1695. it('should not enforce the maxNumberOfFiles rule for ghost files', () => {
  1696. const core = new Core({
  1697. restrictions: {
  1698. maxNumberOfFiles: 1,
  1699. },
  1700. })
  1701. expect(() => {
  1702. // add 1 ghost file
  1703. const fileId1 = core.addFile({
  1704. source: 'vi',
  1705. name: 'foo1.jpg',
  1706. type: 'image/jpeg',
  1707. data: testImage,
  1708. })
  1709. core.setFileState(fileId1, { isGhost: true })
  1710. // add another file
  1711. core.addFile({
  1712. source: 'vi',
  1713. name: 'foo2.jpg',
  1714. type: 'image/jpeg',
  1715. data: testImage,
  1716. })
  1717. }).not.toThrowError()
  1718. })
  1719. it.skip('should enforce the minNumberOfFiles rule')
  1720. it('should enforce the allowedFileTypes rule', () => {
  1721. const core = new Core({
  1722. restrictions: {
  1723. allowedFileTypes: ['image/gif', 'image/png'],
  1724. },
  1725. })
  1726. try {
  1727. core.addFile({
  1728. source: 'vi',
  1729. name: 'foo2.jpg',
  1730. type: 'image/jpeg',
  1731. data: testImage,
  1732. })
  1733. throw new Error('should have thrown')
  1734. } catch (err) {
  1735. expect(err).toMatchObject(
  1736. new Error('You can only upload: image/gif, image/png'),
  1737. )
  1738. expect(core.getState().info[0].message).toEqual(
  1739. 'You can only upload: image/gif, image/png',
  1740. )
  1741. }
  1742. })
  1743. it('should throw if allowedFileTypes is not an array', () => {
  1744. try {
  1745. const core = new Core({
  1746. restrictions: {
  1747. // @ts-ignore
  1748. allowedFileTypes: 'image/gif',
  1749. },
  1750. })
  1751. core.log('hi')
  1752. } catch (err) {
  1753. expect(err).toMatchObject(
  1754. new Error('`restrictions.allowedFileTypes` must be an array'),
  1755. )
  1756. }
  1757. })
  1758. it('should enforce the allowedFileTypes rule with file extensions', () => {
  1759. const core = new Core({
  1760. restrictions: {
  1761. allowedFileTypes: ['.gif', '.jpg', '.jpeg'],
  1762. },
  1763. })
  1764. try {
  1765. core.addFile({
  1766. source: 'vi',
  1767. name: 'foo2.png',
  1768. type: '',
  1769. data: testImage,
  1770. })
  1771. throw new Error('should have thrown')
  1772. } catch (err) {
  1773. expect(err).toMatchObject(
  1774. new Error('You can only upload: .gif, .jpg, .jpeg'),
  1775. )
  1776. expect(core.getState().info[0].message).toEqual(
  1777. 'You can only upload: .gif, .jpg, .jpeg',
  1778. )
  1779. }
  1780. expect(() =>
  1781. core.addFile({
  1782. source: 'vi',
  1783. name: 'foo2.JPG',
  1784. type: '',
  1785. data: testImage,
  1786. }),
  1787. ).not.toThrow()
  1788. })
  1789. it('should enforce the maxFileSize rule', () => {
  1790. const core = new Core({
  1791. restrictions: {
  1792. maxFileSize: 1234,
  1793. },
  1794. })
  1795. try {
  1796. core.addFile({
  1797. source: 'vi',
  1798. name: 'foo.jpg',
  1799. type: 'image/jpeg',
  1800. data: testImage,
  1801. })
  1802. throw new Error('should have thrown')
  1803. } catch (err) {
  1804. expect(err).toMatchObject(
  1805. new Error('foo.jpg exceeds maximum allowed size of 1.2 KB'),
  1806. )
  1807. expect(core.getState().info[0].message).toEqual(
  1808. 'foo.jpg exceeds maximum allowed size of 1.2 KB',
  1809. )
  1810. }
  1811. })
  1812. it('should enforce the minFileSize rule', () => {
  1813. const core = new Core({
  1814. restrictions: {
  1815. minFileSize: 1073741824,
  1816. },
  1817. })
  1818. try {
  1819. core.addFile({
  1820. source: 'vi',
  1821. name: 'foo.jpg',
  1822. type: 'image/jpeg',
  1823. data: testImage,
  1824. })
  1825. throw new Error('should have thrown')
  1826. } catch (err) {
  1827. expect(err).toMatchObject(
  1828. new Error('This file is smaller than the allowed size of 1 GB'),
  1829. )
  1830. expect(core.getState().info[0].message).toEqual(
  1831. 'This file is smaller than the allowed size of 1 GB',
  1832. )
  1833. }
  1834. })
  1835. it('should enforce the maxTotalFileSize rule', () => {
  1836. const core = new Core({
  1837. restrictions: {
  1838. maxTotalFileSize: 34000,
  1839. },
  1840. })
  1841. core.addFile({
  1842. source: 'vi',
  1843. name: 'foo.jpg',
  1844. type: 'image/jpeg',
  1845. data: testImage,
  1846. })
  1847. expect(() => {
  1848. core.addFile({
  1849. source: 'vi',
  1850. name: 'foo1.jpg',
  1851. type: 'image/jpeg',
  1852. data: testImage,
  1853. })
  1854. }).toThrowError(
  1855. new Error('foo1.jpg exceeds maximum allowed size of 33 KB'),
  1856. )
  1857. })
  1858. it('should check if a file validateRestrictions', () => {
  1859. const core = new Core({
  1860. restrictions: {
  1861. minFileSize: 300000,
  1862. },
  1863. })
  1864. const core2 = new Core({
  1865. restrictions: {
  1866. allowedFileTypes: ['image/png'],
  1867. },
  1868. })
  1869. const newFile = {
  1870. source: 'vi',
  1871. name: 'foo1.jpg',
  1872. extension: 'jpg',
  1873. type: 'image/jpeg',
  1874. data: testImage,
  1875. isFolder: false,
  1876. mimeType: 'image/jpeg',
  1877. modifiedDate: '2016-04-13T15:11:31.204Z',
  1878. size: 270733,
  1879. }
  1880. // @ts-ignore
  1881. const validateRestrictions1 = core.validateRestrictions(newFile)
  1882. // @ts-ignore
  1883. const validateRestrictions2 = core2.validateRestrictions(newFile)
  1884. expect(validateRestrictions1!.message).toEqual(
  1885. 'This file is smaller than the allowed size of 293 KB',
  1886. )
  1887. expect(validateRestrictions2!.message).toEqual(
  1888. 'You can only upload: image/png',
  1889. )
  1890. })
  1891. it('should emit `restriction-failed` event when some rule is violated', () => {
  1892. const maxFileSize = 100
  1893. const core = new Core({
  1894. restrictions: {
  1895. maxFileSize,
  1896. },
  1897. })
  1898. const restrictionsViolatedEventMock = vi.fn()
  1899. const file = {
  1900. source: 'vi',
  1901. type: 'image/jpeg',
  1902. name: 'test.jpg',
  1903. data: new Blob([new Uint8Array(2 * maxFileSize)]),
  1904. }
  1905. const errorMessage = core.i18n('exceedsSize', {
  1906. file: file.name,
  1907. size: prettierBytes(maxFileSize),
  1908. })
  1909. try {
  1910. core.on('restriction-failed', restrictionsViolatedEventMock)
  1911. core.addFile(file)
  1912. } catch {
  1913. // Ignore errors
  1914. }
  1915. expect(restrictionsViolatedEventMock.mock.calls.length).toEqual(1)
  1916. expect(restrictionsViolatedEventMock.mock.calls[0][0].name).toEqual(
  1917. file.name,
  1918. )
  1919. expect(restrictionsViolatedEventMock.mock.calls[0][1].message).toEqual(
  1920. errorMessage,
  1921. )
  1922. })
  1923. })
  1924. describe('actions', () => {
  1925. it('should update the state when receiving the error event', () => {
  1926. const core = new Core()
  1927. core.emit('error', new Error('foooooo'))
  1928. expect(core.getState().error).toEqual('foooooo')
  1929. })
  1930. it('should update the state when receiving the upload-error event', () => {
  1931. const core = new Core()
  1932. core.setState({
  1933. files: {
  1934. // @ts-ignore
  1935. fileId: {
  1936. id: 'fileId',
  1937. name: 'filename',
  1938. },
  1939. },
  1940. })
  1941. // @ts-ignore test does not care about missing properties
  1942. core.emit(
  1943. 'upload-error',
  1944. core.getFile('fileId'),
  1945. new Error('this is the error'),
  1946. )
  1947. expect(core.getState().info).toEqual([
  1948. {
  1949. message: 'Failed to upload filename',
  1950. details: 'this is the error',
  1951. type: 'error',
  1952. },
  1953. ])
  1954. })
  1955. it('should reset the error state when receiving the upload event', () => {
  1956. const core = new Core()
  1957. // @ts-ignore test does not care about missing properties
  1958. core.emit('error', { foo: 'bar' })
  1959. // @ts-ignore test does not care about missing properties
  1960. core.emit('upload')
  1961. expect(core.getState().error).toEqual(null)
  1962. })
  1963. })
  1964. describe('updateOnlineStatus', () => {
  1965. const RealNavigatorOnline = globalThis.window.navigator.onLine
  1966. function mockNavigatorOnline(status: boolean) {
  1967. Object.defineProperty(globalThis.window.navigator, 'onLine', {
  1968. value: status,
  1969. writable: true,
  1970. })
  1971. }
  1972. afterEach(() => {
  1973. // @ts-ignore readonly but whatever
  1974. globalThis.window.navigator.onLine = RealNavigatorOnline
  1975. })
  1976. it('should emit the correct event based on whether there is a network connection', () => {
  1977. const onlineEventMock = vi.fn()
  1978. const offlineEventMock = vi.fn()
  1979. const backOnlineEventMock = vi.fn()
  1980. const core = new Core()
  1981. // @ts-ignore untyped
  1982. core.on('is-offline', offlineEventMock)
  1983. // @ts-ignore untyped
  1984. core.on('is-online', onlineEventMock)
  1985. // @ts-ignore untyped
  1986. core.on('back-online', backOnlineEventMock)
  1987. mockNavigatorOnline(true)
  1988. core.updateOnlineStatus()
  1989. expect(onlineEventMock.mock.calls.length).toEqual(1)
  1990. expect(offlineEventMock.mock.calls.length).toEqual(0)
  1991. expect(backOnlineEventMock.mock.calls.length).toEqual(0)
  1992. mockNavigatorOnline(false)
  1993. core.updateOnlineStatus()
  1994. expect(onlineEventMock.mock.calls.length).toEqual(1)
  1995. expect(offlineEventMock.mock.calls.length).toEqual(1)
  1996. expect(backOnlineEventMock.mock.calls.length).toEqual(0)
  1997. mockNavigatorOnline(true)
  1998. core.updateOnlineStatus()
  1999. expect(onlineEventMock.mock.calls.length).toEqual(2)
  2000. expect(offlineEventMock.mock.calls.length).toEqual(1)
  2001. expect(backOnlineEventMock.mock.calls.length).toEqual(1)
  2002. })
  2003. })
  2004. describe('info', () => {
  2005. it('should set a string based message to be displayed infinitely', () => {
  2006. const infoVisibleEvent = vi.fn()
  2007. const core = new Core()
  2008. core.on('info-visible', infoVisibleEvent)
  2009. core.info('This is the message', 'info', 0)
  2010. expect(core.getState().info).toEqual([
  2011. {
  2012. type: 'info',
  2013. message: 'This is the message',
  2014. details: null,
  2015. },
  2016. ])
  2017. expect(infoVisibleEvent.mock.calls.length).toEqual(1)
  2018. })
  2019. it('should set a object based message to be displayed infinitely', () => {
  2020. const infoVisibleEvent = vi.fn()
  2021. const core = new Core()
  2022. core.on('info-visible', infoVisibleEvent)
  2023. core.info(
  2024. {
  2025. message: 'This is the message',
  2026. details: {
  2027. foo: 'bar',
  2028. },
  2029. },
  2030. 'warning',
  2031. 0,
  2032. )
  2033. expect(core.getState().info).toEqual([
  2034. {
  2035. type: 'warning',
  2036. message: 'This is the message',
  2037. details: {
  2038. foo: 'bar',
  2039. },
  2040. },
  2041. ])
  2042. expect(infoVisibleEvent.mock.calls.length).toEqual(1)
  2043. })
  2044. it('should set an info message to be displayed for a period of time before hiding', (done) => {
  2045. const infoVisibleEvent = vi.fn()
  2046. const infoHiddenEvent = vi.fn()
  2047. const core = new Core()
  2048. core.on('info-visible', infoVisibleEvent)
  2049. core.on('info-hidden', infoHiddenEvent)
  2050. core.info('This is the message', 'info', 100)
  2051. expect(infoHiddenEvent.mock.calls.length).toEqual(0)
  2052. setTimeout(() => {
  2053. expect(infoHiddenEvent.mock.calls.length).toEqual(1)
  2054. expect(core.getState().info).toEqual([])
  2055. // @ts-ignore
  2056. done()
  2057. }, 110)
  2058. })
  2059. it('should hide an info message', () => {
  2060. const infoVisibleEvent = vi.fn()
  2061. const infoHiddenEvent = vi.fn()
  2062. const core = new Core()
  2063. core.on('info-visible', infoVisibleEvent)
  2064. core.on('info-hidden', infoHiddenEvent)
  2065. core.info('This is the message', 'info', 0)
  2066. expect(infoHiddenEvent.mock.calls.length).toEqual(0)
  2067. core.hideInfo()
  2068. expect(infoHiddenEvent.mock.calls.length).toEqual(1)
  2069. expect(core.getState().info).toEqual([])
  2070. })
  2071. it('should support multiple messages', () => {
  2072. const infoVisibleEvent = vi.fn()
  2073. const infoHiddenEvent = vi.fn()
  2074. const core = new Core()
  2075. core.on('info-visible', infoVisibleEvent)
  2076. core.on('info-hidden', infoHiddenEvent)
  2077. core.info('This is the message', 'info', 0)
  2078. core.info('But this is another one', 'info', 0)
  2079. expect(infoHiddenEvent.mock.calls.length).toEqual(0)
  2080. expect(core.getState().info).toEqual([
  2081. {
  2082. type: 'info',
  2083. message: 'This is the message',
  2084. details: null,
  2085. },
  2086. {
  2087. type: 'info',
  2088. message: 'But this is another one',
  2089. details: null,
  2090. },
  2091. ])
  2092. core.hideInfo()
  2093. expect(core.getState().info).toEqual([
  2094. {
  2095. type: 'info',
  2096. message: 'But this is another one',
  2097. details: null,
  2098. },
  2099. ])
  2100. core.hideInfo()
  2101. expect(infoHiddenEvent.mock.calls.length).toEqual(2)
  2102. expect(core.getState().info).toEqual([])
  2103. })
  2104. })
  2105. describe('createUpload', () => {
  2106. it('should assign the specified files to a new upload', () => {
  2107. const core = new Core()
  2108. core.addFile({
  2109. source: 'vi',
  2110. name: 'foo.jpg',
  2111. type: 'image/jpeg',
  2112. data: testImage,
  2113. })
  2114. // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  2115. // @ts-ignore accessing private method
  2116. core[Symbol.for('uppy test: createUpload')](
  2117. Object.keys(core.getState().files),
  2118. )
  2119. const uploadId = Object.keys(core.getState().currentUploads)[0]
  2120. const currentUploadsState: State<any, any>['currentUploads'] = {}
  2121. currentUploadsState[uploadId] = {
  2122. fileIDs: Object.keys(core.getState().files),
  2123. step: 0,
  2124. result: {},
  2125. }
  2126. expect(core.getState().currentUploads).toEqual(currentUploadsState)
  2127. })
  2128. })
  2129. describe('i18n', () => {
  2130. it('merges in custom locale strings', () => {
  2131. const core = new Core({
  2132. locale: {
  2133. strings: {
  2134. test: 'beep boop',
  2135. },
  2136. pluralize: () => 0,
  2137. },
  2138. })
  2139. expect(core.i18n('exceedsSize')).toBe(
  2140. '%{file} exceeds maximum allowed size of %{size}',
  2141. )
  2142. expect(core.i18n('test')).toBe('beep boop')
  2143. })
  2144. })
  2145. describe('default restrictions', () => {
  2146. it('should be merged with supplied restrictions', () => {
  2147. const core = new Core({
  2148. restrictions: {
  2149. maxNumberOfFiles: 3,
  2150. },
  2151. })
  2152. expect(core.opts.restrictions.maxNumberOfFiles).toBe(3)
  2153. expect(core.opts.restrictions.minNumberOfFiles).toBe(null)
  2154. })
  2155. })
  2156. describe('log', () => {
  2157. it('should log via provided logger function', () => {
  2158. const myTestLogger = {
  2159. debug: vi.fn(),
  2160. warn: vi.fn(),
  2161. error: vi.fn(),
  2162. }
  2163. const core = new Core({
  2164. logger: myTestLogger,
  2165. })
  2166. core.log('test test')
  2167. core.log('test test', 'error')
  2168. core.log('test test', 'error')
  2169. core.log('test test', 'warning')
  2170. // logger.debug should have been called 1 time above,
  2171. // but we call log in Core’s constructor to output VERSION, hence +1 here
  2172. // @ts-ignore
  2173. expect(core.opts.logger.debug.mock.calls.length).toBe(2)
  2174. // @ts-ignore
  2175. expect(core.opts.logger.error.mock.calls.length).toBe(2)
  2176. // @ts-ignore
  2177. expect(core.opts.logger.warn.mock.calls.length).toBe(1)
  2178. })
  2179. it('should log via provided logger function, even if debug: true', () => {
  2180. const myTestLogger = {
  2181. debug: vi.fn(),
  2182. warn: vi.fn(),
  2183. error: vi.fn(),
  2184. }
  2185. const core = new Core({
  2186. logger: myTestLogger,
  2187. debug: true,
  2188. })
  2189. core.log('test test')
  2190. core.log('test test', 'error')
  2191. core.log('test test', 'error')
  2192. core.log('test test', 'warning')
  2193. // logger.debug should have been called 1 time above,
  2194. // but we call log in Core’s constructor to output VERSION, hence +1 here
  2195. // @ts-ignore
  2196. expect(core.opts.logger.debug.mock.calls.length).toBe(2)
  2197. // @ts-ignore
  2198. expect(core.opts.logger.error.mock.calls.length).toBe(2)
  2199. // logger.warn should have been called 1 time above,
  2200. // but we warn in Core when using both logger and debug: true, hence +1 here
  2201. // @ts-ignore
  2202. expect(core.opts.logger.warn.mock.calls.length).toBe(2)
  2203. })
  2204. it('should log to console when logger: Uppy.debugLogger or debug: true is set', () => {
  2205. console.debug = vi.fn()
  2206. console.error = vi.fn()
  2207. const core = new Core({
  2208. logger: debugLogger,
  2209. })
  2210. core.log('test test')
  2211. core.log('beep boop')
  2212. core.log('beep beep', 'error')
  2213. // console.debug debug should have been called 2 times above,
  2214. // ibut we call log n Core’ constructor to output VERSION, hence +1 here
  2215. // @ts-ignore
  2216. expect(console.debug.mock.calls.length).toBe(3)
  2217. // @ts-ignore
  2218. expect(console.error.mock.calls.length).toBe(1)
  2219. // @ts-ignore
  2220. console.debug.mockClear()
  2221. // @ts-ignore
  2222. console.error.mockClear()
  2223. const core2 = new Core({
  2224. debug: true,
  2225. })
  2226. core2.log('test test')
  2227. core2.log('beep boop')
  2228. core2.log('beep beep', 'error')
  2229. // console.debug debug should have been called 2 times here,
  2230. // but we call log in Core constructor to output VERSION, hence +1 here
  2231. // @ts-ignore
  2232. expect(console.debug.mock.calls.length).toBe(3)
  2233. // @ts-ignore
  2234. expect(console.error.mock.calls.length).toBe(1)
  2235. })
  2236. it('should only log errors to console when logger is not set', () => {
  2237. console.debug = vi.fn()
  2238. console.error = vi.fn()
  2239. const core = new Core()
  2240. core.log('test test')
  2241. core.log('beep boop')
  2242. core.log('beep beep', 'error')
  2243. // @ts-ignore
  2244. expect(console.debug.mock.calls.length).toBe(0)
  2245. // @ts-ignore
  2246. expect(console.error.mock.calls.length).toBe(1)
  2247. })
  2248. })
  2249. })