From 5e8efcc14fb344ff2ff59c7a8a86ddff000a9999 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Sun, 30 Mar 2025 01:03:53 +0100 Subject: [PATCH 01/13] Modify types and create new default values for storage rules --- .../insomnia/src/ui/routes/organization.tsx | 740 +++++++++--------- 1 file changed, 374 insertions(+), 366 deletions(-) diff --git a/packages/insomnia/src/ui/routes/organization.tsx b/packages/insomnia/src/ui/routes/organization.tsx index 629d1d0fef1..01f0427a83c 100644 --- a/packages/insomnia/src/ui/routes/organization.tsx +++ b/packages/insomnia/src/ui/routes/organization.tsx @@ -314,11 +314,11 @@ export const loader: LoaderFunction = async () => { currentPlan, }; } - return { - organizations: [], - user: undefined, - currentPlan: undefined, - }; + return { + organizations: [], + user: undefined, + currentPlan: undefined, + }; }; @@ -340,14 +340,17 @@ export interface Billing { accessDenied: boolean; } -export enum ORG_STORAGE_RULE { - CLOUD_PLUS_LOCAL = 'cloud_plus_local', - CLOUD_ONLY = 'cloud_only', - LOCAL_ONLY = 'local_only', -} +export const DEFAULT_STORAGE_RULES = { + enableCloudSync: true, + enableLocalVault: true, + enableGitSync: true, + isOverridden: false, +}; -export interface StorageRule { - storage: ORG_STORAGE_RULE; +export interface StorageRules { + enableCloudSync: boolean; + enableLocalVault: boolean; + enableGitSync: boolean; isOverridden: boolean; } @@ -356,11 +359,11 @@ export interface OrganizationFeatureLoaderData { billingPromise: Promise; } export interface OrganizationStorageLoaderData { - storagePromise: Promise; + storagePromise: Promise; } // Create an in-memory storage to store the storage rules -export const inMemoryStorageRuleCache: Map = new Map(); +export const inMemoryStorageRuleCache: Map = new Map(); export const organizationStorageLoader: LoaderFunction = async ({ params }): Promise => { const { organizationId } = params as { organizationId: string }; @@ -377,23 +380,28 @@ export const syncOrganizationStorageRuleAction: ActionFunction = async ({ params export async function fetchAndCacheOrganizationStorageRule( organizationId: string | undefined, - forceFetch = false, -): Promise { + forceFetch: boolean = false, +): Promise { invariant(organizationId, 'Organization ID is required'); if (isScratchpadOrganizationId(organizationId)) { - return ORG_STORAGE_RULE.LOCAL_ONLY; + return { + enableCloudSync: false, + enableLocalVault: true, + enableGitSync: false, + isOverridden: false, + }; } if (!forceFetch) { - const storageRule = inMemoryStorageRuleCache.get(organizationId); - if (storageRule) { - return storageRule.storage; + const storageRules = inMemoryStorageRuleCache.get(organizationId); + if (storageRules) { + return storageRules; } } const { id: sessionId } = await userSession.getOrCreate(); // Otherwise fetch from the API - return await insomniaFetch({ + return await insomniaFetch({ method: 'GET', path: `/v1/organizations/${organizationId}/storage-rule`, sessionId, @@ -403,11 +411,11 @@ export async function fetchAndCacheOrganizationStorageRule( if (res) { inMemoryStorageRuleCache.set(organizationId, res); } - return res?.storage || ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL; + return res || DEFAULT_STORAGE_RULES; }, err => { console.log('[storageRule] Failed to load storage rules', err.message); - return ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL; + return DEFAULT_STORAGE_RULES; } ); } @@ -647,107 +655,107 @@ const OrganizationRoute = () => { return ( -
-
+
+
{!isMinimal &&
-
-
- +
+
+
- {!user ? : null} + {!user ? : null}
-
- {user ? ( - - - - - - ) : ( - - - Login - - +
+ {user ? ( + + + + + + ) : ( + + + Login + + Sign up for free - - - )} -
-
} - {isScratchPadBannerVisible ? ( -
-
-
- -
+ + + )}
-
-

- Welcome to the Scratch Pad where you can work locally with up to 1 collection. - To create more and see your projects - {' '} - - login or create an account → - -

+ } + {isScratchPadBannerVisible ? ( +
+
+
+ +
+
+
+

+ Welcome to the Scratch Pad where you can work locally with up to 1 collection. + To create more and see your projects + {' '} + + login or create an account → + +

+
+
- -
- ) : null} - {isOrganizationSidebarOpen &&
- -
} -
+ + + Join an organization + + + + Create a new organization + + + + + +
} +
-
-
-
- - - {({ isSelected }) => { - return ( - - {isSelected ? ( - - ) : ( - - )} - - ); - }} - - - Toggle organizations sidebar - - - - { - setIsMinimal(!flag); - }} - isSelected={!isMinimal} - > - {({ isSelected }) => { - return ( - - {isSelected ? ( - - ) : ( - - )} - - ); - }} - - - Toggle header - -
-
-
+
+
- + {({ isSelected }) => { + return ( + + {isSelected ? ( + + ) : ( + + )} + + ); + }} + - Preferences - + Toggle organizations sidebar - {(hasUntrackedData && !isMinimal) ?
- -
: null} - {(hasUntrackedData && isMinimal) ? ( - + {({ isSelected }) => { + return ( + + {isSelected ? ( + + ) : ( + + )} + + ); + }} + + + Toggle header + + +
+
+
+ - We have detected orphaned projects on your computer, click here to view them. + Preferences + - ) : null} - {isMinimal && } -
-
- {isMinimal && ( - - )} -
-
-
- {loadingAI && ( - + - - Generating tests with Insomnia AI - - - )} - - )} - {!isMinimal && } - {!isMinimal && ( - - We have detected orphaned projects on your computer, click here to view them. + +
: null} + {(hasUntrackedData && isMinimal) ? ( + + + + We have detected orphaned projects on your computer, click here to view them. + + + ) : null} + {isMinimal && } +
+
+ {isMinimal && ( + )}
- {isMinimal && ( -
- {user ? ( - - - - - - ) : ( - - - Login - - +
+ {loadingAI && ( + + {({ percentage }) => ( + + + + Generating tests with Insomnia AI + + + )} + + )} + {!isMinimal && } + {!isMinimal && ( + + - Sign up for free - - + Made with + by + Kong + + )}
- )} + {isMinimal && ( +
+ {user ? ( + + + + + + ) : ( + + + Login + + + Sign up for free + + + )} +
+ )} +
+
- -
); From e9af56f75b7709469c5ff9837e26e9543601ac87 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Sun, 30 Mar 2025 01:04:09 +0100 Subject: [PATCH 02/13] Refactor project storage type handling to use StorageRules and add a function for storage type labels --- packages/insomnia/src/models/project.ts | 30 +++++++++++++++++-------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/packages/insomnia/src/models/project.ts b/packages/insomnia/src/models/project.ts index 95619845e00..5af8e1934a7 100644 --- a/packages/insomnia/src/models/project.ts +++ b/packages/insomnia/src/models/project.ts @@ -1,5 +1,6 @@ import { database as db } from '../common/database'; import { generateId } from '../common/misc'; +import type { StorageRules } from '../ui/routes/organization'; import { type BaseModel } from './index'; export const name = 'Project'; @@ -92,18 +93,12 @@ export function isDefaultOrganizationProject(project: Project) { return project.remoteId?.startsWith('proj_team') || project.remoteId?.startsWith('proj_org'); } -export enum ORG_STORAGE_RULE { - CLOUD_PLUS_LOCAL = 'cloud_plus_local', - CLOUD_ONLY = 'cloud_only', - LOCAL_ONLY = 'local_only', -} - -export function getDefaultProjectStorageType(storage: ORG_STORAGE_RULE, project?: Project): 'local' | 'remote' | 'git' { - if (storage === ORG_STORAGE_RULE.CLOUD_ONLY) { +export function getDefaultProjectStorageType(storageRules: StorageRules, project?: Project): 'local' | 'remote' | 'git' { + if (storageRules.enableCloudSync && !storageRules.enableLocalVault && !storageRules.enableGitSync) { return 'remote'; } - if (storage === ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL) { + if (storageRules.enableCloudSync && storageRules.enableLocalVault) { if (project && isGitProject(project)) { return 'git'; } @@ -121,3 +116,20 @@ export function getDefaultProjectStorageType(storage: ORG_STORAGE_RULE, project? return 'local'; } + +export function getProjectStorageTypeLabel(storageRules: StorageRules): string { + const storageTypes = { + 'Cloud Sync': storageRules.enableCloudSync, + 'Local Vault': storageRules.enableLocalVault, + 'Git Sync': storageRules.enableGitSync, + }; + + const allowedStorageTypes = Object.entries(storageTypes) + .filter(([, enabled]) => enabled) + .map(([label]) => label); + + // Join with ", " but use "and" before the last item + return allowedStorageTypes.length + ? allowedStorageTypes.join(', ').replace(/, ([^,]+)$/, ' and $1') + : 'No storage types selected'; +} From cdc86d3661e1880f31ae32d50d33f2b9eb61c1f7 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Sun, 30 Mar 2025 01:04:19 +0100 Subject: [PATCH 03/13] Refactor ProjectDropdown to use StorageRules and update project storage type handling --- .../components/dropdowns/project-dropdown.tsx | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/packages/insomnia/src/ui/components/dropdowns/project-dropdown.tsx b/packages/insomnia/src/ui/components/dropdowns/project-dropdown.tsx index 2960aae0869..23c33eeed59 100644 --- a/packages/insomnia/src/ui/components/dropdowns/project-dropdown.tsx +++ b/packages/insomnia/src/ui/components/dropdowns/project-dropdown.tsx @@ -13,11 +13,12 @@ import { useFetcher } from 'react-router-dom'; import type { GitRepository } from '../../../models/git-repository'; import { + getProjectStorageTypeLabel, isGitProject, isRemoteProject, type Project, } from '../../../models/project'; -import { ORG_STORAGE_RULE } from '../../routes/organization'; +import { type StorageRules } from '../../routes/organization'; import { Icon } from '../icon'; import { showAlert, showModal } from '../modals'; import { AskModal } from '../modals/ask-modal'; @@ -26,7 +27,7 @@ import { ProjectModal } from '../modals/project-modal'; interface Props { project: Project & { hasUncommittedOrUnpushedChanges?: boolean; gitRepository?: GitRepository }; organizationId: string; - storage: ORG_STORAGE_RULE; + storageRules: StorageRules; isGitSyncEnabled: boolean; } @@ -37,15 +38,16 @@ interface ProjectActionItem { action: (projectId: string, projectName: string) => void; } -export const ProjectDropdown: FC = ({ project, organizationId, storage, isGitSyncEnabled }) => { +export const ProjectDropdown: FC = ({ project, organizationId, storageRules, isGitSyncEnabled }) => { const [isProjectSettingsModalOpen, setIsProjectSettingsModalOpen] = useState(false); const deleteProjectFetcher = useFetcher(); const updateProjectFetcher = useFetcher(); - const isRemoteProjectInconsistent = isRemoteProject(project) && storage === ORG_STORAGE_RULE.LOCAL_ONLY; - const isLocalProjectInconsistent = !isRemoteProject(project) && storage === ORG_STORAGE_RULE.CLOUD_ONLY; - const isProjectInconsistent = isRemoteProjectInconsistent || isLocalProjectInconsistent; + const isRemoteProjectInconsistent = isRemoteProject(project) && !storageRules.enableCloudSync; + const isLocalProjectInconsistent = !isRemoteProject(project) && !storageRules.enableLocalVault; + const isGitProjectInconsistent = isGitProject(project) && !storageRules.enableLocalVault; + const isProjectInconsistent = isRemoteProjectInconsistent || isLocalProjectInconsistent || isGitProjectInconsistent; const projectActionList: ProjectActionItem[] = [ { @@ -123,7 +125,7 @@ export const ProjectDropdown: FC = ({ project, organizationId, storage, i offset={4} className="border select-none text-sm max-w-xs border-solid border-[--hl-sm] shadow-lg bg-[--color-bg] text-[--color-font] px-4 py-2 rounded-md overflow-y-auto max-h-[85vh] focus:outline-none" > - {`This project type is not allowed by the organization owner. You can manually convert it to use ${storage === ORG_STORAGE_RULE.CLOUD_ONLY ? 'Cloud Sync' : 'Local Vault'}.`} + {`This project type is not allowed by the organization owner. You can manually convert it to use ${getProjectStorageTypeLabel(storageRules)}.`} } @@ -167,7 +169,7 @@ export const ProjectDropdown: FC = ({ project, organizationId, storage, i Date: Sun, 30 Mar 2025 01:04:27 +0100 Subject: [PATCH 04/13] Refactor NewWorkspaceModal to use StorageRules for storage handling --- .../src/ui/components/modals/new-workspace-modal.tsx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/insomnia/src/ui/components/modals/new-workspace-modal.tsx b/packages/insomnia/src/ui/components/modals/new-workspace-modal.tsx index afc874e9c50..f995b2e1e0d 100644 --- a/packages/insomnia/src/ui/components/modals/new-workspace-modal.tsx +++ b/packages/insomnia/src/ui/components/modals/new-workspace-modal.tsx @@ -20,10 +20,11 @@ import { } from 'react-aria-components'; import { useFetcher, useParams } from 'react-router-dom'; -import { isGitProject, ORG_STORAGE_RULE, type Project } from '../../../models/project'; +import { isGitProject, type Project } from '../../../models/project'; import { type WorkspaceScope, WorkspaceScopeKeys } from '../../../models/workspace'; import { safeToUseInsomniaFileName, safeToUseInsomniaFileNameWithExt } from '../../routes/actions'; import type { GetRepositoryDirectoryTreeResult } from '../../routes/git-project-actions'; +import type { StorageRules } from '../../routes/organization'; import { Icon } from '../icon'; const titleByScope: Record = { @@ -45,13 +46,13 @@ export const NewWorkspaceModal = ({ onOpenChange, project, scope, - storageRule, + storageRules, currentPlan, }: { isOpen: boolean; onOpenChange: (isOpen: boolean) => void; project: Project; - storageRule: ORG_STORAGE_RULE; + storageRules: StorageRules; currentPlan?: { type: string }; scope: WorkspaceScope; }) => { @@ -59,8 +60,8 @@ export const NewWorkspaceModal = ({ const isLocalProject = !project.remoteId; const isEnterprise = currentPlan?.type.includes('enterprise'); - const isSelfHostedDisabled = !isEnterprise || storageRule === ORG_STORAGE_RULE.CLOUD_ONLY; - const isCloudProjectDisabled = isLocalProject || storageRule === ORG_STORAGE_RULE.LOCAL_ONLY; + const isSelfHostedDisabled = !isEnterprise || !storageRules.enableLocalVault; + const isCloudProjectDisabled = isLocalProject || !storageRules.enableCloudSync; const canOnlyCreateSelfHosted = isLocalProject && isEnterprise; From 753da5f81fe0392d9291605adc794891c6d9965d Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Sun, 30 Mar 2025 01:04:49 +0100 Subject: [PATCH 05/13] Refactor ProjectModal to use StorageRules for storage type handling and update related logic --- .../ui/components/modals/project-modal.tsx | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/insomnia/src/ui/components/modals/project-modal.tsx b/packages/insomnia/src/ui/components/modals/project-modal.tsx index 4bec65c0ddb..5b71d158e9d 100644 --- a/packages/insomnia/src/ui/components/modals/project-modal.tsx +++ b/packages/insomnia/src/ui/components/modals/project-modal.tsx @@ -4,10 +4,10 @@ import { useFetcher, useNavigation, useParams } from 'react-router-dom'; import type { OauthProviderName } from '../../../models/git-credentials'; import { type GitRepository } from '../../../models/git-repository'; -import { getDefaultProjectStorageType, isGitProject, isRemoteProject, type Project } from '../../../models/project'; +import { getDefaultProjectStorageType, getProjectStorageTypeLabel, isGitProject, isRemoteProject, type Project } from '../../../models/project'; import type { UpdateProjectActionResult } from '../../routes/actions'; import type { InitGitCloneResult } from '../../routes/git-project-actions'; -import { ORG_STORAGE_RULE } from '../../routes/organization'; +import { type StorageRules } from '../../routes/organization'; import { scopeToBgColorMap, scopeToIconMap, scopeToLabelMap, scopeToTextColorMap } from '../../routes/project'; import { ErrorBoundary } from '../error-boundary'; import { Icon } from '../icon'; @@ -35,14 +35,14 @@ function isSwitchingStorageType(project: Project, storageType: 'local' | 'remote export const ProjectModal = ({ isOpen, onOpenChange, - storageRule, + storageRules, isGitSyncEnabled, project, gitRepository, }: { isOpen: boolean; onOpenChange: (isOpen: boolean) => void; - storageRule: ORG_STORAGE_RULE; + storageRules: StorageRules; isGitSyncEnabled: boolean; project?: Project; gitRepository?: GitRepository; @@ -60,7 +60,7 @@ export const ProjectModal = ({ oauth2format?: OauthProviderName; }>({ name: project?.name || 'My Project', - storageType: getDefaultProjectStorageType(storageRule, project), + storageType: getDefaultProjectStorageType(storageRules, project), authorName: gitRepository?.author?.name || '', authorEmail: gitRepository?.author?.email || '', uri: gitRepository?.uri || '', @@ -73,7 +73,7 @@ export const ProjectModal = ({ const [activeView, setActiveView] = useState<'project' | 'git-clone' | 'git-results' | 'switch-storage-type'>('project'); const [selectedTab, setTab] = useState('github'); - const showStorageRestrictionMessage = storageRule !== ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL; + const showStorageRestrictionMessage = !storageRules.enableCloudSync || !storageRules.enableLocalVault || !storageRules.enableGitSync; const initCloneGitRepositoryFetcher = useFetcher(); const upsertProjectFetcher = useFetcher(); @@ -211,7 +211,7 @@ export const ProjectModal = ({
@@ -225,7 +225,7 @@ export const ProjectModal = ({ @@ -238,7 +238,7 @@ export const ProjectModal = ({

@@ -256,7 +256,7 @@ export const ProjectModal = ({
- The organization owner mandates that projects must be created and stored {storageRule.split('_').join(' ')}. + The organization owner mandates that projects must be created and stored {getProjectStorageTypeLabel(storageRules)}.
)} From 86f5c4e54910ed85a78aeb5e6af973425a97e760 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Sun, 30 Mar 2025 01:05:08 +0100 Subject: [PATCH 06/13] Refactor WorkspaceSettingsModal to use StorageRules for organization storage handling --- .../ui/components/modals/workspace-settings-modal.tsx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/insomnia/src/ui/components/modals/workspace-settings-modal.tsx b/packages/insomnia/src/ui/components/modals/workspace-settings-modal.tsx index c034fefdd9e..7d4e12bd1ad 100644 --- a/packages/insomnia/src/ui/components/modals/workspace-settings-modal.tsx +++ b/packages/insomnia/src/ui/components/modals/workspace-settings-modal.tsx @@ -11,7 +11,7 @@ import { isRequest } from '../../../models/request'; import { isEnvironment, isMockServer, isScratchpad, type Workspace } from '../../../models/workspace'; import { safeToUseInsomniaFileName, safeToUseInsomniaFileNameWithExt } from '../../routes/actions'; import type { GetRepositoryDirectoryTreeResult } from '../../routes/git-project-actions'; -import { fetchAndCacheOrganizationStorageRule, ORG_STORAGE_RULE, type OrganizationLoaderData } from '../../routes/organization'; +import { DEFAULT_STORAGE_RULES, fetchAndCacheOrganizationStorageRule, type OrganizationLoaderData, type StorageRules } from '../../routes/organization'; import { Link } from '../base/link'; import { PromptButton } from '../base/prompt-button'; import { Icon } from '../icon'; @@ -28,10 +28,10 @@ interface Props { export const WorkspaceSettingsModal = ({ workspace, gitFilePath, project, mockServer, onClose }: Props) => { const { organizationId, projectId } = useParams() as { organizationId: string; projectId: string; workspaceId: string }; const { currentPlan } = useRouteLoaderData('/organization') as OrganizationLoaderData; - const [orgStorageRule, setOrgStorageRule] = useState(ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL); + const [orgStorageRules, setOrgStorageRules] = useState(DEFAULT_STORAGE_RULES); const [description, setDescription] = useState(workspace.description); useEffect(() => { - fetchAndCacheOrganizationStorageRule(organizationId as string).then(setOrgStorageRule); + fetchAndCacheOrganizationStorageRule(organizationId as string).then(setOrgStorageRules); }, [organizationId]); const gitRepoTreeFetcher = useFetcher(); @@ -44,8 +44,8 @@ export const WorkspaceSettingsModal = ({ workspace, gitFilePath, project, mockSe const isLocalProject = !project?.remoteId; const isEnterprise = currentPlan?.type.includes('enterprise'); - const isSelfHostedDisabled = !isEnterprise || orgStorageRule === ORG_STORAGE_RULE.CLOUD_ONLY; - const isCloudProjectDisabled = isLocalProject || orgStorageRule === ORG_STORAGE_RULE.LOCAL_ONLY; + const isSelfHostedDisabled = !isEnterprise || !orgStorageRules.enableLocalVault; + const isCloudProjectDisabled = isLocalProject || !orgStorageRules.enableCloudSync; const isScratchpadWorkspace = isScratchpad(workspace); From 514b60e0d7f173067385590b59964bf22fe7cfec Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Sun, 30 Mar 2025 01:05:21 +0100 Subject: [PATCH 07/13] Refactor ProjectRoute to use StorageRules for storage handling and update related logic --- packages/insomnia/src/ui/routes/project.tsx | 22 +++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/packages/insomnia/src/ui/routes/project.tsx b/packages/insomnia/src/ui/routes/project.tsx index 57ac77e9595..f69e40cc597 100644 --- a/packages/insomnia/src/ui/routes/project.tsx +++ b/packages/insomnia/src/ui/routes/project.tsx @@ -57,6 +57,7 @@ import type { MockServer } from '../../models/mock-server'; import type { Organization } from '../../models/organization'; import { isOwnerOfOrganization, isPersonalOrganization, isScratchpadOrganizationId } from '../../models/organization'; import { + getProjectStorageTypeLabel, isGitProject, isRemoteProject, type Project, @@ -84,7 +85,7 @@ import { TimeFromNow } from '../components/time-from-now'; import { useInsomniaEventStreamContext } from '../context/app/insomnia-event-stream-context'; import { useLoaderDeferData } from '../hooks/use-loader-defer-data'; import { useOrganizationPermissions } from '../hooks/use-organization-features'; -import { ORG_STORAGE_RULE, type OrganizationLoaderData, type OrganizationStorageLoaderData, useOrganizationLoaderData } from './organization'; +import { DEFAULT_STORAGE_RULES, type OrganizationLoaderData, type OrganizationStorageLoaderData, useOrganizationLoaderData } from './organization'; import { useRootLoaderData } from './root'; interface TeamProject { @@ -685,7 +686,7 @@ const ProjectRoute: FC = () => { const { storagePromise } = storageRuleFetcher.data || {}; - const [storage = ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL] = useLoaderDeferData(storagePromise); + const [storageRules = DEFAULT_STORAGE_RULES] = useLoaderDeferData(storagePromise); const [projectListFilter, setProjectListFilter] = useLocalStorage(`${organizationId}:project-list-filter`, ''); const [workspaceListFilter, setWorkspaceListFilter] = useLocalStorage(`${projectId}:workspace-list-filter`, ''); @@ -892,9 +893,10 @@ const ProjectRoute: FC = () => { }, ]; - const isRemoteProjectInconsistent = activeProject && isRemoteProject(activeProject) && storage === ORG_STORAGE_RULE.LOCAL_ONLY; - const isLocalProjectInconsistent = activeProject && !isRemoteProject(activeProject) && storage === ORG_STORAGE_RULE.CLOUD_ONLY; - const isProjectInconsistent = isRemoteProjectInconsistent || isLocalProjectInconsistent; + const isRemoteProjectInconsistent = activeProject && isRemoteProject(activeProject) && !storageRules.enableCloudSync; + const isLocalProjectInconsistent = activeProject && !isRemoteProject(activeProject) && !storageRules.enableLocalVault; + const isGitSyncProjectInconsistent = activeProject && isGitProject(activeProject) && !storageRules.enableGitSync; + const isProjectInconsistent = isRemoteProjectInconsistent || isLocalProjectInconsistent || isGitSyncProjectInconsistent; useEffect(() => { window.main.landingPageRendered(LandingPage.ProjectDashboard); @@ -1044,7 +1046,7 @@ const ProjectRoute: FC = () => { )} @@ -1174,7 +1176,7 @@ const ProjectRoute: FC = () => {

- The organization owner mandates that projects must be created and stored {storage.split('_').join(' ')}. However, you can optionally enable Git Sync. + The organization owner mandates that projects must be created and stored {getProjectStorageTypeLabel(storageRules)}.

@@ -1452,7 +1454,7 @@ const ProjectRoute: FC = () => { )} @@ -1462,7 +1464,7 @@ const ProjectRoute: FC = () => { onOpenChange={setIsUpdateProjectModalOpen} project={activeProject} gitRepository={activeProjectGitRepository || undefined} - storageRule={storage} + storageRules={storageRules} isGitSyncEnabled={isGitSyncEnabled} /> )} @@ -1470,7 +1472,7 @@ const ProjectRoute: FC = () => { { From ae451e0378061c866091344a569d74de608cefb3 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Mon, 31 Mar 2025 13:21:46 +0200 Subject: [PATCH 08/13] Refactor import route to utilize organization storage rules and improve cloud sync logic --- packages/insomnia/src/ui/routes/import.tsx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/packages/insomnia/src/ui/routes/import.tsx b/packages/insomnia/src/ui/routes/import.tsx index 54aac288f65..ac5eec5cbfa 100644 --- a/packages/insomnia/src/ui/routes/import.tsx +++ b/packages/insomnia/src/ui/routes/import.tsx @@ -5,7 +5,7 @@ import type { ActionFunction } from 'react-router-dom'; import type { PostmanDataDumpRawData } from '../../common/import'; import { fetchImportContentFromURI, getFilesFromPostmanExportedDataDump, type ImportFileDetail, importResourcesToProject, importResourcesToWorkspace, scanResources, type ScanResult } from '../../common/import'; import * as models from '../../models'; -import { isRemoteProject, ORG_STORAGE_RULE } from '../../models/project'; +import { isRemoteProject } from '../../models/project'; import type { Workspace } from '../../models/workspace'; import { initializeLocalBackendProjectAndMarkForSync, pushSnapshotOnInitialize } from '../../sync/vcs/initialize-backend-project'; import { VCSInstance } from '../../sync/vcs/insomnia-sync'; @@ -149,7 +149,10 @@ async function syncNewWorkspaceIfNeeded(newWorkspace: Workspace) { const project = await models.project.getById(newWorkspace.parentId); invariant(project, 'Project not found'); const userSession = await models.userSession.getOrCreate(); - if (userSession.id && isRemoteProject(project) && [ORG_STORAGE_RULE.CLOUD_ONLY, ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL].includes(await fetchAndCacheOrganizationStorageRule(project.parentId))) { + const storageRule = await fetchAndCacheOrganizationStorageRule(project.parentId); + invariant(storageRule, 'Storage rule not found'); + + if (userSession.id && isRemoteProject(project) && storageRule.enableCloudSync) { // Create default env, cookie jar, and meta await models.environment.getOrCreateForParentId(newWorkspace._id); await models.cookieJar.getOrCreateForParentId(newWorkspace._id); From e4eb7250f0c296def2088e1074411ab1ad8bd66b Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Mon, 31 Mar 2025 13:33:20 +0200 Subject: [PATCH 09/13] Refactor sync logic in import route to utilize storage rules for cloud synchronization --- packages/insomnia/src/ui/routes/import.tsx | 45 ++++++++++++---------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/packages/insomnia/src/ui/routes/import.tsx b/packages/insomnia/src/ui/routes/import.tsx index ac5eec5cbfa..67643bfa434 100644 --- a/packages/insomnia/src/ui/routes/import.tsx +++ b/packages/insomnia/src/ui/routes/import.tsx @@ -149,27 +149,30 @@ async function syncNewWorkspaceIfNeeded(newWorkspace: Workspace) { const project = await models.project.getById(newWorkspace.parentId); invariant(project, 'Project not found'); const userSession = await models.userSession.getOrCreate(); - const storageRule = await fetchAndCacheOrganizationStorageRule(project.parentId); - invariant(storageRule, 'Storage rule not found'); - - if (userSession.id && isRemoteProject(project) && storageRule.enableCloudSync) { - // Create default env, cookie jar, and meta - await models.environment.getOrCreateForParentId(newWorkspace._id); - await models.cookieJar.getOrCreateForParentId(newWorkspace._id); - await models.workspaceMeta.getOrCreateByParentId(newWorkspace._id); - try { - const vcs = VCSInstance().newInstance(); - await initializeLocalBackendProjectAndMarkForSync({ - vcs, - workspace: newWorkspace, - }); - await pushSnapshotOnInitialize({ - vcs, - workspace: newWorkspace, - project, - }); - } catch (e) { - console.warn(`Failed to initialize sync to insomnia cloud for workspace ${newWorkspace._id}. This will be retried when the workspace is opened on the app. ${e.message}`); + + if (userSession.id && isRemoteProject(project)) { + const storageRules = await fetchAndCacheOrganizationStorageRule(project.parentId); + invariant(storageRules, 'Storage rules not found'); + + if (storageRules.enableCloudSync) { + // Create default env, cookie jar, and meta + await models.environment.getOrCreateForParentId(newWorkspace._id); + await models.cookieJar.getOrCreateForParentId(newWorkspace._id); + await models.workspaceMeta.getOrCreateByParentId(newWorkspace._id); + try { + const vcs = VCSInstance().newInstance(); + await initializeLocalBackendProjectAndMarkForSync({ + vcs, + workspace: newWorkspace, + }); + await pushSnapshotOnInitialize({ + vcs, + workspace: newWorkspace, + project, + }); + } catch (e) { + console.warn(`Failed to initialize sync to insomnia cloud for workspace ${newWorkspace._id}. This will be retried when the workspace is opened on the app. ${e.message}`); + } } } } From e69b75a54c2428ac9b294efef3797be411a58e05 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Mon, 31 Mar 2025 14:35:34 +0200 Subject: [PATCH 10/13] Refactor ProjectModal and ProjectRoute to improve storage type messaging clarity --- .../ui/components/modals/project-modal.tsx | 20 ++----------------- packages/insomnia/src/ui/routes/project.tsx | 2 +- 2 files changed, 3 insertions(+), 19 deletions(-) diff --git a/packages/insomnia/src/ui/components/modals/project-modal.tsx b/packages/insomnia/src/ui/components/modals/project-modal.tsx index 5b71d158e9d..531d5b78ea9 100644 --- a/packages/insomnia/src/ui/components/modals/project-modal.tsx +++ b/packages/insomnia/src/ui/components/modals/project-modal.tsx @@ -4,7 +4,7 @@ import { useFetcher, useNavigation, useParams } from 'react-router-dom'; import type { OauthProviderName } from '../../../models/git-credentials'; import { type GitRepository } from '../../../models/git-repository'; -import { getDefaultProjectStorageType, getProjectStorageTypeLabel, isGitProject, isRemoteProject, type Project } from '../../../models/project'; +import { getDefaultProjectStorageType, getProjectStorageTypeLabel, isGitProject, isRemoteProject, isSwitchingStorageType, type Project } from '../../../models/project'; import type { UpdateProjectActionResult } from '../../routes/actions'; import type { InitGitCloneResult } from '../../routes/git-project-actions'; import { type StorageRules } from '../../routes/organization'; @@ -16,22 +16,6 @@ import { CustomRepositorySettingsFormGroup } from './git-repository-settings-mod import { GitHubRepositorySetupFormGroup } from './git-repository-settings-modal/github-repository-settings-form-group'; import { GitLabRepositorySetupFormGroup } from './git-repository-settings-modal/gitlab-repository-settings-form-group'; -function isSwitchingStorageType(project: Project, storageType: 'local' | 'remote' | 'git') { - if (storageType === 'git' && !isGitProject(project)) { - return true; - } - - if (storageType === 'local' && (isRemoteProject(project) || isGitProject(project))) { - return true; - } - - if (storageType === 'remote' && !isRemoteProject(project)) { - return true; - } - - return false; -} - export const ProjectModal = ({ isOpen, onOpenChange, @@ -256,7 +240,7 @@ export const ProjectModal = ({
- The organization owner mandates that projects must be created and stored {getProjectStorageTypeLabel(storageRules)}. + The organization owner mandates that projects must be created and stored using {getProjectStorageTypeLabel(storageRules)}.
)} diff --git a/packages/insomnia/src/ui/routes/project.tsx b/packages/insomnia/src/ui/routes/project.tsx index f69e40cc597..2aeb39723ee 100644 --- a/packages/insomnia/src/ui/routes/project.tsx +++ b/packages/insomnia/src/ui/routes/project.tsx @@ -1176,7 +1176,7 @@ const ProjectRoute: FC = () => {

- The organization owner mandates that projects must be created and stored {getProjectStorageTypeLabel(storageRules)}. + The organization owner mandates that projects must be created and stored using {getProjectStorageTypeLabel(storageRules)}.

From a9786a720fe66405e102b54917028107a9472d74 Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Mon, 31 Mar 2025 14:36:04 +0200 Subject: [PATCH 11/13] Refactor getDefaultProjectStorageType to enhance storage type determination logic and add isSwitchingStorageType function --- packages/insomnia/src/models/project.ts | 56 +++++++++++++++++++++---- 1 file changed, 49 insertions(+), 7 deletions(-) diff --git a/packages/insomnia/src/models/project.ts b/packages/insomnia/src/models/project.ts index 5af8e1934a7..f13f579c6b9 100644 --- a/packages/insomnia/src/models/project.ts +++ b/packages/insomnia/src/models/project.ts @@ -94,29 +94,71 @@ export function isDefaultOrganizationProject(project: Project) { } export function getDefaultProjectStorageType(storageRules: StorageRules, project?: Project): 'local' | 'remote' | 'git' { - if (storageRules.enableCloudSync && !storageRules.enableLocalVault && !storageRules.enableGitSync) { - return 'remote'; - } + // When the project exist. That means the user open the settings modal + if (project) { + if (isGitProject(project)) { + if (storageRules.enableGitSync) { + return 'git'; + } + if (storageRules.enableLocalVault) { + return 'local'; + } + return 'remote'; + } - if (storageRules.enableCloudSync && storageRules.enableLocalVault) { - if (project && isGitProject(project)) { + if (isRemoteProject(project)) { + if (storageRules.enableCloudSync) { + return 'remote'; + } + if (storageRules.enableLocalVault) { + return 'local'; + } return 'git'; } - if (project && isRemoteProject(project)) { + if (storageRules.enableLocalVault) { + return 'local'; + } + + if (storageRules.enableCloudSync) { return 'remote'; } + return 'git'; + } + + // When the project doesn't exist. That means the user create a new project + if (storageRules.enableLocalVault) { return 'local'; } - if (project && isGitProject(project)) { + if (storageRules.enableCloudSync) { + return 'remote'; + } + + if (storageRules.enableGitSync) { return 'git'; } return 'local'; } +export function isSwitchingStorageType(project: Project, storageType: 'local' | 'remote' | 'git') { + if (storageType === 'git' && !isGitProject(project)) { + return true; + } + + if (storageType === 'local' && (isRemoteProject(project) || isGitProject(project))) { + return true; + } + + if (storageType === 'remote' && !isRemoteProject(project)) { + return true; + } + + return false; +} + export function getProjectStorageTypeLabel(storageRules: StorageRules): string { const storageTypes = { 'Cloud Sync': storageRules.enableCloudSync, From 0b43ec4c522e83aad96a84772183dce0096c63db Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Fri, 4 Apr 2025 16:55:58 +0200 Subject: [PATCH 12/13] Refactor fetchAndCacheOrganizationStorageRule to simplify default parameter assignment --- packages/insomnia/src/ui/routes/organization.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/insomnia/src/ui/routes/organization.tsx b/packages/insomnia/src/ui/routes/organization.tsx index 01f0427a83c..14cab7ee399 100644 --- a/packages/insomnia/src/ui/routes/organization.tsx +++ b/packages/insomnia/src/ui/routes/organization.tsx @@ -380,7 +380,7 @@ export const syncOrganizationStorageRuleAction: ActionFunction = async ({ params export async function fetchAndCacheOrganizationStorageRule( organizationId: string | undefined, - forceFetch: boolean = false, + forceFetch = false, ): Promise { invariant(organizationId, 'Organization ID is required'); From 14cd03fee096ef2bff890092e8c3fff0486f5cdf Mon Sep 17 00:00:00 2001 From: Pavlos Koutoglou Date: Fri, 4 Apr 2025 18:13:13 +0200 Subject: [PATCH 13/13] Refactor storageRule to include cloud sync, Git sync, and local vault options --- packages/insomnia-smoke-test/server/insomnia-api.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/packages/insomnia-smoke-test/server/insomnia-api.ts b/packages/insomnia-smoke-test/server/insomnia-api.ts index 49d0e6e9641..8ace4791f55 100644 --- a/packages/insomnia-smoke-test/server/insomnia-api.ts +++ b/packages/insomnia-smoke-test/server/insomnia-api.ts @@ -181,7 +181,12 @@ const currentRole = { 'description': 'Owner can manage the organization and also delete it.', }; -const storageRule = { 'storage': 'cloud_plus_local', 'isOverridden': false }; +const storageRule = { + 'enableCloudSync': true, + 'enableGitSync': true, + 'enableLocalVault': true, + 'isOverridden': false +}; const members = { 'start': 0,