Skip to content

Commit

Permalink
refactor(ui): move postman import code from helpers to its own file
Browse files Browse the repository at this point in the history
  • Loading branch information
@flawiddsouza
flawiddsouza committed Sep 6, 2024
1 parent 99aa7b1 commit 64226da
Show file tree
Hide file tree
Showing 3 changed files with 309 additions and 301 deletions.
2 changes: 1 addition & 1 deletion packages/ui/src/components/ImportModal.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ import {
fileToJSON,
fileToString,
convertInsomniaExportToRestfoxCollection,
convertPostmanExportToRestfoxCollection,
convertRestfoxExportToRestfoxCollection,
convertOpenAPIExportToRestfoxCollection,
generateNewIdsForTree
} from '@/helpers'
import { convertPostmanExportToRestfoxCollection } from '@/parsers/postman'
import Modal from '@/components/Modal.vue'
import { getCollectionForWorkspace } from '@/db'
import { emitter } from '@/event-bus'
Expand Down
300 changes: 0 additions & 300 deletions packages/ui/src/helpers.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import JSZip from 'jszip'
import { nanoid } from 'nanoid'
import { createRequestContextForPlugin, createResponseContextForPlugin, usePlugin } from './plugin'
import dayjs from 'dayjs'
Expand All @@ -11,7 +10,6 @@ import { convert as curlConvert } from './parsers/curl'
import yaml from 'js-yaml'
import {
CollectionItem,
RequestBody,
RequestAuthentication,
RequestParam,
RequestInitialResponse,
Expand Down Expand Up @@ -674,304 +672,6 @@ export function convertInsomniaExportToRestfoxCollection(json: any, workspaceId:
return toTree(collection)
}

export async function convertPostmanExportToRestfoxCollection(json: any, isZip: boolean, workspaceId: string) {
if(isZip) {
const zip = new JSZip()
const extractedZip = await zip.loadAsync(json)
const filePaths = Object.keys(extractedZip.files)
const filePathMap: Record<string, string> = {}
const basePath = filePaths[filePaths.length - 1].replace('archive.json', '')
filePaths.forEach(filePath => {
filePathMap[filePath.replace(basePath, '')] = filePath
})

const archive = await extractedZip.files[filePathMap['archive.json']].async('text')
const archiveCollection = JSON.parse(archive).collection

const collections: any[] = []

for(const collectionId of Object.keys(archiveCollection)) {
collections.push(JSON.parse(await extractedZip.files[filePathMap[`collection/${collectionId}.json`]].async('text')))
}

return importPostmanV2(collections, workspaceId)
} else {
if('info' in json) {
if('schema' in json.info) {
if(json.info.schema === 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json' || json.info.schema === 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json') {
return importPostmanV2([json], workspaceId)
}
}
}
return importPostmanV1(json.collections, workspaceId)
}
}

function importPostmanV1(collections: any[], workspaceId: string) {
const collection: CollectionItem[] = []

collections.forEach(item => {
const requests: CollectionItem[] = []

item.requests.forEach((request: any) => {
let body: RequestBody = {
mimeType: 'No Body'
}

if(request.dataMode === 'urlencoded') {
const params: RequestParam[] = []
const requestData = request.data !== null ? request.data : []
requestData.forEach((requestDataItem: any) => {
params.push({
name: requestDataItem.key,
value: requestDataItem.value,
description: requestDataItem.description,
disabled: !requestDataItem.enabled
})
})
body = {
mimeType: 'application/x-www-form-urlencoded',
params
}
}

if(request.dataMode === 'raw') {
body = {
mimeType: 'text/plain',
text: request.rawModeData
}
}

const headers: RequestParam[] = []
request.headerData.forEach((header: any) => {
headers.push({
name: header.key,
value: header.value,
description: header.description,
disabled: !header.enabled
})
})

const parameters: RequestParam[] = []
const queryParams = request.queryParams !== null ? request.queryParams : []
queryParams.forEach((queryParam: any) => {
parameters.push({
name: queryParam.key,
value: queryParam.value,
description: queryParam.description,
disabled: !queryParam.enabled
})
})

requests.push({
_id: request.id,
_type: 'request',
method: request.method,
url: request.url,
name: request.name,
body,
headers,
parameters,
parentId: item.id,
workspaceId
})
})

collection.push({
_id: item.id,
_type: 'request_group',
name: item.name,
children: requests,
parentId: null,
workspaceId
})
})

return collection
}

function handlePostmanV2CollectionItem(postmanCollectionItem: any, parentId: string | null = null, workspaceId: string) {
const requests: CollectionItem[] = []
const plugins: Plugin[] = []

postmanCollectionItem.item.forEach((request: any) => {
const requestId = request.id ?? nanoid()
if('item' in request) {
const { convertedRequests, plugins: newPlugins } = handlePostmanV2CollectionItem(request, requestId, workspaceId)
plugins.push(...newPlugins)

requests.push({
_id: requestId,
_type: 'request_group',
name: request.name,
children: convertedRequests,
parentId,
workspaceId
})
return
}

let body: RequestBody = {
mimeType: 'No Body'
}

if('body' in request.request && 'mode' in request.request.body) {
if(request.request.body.mode === 'urlencoded') {
const params: RequestParam[] = []
const requestData = request.request.body.urlencoded
requestData.forEach((requestDataItem: any) => {
params.push({
name: requestDataItem.key,
value: requestDataItem.value,
description: requestDataItem.description,
disabled: requestDataItem.disabled
})
})
body = {
mimeType: 'application/x-www-form-urlencoded',
params
}
}

if(request.request.body.mode === 'raw') {
let mimeType = 'text/plain'

if('options' in request.request.body && 'raw' in request.request.body.options && request.request.body.options.raw.language === 'json') {
mimeType = 'application/json'
}

if(mimeType === 'text/plain') {
try {
JSON.parse(request.request.body.raw)
mimeType = 'application/json'
} catch {}
}

body = {
mimeType: mimeType,
text: request.request.body.raw
}
}
}

const headers: RequestParam[] = []
request.request.header.forEach((header: any) => {
headers.push({
name: header.key,
value: header.value,
description: header.description,
disabled: header.disabled
})
})

const parameters: RequestParam[] = []
const queryParams = 'url' in request.request && typeof request.request.url !== 'string' && 'query' in request.request.url ? request.request.url.query : []
queryParams.forEach((queryParam: any) => {
parameters.push({
name: queryParam.key,
value: queryParam.value,
description: queryParam.description,
disabled: queryParam.disabled
})
})

let url = ''

if('url' in request.request) {
url = typeof request.request.url === 'string' ? request.request.url : request.request.url.raw
}

let authentication: RequestAuthentication = { type: 'No Auth' }

if('auth' in request.request) {
if(request.request.auth.type === 'bearer') {
authentication = {
type: 'bearer'
}
const bearerAuth = 'bearer' in request.request.auth ? request.request.auth.bearer : []
if(bearerAuth.length > 0) {
authentication = {
type: 'bearer',
token: bearerAuth[0].value
}
}
}
}

if(request.event) {
const scriptId = nanoid()
let preScript = ''
let postScript = ''
request.event.forEach((script: any) => {
if(script.listen === 'prerequest') {
preScript += script.script.exec.join('\n')
}

if(script.listen === 'test') {
postScript += script.script.exec.join('\n')
}
})

plugins.push({
'_id': scriptId,
'type': 'script',
'name': null,
'code': {
'pre_request': scriptConversion(preScript, 'postmanToRestfox'),
'post_request': scriptConversion(postScript, 'postmanToRestfox')
},
'collectionId': requestId,
'workspaceId': workspaceId,
'enabled': true,
'createdAt': Date.now(),
'updatedAt': Date.now()
})
}

requests.push({
_id: requestId,
_type: 'request',
method: request.request.method,
url,
name: request.name,
body,
headers,
parameters,
authentication,
description: 'description' in request.request ? request.request.description : undefined,
parentId,
workspaceId
})
})

return { convertedRequests: requests, plugins }
}

function importPostmanV2(collections: any[], workspaceId: string) {
const collection: CollectionItem[] = []
const plugins: Plugin[] = []

collections.forEach(postmanCollectionItem => {
const { convertedRequests, plugins: newPlugins } = handlePostmanV2CollectionItem(postmanCollectionItem, postmanCollectionItem.info._postman_id, workspaceId)
plugins.push(...newPlugins)

collection.push({
_id: postmanCollectionItem.info._postman_id,
_type: 'request_group',
name: postmanCollectionItem.info.name,
environment: 'variable' in postmanCollectionItem ? postmanCollectionItem.variable.reduce((prev: any, acc: any) => {
prev[acc.key] = acc.value
return prev
}, {}) : undefined,
children: convertedRequests,
parentId: null,
workspaceId
})
})

return { collection, plugins }
}

function importRestfoxV1(collections: CollectionItem[], workspaceId: string) {
const collection: CollectionItem[] = []
const plugins: Plugin[] = []
Expand Down
Loading

0 comments on commit 64226da

Please sign in to comment.