feat: mock resources

packages/insomnia-smoke-test/tests/smoke/app.test.ts

@@ -1,7 +1,7 @@
 import { expect } from '@playwright/test';
 
 import { loadFixture } from '../../playwright/paths';
-import { test } from '../../playwright/test';;
+import { test } from '../../playwright/test';
 
 test('can send requests', async ({ app, page }) => {
   test.slow(process.platform === 'darwin' || process.platform === 'win32', 'Slow app start on these platforms');

packages/insomnia-smoke-test/tests/smoke/dashboard-interactions.test.ts

@@ -105,18 +105,15 @@ test.describe('Dashboard', async () => {
       await expect(page.locator('.app')).toContainText('test123');
 
       // Duplicate document
-      await page.click('text=Documenttest123just now >> button');
+      await page.getByLabel('test123').getByRole('button').click();
       await page.getByRole('menuitem', { name: 'Duplicate' }).click();
       await page.locator('input[name="name"]').fill('test123-duplicate');
       await page.click('[role="dialog"] button:has-text("Duplicate")');
 
       await page.getByTestId('project').click();
 
-      const workspaceCards = page.getByLabel('Workspaces').getByRole('gridcell');
-      await expect(workspaceCards).toHaveCount(2);
-
       // Delete document
-      await page.click('text=Documenttest123just now >> button');
+      await page.getByLabel('test123-duplicate').getByRole('button').click();
       await page.getByRole('menuitem', { name: 'Delete' }).click();
       await page.getByRole('button', { name: 'Delete' }).click();
       // @TODO: Re-enable - Requires mocking VCS operations
@@ -143,17 +140,15 @@ test.describe('Dashboard', async () => {
       await expect(page.locator('.app')).toContainText('test123');
 
       // Duplicate collection
-      await page.click('text=Collectiontest123just now >> button');
+      await page.getByLabel('test123').getByRole('button').click();
       await page.getByRole('menuitem', { name: 'Duplicate' }).click();
       await page.locator('input[name="name"]').fill('test123-duplicate');
       await page.click('[role="dialog"] button:has-text("Duplicate")');
 
       await page.getByTestId('project').click();
-      const workspaceCards = page.getByLabel('Workspaces').getByRole('gridcell');
-      await expect(workspaceCards).toHaveCount(2);
 
       // Delete collection
-      await page.click('text=Collectiontest123just now >> button');
+      await page.getByLabel('test123-duplicate').getByRole('button').click();
       await page.getByRole('menuitem', { name: 'Delete' }).click();
       await page.getByRole('button', { name: 'Delete' }).click();
       // @TODO: Re-enable - Requires mocking VCS operations

packages/insomnia-smoke-test/tests/smoke/mock.test.ts

@@ -0,0 +1,25 @@
+import { test } from '../../playwright/test';
+
+// TODO: unskip this test when cloud mock is online
+test.skip('can make a mock route', async ({ page }) => {
+  test.slow(process.platform === 'darwin' || process.platform === 'win32', 'Slow app start on these platforms');
+  await page.getByLabel('New Mock Server').click();
+  await page.getByRole('button', { name: 'Create', exact: true }).click();
+  await page.getByRole('button', { name: 'New Mock Route' }).click();
+  await page.getByText('GET/').click();
+  await page.getByTestId('CodeEditor').getByRole('textbox').fill('123');
+  await page.getByRole('tab', { name: 'Response Headers' }).click();
+  await page.locator('.CodeMirror').first().click();
+  await page.getByRole('textbox').nth(1).fill('my-header');
+  await page.getByRole('textbox').nth(2).fill('my-value');
+  await page.getByRole('tab', { name: 'Response Status' }).click();
+  await page.getByPlaceholder('200').click();
+  await page.getByPlaceholder('200').fill('201');
+
+  await page.getByRole('button', { name: 'Test' }).click();
+  await page.getByRole('tab', { name: 'Preview' }).click();
+  await page.getByLabel('Preview').getByText('123').click();
+  await page.getByRole('tab', { name: 'Timeline' }).click();
+  await page.getByText('HTTP/1.1 201 Created').click();
+  await page.getByText('my-header:').click();
+});

packages/insomnia/src/common/constants.ts

@@ -136,6 +136,7 @@ export enum UpdateURL {
 
 // API
 export const getApiBaseURL = () => env.INSOMNIA_API_URL || 'https://api.insomnia.rest';
+export const getMockServiceURL = () => env.INSOMNIA_MOCK_API_URL || 'https://mock.insomnia.rest';
 export const getAIServiceURL = () => env.INSOMNIA_AI_URL || 'https://ai.insomnia.rest';
 
 export const getUpdatesBaseURL = () => env.INSOMNIA_UPDATES_URL || 'https://updates.insomnia.rest';
@@ -267,7 +268,7 @@ export const CONTENT_TYPE_FORM_DATA = 'multipart/form-data';
 export const CONTENT_TYPE_FILE = 'application/octet-stream';
 export const CONTENT_TYPE_GRAPHQL = 'application/graphql';
 export const CONTENT_TYPE_OTHER = '';
-const contentTypesMap: Record<string, string[]> = {
+export const contentTypesMap: Record<string, string[]> = {
   [CONTENT_TYPE_EDN]: ['EDN', 'EDN'],
   [CONTENT_TYPE_FILE]: ['File', 'Binary File'],
   [CONTENT_TYPE_FORM_DATA]: ['Multipart', 'Multipart Form'],
@@ -573,6 +574,8 @@ export const EXPORT_TYPE_REQUEST = 'request';
 export const EXPORT_TYPE_GRPC_REQUEST = 'grpc_request';
 export const EXPORT_TYPE_WEBSOCKET_REQUEST = 'websocket_request';
 export const EXPORT_TYPE_WEBSOCKET_PAYLOAD = 'websocket_payload';
+export const EXPORT_TYPE_MOCK_SERVER = 'mock';
+export const EXPORT_TYPE_MOCK_ROUTE = 'mock_route';
 export const EXPORT_TYPE_REQUEST_GROUP = 'request_group';
 export const EXPORT_TYPE_UNIT_TEST_SUITE = 'unit_test_suite';
 export const EXPORT_TYPE_UNIT_TEST = 'unit_test';

packages/insomnia/src/common/get-workspace-label.ts

@@ -1,5 +1,9 @@
-import { isDesign, Workspace } from '../models/workspace';
+import { isDesign, isMockServer, Workspace } from '../models/workspace';
 import { strings } from './strings';
 
 export const getWorkspaceLabel = (workspace: Workspace) =>
-  isDesign(workspace) ? strings.document : strings.collection;
+  isDesign(workspace)
+    ? strings.document
+    : isMockServer(workspace)
+      ? strings.mock
+      : strings.collection;

packages/insomnia/src/common/har.ts

@@ -414,9 +414,8 @@ function getRequestCookies(renderedRequest: RenderedRequest) {
   return harCookies;
 }
 
-function getResponseCookies(response: Response) {
-  const headers = response.headers.filter(Boolean) as HarCookie[];
-  const responseCookies = getSetCookieHeaders(headers)
+export function getResponseCookiesFromHeaders(headers: HarCookie[]) {
+  return getSetCookieHeaders(headers)
     .reduce((accumulator, harCookie) => {
       let cookie: null | undefined | ToughCookie = null;
 
@@ -433,7 +432,11 @@ function getResponseCookies(response: Response) {
         mapCookie(cookie),
       ];
     }, [] as HarCookie[]);
-  return responseCookies;
+}
+
+function getResponseCookies(response: Response) {
+  const headers = response.headers.filter(Boolean);
+  return getResponseCookiesFromHeaders(headers);
 }
 
 function mapCookie(cookie: ToughCookie) {

packages/insomnia/src/common/render.ts

@@ -596,5 +596,7 @@ export async function getRenderContextAncestors(base?: Request | GrpcRequest | W
     models.requestGroup.type,
     models.workspace.type,
     models.project.type,
+    models.mockRoute.type,
+    models.mockServer.type,
   ]);
 }

packages/insomnia/src/common/strings.ts

@@ -5,6 +5,7 @@ export interface StringInfo {
 
 type StringId =
   | 'collection'
+  | 'mock'
   | 'document'
   | 'project'
   | 'workspace'
@@ -18,6 +19,10 @@ export const strings: Record<StringId, StringInfo> = {
     singular: 'Collection',
     plural: 'Collections',
   },
+  mock: {
+    singular: 'Mock',
+    plural: 'Mocks',
+  },
   document: {
     singular: 'Document',
     plural: 'Documents',

packages/insomnia/src/models/index.ts

@@ -3,6 +3,8 @@ import {
   EXPORT_TYPE_COOKIE_JAR,
   EXPORT_TYPE_ENVIRONMENT,
   EXPORT_TYPE_GRPC_REQUEST,
+  EXPORT_TYPE_MOCK_ROUTE,
+  EXPORT_TYPE_MOCK_SERVER,
   EXPORT_TYPE_PROTO_DIRECTORY,
   EXPORT_TYPE_PROTO_FILE,
   EXPORT_TYPE_REQUEST,
@@ -22,6 +24,8 @@ import * as _environment from './environment';
 import * as _gitRepository from './git-repository';
 import * as _grpcRequest from './grpc-request';
 import * as _grpcRequestMeta from './grpc-request-meta';
+import * as _mockRoute from './mock-route';
+import * as _mockServer from './mock-server';
 import * as _oAuth2Token from './o-auth-2-token';
 import * as _pluginData from './plugin-data';
 import * as _project from './project';
@@ -64,6 +68,8 @@ export const caCertificate = _caCertificate;
 export const cookieJar = _cookieJar;
 export const environment = _environment;
 export const gitRepository = _gitRepository;
+export const mockServer = _mockServer;
+export const mockRoute = _mockRoute;
 export const oAuth2Token = _oAuth2Token;
 export const pluginData = _pluginData;
 export const request = _request;
@@ -109,6 +115,8 @@ export function all() {
     requestVersion,
     requestMeta,
     response,
+    mockServer,
+    mockRoute,
     oAuth2Token,
     caCertificate,
     clientCertificate,
@@ -211,6 +219,8 @@ export const MODELS_BY_EXPORT_TYPE: Record<string, any> = {
   [EXPORT_TYPE_REQUEST]: request,
   [EXPORT_TYPE_WEBSOCKET_PAYLOAD]: webSocketPayload,
   [EXPORT_TYPE_WEBSOCKET_REQUEST]: webSocketRequest,
+  [EXPORT_TYPE_MOCK_SERVER]: mockServer,
+  [EXPORT_TYPE_MOCK_ROUTE]: mockRoute,
   [EXPORT_TYPE_GRPC_REQUEST]: grpcRequest,
   [EXPORT_TYPE_REQUEST_GROUP]: requestGroup,
   [EXPORT_TYPE_UNIT_TEST_SUITE]: unitTestSuite,

packages/insomnia/src/models/mock-route.ts

@@ -0,0 +1,82 @@
+import { database as db } from '../common/database';
+import type { BaseModel } from './index';
+import { RequestHeader } from './request';
+
+export const name = 'Mock Route';
+
+export const type = 'MockRoute';
+
+export const prefix = 'mock_route';
+
+export const canDuplicate = true;
+
+export const canSync = true;
+
+interface BaseMockRoute {
+  body: string;
+  headers: RequestHeader[];
+  parentId: string;
+  statusCode: number;
+  statusText: string;
+  name: string;
+  mimeType: string;// response body type
+  method: string; // used only for sending the testing request
+}
+
+export type MockRoute = BaseModel & BaseMockRoute;
+
+export function init(): BaseMockRoute {
+  return {
+    body: '',
+    headers: [],
+    parentId: '',
+    statusCode: 200,
+    statusText: '',
+    name: '/',
+    mimeType: 'application/json',
+    method: 'GET',
+  };
+}
+
+export const isMockRoute = (model: Pick<BaseModel, 'type'>): model is MockRoute => (
+  model.type === type
+);
+
+export function migrate(doc: MockRoute) {
+  return doc;
+}
+
+export function create(patch: Partial<MockRoute> = {}) {
+  if (!patch.parentId) {
+    throw new Error('New MockRoute missing `parentId`: ' + JSON.stringify(patch));
+  }
+
+  return db.docCreate<MockRoute>(type, patch);
+}
+
+export function update(
+  mockRoute: MockRoute,
+  patch: Partial<MockRoute> = {},
+) {
+  return db.docUpdate<MockRoute>(mockRoute, patch);
+}
+
+export function getById(id: string) {
+  return db.get<MockRoute>(type, id);
+}
+
+export function findByParentId(parentId: string) {
+  return db.find<MockRoute>(type, { parentId });
+}
+
+export function removeWhere(parentId: string) {
+  return db.removeWhere(type, { parentId });
+}
+
+export function remove(mockRoute: MockRoute) {
+  return db.remove(mockRoute);
+}
+
+export function all() {
+  return db.all<MockRoute>(type);
+}

packages/insomnia/src/models/mock-server.ts

@@ -0,0 +1,91 @@
+import { database as db } from '../common/database';
+import { type BaseModel, workspace } from './index';
+
+export const name = 'Mock Server';
+
+export const type = 'MockServer';
+
+export const prefix = 'mock';
+
+export const canDuplicate = true;
+
+export const canSync = true;
+
+interface BaseMockServer {
+  parentId: string;
+  name: string;
+  url: string;
+  useInsomniaCloud: boolean;
+}
+
+export type MockServer = BaseModel & BaseMockServer;
+
+export function init(): BaseMockServer {
+  return {
+    parentId: '',
+    name: 'New Mock',
+    url: 'http://localhost:8080',
+    useInsomniaCloud: true,
+  };
+}
+
+export const isMockServer = (model: Pick<BaseModel, 'type'>): model is MockServer => (
+  model.type === type
+);
+
+export function migrate(doc: MockServer) {
+  return doc;
+}
+
+export function create(patch: Partial<MockServer> = {}) {
+  if (!patch.parentId) {
+    throw new Error('New MockServer missing `parentId`: ' + JSON.stringify(patch));
+  }
+
+  return db.docCreate<MockServer>(type, patch);
+}
+export async function getOrCreateForParentId(
+  workspaceId: string,
+  patch: Partial<MockServer> = {},
+) {
+  const mockServer = await db.getWhere<MockServer>(type, {
+    parentId: workspaceId,
+  });
+
+  if (!mockServer) {
+    return db.docCreate<MockServer>(type, { ...patch, parentId: workspaceId });
+  }
+
+  return mockServer;
+}
+export function update(
+  mockServer: MockServer,
+  patch: Partial<MockServer> = {},
+) {
+  return db.docUpdate<MockServer>(mockServer, patch);
+}
+
+export function getById(id: string) {
+  return db.get<MockServer>(type, id);
+}
+
+export function getByParentId(parentId: string) {
+  return db.getWhere<MockServer>(type, { parentId });
+}
+
+export async function findByProjectId(projectId: string) {
+  const workspaces = await workspace.findByParentId(projectId);
+  return db.find<MockServer>(type, { parentId: { $in: workspaces.map(ws => ws._id) } });
+}
+
+export function removeWhere(parentId: string) {
+  return db.removeWhere(type, { parentId });
+}
+
+export function remove(mockServer: MockServer) {
+  return db.remove(mockServer);
+}
+
+export function all() {
+  return db.all<MockServer>(type);
+}