first-class support for Url segment params in requester for #14 && ad…

…d 2nd runner as new icon based on votes from discussions/11
ArchGPT · Oct 7, 2023 · 4aa7e50 · 4aa7e50
1 parent dd427cb
commit 4aa7e50
Show file tree

Hide file tree

Showing 44 changed files with 320 additions and 68 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/insomnia/package.json b/packages/insomnia/package.json
@@ -74,6 +74,7 @@
     "jshint": "^2.13.6",
     "jsonlint-mod-fixed": "1.7.7",
     "jsonpath-plus": "^6.0.1",
+    "lodash": "^4.17.21",
     "marked": "^5.1.1",
     "mime-types": "^2.1.35",
     "mocha": "^10.2.0",

diff --git a/packages/insomnia/src/common/database.ts b/packages/insomnia/src/common/database.ts
@@ -1,5 +1,7 @@
 /* eslint-disable prefer-rest-params -- don't want to change ...arguments usage for these sensitive functions without more testing */
 import electron from 'electron';
+// to-do > "@seald-io/nedb": "^2.0.0",
+// import NeDB from '@seald-io/nedb';
 import NeDB from 'nedb';
 import fsPath from 'path';
 import { v4 as uuidv4 } from 'uuid';

diff --git a/packages/insomnia/src/common/import.ts b/packages/insomnia/src/common/import.ts
@@ -148,7 +148,6 @@ export async function scanResources({
 export const importPure = async (json: { resources: BaseModel[] } & any) => {
   const _resources = json.resources;
   // console.log("importPure", json);
-
   return await importResourcesToProject({ _resources });
 }
 

diff --git a/packages/insomnia/src/common/render.ts b/packages/insomnia/src/common/render.ts
@@ -395,7 +395,10 @@ export async function getRenderContext(
     },
     getEnvironmentId: () => environmentId,
     // It is possible for a project to not exist because this code path can be reached via Inso/insomnia-send-request which has no concept of a project.
-    getProjectId: () => project?._id,
+    getProjectId: () => {
+      console.log("getProjectId ??", project, ancestors, _ancestors)
+      return project?._id
+    }
   };
 
   // Generate the context we need to render
@@ -514,6 +517,10 @@ export async function getRenderedRequestAndContext(
 
   // Default the proto if it doesn't exist
   renderedRequest.url = setDefaultProtocol(renderedRequest.url);
+
+  // ARCHY NOTE: Recomposing the values here ?
+  console.log("renderedRequest", renderedRequest);
+
   return {
     context: renderContext,
     request: {
@@ -539,6 +546,7 @@ export async function getRenderedRequestAndContext(
       settingStoreCookies: renderedRequest.settingStoreCookies,
       settingRebuildPath: renderedRequest.settingRebuildPath,
       settingFollowRedirects: renderedRequest.settingFollowRedirects,
+      segmentParams: renderedRequest.segmentParams,
       type: renderedRequest.type,
       url: renderedRequest.url,
     },

diff --git a/packages/insomnia/src/icons/icon-small.png b/packages/insomnia/src/icons/icon-small.png
diff --git a/packages/insomnia/src/icons/icon.png b/packages/insomnia/src/icons/icon.png
diff --git a/packages/insomnia/src/main.development.ts b/packages/insomnia/src/main.development.ts
@@ -41,7 +41,7 @@ if (envDataPath) {
 } else {
   // Explicitly set userData folder from config because it's sketchy to rely on electron-builder to use productName, which could be changed by accident.
   const defaultPath = app.getPath('userData');
-  const newPath = path.join(defaultPath, '../', isDevelopment() ? 'insomnium-dev-desu' : userDataFolder);
+  const newPath = path.join(defaultPath, '../', isDevelopment() ? 'insomnium-dev-desu3' : userDataFolder);
   app.setPath('userData', newPath);
 }
 

diff --git a/packages/insomnia/src/models/helpers/request-operations.ts b/packages/insomnia/src/models/helpers/request-operations.ts
@@ -24,6 +24,8 @@ export function remove(request: Request | GrpcRequest | WebSocketRequest) {
 }
 
 export function update<T extends object>(request: T, patch: Partial<T> = {}): Promise<T> {
+  console.log('request-operations.ts update()', patch);
+
   // @ts-expect-error -- TSCONVERSION
   if (isGrpcRequest(request)) {
     // @ts-expect-error -- TSCONVERSION

diff --git a/packages/insomnia/src/models/request.ts b/packages/insomnia/src/models/request.ts
@@ -71,6 +71,14 @@ export interface RequestParameter {
   fileName?: string;
 }
 
+export interface RequestSegment {
+  name: string;
+  value: string;
+  disabled?: boolean;
+  id?: string;
+  fileName?: string;
+}
+
 export interface RequestBodyParameter {
   name: string;
   value: string;
@@ -107,6 +115,7 @@ export interface BaseRequest {
   settingEncodeUrl: boolean;
   settingRebuildPath: boolean;
   settingFollowRedirects: 'global' | 'on' | 'off';
+  segmentParams: RequestSegment[]
 }
 
 export type Request = BaseModel & BaseRequest;
@@ -142,6 +151,7 @@ export function init(): BaseRequest {
     settingEncodeUrl: true,
     settingRebuildPath: true,
     settingFollowRedirects: 'global',
+    segmentParams: [],
   };
 }
 

diff --git a/packages/insomnia/src/models/websocket-request.ts b/packages/insomnia/src/models/websocket-request.ts
@@ -1,6 +1,6 @@
 import { database } from '../common/database';
 import type { BaseModel } from '.';
-import { RequestAuthentication, RequestHeader, RequestParameter } from './request';
+import { RequestAuthentication, RequestHeader, RequestParameter, RequestSegment } from './request';
 
 export const name = 'WebSocket Request';
 
@@ -24,6 +24,7 @@ export interface BaseWebSocketRequest {
   settingStoreCookies: boolean;
   settingSendCookies: boolean;
   settingFollowRedirects: 'global' | 'on' | 'off';
+  segmentParams: RequestSegment[]
 }
 
 export type WebSocketRequest = BaseModel & BaseWebSocketRequest & { type: typeof type };
@@ -48,6 +49,7 @@ export const init = (): BaseWebSocketRequest => ({
   settingSendCookies: true,
   settingFollowRedirects: 'global',
   description: '',
+  segmentParams: []
 });
 
 export const migrate = (doc: WebSocketRequest) => doc;

diff --git a/packages/insomnia/src/network/network.ts b/packages/insomnia/src/network/network.ts
@@ -19,14 +19,15 @@ import type { HeaderResult, ResponsePatch, ResponseTimelineEntry } from '../main
 import * as models from '../models';
 import { CaCertificate } from '../models/ca-certificate';
 import { ClientCertificate } from '../models/client-certificate';
-import type { Request, RequestAuthentication, RequestParameter } from '../models/request';
+import type { Request, RequestAuthentication, RequestParameter, RequestSegment } from '../models/request';
 import type { Settings } from '../models/settings';
 import { isWorkspace } from '../models/workspace';
 import * as pluginContexts from '../plugins/context/index';
 import * as plugins from '../plugins/index';
 import { guard } from '../utils/guard';
 import { setDefaultProtocol } from '../utils/url/protocol';
 import {
+  addSegValuesToUrl,
   buildQueryStringFromParams,
   joinUrlAndQueryString,
   smartEncodeUrl,
@@ -96,7 +97,7 @@ export async function sendCurlAndWriteTimeline(
   const requestId = renderedRequest._id;
   const timeline: ResponseTimelineEntry[] = [];
 
-  const { finalUrl, socketPath } = transformUrl(renderedRequest.url, renderedRequest.parameters, renderedRequest.authentication, renderedRequest.settingEncodeUrl);
+  const { finalUrl, socketPath } = transformUrl(renderedRequest.url, renderedRequest.parameters, renderedRequest.segmentParams, renderedRequest.authentication, renderedRequest.settingEncodeUrl);
 
   timeline.push({ value: `Preparing request to ${finalUrl}`, name: 'Text', timestamp: Date.now() });
   timeline.push({ value: `Current time is ${new Date().toISOString()}`, name: 'Text', timestamp: Date.now() });
@@ -181,9 +182,10 @@ export const responseTransform = async (patch: ResponsePatch, environmentId: str
     context,
   );
 };
-export const transformUrl = (url: string, params: RequestParameter[], authentication: RequestAuthentication, shouldEncode: boolean) => {
+// ARCHY NOTE: HERE IS THE ACTUAL CALL
+export const transformUrl = (url: string, params: RequestParameter[], segs: RequestSegment[], authentication: RequestAuthentication, shouldEncode: boolean) => {
   const authQueryParam = getAuthQueryParams(authentication);
-  const customUrl = joinUrlAndQueryString(url, buildQueryStringFromParams(authQueryParam ? params.concat([authQueryParam]) : params));
+  const customUrl = addSegValuesToUrl(joinUrlAndQueryString(url, buildQueryStringFromParams(authQueryParam ? params.concat([authQueryParam]) : params)), segs);
   const isUnixSocket = customUrl.match(/https?:\/\/unix:\//);
   if (!isUnixSocket) {
     return { finalUrl: smartEncodeUrl(customUrl, shouldEncode) };
@@ -239,7 +241,12 @@ async function _applyRequestPluginHooks(
 ) {
   const newRenderedRequest = clone(renderedRequest);
 
+
+  console.log("[URL]", newRenderedRequest.url);
+  newRenderedRequest.url = newRenderedRequest.url.replace(":desu", "a")
+
   for (const { plugin, hook } of await plugins.getRequestHooks()) {
+
     const context = {
       ...(pluginContexts.app.init(RENDER_PURPOSE_NO_RENDER) as Record<string, any>),
       ...pluginContexts.data.init(renderedContext.getProjectId()),
@@ -249,6 +256,7 @@ async function _applyRequestPluginHooks(
     };
 
     try {
+      console.log("[plugin] applying ", plugin)
       await hook(context);
     } catch (err) {
       err.plugin = plugin;

diff --git a/packages/insomnia/src/plugins/context/__tests__/data.test.ts b/packages/insomnia/src/plugins/context/__tests__/data.test.ts
@@ -9,7 +9,7 @@ import * as models from '../../../models/index';
 import { DEFAULT_PROJECT_ID, Project } from '../../../models/project';
 import { WorkspaceScopeKeys } from '../../../models/workspace';
 import * as plugin from '../data';
-import * as init from '../init';
+import * as init from '../dataInit';
 
 jest.mock('../../../ui/components/modals');
 

diff --git a/packages/insomnia/src/plugins/context/data.ts b/packages/insomnia/src/plugins/context/data.ts
@@ -1,5 +1,6 @@
 import * as models from '../../models';
 import type { Workspace } from '../../models/workspace';
+import { init as dataInit } from './dataInit';
 
 export interface InsomniaExport {
   workspace?: Workspace;
@@ -20,3 +21,7 @@ export const getWorkspaces = (activeProjectId?: string) => {
   }
 };
 
+export const init = dataInit
+
+
+
diff --git a/...ages/insomnia/src/plugins/context/init.ts → .../insomnia/src/plugins/context/dataInit.ts b/...ages/insomnia/src/plugins/context/init.ts → .../insomnia/src/plugins/context/dataInit.ts
diff --git a/packages/insomnia/src/plugins/index.ts b/packages/insomnia/src/plugins/index.ts
@@ -323,6 +323,8 @@ export async function getRequestHooks(): Promise<RequestHook[]> {
       module: {},
     },
     hook: context => {
+      console.log('[header] HOOK Setting default headers');
+
       const headers = context.request.getEnvironmentVariable('DEFAULT_HEADERS');
       if (!headers) {
         return;

diff --git a/packages/insomnia/src/ui/components/codemirror/one-line-editor.tsx b/packages/insomnia/src/ui/components/codemirror/one-line-editor.tsx
@@ -25,6 +25,7 @@ export interface OneLineEditorProps {
   readOnly?: boolean;
   type?: string;
   onPaste?: (text: string) => void;
+  isInfered?: boolean
 }
 
 export interface OneLineEditorHandle {
@@ -38,6 +39,7 @@ export const OneLineEditor = forwardRef<OneLineEditorHandle, OneLineEditorProps>
   onChange,
   onKeyDown,
   placeholder,
+  isInfered,
   readOnly,
   type,
   onPaste,
@@ -199,6 +201,13 @@ export const OneLineEditor = forwardRef<OneLineEditorHandle, OneLineEditorProps>
     return () => codeMirror.current?.off('changes', fn);
   }, [onChange]);
 
+  useEffect(() => {
+
+    if (isInfered && codeMirror.current) {
+      codeMirror.current?.setValue(defaultValue)
+    }
+  }, [defaultValue, isInfered])
+
   useEffect(() => window.main.on('context-menu-command', (_, { key, tag }) =>
     id === key && codeMirror.current?.replaceSelection(tag)), [id]);
 

diff --git a/packages/insomnia/src/ui/components/dropdowns/auth-dropdown.tsx b/packages/insomnia/src/ui/components/dropdowns/auth-dropdown.tsx
@@ -9,7 +9,7 @@ import {
 import { RequestAuthentication } from '../../../models/request';
 import { SIGNATURE_METHOD_HMAC_SHA1 } from '../../../network/o-auth-1/constants';
 import { GRANT_TYPE_AUTHORIZATION_CODE } from '../../../network/o-auth-2/constants';
-import { useRequestPatcher } from '../../hooks/use-request';
+import { useRequestSetter } from '../../hooks/use-request';
 import { RequestLoaderData } from '../../routes/request';
 import { Dropdown, DropdownButton, DropdownItem, DropdownSection, ItemContent } from '../base/dropdown';
 import { showModal } from '../modals';
@@ -131,7 +131,7 @@ interface Props {
 export const AuthDropdown: FC<Props> = ({ authTypes = defaultTypes, disabled = false }) => {
   const { activeRequest } = useRouteLoaderData('request/:requestId') as RequestLoaderData;
   const { requestId } = useParams() as { organizationId: string; projectId: string; workspaceId: string; requestId: string };
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
   const onClick = useCallback(async (type: AuthType) => {
     if (!activeRequest || !('authentication' in activeRequest)) {
       return;

diff --git a/packages/insomnia/src/ui/components/dropdowns/content-type-dropdown.tsx b/packages/insomnia/src/ui/components/dropdowns/content-type-dropdown.tsx
@@ -19,7 +19,7 @@ import { Request, RequestBody, RequestHeader, RequestParameter } from '../../../
 import { deconstructQueryStringToParams } from '../../../utils/url/querystring';
 
 
-import { useRequestPatcher } from '../../hooks/use-request';
+import { useRequestSetter } from '../../hooks/use-request';
 import { RequestLoaderData } from '../../routes/request';
 import { Dropdown, DropdownButton, DropdownItem, DropdownSection, ItemContent } from '../base/dropdown';
 import { AlertModal } from '../modals/alert-modal';
@@ -29,7 +29,7 @@ const EMPTY_MIME_TYPE = null;
 
 export const ContentTypeDropdown: FC = () => {
   const { activeRequest } = useRouteLoaderData('request/:requestId') as RequestLoaderData;
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
   const { requestId } = useParams() as { requestId: string };
   const handleChangeMimeType = async (mimeType: string | null) => {
     const { body } = activeRequest;

diff --git a/packages/insomnia/src/ui/components/dropdowns/request-actions-dropdown.tsx b/packages/insomnia/src/ui/components/dropdowns/request-actions-dropdown.tsx
@@ -18,7 +18,7 @@ import { WebSocketRequest } from '../../../models/websocket-request';
 import type { RequestAction } from '../../../plugins';
 import { getRequestActions } from '../../../plugins';
 import * as pluginContexts from '../../../plugins/context/index';
-import { useRequestMetaPatcher, useRequestPatcher } from '../../hooks/use-request';
+import { useRequestMetaPatcher, useRequestSetter } from '../../hooks/use-request';
 import { RootLoaderData } from '../../routes/root';
 import { type DropdownProps } from '../base/dropdown';
 import { Icon } from '../icon';
@@ -45,7 +45,7 @@ export const RequestActionsDropdown = ({
     settings,
   } = useRouteLoaderData('root') as RootLoaderData;
   const patchRequestMeta = useRequestMetaPatcher();
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
   const { hotKeyRegistry } = settings;
   const [actionPlugins, setActionPlugins] = useState<RequestAction[]>([]);
   const [loadingActions, setLoadingActions] = useState<Record<string, boolean>>({});

diff --git a/packages/insomnia/src/ui/components/editors/auth/components/auth-input-row.tsx b/packages/insomnia/src/ui/components/editors/auth/components/auth-input-row.tsx
@@ -3,7 +3,7 @@ import { useRouteLoaderData } from 'react-router-dom';
 import { useToggle } from 'react-use';
 
 import { toKebabCase } from '../../../../../common/misc';
-import { useRequestPatcher } from '../../../../hooks/use-request';
+import { useRequestSetter } from '../../../../hooks/use-request';
 import { RequestLoaderData } from '../../../../routes/request';
 import { RootLoaderData } from '../../../../routes/root';
 import { OneLineEditor } from '../../../codemirror/one-line-editor';
@@ -23,7 +23,7 @@ export const AuthInputRow: FC<Props> = ({ label, getAutocompleteConstants, prope
   } = useRouteLoaderData('root') as RootLoaderData;
   const { showPasswords } = settings;
   const { activeRequest: { authentication, _id: requestId } } = useRouteLoaderData('request/:requestId') as RequestLoaderData;
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
   const [masked, toggleMask] = useToggle(true);
   const canBeMasked = !showPasswords && mask;
   const isMasked = canBeMasked && masked;

diff --git a/packages/insomnia/src/ui/components/editors/auth/components/auth-private-key-row.tsx b/packages/insomnia/src/ui/components/editors/auth/components/auth-private-key-row.tsx
@@ -3,7 +3,7 @@ import { useRouteLoaderData } from 'react-router-dom';
 
 import { toKebabCase } from '../../../../../common/misc';
 import { useNunjucks } from '../../../../context/nunjucks/use-nunjucks';
-import { useRequestPatcher } from '../../../../hooks/use-request';
+import { useRequestSetter } from '../../../../hooks/use-request';
 import { RequestLoaderData } from '../../../../routes/request';
 import { showModal } from '../../../modals';
 import { CodePromptModal } from '../../../modals/code-prompt-modal';
@@ -30,7 +30,7 @@ interface Props {
 
 export const AuthPrivateKeyRow: FC<Props> = ({ label, property, help }) => {
   const { activeRequest: { authentication, _id: requestId } } = useRouteLoaderData('request/:requestId') as RequestLoaderData;
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
   const { handleGetRenderContext, handleRender } = useNunjucks();
 
   const privateKey = authentication[property];

diff --git a/packages/insomnia/src/ui/components/editors/auth/components/auth-select-row.tsx b/packages/insomnia/src/ui/components/editors/auth/components/auth-select-row.tsx
@@ -2,7 +2,7 @@ import React, { ChangeEvent, FC, ReactNode, useCallback } from 'react';
 import { useRouteLoaderData } from 'react-router-dom';
 
 import { toKebabCase } from '../../../../../common/misc';
-import { useRequestPatcher } from '../../../../hooks/use-request';
+import { useRequestSetter } from '../../../../hooks/use-request';
 import { RequestLoaderData } from '../../../../routes/request';
 import { AuthRow } from './auth-row';
 
@@ -19,7 +19,7 @@ interface Props {
 
 export const AuthSelectRow: FC<Props> = ({ label, property, help, options, disabled }) => {
   const { activeRequest: { authentication, _id: requestId } } = useRouteLoaderData('request/:requestId') as RequestLoaderData;
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
 
   const selectedValue = authentication.hasOwnProperty(property) ? authentication[property] : options[0].value;
 

diff --git a/packages/insomnia/src/ui/components/editors/auth/components/auth-toggle-row.tsx b/packages/insomnia/src/ui/components/editors/auth/components/auth-toggle-row.tsx
@@ -2,7 +2,7 @@ import React, { FC, ReactNode, useCallback } from 'react';
 import { useRouteLoaderData } from 'react-router-dom';
 
 import { toKebabCase } from '../../../../../common/misc';
-import { useRequestPatcher } from '../../../../hooks/use-request';
+import { useRequestSetter } from '../../../../hooks/use-request';
 import { RequestLoaderData } from '../../../../routes/request';
 import { AuthRow } from './auth-row';
 
@@ -28,7 +28,7 @@ export const AuthToggleRow: FC<Props> = ({
   disabled = false,
 }) => {
   const { activeRequest: { authentication, _id: requestId } } = useRouteLoaderData('request/:requestId') as RequestLoaderData;
-  const patchRequest = useRequestPatcher();
+  const patchRequest = useRequestSetter();
 
   const databaseValue = Boolean(authentication[property]);
   const toggle = useCallback((value?: boolean) => patchRequest(requestId, { authentication: { ...authentication, [property]: value } }), [authentication, patchRequest, property, requestId]);