feat: mock resources

[jackkav]

goal:

Support API mocking features.

terminology:

• "mock server" a group of "mock routes", perhaps with a remotely assigned url the user can copy and use in their app, TBD as server provisioning is an external concern, perhaps mock resource
• "mock route" a stubbed response, perhaps with remote url, route to resolve, TBD as route clashes with react route
• "example response" a saved template used to populate a request bin, saved from a custom form or generated from an OAS spec or existing response

ideas for next pass:

• could transform a request collection into a mock server/mock routes
• could transform a design document into a mock server/mock routes
• could add a mock server navigation to design document menu pills and add pills to collection
• could use kong dialect to describe services and routes if we can find a payoff in orchestration or extension
• should derived mock servers be editable?
• could use the same relationships as a spec, however scope will be migrated if old version is used

questions

• data model
  • to use mock route path and name or just name?
    • additive, it should be cheap to add. apth field later if we need to use name for something else
  • to record url in the route or make it a product of server
    • remove url from route
  • to write response body to file in order to model responses more closely
    • could create body size and content type validator to ensure responses are always human readable content
• should be a child of project or workspace?
• request bins cannot be edited, should we reuse or rebuild?
• should mock servers interact with environments?
• abstractions
  • requestheaderseditor
• alternate protocols? besides http, sse, gql, grpc, websockets?

todo:

• project pane UI
• wire up mock server crud actions
• wire up mock route crud actions
• sidebar
• url bar
• response editor
• mock response UI inside collection
• send to mock url feature, insomnia network stack side, show response, from request tab and from mock server editor
• request bin/mock server activity fetched from mockbin api
• send to mock url, server POC side
• path and naming?
• fix command palette
• remove offline mode workaround
• fix button sizing of collection settings
• icon bg color
• in order not to break downgraded mock servers we will need to make a new workspace key to replace scope, because scope is forced to defualt to design when unknown prior to adding mock server.
• fix duplicate
• rename mock server to mock
• fix mock settings
• persist mock route onblur in tabs
• default cloud mock server, radio button local mock server and input, use create project dialog style
• check route modal for unused fields
• sync
• onblur update mockbin on header key or value blur if key has value
• smoke test
  • github action containerised services for redis and mockbin
  • use our infra
  • build fs adapter and run mockbin in the action with node
• move mock response tab into response pane
• maybe move url out of mock route and make it just a product of server id and env var
• maybe write response body to file
• create only one hidden request under mock route

future work

• spike transform OAS response objects to mock server
• aggregate logs per server somehow
• sync with mockbin at route patch time rather than seperately, handle errors differently
• sync story and nesting mocks inside desing/debug/test/mock thing
• extract the path from a url when extracting a mock from a response
• extract multiple mocks from collection/folder by paths and responses
• extract from HARs
• folders and drag and drop, ordering
• restrict mock body size in order to avoid breaking the database
• improve extract mock ux,
  • sync with mockbin after extraction
  • infer path from request url
  • block oversized and invalid content type
• use insomniaFetch with url override?
• auto add content type header?

design:

• should history be the default pane?
• mockbin api cannot specify a method, still show it for test button?
• does environment make sense to use for this?
• does cookie modal make sense here?

missteps

• made a new mock server object and try to show it on the project view, too difficult to play nice with the workspaceWithMetadata concept, easier to match design spec -> workspace relationship

Notes

attempting to wire up without pathing server to get a working pass before adding a dependency on a backend store for resolving routes to bins.
this begs a few questions; what if the backend is inconsistent with the ui what the user experience should be? what if the backend is inconsistent with the mockbin state.

Ideally all we will have access to the mockbin state store to avoid inconsistencies.

closes INS-3246

[CLAassistant]

All committers have signed the CLA.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[jackkav]

[filfreire]

🏎️🏎️

[gatzjames]

Remember to change this when the api is deployed

[gatzjames]

@todo: For next pass move this to database methods and perhaps put it on an action