12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660 |
- /* eslint-disable @typescript-eslint/ban-ts-comment */
- /* eslint no-console: "off", no-restricted-syntax: "off" */
- import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
- import assert from 'node:assert'
- import fs from 'node:fs'
- import path from 'node:path'
- import prettierBytes from '@transloadit/prettier-bytes'
- import type { Body, Meta } from '@uppy/utils/lib/UppyFile'
- import type { Locale } from '@uppy/utils/lib/Translator'
- import Core from './index.ts'
- import UIPlugin from './UIPlugin.ts'
- import BasePlugin, {
- type DefinePluginOpts,
- type PluginOpts,
- } from './BasePlugin.ts'
- import { debugLogger } from './loggers.ts'
- import AcquirerPlugin1 from './mocks/acquirerPlugin1.ts'
- import AcquirerPlugin2 from './mocks/acquirerPlugin2.ts'
- import InvalidPlugin from './mocks/invalidPlugin.ts'
- import InvalidPluginWithoutId from './mocks/invalidPluginWithoutId.ts'
- import InvalidPluginWithoutType from './mocks/invalidPluginWithoutType.ts'
- // @ts-expect-error trying to import a file from outside the package
- import DeepFrozenStore from '../../../../e2e/cypress/fixtures/DeepFrozenStore.mjs'
- import type { State } from './Uppy.ts'
- const sampleImage = fs.readFileSync(
- // eslint-disable-next-line no-restricted-globals
- path.join(__dirname, '../../../../e2e/cypress/fixtures/images/image.jpg'),
- )
- // @ts-expect-error type object can be second argument
- const testImage = new File([sampleImage], { type: 'image/jpeg' })
- describe('src/Core', () => {
- const RealCreateObjectUrl = globalThis.URL.createObjectURL
- beforeEach(() => {
- globalThis.URL.createObjectURL = vi.fn().mockReturnValue('newUrl')
- })
- afterEach(() => {
- globalThis.URL.createObjectURL = RealCreateObjectUrl
- })
- it('should expose a class', () => {
- const core = new Core()
- expect(core.constructor.name).toEqual('Uppy')
- })
- it('should have a string `id` option that defaults to "uppy"', () => {
- const core = new Core()
- expect(core.getID()).toEqual('uppy')
- const core2 = new Core({ id: 'profile' })
- expect(core2.getID()).toEqual('profile')
- })
- describe('plugins', () => {
- it('should add a plugin to the plugin stack', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- expect(
- // @ts-expect-error untyped
- Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
- .length,
- ).toEqual(1)
- })
- it('should be able to .use() without passing generics again', () => {
- {
- interface TestOpts extends PluginOpts {
- foo?: string
- bar: string
- }
- class TestPlugin<M extends Meta, B extends Body> extends BasePlugin<
- TestOpts,
- M,
- B
- > {
- foo: string
- bar: string
- constructor(uppy: Core<M, B>, opts: TestOpts) {
- super(uppy, opts)
- this.id = 'Test'
- this.type = 'acquirer'
- this.foo = this.opts.foo ?? 'defaultFoo'
- this.bar = this.opts.bar
- }
- }
- // @ts-expect-error missing mandatory option foo
- new Core().use(TestPlugin)
- new Core().use(TestPlugin, { foo: '', bar: '' })
- // @ts-expect-error boolean not allowed
- new Core().use(TestPlugin, { bar: false })
- // @ts-expect-error missing option
- new Core().use(TestPlugin, { foo: '' })
- }
- {
- interface TestOpts extends PluginOpts {
- foo?: string
- bar?: string
- }
- const defaultOptions = {
- foo: 'defaultFoo',
- }
- class TestPlugin<M extends Meta, B extends Body> extends BasePlugin<
- DefinePluginOpts<TestOpts, keyof typeof defaultOptions>,
- M,
- B
- > {
- constructor(uppy: Core<M, B>, opts?: TestOpts) {
- super(uppy, { ...defaultOptions, ...opts })
- this.id = this.opts.id ?? 'Test'
- this.type = 'acquirer'
- }
- }
- new Core().use(TestPlugin)
- new Core().use(TestPlugin, { foo: '', bar: '' })
- new Core().use(TestPlugin, { foo: '' })
- new Core().use(TestPlugin, { bar: '' })
- // @ts-expect-error boolean not allowed
- new Core().use(TestPlugin, { foo: false })
- }
- })
- it('should prevent the same plugin from being added more than once', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- expect(() => {
- core.use(AcquirerPlugin1)
- }).toThrowErrorMatchingSnapshot()
- })
- it('should not be able to add an invalid plugin', () => {
- const core = new Core()
- expect(() => {
- // @ts-expect-error expected
- core.use(InvalidPlugin)
- }).toThrowErrorMatchingSnapshot()
- })
- it('should not be able to add a plugin that has no id', () => {
- const core = new Core()
- expect(() =>
- core.use(InvalidPluginWithoutId),
- ).toThrowErrorMatchingSnapshot()
- })
- it('should not be able to add a plugin that has no type', () => {
- const core = new Core()
- expect(() =>
- core.use(InvalidPluginWithoutType),
- ).toThrowErrorMatchingSnapshot()
- })
- it('should return the plugin that matches the specified name', () => {
- const core = new Core()
- expect(core.getPlugin('foo')).toEqual(undefined)
- core.use(AcquirerPlugin1)
- const plugin = core.getPlugin('TestSelector1')
- expect(plugin!.id).toEqual('TestSelector1')
- expect(plugin instanceof UIPlugin)
- })
- it('should call the specified method on all the plugins', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- core.iteratePlugins((plugin) => {
- // @ts-ignore
- plugin.run('hello')
- })
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
- .calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
- .calls[0],
- ).toEqual(['hello'])
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.run.mock
- .calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.run.mock
- .calls[0],
- ).toEqual(['hello'])
- })
- it('should uninstall and the remove the specified plugin', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- expect(
- // @ts-ignore
- Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
- .length,
- ).toEqual(2)
- const plugin = core.getPlugin('TestSelector1')
- core.removePlugin(plugin!)
- expect(
- // @ts-ignore
- Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
- .length,
- ).toEqual(1)
- // @ts-ignore
- expect(plugin.mocks.uninstall.mock.calls.length).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
- .calls.length,
- ).toEqual(0)
- })
- })
- describe('state', () => {
- it('should update all the plugins with the new state when the updateAll method is called', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- core.updateAll({ foo: 'bar' })
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
- .mock.calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
- .mock.calls[0],
- ).toEqual([{ foo: 'bar' }])
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
- .mock.calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
- .mock.calls[0],
- ).toEqual([{ foo: 'bar' }])
- })
- it('should update the state', () => {
- const core = new Core()
- const stateUpdateEventMock = vi.fn()
- core.on('state-update', stateUpdateEventMock)
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- core.setState({ foo: 'bar', bee: 'boo' })
- core.setState({ foo: 'baar' })
- const newState = {
- bee: 'boo',
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- error: null,
- allowNewUpload: true,
- foo: 'baar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- }
- expect(core.getState()).toEqual(newState)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
- .mock.calls[1],
- ).toEqual([newState])
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
- .mock.calls[1],
- ).toEqual([newState])
- expect(stateUpdateEventMock.mock.calls.length).toEqual(2)
- // current state
- expect(stateUpdateEventMock.mock.calls[1][0]).toEqual({
- bee: 'boo',
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- error: null,
- allowNewUpload: true,
- foo: 'bar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- // new state
- expect(stateUpdateEventMock.mock.calls[1][1]).toEqual({
- bee: 'boo',
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- error: null,
- allowNewUpload: true,
- foo: 'baar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- })
- it('should get the state', () => {
- const core = new Core()
- core.setState({ foo: 'bar' })
- expect(core.getState()).toMatchObject({ foo: 'bar' })
- })
- })
- it('should cancel all when the `cancelAll` method is called', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- // const corePauseEventMock = vi.fn()
- const coreCancelEventMock = vi.fn()
- const coreStateUpdateEventMock = vi.fn()
- core.on('cancel-all', coreCancelEventMock)
- core.on('state-update', coreStateUpdateEventMock)
- core.setState({ foo: 'bar', totalProgress: 30 })
- core.cancelAll()
- expect(coreCancelEventMock).toHaveBeenCalledWith(
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- )
- expect(coreStateUpdateEventMock.mock.calls.length).toEqual(2)
- expect(coreStateUpdateEventMock.mock.calls[1][1]).toEqual({
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- allowNewUpload: true,
- error: null,
- foo: 'bar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- })
- it('should clear all uploads and files on cancelAll()', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- core.cancelAll()
- expect(core.getState().currentUploads[id]).toBeUndefined()
- expect(Object.keys(core.getState().files).length).toEqual(0)
- })
- it('should allow remove all uploads when individualCancellation is disabled', () => {
- const core = new Core()
- const { capabilities } = core.getState()
- core.setState({
- capabilities: {
- ...capabilities,
- individualCancellation: false,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- core.removeFiles(fileIDs)
- expect(core.getState().currentUploads[id]).toBeUndefined()
- expect(Object.keys(core.getState().files).length).toEqual(0)
- })
- it('should disallow remove one upload when individualCancellation is disabled', () => {
- const core = new Core()
- const { capabilities } = core.getState()
- core.setState({
- capabilities: {
- ...capabilities,
- individualCancellation: false,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- assert.throws(
- () => core.removeFile(fileIDs[0]),
- /The installed uploader plugin does not allow removing files during an upload/,
- )
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- })
- it('should allow remove one upload when individualCancellation is enabled', () => {
- const core = new Core()
- const { capabilities } = core.getState()
- core.setState({
- capabilities: {
- ...capabilities,
- individualCancellation: true,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- core.removeFile(fileIDs[0])
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(1)
- })
- it('should close, reset and uninstall when the close method is called', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- core.use(AcquirerPlugin1)
- const coreCancelEventMock = vi.fn()
- const coreStateUpdateEventMock = vi.fn()
- // @ts-ignore
- const plugin = core[Symbol.for('uppy test: getPlugins')]('acquirer')[0]
- core.on('cancel-all', coreCancelEventMock)
- core.on('state-update', coreStateUpdateEventMock)
- core.destroy()
- expect(coreCancelEventMock).toHaveBeenCalledWith(
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- )
- expect(coreStateUpdateEventMock.mock.calls.length).toEqual(1)
- expect(coreStateUpdateEventMock.mock.calls[0][1]).toEqual({
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- allowNewUpload: true,
- error: null,
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- expect(plugin.mocks.uninstall.mock.calls.length).toEqual(1)
- const pluginIteration = vi.fn()
- core.iteratePlugins(pluginIteration)
- expect(pluginIteration.mock.calls.length).toEqual(0)
- })
- describe('upload hooks', () => {
- it('should add data returned from upload hooks to the .upload() result', () => {
- const core = new Core()
- core.addPreProcessor((_, uploadID) => {
- core.addResultData(uploadID, { pre: 'ok' })
- })
- core.addPostProcessor((_, uploadID) => {
- core.addResultData(uploadID, { post: 'ok' })
- })
- core.addUploader((_, uploadID) => {
- core.addResultData(uploadID, { upload: 'ok' })
- })
- return core.upload().then((result) => {
- if (result) {
- expect(result.pre).toBe('ok')
- expect(result.upload).toBe('ok')
- expect(result.post).toBe('ok')
- }
- })
- })
- })
- describe('preprocessors', () => {
- it('should add and remove preprocessor', () => {
- const core = new Core()
- const preprocessor = () => {}
- expect(core.removePreProcessor(preprocessor)).toBe(false)
- core.addPreProcessor(preprocessor)
- expect(core.removePreProcessor(preprocessor)).toBe(true)
- expect(core.removePreProcessor(preprocessor)).toBe(false)
- })
- it('should execute all the preprocessors when uploading a file', () => {
- const core = new Core()
- const preprocessor1 = vi.fn()
- const preprocessor2 = vi.fn()
- core.addPreProcessor(preprocessor1)
- core.addPreProcessor(preprocessor2)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return core.upload().then(() => {
- const fileId = Object.keys(core.getState().files)[0]
- expect(preprocessor1.mock.calls.length).toEqual(1)
- expect(preprocessor1.mock.calls[0][0].length).toEqual(1)
- expect(preprocessor1.mock.calls[0][0][0]).toEqual(fileId)
- expect(preprocessor2.mock.calls[0][0].length).toEqual(1)
- expect(preprocessor2.mock.calls[0][0][0]).toEqual(fileId)
- })
- })
- it('should not pass removed file IDs to next step', async () => {
- const core = new Core()
- const uploader = vi.fn()
- core.addPreProcessor((fileIDs) => {
- core.removeFile(fileIDs[0])
- })
- core.addUploader(uploader)
- core.addFile({
- source: 'vi',
- name: 'rmd.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'kept.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.upload()
- expect(uploader.mock.calls.length).toEqual(1)
- expect(uploader.mock.calls[0][0].length).toEqual(1)
- expect(core.getFile(uploader.mock.calls[0][0][0]).name).toEqual(
- 'kept.jpg',
- )
- })
- it('should update the file progress state when preprocess-progress event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('preprocess-progress', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- preprocess: { mode: 'determinate', message: 'something', value: 0 },
- })
- })
- it('should update the file progress state when preprocess-complete event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileID = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileID)
- core.emit('preprocess-complete', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileID).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- })
- })
- describe('postprocessors', () => {
- it('should add and remove postprocessor', () => {
- const core = new Core()
- const postprocessor = () => {}
- expect(core.removePostProcessor(postprocessor)).toBe(false)
- core.addPostProcessor(postprocessor)
- expect(core.removePostProcessor(postprocessor)).toBe(true)
- expect(core.removePostProcessor(postprocessor)).toBe(false)
- })
- it('should execute all the postprocessors when uploading a file', () => {
- const core = new Core()
- const postprocessor1 = vi.fn()
- const postprocessor2 = vi.fn()
- core.addPostProcessor(postprocessor1)
- core.addPostProcessor(postprocessor2)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return core.upload().then(() => {
- expect(postprocessor1.mock.calls.length).toEqual(1)
- // const lastModifiedTime = new Date()
- // const fileId = 'foojpg' + lastModifiedTime.getTime()
- const fileId = 'uppy-foo/jpg-1e-image'
- expect(postprocessor1.mock.calls[0][0].length).toEqual(1)
- expect(postprocessor1.mock.calls[0][0][0].substring(0, 17)).toEqual(
- fileId.substring(0, 17),
- )
- expect(postprocessor2.mock.calls[0][0].length).toEqual(1)
- expect(postprocessor2.mock.calls[0][0][0].substring(0, 17)).toEqual(
- fileId.substring(0, 17),
- )
- })
- })
- it('should update the file progress state when postprocess-progress event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('postprocess-progress', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- postprocess: { mode: 'determinate', message: 'something', value: 0 },
- })
- })
- it('should update the file progress state when postprocess-complete event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('postprocess-complete', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- })
- it('should report an error if post-processing a file fails', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('error', new Error('foooooo'), file)
- expect(core.getState().error).toEqual('foooooo')
- expect(core.upload()).resolves.toMatchObject({
- failed: [{ name: 'foo.jpg' }],
- })
- })
- })
- describe('uploaders', () => {
- it('should add and remove uploader', () => {
- const core = new Core()
- const uploader = () => {}
- expect(core.removeUploader(uploader)).toBe(false)
- core.addUploader(uploader)
- expect(core.removeUploader(uploader)).toBe(true)
- expect(core.removeUploader(uploader)).toBe(false)
- })
- })
- describe('adding a file', () => {
- it('should call onBeforeFileAdded if it was specified in the options when initialising the class', () => {
- const onBeforeFileAdded = vi.fn()
- const core = new Core({
- // need to capture a snapshot of files, because files will change in the next tick, thus failing the expect below
- onBeforeFileAdded: (file, files) =>
- onBeforeFileAdded(file, { ...files }),
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- expect(onBeforeFileAdded.mock.calls.length).toEqual(1)
- expect(onBeforeFileAdded.mock.calls[0][0].name).toEqual('foo.jpg')
- expect(onBeforeFileAdded.mock.calls[0][1]).toEqual({})
- })
- it('should allow uploading duplicate file if explicitly allowed in onBeforeFileAdded', async () => {
- const core = new Core({ onBeforeFileAdded: () => true })
- const sameFileBlob = testImage
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- })
- })
- it('should add a file', () => {
- const fileData = testImage
- const fileAddedEventMock = vi.fn()
- const core = new Core()
- core.on('file-added', fileAddedEventMock)
- const fileId = core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: fileData,
- })
- const newFile = {
- extension: 'jpg',
- id: fileId,
- isRemote: false,
- meta: { name: 'foo.jpg', type: 'image/jpeg' },
- name: 'foo.jpg',
- preview: undefined,
- data: fileData,
- isGhost: false,
- progress: {
- bytesTotal: 17175,
- bytesUploaded: false,
- percentage: 0,
- uploadComplete: false,
- uploadStarted: null,
- },
- remote: undefined,
- size: 17175,
- source: 'vi',
- type: 'image/jpeg',
- }
- expect(core.getFile(fileId)).toEqual(newFile)
- expect(fileAddedEventMock.mock.calls[0][0]).toEqual(newFile)
- })
- it('should add a file from a File object', () => {
- const fileData = testImage
- const core = new Core()
- const fileId = core.addFile(fileData)
- expect(core.getFile(fileId).id).toEqual(fileId)
- })
- it('should not allow a file that does not meet the restrictions', () => {
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['image/gif', 'video/webm'],
- },
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow('You can only upload: image/gif, video/webm')
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.webm',
- type: 'video/webm; codecs="vp8, opus"',
- // @ts-ignore
- data: new File([sampleImage], {
- type: 'video/webm; codecs="vp8, opus"',
- }),
- })
- }).not.toThrow()
- })
- it('should not allow a dupicate file, a file with the same id', () => {
- const core = new Core()
- const sameFileBlob = testImage
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- meta: {
- notARelativePath: 'folder/a',
- },
- })
- }).toThrow("Cannot add the duplicate file 'foo.jpg', it already exists")
- expect(core.getFiles().length).toEqual(1)
- })
- it('should allow a duplicate file if its relativePath is different, thus the id is different', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- meta: {
- relativePath: 'folder/a',
- },
- })
- expect(core.getFiles().length).toEqual(2)
- })
- it('should not allow a file if onBeforeFileAdded returned false', () => {
- const core = new Core({
- onBeforeFileAdded: (file) => {
- if (file.source === 'vi') {
- return false
- }
- return undefined
- },
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow(
- 'Cannot add the file because onBeforeFileAdded returned false.',
- )
- expect(core.getFiles().length).toEqual(0)
- })
- describe('with allowMultipleUploadBatches: false', () => {
- it('allows no new files after upload', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.upload()
- expect(() => {
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow(/Cannot add more files/)
- })
- it('allows no new files after upload with legacy allowMultipleUploads option', async () => {
- const core = new Core({ allowMultipleUploads: false })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.upload()
- expect(() => {
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow(/Cannot add more files/)
- })
- it('does not allow new files after the removeFile() if some file is still present', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- // adding 2 files
- const fileId1 = core.addFile({
- source: 'vi',
- name: '1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: '2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- // removing 1 file
- core.removeFile(fileId1)
- await expect(core.upload()).resolves.toBeDefined()
- })
- it('allows new files after the last removeFile()', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- // adding 2 files
- const fileId1 = core.addFile({
- source: 'vi',
- name: '1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId2 = core.addFile({
- source: 'vi',
- name: '2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- // removing 2 files
- core.removeFile(fileId1)
- core.removeFile(fileId2)
- await expect(core.upload()).resolves.toBeDefined()
- })
- })
- it('does not dedupe different files', async () => {
- const core = new Core()
- const data = new Blob([sampleImage], { type: 'image/jpeg' })
- // @ts-ignore
- data.lastModified = 1562770350937
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data,
- })
- core.addFile({
- source: 'vi',
- name: 'foo푸.jpg',
- type: 'image/jpeg',
- data,
- })
- expect(core.getFiles()).toHaveLength(2)
- expect(
- core.getFile('uppy-foo/jpg-1e-image/jpeg-17175-1562770350937'),
- ).toBeDefined()
- expect(
- core.getFile('uppy-foo//jpg-1l3o-1e-image/jpeg-17175-1562770350937'),
- ).toBeDefined()
- })
- })
- describe('uploading a file', () => {
- it('should return a { successful, failed } pair containing file objects', () => {
- const core = new Core()
- core.addUploader(() => Promise.resolve())
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return expect(core.upload()).resolves.toMatchObject({
- successful: [{ name: 'foo.jpg' }, { name: 'bar.jpg' }],
- failed: [],
- })
- })
- it('should return files with errors in the { failed } key', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- core.addUploader((fileIDs) => {
- fileIDs.forEach((fileID) => {
- const file = core.getFile(fileID)
- if (file.name != null && /bar/.test(file.name)) {
- // @ts-ignore
- core.emit(
- 'upload-error',
- file,
- new Error('This is bar and I do not like bar'),
- )
- }
- })
- return Promise.resolve()
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return expect(core.upload()).resolves.toMatchObject({
- successful: [{ name: 'foo.jpg' }],
- failed: [
- { name: 'bar.jpg', error: 'This is bar and I do not like bar' },
- ],
- })
- })
- it('should only upload files that are not already assigned to another upload id', () => {
- const core = new Core()
- // @ts-ignore
- core.store.state.currentUploads = {
- // @ts-ignore
- upload1: {
- fileIDs: [
- 'uppy-file1/jpg-1e-image/jpeg',
- 'uppy-file2/jpg-1e-image/jpeg',
- 'uppy-file3/jpg-1e-image/jpeg',
- ],
- },
- // @ts-ignore
- upload2: {
- fileIDs: [
- 'uppy-file4/jpg-1e-image/jpeg',
- 'uppy-file5/jpg-1e-image/jpeg',
- 'uppy-file6/jpg-1e-image/jpeg',
- ],
- },
- }
- core.addUploader(() => Promise.resolve())
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: new Uint8Array(),
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: new Uint8Array(),
- })
- core.addFile({
- source: 'file3',
- name: 'file3.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: new Uint8Array(),
- })
- // uploadID is random, we don't want randomness in the snapshot
- return expect(
- core
- .upload()
- .then((r) =>
- typeof r!.uploadID === 'string' && r!.uploadID.length === 21 ?
- { ...r, uploadID: 'cjd09qwxb000dlql4tp4doz8h' }
- : r,
- ),
- ).resolves.toMatchSnapshot()
- })
- it('should not upload if onBeforeUpload returned false', () => {
- const core = new Core({
- onBeforeUpload: (files) => {
- for (const fileId in files) {
- if (files[fileId].name === '123.foo') {
- return false
- }
- }
- return files
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- return core.upload().catch((err) => {
- expect(err).toMatchObject(
- new Error(
- 'Not starting the upload because onBeforeUpload returned false',
- ),
- )
- })
- })
- it('only allows a single upload() batch when allowMultipleUploadBatches: false', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await expect(core.upload()).resolves.toBeDefined()
- await expect(core.upload()).rejects.toThrow(
- /Cannot create a new upload: already uploading\./,
- )
- })
- it('allows new files again with allowMultipleUploadBatches: false after cancelAll() was called', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await expect(core.upload()).resolves.toBeDefined()
- core.cancelAll()
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- await expect(core.upload()).resolves.toBeDefined()
- })
- })
- describe('removing a file', () => {
- it('should remove the file', () => {
- const fileRemovedEventMock = vi.fn()
- const core = new Core()
- core.on('file-removed', fileRemovedEventMock)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- expect(core.getFiles().length).toEqual(1)
- core.setState({
- totalProgress: 50,
- })
- const file = core.getFile(fileId)
- core.removeFile(fileId)
- expect(core.getFiles().length).toEqual(0)
- expect(fileRemovedEventMock.mock.calls[0][0]).toEqual(file)
- expect(core.getState().totalProgress).toEqual(0)
- })
- })
- describe('retries', () => {
- it('should start a new upload with failed files', async () => {
- const onUpload = vi.fn()
- const onRetryAll = vi.fn()
- const core = new Core()
- core.on('upload', onUpload)
- core.on('retry-all', onRetryAll)
- const id = core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.setFileState(id, {
- error: 'something went wrong',
- })
- await core.retryAll()
- expect(onRetryAll).toHaveBeenCalled()
- expect(onUpload).toHaveBeenCalled()
- })
- it('should not start a new upload if there are no failed files', async () => {
- const onUpload = vi.fn()
- const core = new Core()
- core.on('upload', onUpload)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.retryAll()
- expect(onUpload).not.toHaveBeenCalled()
- })
- })
- describe('restoring a file', () => {
- it.skip('should restore a file')
- it.skip("should fail to restore a file if it doesn't exist")
- })
- describe('get a file', () => {
- it('should get the specified file', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- expect(core.getFile(fileId).name).toEqual('foo.jpg')
- expect(core.getFile('non existent file')).toEqual(undefined)
- })
- })
- describe('getFiles', () => {
- it('should return an empty array if there are no files', () => {
- const core = new Core()
- expect(core.getFiles()).toEqual([])
- })
- it('should return all files as an array', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'empty.dat',
- type: 'application/octet-stream',
- // @ts-ignore
- data: new File([new Uint8Array(1000)], {
- type: 'application/octet-stream',
- }),
- })
- expect(core.getFiles()).toHaveLength(2)
- expect(
- core
- .getFiles()
- .map((file) => file.name)
- .sort(),
- ).toEqual(['empty.dat', 'foo.jpg'])
- })
- })
- describe('setOptions', () => {
- it('should change options on the fly', () => {
- const core = new Core()
- core.setOptions({
- id: 'lolUppy',
- autoProceed: true,
- allowMultipleUploadBatches: true,
- })
- expect(core.opts.id).toEqual('lolUppy')
- expect(core.opts.autoProceed).toEqual(true)
- expect(core.opts.allowMultipleUploadBatches).toEqual(true)
- })
- it('should change locale on the fly', () => {
- const core = new Core()
- expect(core.i18n('cancel')).toEqual('Cancel')
- core.setOptions({
- locale: {
- strings: {
- cancel: 'Отмена',
- },
- },
- })
- expect(core.i18n('cancel')).toEqual('Отмена')
- expect(core.i18n('logOut')).toEqual('Log out')
- })
- it('should change meta on the fly', () => {
- const core = new Core<{ foo: string; beep: string }, any>({
- meta: { foo: 'bar', beep: '' },
- })
- expect(core.getState().meta).toMatchObject({
- foo: 'bar',
- })
- core.setOptions({
- meta: {
- beep: 'boop',
- },
- })
- expect(core.getState().meta).toMatchObject({
- foo: 'bar',
- beep: 'boop',
- })
- })
- it('should change restrictions on the fly', () => {
- const fr_FR: Locale<0 | 1> = {
- strings: {
- youCanOnlyUploadFileTypes:
- 'Vous pouvez seulement téléverser: %{types}',
- },
- pluralize(n) {
- if (n <= 1) {
- return 0
- }
- return 1
- },
- }
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['image/jpeg'],
- maxNumberOfFiles: 2,
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo1.png',
- type: 'image/png',
- // @ts-ignore
- data: new File([sampleImage], { type: 'image/png' }),
- })
- } catch (err) {
- expect(err).toMatchObject(new Error('You can only upload: image/jpeg'))
- }
- core.setOptions({
- locale: fr_FR,
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo1.png',
- type: 'image/png',
- // @ts-ignore
- data: new File([sampleImage], { type: 'image/png' }),
- })
- } catch (err) {
- expect(err).toMatchObject(
- new Error('Vous pouvez seulement téléverser: image/jpeg'),
- )
- }
- core.setOptions({
- locale: fr_FR,
- restrictions: {
- allowedFileTypes: ['image/png'],
- },
- })
- expect(core.opts.restrictions.allowedFileTypes).toMatchObject([
- 'image/png',
- ])
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo1.png',
- type: 'image/png',
- // @ts-ignore
- data: new File([sampleImage], { type: 'image/png' }),
- })
- }).not.toThrow()
- expect(core.getFiles().length).toEqual(1)
- })
- })
- describe('meta data', () => {
- it('should set meta data by calling setMeta', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core<
- {
- foo: string
- boo: string
- foo2: string
- bur: string
- },
- any
- >({
- store: DeepFrozenStore(),
- // @ts-ignore
- meta: { foo2: 'bar2' },
- })
- core.setMeta({ foo: 'bar', bur: 'mur' })
- core.setMeta({ boo: 'moo', bur: 'fur' })
- expect(core.getState().meta).toEqual({
- foo: 'bar',
- foo2: 'bar2',
- boo: 'moo',
- bur: 'fur',
- })
- })
- it('should update meta data for a file by calling updateMeta', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- core.setFileMeta(fileId, { foo: 'bar', bur: 'mur' })
- core.setFileMeta(fileId, { boo: 'moo', bur: 'fur' })
- expect(core.getFile(fileId).meta).toEqual({
- name: 'foo.jpg',
- type: 'image/jpeg',
- foo: 'bar',
- bur: 'fur',
- boo: 'moo',
- })
- })
- it('should merge meta data when add file', () => {
- const core = new Core({
- meta: { foo2: 'bar2' },
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- meta: {
- // @ts-ignore
- resize: 5000,
- },
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- expect(core.getFile(fileId).meta).toEqual({
- name: 'foo.jpg',
- type: 'image/jpeg',
- foo2: 'bar2',
- resize: 5000,
- })
- })
- })
- describe('progress', () => {
- it('should calculate the progress of a file upload', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('upload-start', [core.getFile(fileId)])
- // @ts-ignore
- core.emit('upload-progress', file, {
- bytesUploaded: 12345,
- bytesTotal: 17175,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 72,
- bytesUploaded: 12345,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: expect.any(Number),
- })
- // @ts-ignore
- core.emit('upload-progress', file, {
- bytesUploaded: 17175,
- bytesTotal: 17175,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 100,
- bytesUploaded: 17175,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: expect.any(Number),
- })
- })
- it('should work with unsized files', async () => {
- const core = new Core()
- let proceedUpload
- let finishUpload
- const promise = new Promise((resolve) => {
- proceedUpload = resolve
- })
- const finishPromise = new Promise((resolve) => {
- finishUpload = resolve
- })
- core.addUploader(async ([id]) => {
- core.emit('upload-start', [core.getFile(id)])
- await promise
- // @ts-ignore deprecated
- core.emit('upload-progress', core.getFile(id), {
- bytesTotal: 3456,
- bytesUploaded: 1234,
- })
- await finishPromise
- // @ts-ignore deprecated
- core.emit('upload-success', core.getFile(id), { uploadURL: 'lol' })
- })
- core.addFile({
- source: 'instagram',
- name: 'foo.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: {},
- })
- // @ts-ignore
- core[Symbol.for('uppy test: updateTotalProgress')]()
- const uploadPromise = core.upload()
- await Promise.all([
- new Promise((resolve) => core.once('upload-start', resolve)),
- ])
- expect(core.getFiles()[0].size).toBeNull()
- expect(core.getFiles()[0].progress).toMatchObject({
- bytesUploaded: 0,
- // null indicates unsized
- bytesTotal: null,
- })
- // @ts-ignore
- proceedUpload()
- // wait for progress event
- await promise
- expect(core.getFiles()[0].size).toBeNull()
- expect(core.getFiles()[0].progress).toMatchObject({
- bytesUploaded: 1234,
- bytesTotal: 3456,
- percentage: 36,
- })
- expect(core.getState().totalProgress).toBe(36)
- // @ts-ignore
- finishUpload()
- // wait for success event
- await finishPromise
- expect(core.getFiles()[0].size).toBe(3456)
- expect(core.getFiles()[0].progress).toMatchObject({
- bytesUploaded: 3456,
- bytesTotal: 3456,
- percentage: 100,
- })
- await uploadPromise
- core.destroy()
- })
- it('should estimate progress for unsized files', () => {
- const core = new Core()
- core.once('file-added', (file) => {
- core.emit('upload-start', [file])
- // @ts-ignore
- core.emit('upload-progress', file, {
- bytesTotal: 3456,
- bytesUploaded: 1234,
- })
- })
- core.addFile({
- source: 'instagram',
- name: 'foo.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: {},
- })
- core.once('file-added', (file) => {
- core.emit('upload-start', [file])
- core.emit('upload-progress', file, {
- // @ts-ignore
- bytesTotal: null,
- // @ts-ignore
- bytesUploaded: null,
- })
- })
- core.addFile({
- source: 'instagram',
- name: 'bar.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: {},
- })
- // @ts-ignore
- core[Symbol.for('uppy test: updateTotalProgress')]()
- // foo.jpg at 35%, bar.jpg has unknown size and will not be counted
- expect(core.getState().totalProgress).toBe(36)
- core.destroy()
- })
- it('should calculate the total progress of all file uploads', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const [file1, file2] = core.getFiles()
- core.setFileState(file1.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file1.progress, uploadStarted: new Date() },
- })
- core.setFileState(file2.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file2.progress, uploadStarted: new Date() },
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file1.id), {
- bytesUploaded: 12345,
- bytesTotal: 17175,
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file2.id), {
- bytesUploaded: 10201,
- bytesTotal: 17175,
- })
- // @ts-ignore
- core[Symbol.for('uppy test: updateTotalProgress')]()
- expect(core.getState().totalProgress).toEqual(66)
- })
- it('should emit the progress', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const [file1, file2] = core.getFiles()
- core.setFileState(file1.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file1.progress, uploadStarted: new Date() },
- })
- core.setFileState(file2.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file2.progress, uploadStarted: new Date() },
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file1.id), {
- bytesUploaded: 12345,
- bytesTotal: 17175,
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file2.id), {
- bytesUploaded: 10201,
- bytesTotal: 17175,
- })
- // @ts-ignore
- core[Symbol.for('uppy test: updateTotalProgress')]()
- expect(core.getState().totalProgress).toEqual(66)
- expect(core.getState().allowNewUpload).toEqual(true)
- expect(core.getState().error).toEqual(null)
- expect(core.getState().recoveredState).toEqual(null)
- })
- })
- describe('clear', () => {
- it('should reset state to default', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.clear()
- expect(core.getState()).toMatchObject({
- totalProgress: 0,
- allowNewUpload: true,
- error: null,
- recoveredState: null,
- files: {},
- })
- })
- it('should throw error if plugin does not allow removing files during an upload', () => {
- const core = new Core()
- const newState = {
- capabilities: {
- individualCancellation: false,
- uploadProgress: true,
- resumableUploads: false,
- },
- currentUploads: {
- upload1: {
- fileIDs: [
- 'uppy-file1/jpg-1e-image/jpeg',
- 'uppy-file2/jpg-1e-image/jpeg',
- 'uppy-file3/jpg-1e-image/jpeg',
- ],
- },
- },
- }
- // @ts-ignore
- core.setState(newState)
- expect(() => {
- core.clear()
- }).toThrowError()
- })
- })
- describe('checkRestrictions', () => {
- it('should enforce the maxNumberOfFiles rule', () => {
- const core = new Core({
- restrictions: {
- maxNumberOfFiles: 1,
- },
- })
- // add 2 files
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(new Error('You can only upload 1 file'))
- expect(core.getState().info[0].message).toEqual(
- 'You can only upload 1 file',
- )
- }
- })
- it('should not enforce the maxNumberOfFiles rule for ghost files', () => {
- const core = new Core({
- restrictions: {
- maxNumberOfFiles: 1,
- },
- })
- expect(() => {
- // add 1 ghost file
- const fileId1 = core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.setFileState(fileId1, { isGhost: true })
- // add another file
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).not.toThrowError()
- })
- it.skip('should enforce the minNumberOfFiles rule')
- it('should enforce the allowedFileTypes rule', () => {
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['image/gif', 'image/png'],
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('You can only upload: image/gif, image/png'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'You can only upload: image/gif, image/png',
- )
- }
- })
- it('should throw if allowedFileTypes is not an array', () => {
- try {
- const core = new Core({
- restrictions: {
- // @ts-ignore
- allowedFileTypes: 'image/gif',
- },
- })
- core.log('hi')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('`restrictions.allowedFileTypes` must be an array'),
- )
- }
- })
- it('should enforce the allowedFileTypes rule with file extensions', () => {
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['.gif', '.jpg', '.jpeg'],
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo2.png',
- type: '',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('You can only upload: .gif, .jpg, .jpeg'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'You can only upload: .gif, .jpg, .jpeg',
- )
- }
- expect(() =>
- core.addFile({
- source: 'vi',
- name: 'foo2.JPG',
- type: '',
- data: testImage,
- }),
- ).not.toThrow()
- })
- it('should enforce the maxFileSize rule', () => {
- const core = new Core({
- restrictions: {
- maxFileSize: 1234,
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('foo.jpg exceeds maximum allowed size of 1.2 KB'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'foo.jpg exceeds maximum allowed size of 1.2 KB',
- )
- }
- })
- it('should enforce the minFileSize rule', () => {
- const core = new Core({
- restrictions: {
- minFileSize: 1073741824,
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('This file is smaller than the allowed size of 1 GB'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'This file is smaller than the allowed size of 1 GB',
- )
- }
- })
- it('should enforce the maxTotalFileSize rule', () => {
- const core = new Core({
- restrictions: {
- maxTotalFileSize: 20000,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrowError(
- new Error(
- 'You selected 34 KB of files, but maximum allowed size is 20 KB',
- ),
- )
- })
- it('should report error on validateSingleFile', () => {
- const core = new Core({
- restrictions: {
- minFileSize: 300000,
- },
- })
- const core2 = new Core({
- restrictions: {
- allowedFileTypes: ['image/png'],
- },
- })
- const newFile = {
- source: 'vi',
- name: 'foo1.jpg',
- extension: 'jpg',
- type: 'image/jpeg',
- data: testImage,
- isFolder: false,
- mimeType: 'image/jpeg',
- modifiedDate: '2016-04-13T15:11:31.204Z',
- size: 270733,
- }
- const validateRestrictions1 = core.validateSingleFile(newFile)
- const validateRestrictions2 = core2.validateSingleFile(newFile)
- expect(validateRestrictions1).toEqual(
- 'This file is smaller than the allowed size of 293 KB',
- )
- expect(validateRestrictions2).toEqual('You can only upload: image/png')
- })
- it('should emit `restriction-failed` event when some rule is violated', () => {
- const maxFileSize = 100
- const core = new Core({
- restrictions: {
- maxFileSize,
- },
- })
- const restrictionsViolatedEventMock = vi.fn()
- const file = {
- source: 'vi',
- type: 'image/jpeg',
- name: 'test.jpg',
- data: new Blob([new Uint8Array(2 * maxFileSize)]),
- }
- const errorMessage = core.i18n('exceedsSize', {
- file: file.name,
- size: prettierBytes(maxFileSize),
- })
- try {
- core.on('restriction-failed', restrictionsViolatedEventMock)
- core.addFile(file)
- } catch {
- // Ignore errors
- }
- expect(restrictionsViolatedEventMock.mock.calls.length).toEqual(1)
- expect(restrictionsViolatedEventMock.mock.calls[0][0].name).toEqual(
- file.name,
- )
- expect(restrictionsViolatedEventMock.mock.calls[0][1].message).toEqual(
- errorMessage,
- )
- })
- })
- describe('actions', () => {
- it('should update the state when receiving the error event', () => {
- const core = new Core()
- core.emit('error', new Error('foooooo'))
- expect(core.getState().error).toEqual('foooooo')
- })
- it('should update the state when receiving the upload-error event', () => {
- const core = new Core()
- core.setState({
- files: {
- // @ts-ignore
- fileId: {
- id: 'fileId',
- name: 'filename',
- },
- },
- })
- // @ts-ignore test does not care about missing properties
- core.emit(
- 'upload-error',
- core.getFile('fileId'),
- new Error('this is the error'),
- )
- expect(core.getState().info).toEqual([
- {
- message: 'Failed to upload filename',
- details: 'this is the error',
- type: 'error',
- },
- ])
- })
- it('should reset the error state when receiving the upload event', () => {
- const core = new Core()
- // @ts-ignore test does not care about missing properties
- core.emit('error', { foo: 'bar' })
- // @ts-ignore test does not care about missing properties
- core.emit('upload')
- expect(core.getState().error).toEqual(null)
- })
- })
- describe('updateOnlineStatus', () => {
- const RealNavigatorOnline = globalThis.window.navigator.onLine
- function mockNavigatorOnline(status: boolean) {
- Object.defineProperty(globalThis.window.navigator, 'onLine', {
- value: status,
- writable: true,
- })
- }
- afterEach(() => {
- // @ts-ignore readonly but whatever
- globalThis.window.navigator.onLine = RealNavigatorOnline
- })
- it('should emit the correct event based on whether there is a network connection', () => {
- const onlineEventMock = vi.fn()
- const offlineEventMock = vi.fn()
- const backOnlineEventMock = vi.fn()
- const core = new Core()
- // @ts-ignore untyped
- core.on('is-offline', offlineEventMock)
- // @ts-ignore untyped
- core.on('is-online', onlineEventMock)
- // @ts-ignore untyped
- core.on('back-online', backOnlineEventMock)
- mockNavigatorOnline(true)
- core.updateOnlineStatus()
- expect(onlineEventMock.mock.calls.length).toEqual(1)
- expect(offlineEventMock.mock.calls.length).toEqual(0)
- expect(backOnlineEventMock.mock.calls.length).toEqual(0)
- mockNavigatorOnline(false)
- core.updateOnlineStatus()
- expect(onlineEventMock.mock.calls.length).toEqual(1)
- expect(offlineEventMock.mock.calls.length).toEqual(1)
- expect(backOnlineEventMock.mock.calls.length).toEqual(0)
- mockNavigatorOnline(true)
- core.updateOnlineStatus()
- expect(onlineEventMock.mock.calls.length).toEqual(2)
- expect(offlineEventMock.mock.calls.length).toEqual(1)
- expect(backOnlineEventMock.mock.calls.length).toEqual(1)
- })
- })
- describe('info', () => {
- it('should set a string based message to be displayed infinitely', () => {
- const infoVisibleEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.info('This is the message', 'info', 0)
- expect(core.getState().info).toEqual([
- {
- type: 'info',
- message: 'This is the message',
- details: null,
- },
- ])
- expect(infoVisibleEvent.mock.calls.length).toEqual(1)
- })
- it('should set a object based message to be displayed infinitely', () => {
- const infoVisibleEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.info(
- {
- message: 'This is the message',
- details: {
- foo: 'bar',
- },
- },
- 'warning',
- 0,
- )
- expect(core.getState().info).toEqual([
- {
- type: 'warning',
- message: 'This is the message',
- details: {
- foo: 'bar',
- },
- },
- ])
- expect(infoVisibleEvent.mock.calls.length).toEqual(1)
- })
- it('should set an info message to be displayed for a period of time before hiding', (done) => {
- const infoVisibleEvent = vi.fn()
- const infoHiddenEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.on('info-hidden', infoHiddenEvent)
- core.info('This is the message', 'info', 100)
- expect(infoHiddenEvent.mock.calls.length).toEqual(0)
- setTimeout(() => {
- expect(infoHiddenEvent.mock.calls.length).toEqual(1)
- expect(core.getState().info).toEqual([])
- // @ts-ignore
- done()
- }, 110)
- })
- it('should hide an info message', () => {
- const infoVisibleEvent = vi.fn()
- const infoHiddenEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.on('info-hidden', infoHiddenEvent)
- core.info('This is the message', 'info', 0)
- expect(infoHiddenEvent.mock.calls.length).toEqual(0)
- core.hideInfo()
- expect(infoHiddenEvent.mock.calls.length).toEqual(1)
- expect(core.getState().info).toEqual([])
- })
- it('should support multiple messages', () => {
- const infoVisibleEvent = vi.fn()
- const infoHiddenEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.on('info-hidden', infoHiddenEvent)
- core.info('This is the message', 'info', 0)
- core.info('But this is another one', 'info', 0)
- expect(infoHiddenEvent.mock.calls.length).toEqual(0)
- expect(core.getState().info).toEqual([
- {
- type: 'info',
- message: 'This is the message',
- details: null,
- },
- {
- type: 'info',
- message: 'But this is another one',
- details: null,
- },
- ])
- core.hideInfo()
- expect(core.getState().info).toEqual([
- {
- type: 'info',
- message: 'But this is another one',
- details: null,
- },
- ])
- core.hideInfo()
- expect(infoHiddenEvent.mock.calls.length).toEqual(2)
- expect(core.getState().info).toEqual([])
- })
- })
- describe('createUpload', () => {
- it('should assign the specified files to a new upload', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore accessing private method
- core[Symbol.for('uppy test: createUpload')](
- Object.keys(core.getState().files),
- )
- const uploadId = Object.keys(core.getState().currentUploads)[0]
- const currentUploadsState: State<any, any>['currentUploads'] = {}
- currentUploadsState[uploadId] = {
- fileIDs: Object.keys(core.getState().files),
- step: 0,
- result: {},
- }
- expect(core.getState().currentUploads).toEqual(currentUploadsState)
- })
- })
- describe('i18n', () => {
- it('merges in custom locale strings', () => {
- const core = new Core({
- locale: {
- strings: {
- test: 'beep boop',
- },
- pluralize: () => 0,
- },
- })
- expect(core.i18n('exceedsSize')).toBe(
- '%{file} exceeds maximum allowed size of %{size}',
- )
- expect(core.i18n('test')).toBe('beep boop')
- })
- })
- describe('default restrictions', () => {
- it('should be merged with supplied restrictions', () => {
- const core = new Core({
- restrictions: {
- maxNumberOfFiles: 3,
- },
- })
- expect(core.opts.restrictions.maxNumberOfFiles).toBe(3)
- expect(core.opts.restrictions.minNumberOfFiles).toBe(null)
- })
- })
- describe('log', () => {
- it('should log via provided logger function', () => {
- const myTestLogger = {
- debug: vi.fn(),
- warn: vi.fn(),
- error: vi.fn(),
- }
- const core = new Core({
- logger: myTestLogger,
- })
- core.log('test test')
- core.log('test test', 'error')
- core.log('test test', 'error')
- core.log('test test', 'warning')
- // logger.debug should have been called 1 time above,
- // but we call log in Core’s constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(core.opts.logger.debug.mock.calls.length).toBe(2)
- // @ts-ignore
- expect(core.opts.logger.error.mock.calls.length).toBe(2)
- // @ts-ignore
- expect(core.opts.logger.warn.mock.calls.length).toBe(1)
- })
- it('should log via provided logger function, even if debug: true', () => {
- const myTestLogger = {
- debug: vi.fn(),
- warn: vi.fn(),
- error: vi.fn(),
- }
- const core = new Core({
- logger: myTestLogger,
- debug: true,
- })
- core.log('test test')
- core.log('test test', 'error')
- core.log('test test', 'error')
- core.log('test test', 'warning')
- // logger.debug should have been called 1 time above,
- // but we call log in Core’s constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(core.opts.logger.debug.mock.calls.length).toBe(2)
- // @ts-ignore
- expect(core.opts.logger.error.mock.calls.length).toBe(2)
- // logger.warn should have been called 1 time above,
- // but we warn in Core when using both logger and debug: true, hence +1 here
- // @ts-ignore
- expect(core.opts.logger.warn.mock.calls.length).toBe(2)
- })
- it('should log to console when logger: Uppy.debugLogger or debug: true is set', () => {
- console.debug = vi.fn()
- console.error = vi.fn()
- const core = new Core({
- logger: debugLogger,
- })
- core.log('test test')
- core.log('beep boop')
- core.log('beep beep', 'error')
- // console.debug debug should have been called 2 times above,
- // ibut we call log n Core’ constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(console.debug.mock.calls.length).toBe(3)
- // @ts-ignore
- expect(console.error.mock.calls.length).toBe(1)
- // @ts-ignore
- console.debug.mockClear()
- // @ts-ignore
- console.error.mockClear()
- const core2 = new Core({
- debug: true,
- })
- core2.log('test test')
- core2.log('beep boop')
- core2.log('beep beep', 'error')
- // console.debug debug should have been called 2 times here,
- // but we call log in Core constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(console.debug.mock.calls.length).toBe(3)
- // @ts-ignore
- expect(console.error.mock.calls.length).toBe(1)
- })
- it('should only log errors to console when logger is not set', () => {
- console.debug = vi.fn()
- console.error = vi.fn()
- const core = new Core()
- core.log('test test')
- core.log('beep boop')
- core.log('beep beep', 'error')
- // @ts-ignore
- expect(console.debug.mock.calls.length).toBe(0)
- // @ts-ignore
- expect(console.error.mock.calls.length).toBe(1)
- })
- })
- })
|