// @flow import type { BaseModel } from './index'; import * as models from './index'; import * as db from '../common/database'; import { getAppId, getAppName } from '../common/constants'; import { APP_ID_DESIGNER } from '../../config'; export const name = 'Workspace'; export const type = 'Workspace'; export const prefix = 'wrk'; export const canDuplicate = true; export const canSync = true; type BaseWorkspace = { name: string, description: string, scope: 'spec' | 'debug' | null, }; export type Workspace = BaseModel & BaseWorkspace; export function init() { return { name: 'New Workspace', description: '', scope: null, }; } export async function migrate(doc: Workspace): Promise { doc = await _migrateExtractClientCertificates(doc); doc = await _migrateEnsureName(doc); await models.apiSpec.getOrCreateForParentId(doc._id, { fileName: doc.name }); return doc; } export function getById(id: string): Promise { return db.get(type, id); } export async function create(patch: $Shape = {}): Promise { return db.docCreate(type, patch); } export async function all(): Promise> { const workspaces = await db.all(type); if (workspaces.length === 0) { await create({ name: getAppName(), scope: getAppId() === APP_ID_DESIGNER ? 'spec' : null }); return all(); } else { return workspaces; } } export function count() { return db.count(type); } export function update(workspace: Workspace, patch: $Shape): Promise { return db.docUpdate(workspace, patch); } export function remove(workspace: Workspace): Promise { return db.remove(workspace); } async function _migrateExtractClientCertificates(workspace: Workspace): Promise { const certificates = (workspace: Object).certificates || null; if (!Array.isArray(certificates)) { // Already migrated return workspace; } for (const cert of certificates) { await models.clientCertificate.create({ parentId: workspace._id, host: cert.host || '', passphrase: cert.passphrase || null, cert: cert.cert || null, key: cert.key || null, pfx: cert.pfx || null, isPrivate: false, }); } delete (workspace: Object).certificates; // This will remove the now-missing `certificates` property // NOTE: Using db.update so we don't change things like modified time await db.update(workspace); return workspace; } /** * Ensure workspace has a valid String name. Due to real-world bug reports, we know * this happens (and it causes problems) so this migration will ensure that it is * corrected. */ async function _migrateEnsureName(workspace: Workspace): Promise { if (typeof workspace.name !== 'string') { workspace.name = 'My Workspace'; } return workspace; }