[download][s]Support for Column Order by header parameter if given in the body of the download query

Author: leomrocha

routes/index.js

@@ -121,12 +121,11 @@ DOWNLOAD_FORMATS_SUPPORTED = ['json', 'csv', 'tsv', 'xlsx', 'ods']
 router.post(`/${APP_VERSION}/download`, async function (req, res, next) {
   // get the graphql query from body
   const query = req.body.query ? req.body.query : req.body
+  const xlsxHeader = req.body.header ? req.body.header : undefined
+  // TODO header verification, else it will break when ordering fields
   // call GraphQL
   try {
-    // TODO check graphql syntax BEFORE sending it
-    const gqlRes = await request(`${process.env.HASURA_URL}/v1/graphql`, query)
-
-    // // capture graphql response
+    // Some checks before the DB call
     const ext = (req.params.format || req.query.format || 'json')
       .toLowerCase()
       .trim()
@@ -137,12 +136,18 @@ router.post(`/${APP_VERSION}/download`, async function (req, res, next) {
           'Bad format. Supported Formats: ' +
             JSON.stringify(DOWNLOAD_FORMATS_SUPPORTED)
         )
+        .end()
+      return
     }
     const colSep = (req.query.field_separator || ',').trim()
     res.set(
       'Content-Disposition',
       'attachment; filename="download.' + ext + '";'
     )
+    // TODO check graphql syntax BEFORE sending it
+    const gqlRes = await request(`${process.env.HASURA_URL}/v1/graphql`, query)
+
+    // // capture graphql response
     if (ext != 'json') {
       // any spreadsheet supported by [js-xlsx](https://github.com/SheetJS/sheetjs)
       let wb = XLSX.utils.book_new()
@@ -153,7 +158,9 @@ router.post(`/${APP_VERSION}/download`, async function (req, res, next) {
 
       //iterate over the result sets and create a work sheet to append to the book
       Object.keys(gqlRes).map((k) => {
-        const ws = XLSX.utils.json_to_sheet(gqlRes[k])
+        const ws = xlsxHeader
+          ? XLSX.utils.json_to_sheet(gqlRes[k], { header: xlsxHeader })
+          : XLSX.utils.json_to_sheet(gqlRes[k])
         XLSX.utils.book_append_sheet(wb, ws, k)
       })
       if (ext === 'tsv' || (ext === 'csv' && colSep != ',')) {

test/integration/download.test.js

@@ -13,6 +13,9 @@ query MyQuery {
 }
 `
 
+// const HEADER = `[float_column, int_column, text_column, time_column]`
+const HEADER = ['int_column', 'float_column', 'time_column', 'text_column']
+
 describe('data-api-download', function () {
   it('should return JSON when no format parameter is passed', function (done) {
     request(app)
@@ -88,6 +91,12 @@ describe('data-api-download', function () {
         )
         assert(res.header['content-type'] == 'text/csv; charset=utf-8')
         // check that is a CSV
+        const pipeSeparated = res.text
+          .split('\n')
+          .filter((line) => line.length > 0)
+          .every((line) => line.includes(','))
+        // console.log('pipe Separated = ', pipeSeparated)
+        assert(pipeSeparated)
         done()
       })
   })
@@ -110,6 +119,52 @@ describe('data-api-download', function () {
         )
         assert(res.header['content-type'] == 'text/csv; charset=utf-8')
         // check that is a pipe-separated-CSV
+        const pipeSeparated = res.text
+          .split('\n')
+          .filter((line) => line.length > 0)
+          .every((line) => line.includes('|'))
+        // console.log('pipe Separated = ', pipeSeparated)
+        assert(pipeSeparated)
+
+        done()
+      })
+  })
+
+  it('should return columns in specified ORDER when adding headers to the call', function (done) {
+    request(app)
+      .post('/v1/download?format=csv')
+      .send({
+        query: QUERY,
+        header: HEADER,
+      })
+      .expect(200)
+      .end(function (err, res) {
+        console.log('ERROR = ', err)
+        // console.log('response TEXT: ', res.text)
+        // console.log('response BODY: ', res.body)
+        console.log(res.header)
+        assert(
+          res.header['content-disposition'] ==
+            'attachment; filename="download.csv";'
+        )
+        assert(res.header['content-type'] == 'text/csv; charset=utf-8')
+        // check that the header is ordered
+        const headerLine = res.text.split('\n')[0].split(',')
+        // console.log('header line = ', headerLine, HEADER)
+        assert(headerLine.length === HEADER.length)
+        const matchingHeader = headerLine
+          .map(function (e, i) {
+            // console.log(
+            //   'matching header',
+            //   e.trim() == HEADER[i].trim(),
+            //   e,
+            //   HEADER[i]
+            // )
+            return e.trim() == HEADER[i].trim()
+          })
+          .every((e) => e == true)
+
+        assert(matchingHeader)
 
         done()
       })