Skip to content

Commit

Permalink
fix(DHIS2-16988): download uncompressed json rather than open inline
Browse files Browse the repository at this point in the history
  • Loading branch information
kabaros committed May 30, 2024
1 parent 9875cf5 commit 400e2b1
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 12 deletions.
34 changes: 22 additions & 12 deletions src/utils/helper.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,22 +188,32 @@ const uploadFile = ({
})
}

const downloadWindowTitle = i18n.t('Loading exported data')
const downloadWindowHtml = `
<div style="height: 100%; width: 100%; display: flex; justify-content: center; align-items: center; color: rgb(33, 41, 52)">
<p>${downloadWindowTitle}</p>
</div>
`

// call stub function if available
const locationAssign = (url) => {
const locationAssign = (relativeUrl) => {
if (window.locationAssign) {
window.locationAssign(url)
window.locationAssign(relativeUrl)
} else {
const downloadWindow = window.open(url, '_blank')
try {
const url = relativeUrl.startsWith('..')
? new URL(relativeUrl, document.baseURI).href
: relativeUrl

const urlFilePart = new URL(url).pathname.split('/').pop()
const [, file, extension] = urlFilePart.match(/(^[^.]+)(\..+$)/)

downloadWindow.document.title = downloadWindowTitle
downloadWindow.document.body.innerHTML = downloadWindowHtml // does not work in Chrome
const downloadedFileName = `${file}${extension}`

const link = document.createElement('a')
link.href = url
link.download = downloadedFileName
link.target = '_blank'
link.click()

return link
} catch (err) {
console.error(err)
window.open(relativeUrl, '_blank')
}
}
}

Expand Down
60 changes: 60 additions & 0 deletions src/utils/helper.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
import { locationAssign } from './helper.js'

describe('locationAssign', () => {
it('should create a file name based on the params', () => {
const url =
'https://debug.dhis2.org/dev/api/tracker/trackedEntities.json?ouMode=CAPTURE&format=json&includeDeleted=false&dataElementIdScheme=UID&eventIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=trackedEntities.json&paging=false&totalPages=false&program=lxAQ7Zs9VYR'
const link = locationAssign(url)
expect(link.download).toEqual('trackedEntities.json')
})
it('should create url with orgUnits', () => {
const url =
'https://debug.dhis2.org/dev/api/tracker/trackedEntities.json?ouMode=SELECTED&includeDeleted=false&dataElementIdScheme=UID&eventIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=trackedEntities.json&paging=false&totalPages=false&orgUnits=O6uvpzGd5pu,fdc6uOvgoji&program=kla3mAPgvCH'
const link = locationAssign(url)
expect(link.download).toEqual('trackedEntities.json')
})
it('should create url with tracked entities', () => {
const url =
'https://debug.dhis2.org/dev/api/tracker/trackedEntities.json?ouMode=SELECTED&includeDeleted=false&dataElementIdScheme=UID&eventIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=trackedEntities.json&paging=false&totalPages=false&orgUnits=ImspTQPwCqd&trackedEntityType=bVkFYAvoUCP'
const link = locationAssign(url)
expect(link.download).toEqual('trackedEntities.json')
})
it('should create url with CSV', () => {
const url =
'https://debug.dhis2.org/dev/api/tracker/trackedEntities.csv?ouMode=SELECTED&includeDeleted=false&dataElementIdScheme=UID&eventIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=trackedEntities.csv&paging=false&totalPages=false&orgUnits=ImspTQPwCqd&program=lxAQ7Zs9VYR'
const link = locationAssign(url)
expect(link.download).toEqual('trackedEntities.csv')
})

it('should create url with events zip', () => {
const url =
'https://debug.dhis2.org/dev/api/tracker/events.json.zip?links=false&paging=false&totalPages=false&orgUnit=fwH9ipvXde9&program=VBqh0ynB2wv&includeDeleted=false&dataElementIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=events.json.zip&occurredAfter=2023-12-12&occurredBefore=2024-03-12&ouMode=CHILDREN&format=json'
const link = locationAssign(url)
expect(link.download).toEqual('events.json.zip')
})

it('should create url with events gzip', () => {
const url =
'https://debug.dhis2.org/dev/api/tracker/events.json.gz?links=false&paging=false&totalPages=false&orgUnit=ImspTQPwCqd&program=lxAQ7Zs9VYR&includeDeleted=false&dataElementIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=events.json.gz&occurredAfter=2023-12-12&occurredBefore=2024-03-12&ouMode=SELECTED&format=json'
const link = locationAssign(url)
expect(link.download).toEqual('events.json.gz')
})
it('should work with relative URLs when bundled in DHIS2', () => {
Object.defineProperty(global.document, 'baseURI', {
value: 'http://localhost:8080/dhis-web-import-export/index.html#/export/tei',
})
const url =
'../api/tracker/trackedEntities.json?ouMode=SELECTED&includeDeleted=false&dataElementIdScheme=UID&eventIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=trackedEntities.json&paging=false&totalPages=false&orgUnits=ImspTQPwCqd&program=lxAQ7Zs9VYR'
const link = locationAssign(url)
expect(link.download).toEqual('trackedEntities.json')
})
it('should work with relative URLs when bundled in DHIS2 for zip', () => {
Object.defineProperty(global.document, 'baseURI', {
value: 'http://localhost:8080/dhis-web-import-export/index.html#/export/tei',
})
const url =
'../api/tracker/events.json.zip?links=false&paging=false&totalPages=false&orgUnit=ImspTQPwCqd&program=lxAQ7Zs9VYR&includeDeleted=false&dataElementIdScheme=UID&orgUnitIdScheme=UID&idScheme=UID&attachment=events.json.zip&occurredAfter=2023-12-12&occurredBefore=2024-03-12&ouMode=SELECTED&format=json'
const link = locationAssign(url)
expect(link.download).toEqual('events.json.zip')
})
})

0 comments on commit 400e2b1

Please sign in to comment.