Uppy.test.ts 71 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631
  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. // @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. /individualCancellation is disabled/,
  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 (/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. // @ts-ignore
  1494. core.emit('upload-progress', file, {
  1495. bytesUploaded: 12345,
  1496. bytesTotal: 17175,
  1497. })
  1498. expect(core.getFile(fileId).progress).toEqual({
  1499. percentage: 72,
  1500. bytesUploaded: 12345,
  1501. bytesTotal: 17175,
  1502. uploadComplete: false,
  1503. uploadStarted: null,
  1504. })
  1505. // @ts-ignore
  1506. core.emit('upload-progress', file, {
  1507. bytesUploaded: 17175,
  1508. bytesTotal: 17175,
  1509. })
  1510. core.calculateProgress.flush()
  1511. expect(core.getFile(fileId).progress).toEqual({
  1512. percentage: 100,
  1513. bytesUploaded: 17175,
  1514. bytesTotal: 17175,
  1515. uploadComplete: false,
  1516. uploadStarted: null,
  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. core.calculateTotalProgress()
  1549. const uploadPromise = core.upload()
  1550. await Promise.all([
  1551. new Promise((resolve) => core.once('upload-start', resolve)),
  1552. ])
  1553. expect(core.getFiles()[0].size).toBeNull()
  1554. expect(core.getFiles()[0].progress).toMatchObject({
  1555. bytesUploaded: 0,
  1556. // null indicates unsized
  1557. bytesTotal: null,
  1558. percentage: 0,
  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. core.calculateTotalProgress()
  1618. // foo.jpg at 35%, bar.jpg at 0%
  1619. expect(core.getState().totalProgress).toBe(18)
  1620. core.destroy()
  1621. })
  1622. it('should calculate the total progress of all file uploads', () => {
  1623. // use DeepFrozenStore in some tests to make sure we are not mutating things
  1624. const core = new Core({
  1625. store: DeepFrozenStore(),
  1626. })
  1627. core.addFile({
  1628. source: 'vi',
  1629. name: 'foo.jpg',
  1630. type: 'image/jpeg',
  1631. data: testImage,
  1632. })
  1633. core.addFile({
  1634. source: 'vi',
  1635. name: 'foo2.jpg',
  1636. type: 'image/jpeg',
  1637. data: testImage,
  1638. })
  1639. const [file1, file2] = core.getFiles()
  1640. core.setFileState(file1.id, {
  1641. // @ts-ignore suddenly dates??
  1642. progress: { ...file1.progress, uploadStarted: new Date() },
  1643. })
  1644. core.setFileState(file2.id, {
  1645. // @ts-ignore suddenly dates??
  1646. progress: { ...file2.progress, uploadStarted: new Date() },
  1647. })
  1648. // @ts-ignore test does not care about missing properties
  1649. core.emit('upload-progress', core.getFile(file1.id), {
  1650. bytesUploaded: 12345,
  1651. bytesTotal: 17175,
  1652. })
  1653. // @ts-ignore test does not care about missing properties
  1654. core.emit('upload-progress', core.getFile(file2.id), {
  1655. bytesUploaded: 10201,
  1656. bytesTotal: 17175,
  1657. })
  1658. core.calculateTotalProgress()
  1659. core.calculateProgress.flush()
  1660. expect(core.getState().totalProgress).toEqual(66)
  1661. })
  1662. it('should reset the progress', () => {
  1663. const resetProgressEvent = vi.fn()
  1664. const core = new Core()
  1665. core.on('reset-progress', resetProgressEvent)
  1666. core.addFile({
  1667. source: 'vi',
  1668. name: 'foo.jpg',
  1669. type: 'image/jpeg',
  1670. data: testImage,
  1671. })
  1672. core.addFile({
  1673. source: 'vi',
  1674. name: 'foo2.jpg',
  1675. type: 'image/jpeg',
  1676. data: testImage,
  1677. })
  1678. const [file1, file2] = core.getFiles()
  1679. core.setFileState(file1.id, {
  1680. // @ts-ignore suddenly dates??
  1681. progress: { ...file1.progress, uploadStarted: new Date() },
  1682. })
  1683. core.setFileState(file2.id, {
  1684. // @ts-ignore suddenly dates??
  1685. progress: { ...file2.progress, uploadStarted: new Date() },
  1686. })
  1687. // @ts-ignore test does not care about missing properties
  1688. core.emit('upload-progress', core.getFile(file1.id), {
  1689. bytesUploaded: 12345,
  1690. bytesTotal: 17175,
  1691. })
  1692. // @ts-ignore test does not care about missing properties
  1693. core.emit('upload-progress', core.getFile(file2.id), {
  1694. bytesUploaded: 10201,
  1695. bytesTotal: 17175,
  1696. })
  1697. core.calculateTotalProgress()
  1698. core.calculateProgress.flush()
  1699. expect(core.getState().totalProgress).toEqual(66)
  1700. core.resetProgress()
  1701. expect(core.getFile(file1.id).progress).toEqual({
  1702. percentage: 0,
  1703. bytesUploaded: false,
  1704. bytesTotal: 17175,
  1705. uploadComplete: false,
  1706. uploadStarted: null,
  1707. })
  1708. expect(core.getFile(file2.id).progress).toEqual({
  1709. percentage: 0,
  1710. bytesUploaded: false,
  1711. bytesTotal: 17175,
  1712. uploadComplete: false,
  1713. uploadStarted: null,
  1714. })
  1715. expect(core.getState().totalProgress).toEqual(0)
  1716. expect(core.getState().allowNewUpload).toEqual(true)
  1717. expect(core.getState().error).toEqual(null)
  1718. expect(core.getState().recoveredState).toEqual(null)
  1719. expect(resetProgressEvent.mock.calls.length).toEqual(1)
  1720. })
  1721. })
  1722. describe('checkRestrictions', () => {
  1723. it('should enforce the maxNumberOfFiles rule', () => {
  1724. const core = new Core({
  1725. restrictions: {
  1726. maxNumberOfFiles: 1,
  1727. },
  1728. })
  1729. // add 2 files
  1730. core.addFile({
  1731. source: 'vi',
  1732. name: 'foo1.jpg',
  1733. type: 'image/jpeg',
  1734. data: testImage,
  1735. })
  1736. try {
  1737. core.addFile({
  1738. source: 'vi',
  1739. name: 'foo2.jpg',
  1740. type: 'image/jpeg',
  1741. data: testImage,
  1742. })
  1743. throw new Error('should have thrown')
  1744. } catch (err) {
  1745. expect(err).toMatchObject(new Error('You can only upload 1 file'))
  1746. expect(core.getState().info[0].message).toEqual(
  1747. 'You can only upload 1 file',
  1748. )
  1749. }
  1750. })
  1751. it('should not enforce the maxNumberOfFiles rule for ghost files', () => {
  1752. const core = new Core({
  1753. restrictions: {
  1754. maxNumberOfFiles: 1,
  1755. },
  1756. })
  1757. expect(() => {
  1758. // add 1 ghost file
  1759. const fileId1 = core.addFile({
  1760. source: 'vi',
  1761. name: 'foo1.jpg',
  1762. type: 'image/jpeg',
  1763. data: testImage,
  1764. })
  1765. core.setFileState(fileId1, { isGhost: true })
  1766. // add another file
  1767. core.addFile({
  1768. source: 'vi',
  1769. name: 'foo2.jpg',
  1770. type: 'image/jpeg',
  1771. data: testImage,
  1772. })
  1773. }).not.toThrowError()
  1774. })
  1775. it.skip('should enforce the minNumberOfFiles rule')
  1776. it('should enforce the allowedFileTypes rule', () => {
  1777. const core = new Core({
  1778. restrictions: {
  1779. allowedFileTypes: ['image/gif', 'image/png'],
  1780. },
  1781. })
  1782. try {
  1783. core.addFile({
  1784. source: 'vi',
  1785. name: 'foo2.jpg',
  1786. type: 'image/jpeg',
  1787. data: testImage,
  1788. })
  1789. throw new Error('should have thrown')
  1790. } catch (err) {
  1791. expect(err).toMatchObject(
  1792. new Error('You can only upload: image/gif, image/png'),
  1793. )
  1794. expect(core.getState().info[0].message).toEqual(
  1795. 'You can only upload: image/gif, image/png',
  1796. )
  1797. }
  1798. })
  1799. it('should throw if allowedFileTypes is not an array', () => {
  1800. try {
  1801. const core = new Core({
  1802. restrictions: {
  1803. // @ts-ignore
  1804. allowedFileTypes: 'image/gif',
  1805. },
  1806. })
  1807. core.log('hi')
  1808. } catch (err) {
  1809. expect(err).toMatchObject(
  1810. new Error('`restrictions.allowedFileTypes` must be an array'),
  1811. )
  1812. }
  1813. })
  1814. it('should enforce the allowedFileTypes rule with file extensions', () => {
  1815. const core = new Core({
  1816. restrictions: {
  1817. allowedFileTypes: ['.gif', '.jpg', '.jpeg'],
  1818. },
  1819. })
  1820. try {
  1821. core.addFile({
  1822. source: 'vi',
  1823. name: 'foo2.png',
  1824. type: '',
  1825. data: testImage,
  1826. })
  1827. throw new Error('should have thrown')
  1828. } catch (err) {
  1829. expect(err).toMatchObject(
  1830. new Error('You can only upload: .gif, .jpg, .jpeg'),
  1831. )
  1832. expect(core.getState().info[0].message).toEqual(
  1833. 'You can only upload: .gif, .jpg, .jpeg',
  1834. )
  1835. }
  1836. expect(() =>
  1837. core.addFile({
  1838. source: 'vi',
  1839. name: 'foo2.JPG',
  1840. type: '',
  1841. data: testImage,
  1842. }),
  1843. ).not.toThrow()
  1844. })
  1845. it('should enforce the maxFileSize rule', () => {
  1846. const core = new Core({
  1847. restrictions: {
  1848. maxFileSize: 1234,
  1849. },
  1850. })
  1851. try {
  1852. core.addFile({
  1853. source: 'vi',
  1854. name: 'foo.jpg',
  1855. type: 'image/jpeg',
  1856. data: testImage,
  1857. })
  1858. throw new Error('should have thrown')
  1859. } catch (err) {
  1860. expect(err).toMatchObject(
  1861. new Error('foo.jpg exceeds maximum allowed size of 1.2 KB'),
  1862. )
  1863. expect(core.getState().info[0].message).toEqual(
  1864. 'foo.jpg exceeds maximum allowed size of 1.2 KB',
  1865. )
  1866. }
  1867. })
  1868. it('should enforce the minFileSize rule', () => {
  1869. const core = new Core({
  1870. restrictions: {
  1871. minFileSize: 1073741824,
  1872. },
  1873. })
  1874. try {
  1875. core.addFile({
  1876. source: 'vi',
  1877. name: 'foo.jpg',
  1878. type: 'image/jpeg',
  1879. data: testImage,
  1880. })
  1881. throw new Error('should have thrown')
  1882. } catch (err) {
  1883. expect(err).toMatchObject(
  1884. new Error('This file is smaller than the allowed size of 1 GB'),
  1885. )
  1886. expect(core.getState().info[0].message).toEqual(
  1887. 'This file is smaller than the allowed size of 1 GB',
  1888. )
  1889. }
  1890. })
  1891. it('should enforce the maxTotalFileSize rule', () => {
  1892. const core = new Core({
  1893. restrictions: {
  1894. maxTotalFileSize: 34000,
  1895. },
  1896. })
  1897. core.addFile({
  1898. source: 'vi',
  1899. name: 'foo.jpg',
  1900. type: 'image/jpeg',
  1901. data: testImage,
  1902. })
  1903. expect(() => {
  1904. core.addFile({
  1905. source: 'vi',
  1906. name: 'foo1.jpg',
  1907. type: 'image/jpeg',
  1908. data: testImage,
  1909. })
  1910. }).toThrowError(
  1911. new Error('foo1.jpg exceeds maximum allowed size of 33 KB'),
  1912. )
  1913. })
  1914. it('should check if a file validateRestrictions', () => {
  1915. const core = new Core({
  1916. restrictions: {
  1917. minFileSize: 300000,
  1918. },
  1919. })
  1920. const core2 = new Core({
  1921. restrictions: {
  1922. allowedFileTypes: ['image/png'],
  1923. },
  1924. })
  1925. const newFile = {
  1926. source: 'vi',
  1927. name: 'foo1.jpg',
  1928. extension: 'jpg',
  1929. type: 'image/jpeg',
  1930. data: testImage,
  1931. isFolder: false,
  1932. mimeType: 'image/jpeg',
  1933. modifiedDate: '2016-04-13T15:11:31.204Z',
  1934. size: 270733,
  1935. }
  1936. // @ts-ignore
  1937. const validateRestrictions1 = core.validateRestrictions(newFile)
  1938. // @ts-ignore
  1939. const validateRestrictions2 = core2.validateRestrictions(newFile)
  1940. expect(validateRestrictions1!.message).toEqual(
  1941. 'This file is smaller than the allowed size of 293 KB',
  1942. )
  1943. expect(validateRestrictions2!.message).toEqual(
  1944. 'You can only upload: image/png',
  1945. )
  1946. })
  1947. it('should emit `restriction-failed` event when some rule is violated', () => {
  1948. const maxFileSize = 100
  1949. const core = new Core({
  1950. restrictions: {
  1951. maxFileSize,
  1952. },
  1953. })
  1954. const restrictionsViolatedEventMock = vi.fn()
  1955. const file = {
  1956. source: 'vi',
  1957. type: 'image/jpeg',
  1958. name: 'test.jpg',
  1959. data: new Blob([new Uint8Array(2 * maxFileSize)]),
  1960. }
  1961. const errorMessage = core.i18n('exceedsSize', {
  1962. file: file.name,
  1963. size: prettierBytes(maxFileSize),
  1964. })
  1965. try {
  1966. core.on('restriction-failed', restrictionsViolatedEventMock)
  1967. core.addFile(file)
  1968. } catch {
  1969. // Ignore errors
  1970. }
  1971. expect(restrictionsViolatedEventMock.mock.calls.length).toEqual(1)
  1972. expect(restrictionsViolatedEventMock.mock.calls[0][0].name).toEqual(
  1973. file.name,
  1974. )
  1975. expect(restrictionsViolatedEventMock.mock.calls[0][1].message).toEqual(
  1976. errorMessage,
  1977. )
  1978. })
  1979. })
  1980. describe('actions', () => {
  1981. it('should update the state when receiving the error event', () => {
  1982. const core = new Core()
  1983. core.emit('error', new Error('foooooo'))
  1984. expect(core.getState().error).toEqual('foooooo')
  1985. })
  1986. it('should update the state when receiving the upload-error event', () => {
  1987. const core = new Core()
  1988. core.setState({
  1989. files: {
  1990. // @ts-ignore
  1991. fileId: {
  1992. id: 'fileId',
  1993. name: 'filename',
  1994. },
  1995. },
  1996. })
  1997. // @ts-ignore test does not care about missing properties
  1998. core.emit(
  1999. 'upload-error',
  2000. core.getFile('fileId'),
  2001. new Error('this is the error'),
  2002. )
  2003. expect(core.getState().info).toEqual([
  2004. {
  2005. message: 'Failed to upload filename',
  2006. details: 'this is the error',
  2007. type: 'error',
  2008. },
  2009. ])
  2010. })
  2011. it('should reset the error state when receiving the upload event', () => {
  2012. const core = new Core()
  2013. // @ts-ignore test does not care about missing properties
  2014. core.emit('error', { foo: 'bar' })
  2015. // @ts-ignore test does not care about missing properties
  2016. core.emit('upload')
  2017. expect(core.getState().error).toEqual(null)
  2018. })
  2019. })
  2020. describe('updateOnlineStatus', () => {
  2021. const RealNavigatorOnline = globalThis.window.navigator.onLine
  2022. function mockNavigatorOnline(status: boolean) {
  2023. Object.defineProperty(globalThis.window.navigator, 'onLine', {
  2024. value: status,
  2025. writable: true,
  2026. })
  2027. }
  2028. afterEach(() => {
  2029. // @ts-ignore readonly but whatever
  2030. globalThis.window.navigator.onLine = RealNavigatorOnline
  2031. })
  2032. it('should emit the correct event based on whether there is a network connection', () => {
  2033. const onlineEventMock = vi.fn()
  2034. const offlineEventMock = vi.fn()
  2035. const backOnlineEventMock = vi.fn()
  2036. const core = new Core()
  2037. // @ts-ignore untyped
  2038. core.on('is-offline', offlineEventMock)
  2039. // @ts-ignore untyped
  2040. core.on('is-online', onlineEventMock)
  2041. // @ts-ignore untyped
  2042. core.on('back-online', backOnlineEventMock)
  2043. mockNavigatorOnline(true)
  2044. core.updateOnlineStatus()
  2045. expect(onlineEventMock.mock.calls.length).toEqual(1)
  2046. expect(offlineEventMock.mock.calls.length).toEqual(0)
  2047. expect(backOnlineEventMock.mock.calls.length).toEqual(0)
  2048. mockNavigatorOnline(false)
  2049. core.updateOnlineStatus()
  2050. expect(onlineEventMock.mock.calls.length).toEqual(1)
  2051. expect(offlineEventMock.mock.calls.length).toEqual(1)
  2052. expect(backOnlineEventMock.mock.calls.length).toEqual(0)
  2053. mockNavigatorOnline(true)
  2054. core.updateOnlineStatus()
  2055. expect(onlineEventMock.mock.calls.length).toEqual(2)
  2056. expect(offlineEventMock.mock.calls.length).toEqual(1)
  2057. expect(backOnlineEventMock.mock.calls.length).toEqual(1)
  2058. })
  2059. })
  2060. describe('info', () => {
  2061. it('should set a string based message to be displayed infinitely', () => {
  2062. const infoVisibleEvent = vi.fn()
  2063. const core = new Core()
  2064. core.on('info-visible', infoVisibleEvent)
  2065. core.info('This is the message', 'info', 0)
  2066. expect(core.getState().info).toEqual([
  2067. {
  2068. type: 'info',
  2069. message: 'This is the message',
  2070. details: null,
  2071. },
  2072. ])
  2073. expect(infoVisibleEvent.mock.calls.length).toEqual(1)
  2074. })
  2075. it('should set a object based message to be displayed infinitely', () => {
  2076. const infoVisibleEvent = vi.fn()
  2077. const core = new Core()
  2078. core.on('info-visible', infoVisibleEvent)
  2079. core.info(
  2080. {
  2081. message: 'This is the message',
  2082. details: {
  2083. foo: 'bar',
  2084. },
  2085. },
  2086. 'warning',
  2087. 0,
  2088. )
  2089. expect(core.getState().info).toEqual([
  2090. {
  2091. type: 'warning',
  2092. message: 'This is the message',
  2093. details: {
  2094. foo: 'bar',
  2095. },
  2096. },
  2097. ])
  2098. expect(infoVisibleEvent.mock.calls.length).toEqual(1)
  2099. })
  2100. it('should set an info message to be displayed for a period of time before hiding', (done) => {
  2101. const infoVisibleEvent = vi.fn()
  2102. const infoHiddenEvent = vi.fn()
  2103. const core = new Core()
  2104. core.on('info-visible', infoVisibleEvent)
  2105. core.on('info-hidden', infoHiddenEvent)
  2106. core.info('This is the message', 'info', 100)
  2107. expect(infoHiddenEvent.mock.calls.length).toEqual(0)
  2108. setTimeout(() => {
  2109. expect(infoHiddenEvent.mock.calls.length).toEqual(1)
  2110. expect(core.getState().info).toEqual([])
  2111. // @ts-ignore
  2112. done()
  2113. }, 110)
  2114. })
  2115. it('should hide an info message', () => {
  2116. const infoVisibleEvent = vi.fn()
  2117. const infoHiddenEvent = vi.fn()
  2118. const core = new Core()
  2119. core.on('info-visible', infoVisibleEvent)
  2120. core.on('info-hidden', infoHiddenEvent)
  2121. core.info('This is the message', 'info', 0)
  2122. expect(infoHiddenEvent.mock.calls.length).toEqual(0)
  2123. core.hideInfo()
  2124. expect(infoHiddenEvent.mock.calls.length).toEqual(1)
  2125. expect(core.getState().info).toEqual([])
  2126. })
  2127. it('should support multiple messages', () => {
  2128. const infoVisibleEvent = vi.fn()
  2129. const infoHiddenEvent = vi.fn()
  2130. const core = new Core()
  2131. core.on('info-visible', infoVisibleEvent)
  2132. core.on('info-hidden', infoHiddenEvent)
  2133. core.info('This is the message', 'info', 0)
  2134. core.info('But this is another one', 'info', 0)
  2135. expect(infoHiddenEvent.mock.calls.length).toEqual(0)
  2136. expect(core.getState().info).toEqual([
  2137. {
  2138. type: 'info',
  2139. message: 'This is the message',
  2140. details: null,
  2141. },
  2142. {
  2143. type: 'info',
  2144. message: 'But this is another one',
  2145. details: null,
  2146. },
  2147. ])
  2148. core.hideInfo()
  2149. expect(core.getState().info).toEqual([
  2150. {
  2151. type: 'info',
  2152. message: 'But this is another one',
  2153. details: null,
  2154. },
  2155. ])
  2156. core.hideInfo()
  2157. expect(infoHiddenEvent.mock.calls.length).toEqual(2)
  2158. expect(core.getState().info).toEqual([])
  2159. })
  2160. })
  2161. describe('createUpload', () => {
  2162. it('should assign the specified files to a new upload', () => {
  2163. const core = new Core()
  2164. core.addFile({
  2165. source: 'vi',
  2166. name: 'foo.jpg',
  2167. type: 'image/jpeg',
  2168. data: testImage,
  2169. })
  2170. // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  2171. // @ts-ignore accessing private method
  2172. core[Symbol.for('uppy test: createUpload')](
  2173. Object.keys(core.getState().files),
  2174. )
  2175. const uploadId = Object.keys(core.getState().currentUploads)[0]
  2176. const currentUploadsState: State<any, any>['currentUploads'] = {}
  2177. currentUploadsState[uploadId] = {
  2178. fileIDs: Object.keys(core.getState().files),
  2179. step: 0,
  2180. result: {},
  2181. }
  2182. expect(core.getState().currentUploads).toEqual(currentUploadsState)
  2183. })
  2184. })
  2185. describe('i18n', () => {
  2186. it('merges in custom locale strings', () => {
  2187. const core = new Core({
  2188. locale: {
  2189. strings: {
  2190. test: 'beep boop',
  2191. },
  2192. pluralize: () => 0,
  2193. },
  2194. })
  2195. expect(core.i18n('exceedsSize')).toBe(
  2196. '%{file} exceeds maximum allowed size of %{size}',
  2197. )
  2198. expect(core.i18n('test')).toBe('beep boop')
  2199. })
  2200. })
  2201. describe('default restrictions', () => {
  2202. it('should be merged with supplied restrictions', () => {
  2203. const core = new Core({
  2204. restrictions: {
  2205. maxNumberOfFiles: 3,
  2206. },
  2207. })
  2208. expect(core.opts.restrictions.maxNumberOfFiles).toBe(3)
  2209. expect(core.opts.restrictions.minNumberOfFiles).toBe(null)
  2210. })
  2211. })
  2212. describe('log', () => {
  2213. it('should log via provided logger function', () => {
  2214. const myTestLogger = {
  2215. debug: vi.fn(),
  2216. warn: vi.fn(),
  2217. error: vi.fn(),
  2218. }
  2219. const core = new Core({
  2220. logger: myTestLogger,
  2221. })
  2222. core.log('test test')
  2223. core.log('test test', 'error')
  2224. core.log('test test', 'error')
  2225. core.log('test test', 'warning')
  2226. // logger.debug should have been called 1 time above,
  2227. // but we call log in Core’s constructor to output VERSION, hence +1 here
  2228. // @ts-ignore
  2229. expect(core.opts.logger.debug.mock.calls.length).toBe(2)
  2230. // @ts-ignore
  2231. expect(core.opts.logger.error.mock.calls.length).toBe(2)
  2232. // @ts-ignore
  2233. expect(core.opts.logger.warn.mock.calls.length).toBe(1)
  2234. })
  2235. it('should log via provided logger function, even if debug: true', () => {
  2236. const myTestLogger = {
  2237. debug: vi.fn(),
  2238. warn: vi.fn(),
  2239. error: vi.fn(),
  2240. }
  2241. const core = new Core({
  2242. logger: myTestLogger,
  2243. debug: true,
  2244. })
  2245. core.log('test test')
  2246. core.log('test test', 'error')
  2247. core.log('test test', 'error')
  2248. core.log('test test', 'warning')
  2249. // logger.debug should have been called 1 time above,
  2250. // but we call log in Core’s constructor to output VERSION, hence +1 here
  2251. // @ts-ignore
  2252. expect(core.opts.logger.debug.mock.calls.length).toBe(2)
  2253. // @ts-ignore
  2254. expect(core.opts.logger.error.mock.calls.length).toBe(2)
  2255. // logger.warn should have been called 1 time above,
  2256. // but we warn in Core when using both logger and debug: true, hence +1 here
  2257. // @ts-ignore
  2258. expect(core.opts.logger.warn.mock.calls.length).toBe(2)
  2259. })
  2260. it('should log to console when logger: Uppy.debugLogger or debug: true is set', () => {
  2261. console.debug = vi.fn()
  2262. console.error = vi.fn()
  2263. const core = new Core({
  2264. logger: debugLogger,
  2265. })
  2266. core.log('test test')
  2267. core.log('beep boop')
  2268. core.log('beep beep', 'error')
  2269. // console.debug debug should have been called 2 times above,
  2270. // ibut we call log n Core’ constructor to output VERSION, hence +1 here
  2271. // @ts-ignore
  2272. expect(console.debug.mock.calls.length).toBe(3)
  2273. // @ts-ignore
  2274. expect(console.error.mock.calls.length).toBe(1)
  2275. // @ts-ignore
  2276. console.debug.mockClear()
  2277. // @ts-ignore
  2278. console.error.mockClear()
  2279. const core2 = new Core({
  2280. debug: true,
  2281. })
  2282. core2.log('test test')
  2283. core2.log('beep boop')
  2284. core2.log('beep beep', 'error')
  2285. // console.debug debug should have been called 2 times here,
  2286. // but we call log in Core constructor to output VERSION, hence +1 here
  2287. // @ts-ignore
  2288. expect(console.debug.mock.calls.length).toBe(3)
  2289. // @ts-ignore
  2290. expect(console.error.mock.calls.length).toBe(1)
  2291. })
  2292. it('should only log errors to console when logger is not set', () => {
  2293. console.debug = vi.fn()
  2294. console.error = vi.fn()
  2295. const core = new Core()
  2296. core.log('test test')
  2297. core.log('beep boop')
  2298. core.log('beep beep', 'error')
  2299. // @ts-ignore
  2300. expect(console.debug.mock.calls.length).toBe(0)
  2301. // @ts-ignore
  2302. expect(console.error.mock.calls.length).toBe(1)
  2303. })
  2304. })
  2305. })