feat(api): deployment through zipped/compressed file

api/src/controllers/drive.ts

@@ -96,7 +96,12 @@ export class DriveController {
   }
 
   /**
-   * @summary Creates/updates files within SASjs Drive using uploaded JSON file.
+   * Accepts JSON file and zipped compressed JSON file as well.
+   * Compressed file should only contain one JSON file and should have same name
+   * as of compressed file e.g. deploy.JSON should be compressed to deploy.JSON.zip
+   * Any other file or JSON file in zipped will be ignored!
+   *
+   * @summary Creates/updates files within SASjs Drive using uploaded JSON/compressed JSON file.
    *
    */
   @Example<DeployResponse>(successDeployResponse)

api/src/routes/api/drive.ts

@@ -7,9 +7,12 @@ import { multerSingle } from '../../middlewares/multer'
 import { DriveController } from '../../controllers/'
 import {
   deployValidation,
+  extractJSONFromZip,
+  extractName,
   fileBodyValidation,
   fileParamValidation,
-  folderParamValidation
+  folderParamValidation,
+  isZipFile
 } from '../../utils'
 
 const controller = new DriveController()
@@ -49,7 +52,24 @@ driveRouter.post(
   async (req, res) => {
     if (!req.file) return res.status(400).send('"file" is not present.')
 
-    const fileContent = await readFile(req.file.path)
+    let fileContent: string = ''
+
+    const { value: zipFile } = isZipFile(req.file)
+    if (zipFile) {
+      fileContent = await extractJSONFromZip(zipFile)
+      const fileInZip = extractName(zipFile.originalname)
+
+      if (!fileContent) {
+        deleteFile(req.file.path)
+        return res
+          .status(400)
+          .send(
+            `No content present in ${fileInZip} of compressed file ${zipFile.originalname}`
+          )
+      }
+    } else {
+      fileContent = await readFile(req.file.path)
+    }
 
     let jsonContent
     try {

api/src/utils/extractName.ts

@@ -0,0 +1,6 @@
+import path from 'path'
+
+export const extractName = (filePath: string) => {
+  const extension = path.extname(filePath)
+  return path.basename(filePath, extension)
+}

api/src/utils/file.ts

@@ -1,5 +1,6 @@
 import path from 'path'
 import { homedir } from 'os'
+import fs from 'fs-extra'
 
 export const apiRoot = path.join(__dirname, '..', '..')
 export const codebaseRoot = path.join(apiRoot, '..')
@@ -47,3 +48,6 @@ export const generateUniqueFileName = (fileName: string, extension = '') =>
     new Date().getTime(),
     extension
   ].join('')
+
+export const createReadStream = async (filePath: string) =>
+  fs.createReadStream(filePath)

api/src/utils/index.ts

@@ -3,6 +3,7 @@ export * from './connectDB'
 export * from './copySASjsCore'
 export * from './desktopAutoExec'
 export * from './extractHeaders'
+export * from './extractName'
 export * from './file'
 export * from './generateAccessToken'
 export * from './generateAuthCode'
@@ -13,6 +14,7 @@ export * from './getPreProgramVariables'
 export * from './getServerUrl'
 export * from './instantiateLogger'
 export * from './isDebugOn'
+export * from './zipped'
 export * from './parseLogToArray'
 export * from './removeTokensInDB'
 export * from './saveTokensInDB'

api/src/utils/zipped.ts

@@ -0,0 +1,39 @@
+import path from 'path'
+import unZipper from 'unzipper'
+import { extractName } from './extractName'
+import { createReadStream } from './file'
+
+export const isZipFile = (
+  file: Express.Multer.File
+): { error?: string; value?: Express.Multer.File } => {
+  const fileExtension = path.extname(file.originalname)
+  if (fileExtension.toUpperCase() !== '.ZIP')
+    return { error: `"file" has invalid extension ${fileExtension}` }
+
+  const allowedMimetypes = ['application/zip', 'application/x-zip-compressed']
+
+  if (!allowedMimetypes.includes(file.mimetype))
+    return { error: `"file" has invalid type ${file.mimetype}` }
+
+  return { value: file }
+}
+
+export const extractJSONFromZip = async (zipFile: Express.Multer.File) => {
+  let fileContent: string = ''
+
+  const fileInZip = extractName(zipFile.originalname)
+  const zip = (await createReadStream(zipFile.path)).pipe(
+    unZipper.Parse({ forceStream: true })
+  )
+
+  for await (const entry of zip) {
+    const fileName = entry.path as string
+    if (fileName.toUpperCase().endsWith('.JSON') && fileName === fileInZip) {
+      fileContent = await entry.buffer()
+    } else {
+      entry.autodrain()
+    }
+  }
+
+  return fileContent
+}