feat: adds refresh ruleset logic to invalidate stale data

Author: fiosman

packages/insomnia/src/entry.preload.ts

@@ -282,6 +282,7 @@ const main: Window['main'] = {
   cancelCurlRequest: options => ipcRenderer.send('cancelCurlRequest', options),
   writeFile: options => invokeWithNormalizedError('writeFile', options),
   deleteCompiledRuleset: options => invokeWithNormalizedError('deleteCompiledRuleset', options),
+  refreshCompiledRuleset: options => invokeWithNormalizedError('refreshCompiledRuleset', options),
   writeResponseBodyToFile: options => invokeWithNormalizedError('writeResponseBodyToFile', options),
   getAuthHeader: (renderedRequest: RenderedRequest, url: string): Promise<RequestHeader | undefined> =>
     invokeWithNormalizedError('getAuthHeader', renderedRequest, url),

packages/insomnia/src/main/ipc/electron.ts

@@ -170,6 +170,7 @@ export type HandleChannels =
   | 'timeline.getPath'
   | 'writeFile'
   | 'deleteCompiledRuleset'
+  | 'refreshCompiledRuleset'
   | 'writeResponseBodyToFile'
   | 'vault.encryptSecretValue'
   | 'vault.decryptSecretValue';

packages/insomnia/src/main/ipc/main.ts

@@ -29,7 +29,7 @@ import { convert } from '~/main/importers/convert';
 import { getCurrentConfig, type LLMConfigServiceAPI } from '~/main/llm-config-service';
 import { multipartBufferToArray, type Part } from '~/main/multipart-buffer-to-array';
 import { insecureReadFile, insecureReadFileWithEncoding, isPathAllowed, secureReadFile } from '~/main/secure-read-file';
-import { deleteCompiledRuleset, writeCompiledRuleset } from '~/main/spectral-ruleset-cache';
+import { deleteCompiledRuleset, invalidateCompiledRulesetCache, writeCompiledRuleset } from '~/main/spectral-ruleset-cache';
 import type {
   GenerateCommitsFromDiffFunction,
   GenerateMcpSamplingResponseFunction,
@@ -190,6 +190,7 @@ export interface RendererToMainBridgeAPI {
   multipartBufferToArray: (options: { bodyBuffer: Buffer; contentType: string }) => Promise<Part[]>;
   writeFile: (options: { path: string; content: string | Buffer }) => Promise<string>;
   deleteCompiledRuleset: (options: { projectId: string }) => Promise<void>;
+  refreshCompiledRuleset: (options: { projectId: string; rulesetContent: string }) => Promise<{ compiledPath: string }>;
   writeResponseBodyToFile: (options: {
     sourcePath: string;
     destinationPath: string;
@@ -386,6 +387,10 @@ export function registerMainHandlers() {
   ipcMainHandle('deleteCompiledRuleset', async (_, options: { projectId: string }) => {
     await deleteCompiledRuleset(options.projectId);
   });
+  ipcMainHandle('refreshCompiledRuleset', async (_, options: { projectId: string; rulesetContent: string }) => {
+    invalidateCompiledRulesetCache(options.projectId);
+    return writeCompiledRuleset(options.projectId, options.rulesetContent);
+  });
   ipcMainHandle('writeResponseBodyToFile', writeResponseBodyToFile);
   ipcMainHandle('getAuthHeader', (_, renderedRequest: RenderedRequest, url: string) => {
     return getAuthHeaderInMain(renderedRequest, url);

packages/insomnia/src/main/spectral-ruleset-cache.ts

@@ -46,6 +46,12 @@ export async function writeCompiledRuleset(
   return { compiledPath };
 }
 
+// Clears the in-memory hash cache for a project without touching the disk.
+// Forces the next writeCompiledRuleset call to recompile.
+export function invalidateCompiledRulesetCache(projectId: string): void {
+  lastWrittenHash.delete(projectId);
+}
+
 // Deletes the compiled ruleset file for a project and clears the in-memory hash cache,
 // so the next writeCompiledRuleset call always recompiles from scratch.
 export async function deleteCompiledRuleset(projectId: string): Promise<void> {

packages/insomnia/src/routes/organization.$organizationId.project.$projectId.refresh-ruleset.tsx

@@ -0,0 +1,32 @@
+import { services } from 'insomnia-data';
+import { href } from 'react-router';
+
+import { invariant } from '~/utils/invariant';
+import { createFetcherSubmitHook } from '~/utils/router';
+
+import type { Route } from './+types/organization.$organizationId.project.$projectId.refresh-ruleset';
+
+export async function clientAction({ params }: Route.ClientActionArgs) {
+  const { projectId } = params;
+
+  const project = await services.project.get(projectId);
+  invariant(project, 'Project not found');
+
+  // Touch the record so `modified` reflects when the ruleset was last recompiled.
+  await services.projectLintRuleset.upsert(projectId, {});
+
+  return null;
+}
+
+export const useRefreshProjectRulesetActionFetcher = createFetcherSubmitHook(
+  submit =>
+    ({ organizationId, projectId }: { organizationId: string; projectId: string }) => {
+      return submit(null, {
+        action: href('/organization/:organizationId/project/:projectId/refresh-ruleset', {
+          organizationId,
+          projectId,
+        }),
+        method: 'POST',
+      });
+    },
+);

packages/insomnia/src/routes/organization.$organizationId.project.$projectId.workspace.$workspaceId.spec.tsx

@@ -33,6 +33,7 @@ import { debounce } from '~/common/misc';
 import { selectFileOrFolder } from '~/common/select-file-or-folder';
 import { useRootLoaderData } from '~/root';
 import { useDeleteProjectRulesetActionFetcher } from '~/routes/organization.$organizationId.project.$projectId.delete-ruleset';
+import { useRefreshProjectRulesetActionFetcher } from '~/routes/organization.$organizationId.project.$projectId.refresh-ruleset';
 import { useUpdateProjectRulesetActionFetcher } from '~/routes/organization.$organizationId.project.$projectId.update-ruleset';
 import {
   useWorkspaceLoaderData,
@@ -101,6 +102,7 @@ export async function clientLoader({ params }: Route.ClientLoaderArgs) {
   // For git, the RepoFileWatcher keeps .spectral.yaml in sync with this record.
   const projectLintRuleset = await services.projectLintRuleset.getByParentId(projectId);
   const rulesetContent = projectLintRuleset?.rulesetContent || '';
+  const rulesetLastCompiledAt = projectLintRuleset?.modified ?? null;
 
   let parsedSpec: OpenAPIV3.Document | undefined;
 
@@ -114,6 +116,7 @@ export async function clientLoader({ params }: Route.ClientLoaderArgs) {
     isConnectedGitProject,
     parsedSpec,
     rulesetContent,
+    rulesetLastCompiledAt,
   };
 }
 
@@ -192,7 +195,7 @@ const Component = ({ params }: Route.ComponentProps) => {
 
   const { isGenerateMockServersWithAIEnabled } = useAIFeatureStatus();
 
-  const { apiSpec, gitSyncRulesetPath, isConnectedGitProject, parsedSpec, rulesetContent } =
+  const { apiSpec, gitSyncRulesetPath, isConnectedGitProject, parsedSpec, rulesetContent, rulesetLastCompiledAt } =
     useLoaderData<typeof clientLoader>();
 
   const [lintMessages, setLintMessages] = useState<LintMessage[]>([]);
@@ -201,6 +204,8 @@ const Component = ({ params }: Route.ComponentProps) => {
   const { submit: updateApiSpec } = useSpecUpdateActionFetcher();
   const { submit: updateProjectRuleset } = useUpdateProjectRulesetActionFetcher();
   const { submit: deleteProjectRuleset } = useDeleteProjectRulesetActionFetcher();
+  const { submit: refreshProjectRuleset } = useRefreshProjectRulesetActionFetcher();
+  const [isRefreshing, setIsRefreshing] = useState(false);
   const generateRequestCollectionFetcher = useSpecGenerateRequestCollectionActionFetcher();
   const gitVersion = useGitVCSVersion();
   const [isLintPaneOpen, setIsLintPaneOpen] = useState(false);
@@ -454,6 +459,25 @@ const Component = ({ params }: Route.ComponentProps) => {
     setSelectedRulesetPath(gitSyncRulesetPath || rulesetWritePath);
   };
 
+  const handleRefreshRuleset = async () => {
+    if (!rulesetContent) {
+      return;
+    }
+    setIsRefreshing(true);
+    try {
+      await window.main.refreshCompiledRuleset({ projectId, rulesetContent });
+      refreshProjectRuleset({ organizationId, projectId });
+      editor.current?.tryToSetOption('lint', { ...lintOptions });
+    } catch (err) {
+      showError({
+        title: 'Refresh Failed',
+        message: `Failed to refresh ruleset: ${err instanceof Error ? err.message : String(err)}`,
+      });
+    } finally {
+      setIsRefreshing(false);
+    }
+  };
+
   const handleUnselectSpectralFile = async () => {
     showModal(AskModal, {
       title: 'Remove Ruleset File',
@@ -1111,22 +1135,49 @@ const Component = ({ params }: Route.ComponentProps) => {
                             )}
                           </span>
                           {selectedRulesetPath ? (
-                            <TooltipTrigger delay={0}>
-                              <Button
-                                aria-label="Remove custom ruleset"
-                                onPress={handleUnselectSpectralFile}
-                                className="flex aspect-square h-6 shrink-0 items-center justify-center rounded-xs text-sm text-(--color-font) ring-1 ring-transparent transition-all hover:bg-(--hl-xs) focus:ring-(--hl-md) focus:ring-inset aria-pressed:bg-(--hl-sm)"
-                              >
-                                <Icon icon="xmark" />
-                              </Button>
-                              <Tooltip
-                                placement="top end"
-                                offset={8}
-                                className="max-h-[85vh] max-w-xs overflow-y-auto rounded-md border border-solid border-(--hl-sm) bg-(--color-bg) px-4 py-2 text-sm text-(--color-font) shadow-lg select-none focus:outline-hidden"
-                              >
-                                <p>Clear custom ruleset and use default OAS ruleset</p>
-                              </Tooltip>
-                            </TooltipTrigger>
+                            <>
+                              <TooltipTrigger delay={0}>
+                                <Button
+                                  aria-label="Refresh ruleset from remote sources"
+                                  isDisabled={isRefreshing}
+                                  onPress={handleRefreshRuleset}
+                                  className="flex aspect-square h-6 shrink-0 items-center justify-center rounded-xs text-sm text-(--color-font) ring-1 ring-transparent transition-all hover:bg-(--hl-xs) focus:ring-(--hl-md) focus:ring-inset disabled:opacity-50 aria-pressed:bg-(--hl-sm)"
+                                >
+                                  <Icon
+                                    icon={isRefreshing ? 'spinner' : 'rotate'}
+                                    className={isRefreshing ? 'animate-spin' : ''}
+                                  />
+                                </Button>
+                                <Tooltip
+                                  placement="top end"
+                                  offset={8}
+                                  className="max-h-[85vh] max-w-xs overflow-y-auto rounded-md border border-solid border-(--hl-sm) bg-(--color-bg) px-4 py-2 text-sm text-(--color-font) shadow-lg select-none focus:outline-hidden"
+                                >
+                                  <p>Recompile ruleset, including re-fetching any referenced remote entries.</p>
+                                  {rulesetLastCompiledAt && (
+                                    <p className="mt-1">
+                                      {`Last updated ${new Date(rulesetLastCompiledAt).toLocaleString()}`}.
+                                    </p>
+                                  )}
+                                </Tooltip>
+                              </TooltipTrigger>
+                              <TooltipTrigger delay={0}>
+                                <Button
+                                  aria-label="Remove custom ruleset"
+                                  onPress={handleUnselectSpectralFile}
+                                  className="flex aspect-square h-6 shrink-0 items-center justify-center rounded-xs text-sm text-(--color-font) ring-1 ring-transparent transition-all hover:bg-(--hl-xs) focus:ring-(--hl-md) focus:ring-inset aria-pressed:bg-(--hl-sm)"
+                                >
+                                  <Icon icon="xmark" />
+                                </Button>
+                                <Tooltip
+                                  placement="top end"
+                                  offset={8}
+                                  className="max-h-[85vh] max-w-xs overflow-y-auto rounded-md border border-solid border-(--hl-sm) bg-(--color-bg) px-4 py-2 text-sm text-(--color-font) shadow-lg select-none focus:outline-hidden"
+                                >
+                                  <p>Clear custom ruleset and use default OAS ruleset</p>
+                                </Tooltip>
+                              </TooltipTrigger>
+                            </>
                           ) : (
                             <Button
                               aria-label="Upload custom ruleset"