insomnia/packages/insomnia-app/app/models/cookie-jar.js
Opender Singh b072745b6d
Introduce flow $Shape<T> to db models (#2002)
* Introduce flow <T> to db models

* Resolve errors discovered while fixing typing

* Revert change for response
2020-03-18 11:58:57 -07:00

98 lines
2.1 KiB
JavaScript

// @flow
import crypto from 'crypto';
import * as db from '../common/database';
import type { BaseModel } from './index';
export const name = 'Cookie Jar';
export const type = 'CookieJar';
export const prefix = 'jar';
export const canDuplicate = true;
export const canSync = false;
export type Cookie = {
id: string,
key: string,
value: string,
expires: Date | string | number | null,
domain: string,
path: string,
secure: boolean,
httpOnly: boolean,
extensions?: Array<any>,
creation?: Date,
creationIndex?: number,
hostOnly?: boolean,
pathIsDefault?: boolean,
lastAccessed?: Date,
};
type BaseCookieJar = {
name: string,
cookies: Array<Cookie>,
};
export type CookieJar = BaseModel & BaseCookieJar;
export function init() {
return {
name: 'Default Jar',
cookies: [],
};
}
export function migrate(doc: CookieJar): CookieJar {
doc = migrateCookieId(doc);
return doc;
}
export async function create(patch: $Shape<CookieJar>) {
if (!patch.parentId) {
throw new Error(`New CookieJar missing \`parentId\`: ${JSON.stringify(patch)}`);
}
return db.docCreate(type, patch);
}
export async function getOrCreateForParentId(parentId: string) {
const cookieJars = await db.find(type, { parentId });
if (cookieJars.length === 0) {
return create({
parentId,
// Deterministic ID. It helps reduce sync complexity since we won't have to
// de-duplicate environments.
_id: `${prefix}_${crypto
.createHash('sha1')
.update(parentId)
.digest('hex')}`,
});
} else {
return cookieJars[0];
}
}
export async function all(): Promise<Array<BaseModel>> {
return db.all(type);
}
export async function getById(id: string) {
return db.get(type, id);
}
export async function update(cookieJar: CookieJar, patch: $Shape<CookieJar> = {}) {
return db.docUpdate(cookieJar, patch);
}
/** Ensure every cookie has an ID property */
function migrateCookieId(cookieJar: CookieJar) {
for (const cookie of cookieJar.cookies) {
if (!cookie.id) {
cookie.id = Math.random()
.toString()
.replace('0.', '');
}
}
return cookieJar;
}