Uppy.test.ts 71 KB

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