// @flow import type {BaseModel} from './index'; import {AUTH_BASIC, AUTH_DIGEST, AUTH_NONE, AUTH_NTLM, AUTH_OAUTH_1, AUTH_OAUTH_2, AUTH_HAWK, AUTH_AWS_IAM, AUTH_NETRC, AUTH_ASAP, CONTENT_TYPE_FILE, CONTENT_TYPE_FORM_DATA, CONTENT_TYPE_FORM_URLENCODED, CONTENT_TYPE_OTHER, getContentTypeFromHeaders, METHOD_GET, CONTENT_TYPE_GRAPHQL, CONTENT_TYPE_JSON, METHOD_POST, HAWK_ALGORITHM_SHA256} from '../common/constants'; import * as db from '../common/database'; import {getContentTypeHeader} from '../common/misc'; import {buildQueryStringFromParams, deconstructQueryStringToParams} from 'insomnia-url'; import {GRANT_TYPE_AUTHORIZATION_CODE} from '../network/o-auth-2/constants'; import {SIGNATURE_METHOD_HMAC_SHA1} from '../network/o-auth-1/constants'; export const name = 'Request'; export const type = 'Request'; export const prefix = 'req'; export const canDuplicate = true; export type RequestAuthentication = Object; export type RequestHeader = { name: string, value: string, disabled?: boolean }; export type RequestParameter = { name: string, value: string, disabled?: boolean, id?: string, fileName?: string }; export type RequestBodyParameter = { name: string, value: string, disabled?: boolean, id?: string, fileName?: string, type?: string }; export type RequestBody = { mimeType?: string | null, text?: string, fileName?: string, params?: Array }; type BaseRequest = { url: string, name: string, description: string, method: string, body: RequestBody, parameters: Array, headers: Array, authentication: RequestAuthentication, metaSortKey: number, // Settings settingStoreCookies: boolean, settingSendCookies: boolean, settingDisableRenderRequestBody: boolean, settingEncodeUrl: boolean }; export type Request = BaseModel & BaseRequest; export function init (): BaseRequest { return { url: '', name: 'New Request', description: '', method: METHOD_GET, body: {}, parameters: [], headers: [], authentication: {}, metaSortKey: -1 * Date.now(), // Settings settingStoreCookies: true, settingSendCookies: true, settingDisableRenderRequestBody: false, settingEncodeUrl: true }; } export function newAuth (type: string, oldAuth: RequestAuthentication = {}): RequestAuthentication { switch (type) { // No Auth case AUTH_NONE: return {}; // HTTP Basic Authentication case AUTH_BASIC: case AUTH_DIGEST: case AUTH_NTLM: return { type, disabled: oldAuth.disabled || false, username: oldAuth.username || '', password: oldAuth.password || '' }; case AUTH_OAUTH_1: return { type, disabled: false, signatureMethod: SIGNATURE_METHOD_HMAC_SHA1, consumerKey: '', consumerSecret: '', tokenKey: '', tokenSecret: '', version: '1.0', nonce: '', timestamp: '', callback: '' }; // OAuth 2.0 case AUTH_OAUTH_2: return { type, grantType: GRANT_TYPE_AUTHORIZATION_CODE }; // Aws IAM case AUTH_AWS_IAM: return { type, disabled: oldAuth.disabled || false, accessKeyId: oldAuth.accessKeyId || '', secretAccessKey: oldAuth.secretAccessKey || '' }; // Hawk case AUTH_HAWK: return { type, algorithm: HAWK_ALGORITHM_SHA256 }; // Atlassian ASAP case AUTH_ASAP: return { type, issuer: '', subject: '', audience: '', keyId: '', privateKey: '' }; // Types needing no defaults case AUTH_NETRC: default: return {type}; } } export function newBodyNone (): RequestBody { return {}; } export function newBodyRaw (rawBody: string, contentType?: string): RequestBody { if (typeof contentType !== 'string') { return {text: rawBody}; } const mimeType = contentType.split(';')[0]; return {mimeType, text: rawBody}; } export function newBodyFormUrlEncoded (parameters: Array | null): RequestBody { // Remove any properties (eg. fileName) that might not fit parameters = (parameters || []).map(parameter => { const newParameter: RequestBodyParameter = { name: parameter.name, value: parameter.value }; if (parameter.hasOwnProperty('id')) { newParameter.id = parameter.id; } if (parameter.hasOwnProperty('disabled')) { newParameter.disabled = parameter.disabled; } else { newParameter.disabled = false; } return newParameter; }); return { mimeType: CONTENT_TYPE_FORM_URLENCODED, params: parameters }; } export function newBodyFile (path: string): RequestBody { return { mimeType: CONTENT_TYPE_FILE, fileName: path }; } export function newBodyForm (parameters: Array): RequestBody { return { mimeType: CONTENT_TYPE_FORM_DATA, params: parameters || [] }; } export function migrate (doc: Request): Request { doc = migrateBody(doc); doc = migrateWeirdUrls(doc); doc = migrateAuthType(doc); return doc; } export function create (patch: Object = {}): Promise { if (!patch.parentId) { throw new Error(`New Requests missing \`parentId\`: ${JSON.stringify(patch)}`); } return db.docCreate(type, patch); } export function getById (id: string): Promise { return db.get(type, id); } export function findByParentId (parentId: string): Promise> { return db.find(type, {parentId: parentId}); } export function update (request: Request, patch: Object): Promise { return db.docUpdate(request, patch); } export function updateMimeType ( request: Request, mimeType: string, doCreate: boolean = false ): Promise { let headers = request.headers ? [...request.headers] : []; const contentTypeHeader = getContentTypeHeader(headers); // GraphQL uses JSON content-type const contentTypeHeaderValue = mimeType === CONTENT_TYPE_GRAPHQL ? CONTENT_TYPE_JSON : mimeType; // GraphQL must be POST if (mimeType === CONTENT_TYPE_GRAPHQL) { request.method = METHOD_POST; } // Check if we are converting to/from variants of XML or JSON let leaveContentTypeAlone = false; if (contentTypeHeader && mimeType) { const current = contentTypeHeader.value; if (current.includes('xml') && mimeType.includes('xml')) { leaveContentTypeAlone = true; } else if (current.includes('json') && mimeType.includes('json')) { leaveContentTypeAlone = true; } } // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // // 1. Update Content-Type header // // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // const hasBody = typeof mimeType === 'string'; if (!hasBody || mimeType === CONTENT_TYPE_OTHER) { headers = headers.filter(h => h !== contentTypeHeader); } else if (mimeType && contentTypeHeader && !leaveContentTypeAlone) { contentTypeHeader.value = contentTypeHeaderValue; } else if (mimeType && !contentTypeHeader) { headers.push({name: 'Content-Type', value: contentTypeHeaderValue}); } // ~~~~~~~~~~~~~~~~~~~~~~~~~~ // // 2. Make a new request body // // ~~~~~~~~~~~~~~~~~~~~~~~~~~ // let body; if (mimeType === CONTENT_TYPE_FORM_URLENCODED) { // Urlencoded body = request.body.params ? newBodyFormUrlEncoded(request.body.params) : newBodyFormUrlEncoded(deconstructQueryStringToParams(request.body.text)); } else if (mimeType === CONTENT_TYPE_FORM_DATA) { // Form Data body = request.body.params ? newBodyForm(request.body.params) : newBodyForm(deconstructQueryStringToParams(request.body.text)); } else if (mimeType === CONTENT_TYPE_FILE) { // File body = newBodyFile(''); } else if (mimeType === CONTENT_TYPE_GRAPHQL) { if (contentTypeHeader) { contentTypeHeader.value = CONTENT_TYPE_JSON; } body = newBodyRaw(request.body.text || '', CONTENT_TYPE_GRAPHQL); } else if (typeof mimeType !== 'string') { // No body body = newBodyNone(); } else { // Raw Content-Type (ex: application/json) body = request.body.params ? newBodyRaw(buildQueryStringFromParams(request.body.params, false), mimeType) : newBodyRaw(request.body.text || '', mimeType); } // ~~~~~~~~~~~~~~~~~~~~~~~~ // // 2. create/update request // // ~~~~~~~~~~~~~~~~~~~~~~~~ // if (doCreate) { const newRequest: Request = Object.assign({}, request, {headers, body}); return create(newRequest); } else { return update(request, {headers, body}); } } export async function duplicate (request: Request): Promise { const name = `${request.name} (Copy)`; // Get sort key of next request const q = {metaSortKey: {$gt: request.metaSortKey}}; const [nextRequest] = await db.find(type, q, {metaSortKey: 1}); const nextSortKey = nextRequest ? nextRequest.metaSortKey : request.metaSortKey + 100; // Calculate new sort key const sortKeyIncrement = (nextSortKey - request.metaSortKey) / 2; const metaSortKey = request.metaSortKey + sortKeyIncrement; return db.duplicate(request, {name, metaSortKey}); } export function remove (request: Request): Promise { return db.remove(request); } export function all () { return db.all(type); } // ~~~~~~~~~~ // // Migrations // // ~~~~~~~~~~ // /** * Migrate old body (string) to new body (object) * @param request * @returns {*} */ function migrateBody (request: Request): Request { if (request.body && typeof request.body === 'object') { return request; } // Second, convert all existing urlencoded bodies to new format const contentType = getContentTypeFromHeaders(request.headers) || ''; const wasFormUrlEncoded = !!contentType.match(/^application\/x-www-form-urlencoded/i); if (wasFormUrlEncoded) { // Convert old-style form-encoded request bodies to new style const body = typeof request.body === 'string' ? request.body : ''; request.body = newBodyFormUrlEncoded(deconstructQueryStringToParams(body, false)); } else if (!request.body && !contentType) { request.body = {}; } else { const body: string = typeof request.body === 'string' ? request.body : ''; request.body = newBodyRaw(body, contentType); } return request; } /** * Fix some weird URLs that were caused by an old bug * @param request * @returns {*} */ function migrateWeirdUrls (request: Request): Request { // Some people seem to have requests with URLs that don't have the indexOf // function. This should clear that up. This can be removed at a later date. if (typeof request.url !== 'string') { request.url = ''; } return request; } /** * Ensure the request.authentication.type property is added * @param request * @returns {*} */ function migrateAuthType (request: Request): Request { const isAuthSet = request.authentication && request.authentication.username; if (isAuthSet && !request.authentication.type) { request.authentication.type = AUTH_BASIC; } return request; }