squash

jackkav · jackkav · commit 0f9bbfdba8d7 · 2025-08-27T16:39:36.000+02:00
diff --git a/packages/insomnia/scripts/build.ts b/packages/insomnia/scripts/build.ts
@@ -43,7 +43,7 @@ export const start = async () => {
   await copyFiles('../bin', buildFolder);
   await copyFiles('../src/static', path.join(buildFolder, 'static'));
   await copyFiles('../src/icons', buildFolder);
-  await copyFiles('../src/main/lint-process.mjs', path.join(buildFolder, 'main/lint-process.mjs'));
+  await copyFiles('../src/entry.utility.spectral.mjs', path.join(buildFolder, 'entry.utility.spectral.mjs'));
   await copyFiles('../src/hidden-window.html', path.join(buildFolder, 'hidden-window.html'));
 
   console.log('[build] Complete!');
diff --git a/packages/insomnia/src/common/render.ts b/packages/insomnia/src/common/render.ts
@@ -16,8 +16,8 @@ import type { SocketIORequest } from '../models/socket-io-request';
 import type { WebSocketRequest } from '../models/websocket-request';
 import { isWorkspace, type Workspace } from '../models/workspace';
 import { getOrInheritAuthentication, getOrInheritHeaders } from '../network/network';
-import * as templating from '../templating';
 import { RenderError } from '../templating/render-error';
+import { render as templateRendering } from '../templating/template-rendering';
 import type {
   BaseRenderContext,
   BaseRenderContextOptions,
@@ -230,7 +230,7 @@ export async function buildRenderContext({
   return finalRenderContext;
 }
 const renderInThisProcess = async (input: RenderInputType) => {
-  return templating.render(input.input, {
+  return templateRendering(input.input, {
     context: input.context,
     path: input.path,
     ignoreUndefinedEnvVariable: input.ignoreUndefinedEnvVariable,
@@ -300,7 +300,7 @@ export async function render<T>(
         const currentProcessIsRendererAndPluginsAreRestricted =
           process.type === 'renderer' && pluginsAreRestrictedToRunInWorker;
         const renderFork = currentProcessIsRendererAndPluginsAreRestricted
-          ? (await import('../ui/worker/templating-handler')).renderInWorker
+          ? (await import('../ui/worker/create-templating-worker')).renderInWorker
           : renderInThisProcess;
 
         // @ts-expect-error -- TSCONVERSION
@@ -442,7 +442,7 @@ export async function getRenderContext({
     }
   }
 
-  const inKey = templating.NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME;
+  const inKey = '_';
 
   if (rootGlobalEnvironment) {
     getKeySource(rootGlobalEnvironment.data || {}, inKey, 'rootGlobal');
@@ -580,7 +580,7 @@ export async function getRenderedRequestAndContext({
       o.query = o.query.replace(/#}/g, '# }');
       request.body.text = JSON.stringify(o);
     }
-  } catch (err) { }
+  } catch (err) {}
 
   // Render description separately because it's lower priority
   const description = request.description;
diff --git a/packages/insomnia/src/entry.utility.spectral.mjs b/packages/insomnia/src/entry.utility.spectral.mjs
@@ -1,5 +1,5 @@
 /* eslint-disable no-undef */
-console.log('[lint-process] Lint worker started');
+console.log('[utility] Spectral Lint worker started');
 import fs from 'node:fs';
 
 import Spectral from '@stoplight/spectral-core';
@@ -16,14 +16,14 @@ process.parentPort.on('message', async ({ data: { documentContent, rulesetPath }
     try {
       (await fs.promises.stat(rulesetPath)).isFile();
       hasValidCustomRuleset = true;
-    } catch {}
+    } catch { }
   }
   try {
     const spectral = new Spectral.Spectral();
     const { fetch } = spectralRuntime;
     const ruleset = hasValidCustomRuleset ? await bundleAndLoadRuleset(rulesetPath, { fs, fetch }) : oas;
     spectral.setRuleset(ruleset);
-    console.log('[lint-process] Ruleset loaded:', rulesetPath || 'default OAS ruleset');
+    console.log('[utility] Ruleset loaded:', rulesetPath || 'default OAS ruleset');
     const diagnostics = await spectral.run(documentContent);
     process.parentPort.postMessage({ diagnostics });
   } catch (err) {
diff --git a/packages/insomnia/src/main/ipc/main.ts b/packages/insomnia/src/main/ipc/main.ts
@@ -173,12 +173,12 @@ export function registerMainHandlers() {
         lintProcess.kill();
       }
 
-      lintProcess = utilityProcess.fork(path.join(__dirname, 'main/lint-process.mjs'));
+      lintProcess = utilityProcess.fork(path.join(__dirname, 'entry.utility.spectral.mjs'));
 
       let process: UtilityProcess | null = lintProcess!;
 
       process.on('exit', code => {
-        console.log('[lint-process] exited with code:', code);
+        console.log('[main] utilityProcess exited with code:', code);
         resolve({ cancelled: true });
       });
 
@@ -189,7 +189,7 @@ export function registerMainHandlers() {
       });
 
       process.on('error', err => {
-        console.error('[lint-process] error:', err);
+        console.error('[main] utilityProcess error:', err);
         reject({ error: err.toString() });
       });
 
diff --git a/packages/insomnia/src/templating/local-template-tags.ts b/packages/insomnia/src/templating/local-template-tags.ts
@@ -1,9 +1,10 @@
 import { format } from 'date-fns';
-import type { TemplateTag } from 'insomnia/src/plugins';
-import type { PluginTemplateTag } from 'insomnia/src/templating/types';
-import { invariant } from 'insomnia/src/utils/invariant';
 import { JSONPath } from 'jsonpath-plus';
 
+import type { TemplateTag } from '~/plugins';
+import type { PluginTemplateTag } from '~/templating/types';
+import { invariant } from '~/utils/invariant';
+
 import { fakerFunctions } from './faker-functions';
 const localTemplatePlugins: { templateTag: PluginTemplateTag }[] = [
   {
diff --git a/packages/insomnia/src/templating/nunjucks-extension.ts b/packages/insomnia/src/templating/nunjucks-extension.ts
@@ -14,13 +14,13 @@ import * as pluginApp from '../plugins/context/app';
 import * as pluginNetwork from '../plugins/context/network';
 import * as pluginStore from '../plugins/context/store';
 import type { Plugin } from '../plugins/index';
-import * as templating from './index';
+import { render as templateRendering } from './template-rendering';
 import type { BaseRenderContext, PluginTemplateTag, PluginTemplateTagContext } from './types';
 import { decodeEncoding } from './utils';
 
 const EMPTY_ARG = '__EMPTY_NUNJUCKS_ARG__';
 
-export default class BaseExtension {
+export class NunjucksExtension {
   _ext: PluginTemplateTag | null = null;
   _plugin: Plugin | null = null;
   tags: PluginTemplateTag['name'][] = [];
@@ -120,19 +120,21 @@ export default class BaseExtension {
           };
         },
         readFile: async (path: string, encoding = 'utf8') => {
-          const allowed = renderContext?.getSettings().dataFolders.some((folder: string) => folder !== '' && path.startsWith(folder));
+          const allowed = renderContext
+            ?.getSettings()
+            .dataFolders.some((folder: string) => folder !== '' && path.startsWith(folder));
           if (!allowed) {
             throw `Insomnia cannot access the file ‘${path}’. You can adjust this in Preferences → Security.`;
           }
-                    
+
           const content = await fs.promises.readFile(path);
           return encoding === 'utf8' ? content.toString(encoding) : content;
         },
         decode: async (buffer: Buffer, encoding = 'utf8') => iconv.decode(buffer, encoding),
         encode: async (input: string, encoding: BinaryToTextEncoding) =>
           crypto.createHash('md5').update(input).digest(encoding),
         render: (str: string) =>
-          templating.render(str, {
+          templateRendering(str, {
             context: renderContext,
           }),
         openInBrowser: (url: string) => window.main.openInBrowser(url),
diff --git a/packages/insomnia/src/templating/template-rendering.ts b/packages/insomnia/src/templating/template-rendering.ts
@@ -1,15 +1,15 @@
-import { localTemplateTags } from 'insomnia/src/templating/local-template-tags';
 import type { Environment } from 'nunjucks';
 
-import BaseExtension from './base-extension';
+import { localTemplateTags } from '~/templating/local-template-tags';
+
 import { nunjucks } from './nunjucks.client';
+import { NunjucksExtension } from './nunjucks-extension';
 import { extractUndefinedVariableKey, RenderError } from './render-error';
 
 // Some constants
 export const RENDER_ALL = 'all';
 export const RENDER_VARS = 'variables';
 export const RENDER_TAGS = 'tags';
-export const NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME = '_';
 
 type NunjucksEnvironment = Environment & {
   extensions: Record<string, any>;
@@ -47,7 +47,7 @@ export function render(
   // context needs to exist on the root for the old templating syntax, and in _ for the new templating syntax
   // old: {{ arr[0].prop }}
   // new: {{ _['arr-name-with-dash'][0].prop }}
-  const templatingContext = { ...context, [NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME]: context };
+  const templatingContext = { ...context, ['_']: context };
   const path = config.path || null;
   const renderMode = config.renderMode || RENDER_ALL;
   return new Promise<string | null>(async (resolve, reject) => {
@@ -186,7 +186,7 @@ async function getNunjucks(renderMode: string, ignoreUndefinedEnvVariable?: bool
   for (const extension of allExtensions) {
     const { templateTag, plugin } = extension;
     templateTag.priority = templateTag.priority || allExtensions.indexOf(extension);
-    const instance = new BaseExtension(templateTag, plugin);
+    const instance = new NunjucksExtension(templateTag, plugin);
     nunjucksEnvironment.addExtension(instance.getTag() || '', instance);
     // Hidden helper filter to debug complicated things
     // eg. `{{ foo | urlencode | debug | upper }}`
diff --git a/packages/insomnia/src/ui/components/.client/codemirror/code-editor.tsx b/packages/insomnia/src/ui/components/.client/codemirror/code-editor.tsx
@@ -21,7 +21,7 @@ import * as misc from '~/common/misc';
 import type { KeyCombination } from '~/common/settings';
 import { getTemplateTags } from '~/plugins';
 import { useRootLoaderData } from '~/root';
-import { getTagDefinitions } from '~/templating/index';
+import { getTagDefinitions } from '~/templating/template-rendering';
 import { type NunjucksParsedTag, type nunjucksTagContextMenuOptions } from '~/templating/types';
 import { extractNunjucksTagFromCoords } from '~/templating/utils';
 import { Icon } from '~/ui/components/icon';
diff --git a/packages/insomnia/src/ui/components/.client/codemirror/extensions/nunjucks-tags.ts b/packages/insomnia/src/ui/components/.client/codemirror/extensions/nunjucks-tags.ts
@@ -1,7 +1,7 @@
 import CodeMirror, { type Token } from 'codemirror';
 
 import * as misc from '~/common/misc';
-import { getTagDefinitions } from '~/templating/index';
+import { getTagDefinitions } from '~/templating/template-rendering';
 import type { HandleRender, RenderContextAndKeys } from '~/templating/types';
 import { tokenizeTag } from '~/templating/utils';
 import { showModal } from '~/ui/components/modals/index';
diff --git a/packages/insomnia/src/ui/components/.client/codemirror/lint/json-lint.ts b/packages/insomnia/src/ui/components/.client/codemirror/lint/json-lint.ts
@@ -8,7 +8,7 @@ import 'codemirror/addon/lint/json-lint';
 import CodeMirror from 'codemirror';
 import * as jsonlint from 'jsonlint-mod-fixed';
 
-import { render } from '~/templating/index';
+import { render } from '~/templating/template-rendering';
 CodeMirror.registerHelper('lint', 'json', validator);
 
 interface ValidationError {
diff --git a/packages/insomnia/src/ui/components/.client/codemirror/one-line-editor.tsx b/packages/insomnia/src/ui/components/.client/codemirror/one-line-editor.tsx
@@ -11,7 +11,7 @@ import * as misc from '~/common/misc';
 import type { KeyCombination } from '~/common/settings';
 import { getTemplateTags } from '~/plugins';
 import { useRootLoaderData } from '~/root';
-import { getTagDefinitions } from '~/templating/index';
+import { getTagDefinitions } from '~/templating/template-rendering';
 import { type NunjucksParsedTag, type nunjucksTagContextMenuOptions } from '~/templating/types';
 import { extractNunjucksTagFromCoords } from '~/templating/utils';
 import { showModal } from '~/ui/components/modals';
diff --git a/packages/insomnia/src/ui/components/editors/__tests__/environment-editor.test.ts b/packages/insomnia/src/ui/components/editors/__tests__/environment-editor.test.ts
@@ -1,7 +1,6 @@
 // @vitest-environment jsdom
 import { describe, expect, it } from 'vitest';
 
-import { NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME } from '../../../../templating';
 import { checkNestedKeys, ensureKeyIsValid } from '../environment-utils';
 
 describe('ensureKeyIsValid()', () => {
@@ -21,28 +20,11 @@ describe('ensureKeyIsValid()', () => {
     expect(ensureKeyIsValid(key, true)).toBe(`"${key}" is a reserved key`);
   });
 
-  it.each([
-    '_',
-    'a',
-    'ab',
-    'a$',
-    'a$b',
-    'a-b',
-    `a${NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME}b`,
-    `${NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME}ab`,
-  ])('"%s" should be valid as a nested key', key => {
+  it.each(['_', 'a', 'ab', 'a$', 'a$b', 'a-b', `a_b`, `_ab`])('"%s" should be valid as a nested key', key => {
     expect(ensureKeyIsValid(key, false)).toBe(null);
   });
 
-  it.each([
-    'a',
-    'ab',
-    'a$',
-    'a$b',
-    'a-b',
-    `a${NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME}b`,
-    `${NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME}ab`,
-  ])('"%s" should be valid as a root value', key => {
+  it.each(['a', 'ab', 'a$', 'a$b', 'a-b', `a_b`, `_ab`])('"%s" should be valid as a root value', key => {
     expect(ensureKeyIsValid(key, true)).toBe(null);
   });
 });
diff --git a/packages/insomnia/src/ui/components/editors/environment-utils.tsx b/packages/insomnia/src/ui/components/editors/environment-utils.tsx
@@ -6,7 +6,6 @@ import {
   vaultEnvironmentPath,
   vaultEnvironmentRuntimePath,
 } from '../../../models/environment';
-import { NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME } from '../../../templating';
 import { showModal } from '../modals';
 import { AlertModal } from '../modals/alert-modal';
 import { AskModal } from '../modals/ask-modal';
@@ -20,8 +19,8 @@ export const ensureKeyIsValid = (key: string, isRoot: boolean): string | null =>
     return `"${key}" cannot begin with '$' or contain a '.'`;
   }
 
-  if (key === NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME && isRoot) {
-    return `"${NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME}" is a reserved key`;
+  if (key === '_' && isRoot) {
+    return `"_" is a reserved key`;
   }
 
   if (key === vaultEnvironmentPath && isRoot) {
diff --git a/packages/insomnia/src/ui/components/settings/plugins.tsx b/packages/insomnia/src/ui/components/settings/plugins.tsx
@@ -19,7 +19,7 @@ import { ACCEPTED_NODE_CA_FILE_EXTS, NPM_PACKAGE_BASE, PLUGIN_HUB_BASE } from '.
 import { docsPlugins } from '../../../common/documentation';
 import type { Plugin } from '../../../plugins/index';
 import { getPlugins } from '../../../plugins/index';
-import { reload } from '../../../templating/index';
+import { reload } from '../../../templating/template-rendering';
 import { validatePluginName } from '../../../utils/plugin';
 import { useSettingsPatcher } from '../../hooks/use-request';
 import { CopyButton } from '../base/copy-button';
diff --git a/packages/insomnia/src/ui/components/templating/tag-editor.tsx b/packages/insomnia/src/ui/components/templating/tag-editor.tsx
@@ -17,7 +17,7 @@ import { isRequestGroup, type RequestGroup } from '../../../models/request-group
 import type { Workspace } from '../../../models/workspace';
 import * as plugins from '../../../plugins';
 import * as pluginStore from '../../../plugins/context/store';
-import * as templating from '../../../templating';
+import * as templating from '../../../templating/template-rendering';
 import type { NunjucksParsedTag, NunjucksParsedTagArg } from '../../../templating/types';
 import { sanitizeStrForWin32 } from '../../../templating/utils';
 import * as templateUtils from '../../../templating/utils';
diff --git a/packages/insomnia/src/ui/components/templating/variable-editor.tsx b/packages/insomnia/src/ui/components/templating/variable-editor.tsx
@@ -1,7 +1,6 @@
 import React, { type FC, useEffect, useMemo, useState } from 'react';
 
 import { vaultEnvironmentMaskValue, vaultEnvironmentRuntimePath } from '../../../models/environment';
-import { NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME } from '../../../templating';
 import type { RenderPurpose } from '../../../templating/types';
 import { useNunjucks } from '../../context/nunjucks/use-nunjucks';
 
@@ -23,11 +22,7 @@ export const VariableEditor: FC<Props> = ({ onChange, defaultValue }) => {
   const [error, setError] = useState('');
   const isVaultVariable =
     selected &&
-    selected
-      .replace('{{', '')
-      .replace('}}', '')
-      .trim()
-      .startsWith(`${NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME}.${vaultEnvironmentRuntimePath}`) &&
+    selected.replace('{{', '').replace('}}', '').trim().startsWith(`_.${vaultEnvironmentRuntimePath}`) &&
     preview === vaultEnvironmentMaskValue;
 
   useEffect(() => {
diff --git a/packages/insomnia/src/ui/context/nunjucks/use-nunjucks.ts b/packages/insomnia/src/ui/context/nunjucks/use-nunjucks.ts
@@ -4,7 +4,6 @@ import { getRenderContext, getRenderContextAncestors, render } from '~/common/re
 import { useWorkspaceLoaderData } from '~/routes/organization.$organizationId.project.$projectId.workspace.$workspaceId';
 import { useRequestLoaderData } from '~/routes/organization.$organizationId.project.$projectId.workspace.$workspaceId.debug.request.$requestId';
 import { useRequestGroupLoaderData } from '~/routes/organization.$organizationId.project.$projectId.workspace.$workspaceId.debug.request-group.$requestGroupId';
-import { NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME } from '~/templating';
 import type { HandleRender, RenderContextOptions } from '~/templating/types';
 import { getKeys } from '~/templating/utils';
 
@@ -53,7 +52,7 @@ export const useNunjucks = (options?: UseNunjucksOptions) => {
         contextCacheKey && getRenderContextPromiseCache[contextCacheKey]
           ? await getRenderContextPromiseCache[contextCacheKey]
           : await fetchRenderContext();
-      const keys = getKeys(context, NUNJUCKS_TEMPLATE_GLOBAL_PROPERTY_NAME);
+      const keys = getKeys(context, '_');
       return { context, keys };
     },
     [fetchRenderContext],
diff --git a/packages/insomnia/src/ui/rendererListeners.ts b/packages/insomnia/src/ui/rendererListeners.ts
@@ -3,7 +3,7 @@ import { database } from '../common/database';
 import * as models from '../models';
 import * as plugins from '../plugins';
 import * as themes from '../plugins/misc';
-import * as templating from '../templating';
+import * as templating from '../templating/template-rendering';
 import { showModal } from './components/modals';
 import { AskModal } from './components/modals/ask-modal';
 import { SelectModal } from './components/modals/select-modal';
diff --git a/packages/insomnia/src/ui/worker/create-templating-worker.ts b/packages/insomnia/src/ui/worker/create-templating-worker.ts
@@ -1,9 +1,9 @@
-import { extractUndefinedVariableKey, RenderError } from '../../templating/render-error';
-import type { RenderInputType } from '../../templating/types';
+import { extractUndefinedVariableKey, RenderError } from '~/templating/render-error';
+import type { RenderInputType } from '~/templating/types';
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- see below
 // @ts-ignore -- inso transpiles to commonjs so doesn't play nice with this
-const worker = new Worker(new URL('templating-worker.ts', import.meta.url), { type: 'module' });
+const worker = new Worker(new URL('entry.worker.templating.ts', import.meta.url), { type: 'module' });
 
 // Triggered by a mistake in the work initialization code above
 worker.addEventListener('error', event => {
diff --git a/packages/insomnia/src/ui/worker/entry.worker.templating.ts b/packages/insomnia/src/ui/worker/entry.worker.templating.ts
@@ -1,12 +1,12 @@
-import * as templating from '../../templating/worker';
+import { render } from './template-rendering';
 
 async function performJob(input: {
   input: string;
   context: Record<string, any>;
   path: string;
   ignoreUndefinedEnvVariable: boolean;
 }) {
-  return templating.render(input.input, {
+  return render(input.input, {
     context: input.context,
     path: input.path,
     ignoreUndefinedEnvVariable: input.ignoreUndefinedEnvVariable,
diff --git a/packages/insomnia/src/ui/worker/nunjucks-extension.ts b/packages/insomnia/src/ui/worker/nunjucks-extension.ts
diff --git a/packages/insomnia/src/ui/worker/template-rendering.ts b/packages/insomnia/src/ui/worker/template-rendering.ts
