Uppy.test.ts 71 KB

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