feat: Add disabling logic to mandate storage option by the API [INS-5159]

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,

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,32 +93,85 @@ 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) {
-    return 'remote';
-  }
+export function getDefaultProjectStorageType(storageRules: StorageRules, project?: Project): 'local' | 'remote' | 'git' {
+  // 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 (storage === ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL) {
-    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,
+    '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';
+}

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<Props> = ({ project, organizationId, storage, isGitSyncEnabled }) => {
+export const ProjectDropdown: FC<Props> = ({ 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<Props> = ({ 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)}.`}
           </Tooltip>
         </TooltipTrigger>
       }
@@ -167,7 +169,7 @@ export const ProjectDropdown: FC<Props> = ({ project, organizationId, storage, i
         <ProjectModal
           project={project}
           isGitSyncEnabled={isGitSyncEnabled}
-          storageRule={storage}
+          storageRules={storageRules}
           gitRepository={project.gitRepository}
           isOpen={isProjectSettingsModalOpen}
           onOpenChange={setIsProjectSettingsModalOpen}

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<WorkspaceScope, string> = {
@@ -45,22 +46,22 @@ 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;
 }) => {
   const { organizationId } = useParams() as { organizationId: string; projectId: string };
 
   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;
 

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, isSwitchingStorageType, 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';
@@ -16,33 +16,17 @@ 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,
-  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 +44,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 +57,7 @@ export const ProjectModal = ({
   const [activeView, setActiveView] = useState<'project' | 'git-clone' | 'git-results' | 'switch-storage-type'>('project');
   const [selectedTab, setTab] = useState<OauthProviderName>('github');
 
-  const showStorageRestrictionMessage = storageRule !== ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL;
+  const showStorageRestrictionMessage = !storageRules.enableCloudSync || !storageRules.enableLocalVault || !storageRules.enableGitSync;
   const initCloneGitRepositoryFetcher = useFetcher<InitGitCloneResult>();
   const upsertProjectFetcher = useFetcher<UpdateProjectActionResult>();
 
@@ -211,7 +195,7 @@ export const ProjectModal = ({
                       </Label>
                       <div className="flex gap-2">
                         <Radio
-                          isDisabled={storageRule === ORG_STORAGE_RULE.CLOUD_ONLY}
+                          isDisabled={!storageRules.enableLocalVault}
                           value="local"
                           className="flex-1 data-[selected]:border-[--color-surprise] data-[selected]:ring-2 data-[selected]:ring-[--color-surprise] data-[disabled]:opacity-25 hover:bg-[--hl-xs] focus:bg-[--hl-sm] border border-solid border-[--hl-md] rounded p-4 focus:outline-none transition-colors"
                         >
@@ -225,7 +209,7 @@ export const ProjectModal = ({
                         </Radio>
 
                         <Radio
-                          isDisabled={storageRule === ORG_STORAGE_RULE.LOCAL_ONLY}
+                          isDisabled={!storageRules.enableCloudSync}
                           value="remote"
                           className="flex-1 data-[selected]:border-[--color-surprise] data-[selected]:ring-2 data-[selected]:ring-[--color-surprise] data-[disabled]:opacity-25 hover:bg-[--hl-xs] focus:bg-[--hl-sm] border border-solid border-[--hl-md] rounded p-4 focus:outline-none transition-colors"
                         >
@@ -238,7 +222,7 @@ export const ProjectModal = ({
                           </p>
                         </Radio>
                         <Radio
-                          isDisabled={!isGitSyncEnabled}
+                          isDisabled={!isGitSyncEnabled || !storageRules.enableGitSync}
                           value="git"
                           className="flex-1 data-[selected]:border-[--color-surprise] data-[selected]:ring-2 data-[selected]:ring-[--color-surprise] data-[disabled]:opacity-25 hover:bg-[--hl-xs] focus:bg-[--hl-sm] border border-solid border-[--hl-md] rounded p-4 focus:outline-none transition-colors"
                         >
@@ -256,7 +240,7 @@ export const ProjectModal = ({
                       <div className="flex items-center px-2 py-1 gap-2 text-sm rounded-sm text-[--color-font-warning] bg-[rgba(var(--color-warning-rgb),0.5)]">
                         <Icon icon="triangle-exclamation" />
                         <span>
-                          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 using {getProjectStorageTypeLabel(storageRules)}.
                         </span>
                       </div>
                     )}

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>(ORG_STORAGE_RULE.CLOUD_PLUS_LOCAL);
+  const [orgStorageRules, setOrgStorageRules] = useState<StorageRules>(DEFAULT_STORAGE_RULES);
   const [description, setDescription] = useState<string>(workspace.description);
   useEffect(() => {
-    fetchAndCacheOrganizationStorageRule(organizationId as string).then(setOrgStorageRule);
+    fetchAndCacheOrganizationStorageRule(organizationId as string).then(setOrgStorageRules);
   }, [organizationId]);
 
   const gitRepoTreeFetcher = useFetcher<GetRepositoryDirectoryTreeResult>();
@@ -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);