feat: remove deployment environment from register repository page (#231)

This change updates the Register Repository Page removing the deployment environment selection when the repository content type is set to deployments.

Author: ChristopherFry

plugins/cad/src/components/RegisterRepositoryPage/RegisterRepositoryPage.tsx

@@ -40,8 +40,6 @@ import { Secret } from '../../types/Secret';
 import { allowFunctionRepositoryRegistration } from '../../utils/featureFlags';
 import {
   ContentSummary,
-  DeploymentEnvironment,
-  DeploymentEnvironmentDetails,
   getRepositoryGitDetails,
   getRepositoryOciDetails,
   getRepositoryResource,
@@ -138,7 +136,6 @@ export const RegisterRepositoryPage = () => {
 
     let gitDetails: RepositoryGitDetails | undefined = undefined;
     let ociDetails: RepositoryOciDetails | undefined = undefined;
-    let deploymentEnvironment: DeploymentEnvironment | undefined = undefined;
 
     if (state.type === RepositoryType.GIT) {
       const createBranch = true;
@@ -159,19 +156,13 @@ export const RegisterRepositoryPage = () => {
     const contentSummary = state.contentSummary as ContentSummary;
     const repositoryAccess = state.repositoryAccess as RepositoryAccess;
 
-    if (contentSummary === ContentSummary.DEPLOYMENT) {
-      deploymentEnvironment =
-        state.deploymentEnvironment as DeploymentEnvironment;
-    }
-
     const resource = getRepositoryResource(
       state.name,
       state.description,
       contentSummary,
       repositoryAccess,
       gitDetails,
       ociDetails,
-      deploymentEnvironment,
     );
 
     return resource;
@@ -248,14 +239,6 @@ export const RegisterRepositoryPage = () => {
         }
       }
 
-      for (const [environment, details] of Object.entries(
-        DeploymentEnvironmentDetails,
-      )) {
-        if (repositoryUrl.includes(details.shortName)) {
-          toSet.deploymentEnvironment = environment;
-        }
-      }
-
       const suggestedName = kebabCase(
         repositoryUrl
           .split('/')
@@ -311,16 +294,6 @@ export const RegisterRepositoryPage = () => {
     return selectItems;
   }, []);
 
-  const deploymentEnvironmentRadioOptions = useMemo(
-    () =>
-      Object.keys(DeploymentEnvironmentDetails).map(env => ({
-        label: env,
-        value: env,
-        description: DeploymentEnvironmentDetails[env].description,
-      })),
-    [],
-  );
-
   return (
     <div>
       <Breadcrumbs>
@@ -498,22 +471,6 @@ export const RegisterRepositoryPage = () => {
           </div>
         </SimpleStepperStep>
 
-        {state.contentSummary === ContentSummary.DEPLOYMENT && (
-          <SimpleStepperStep title="Deployment Environment">
-            <div className={classes.stepContent}>
-              <RadioGroup
-                label="Development Environment"
-                onChange={value =>
-                  updateStateValue('deploymentEnvironment', value)
-                }
-                value={state.deploymentEnvironment}
-                options={deploymentEnvironmentRadioOptions}
-                helperText="Select the environment that maps to your repository."
-              />
-            </div>
-          </SimpleStepperStep>
-        )}
-
         <SimpleStepperStep
           title="Confirm"
           actions={{ nextText: 'Register Repository', onNext: registerRepo }}

plugins/cad/src/components/RepositoryPage/components/RepositoryDetails.tsx

@@ -19,9 +19,7 @@ import React from 'react';
 import { Repository } from '../../../types/Repository';
 import { RepositorySummary } from '../../../types/RepositorySummary';
 import {
-  getDeploymentEnvironment,
   getPackageDescriptor,
-  isDeploymentRepository,
   isReadOnlyRepository,
 } from '../../../utils/repository';
 
@@ -90,16 +88,11 @@ const getRepositoryMetadata = (repository: Repository): Metadata => {
     name: repository.metadata.name,
     description: repository.spec.description ?? '',
     content: `${getPackageDescriptor(repository)}s`,
-    deploymentEnvironment: getDeploymentEnvironment(repository),
     repositoryAccess: isReadOnly ? 'read-only access' : 'write access',
     ...getRepositoryStoreMetadata(repository),
     ...getRepositoryStatusConditions(repository),
   };
 
-  if (!isDeploymentRepository(repository)) {
-    delete metadata.deploymentEnvironment;
-  }
-
   return metadata;
 };
 

plugins/cad/src/utils/repository.ts

@@ -46,20 +46,7 @@ type ContentCloneToDetail = {
   message?: string;
 };
 
-type EnvironmentDetails = {
-  [key: string]: EnvironmentDetail;
-};
-
-type EnvironmentDetail = {
-  shortName: string;
-  description: string;
-  repositoryEnvironmentLabelValue?: string;
-  notDeploymentEnvironment?: DeploymentEnvironment[];
-};
-
 const REPOSITORY_CONTENT_LABEL = 'kpt.dev/repository-content';
-const REPOSITORY_DEPLOYMENT_ENVIRONMENT_LABEL =
-  'kpt.dev/deployment-environment';
 const REPOSITORY_ACCESS_LABEL = 'kpt.dev/repository-access';
 
 export enum ContentSummary {
@@ -70,12 +57,6 @@ export enum ContentSummary {
   FUNCTION = 'Function',
 }
 
-export enum DeploymentEnvironment {
-  DEVELOPMENT = 'Development',
-  STAGING = 'Staging',
-  PRODUCTION = 'Production',
-}
-
 export enum RepositoryAccess {
   FULL = 'full',
   READ_ONLY = 'read-only',
@@ -180,30 +161,6 @@ export const RepositoryContentDetails: ContentDetailsLookup = {
   },
 };
 
-export const DeploymentEnvironmentDetails: EnvironmentDetails = {
-  [DeploymentEnvironment.DEVELOPMENT]: {
-    shortName: 'dev',
-    description:
-      'The development environment is the environment your team uses for day-to-day development. A Team Blueprint package is expected to be cloned to this environment first.',
-    notDeploymentEnvironment: [
-      DeploymentEnvironment.STAGING,
-      DeploymentEnvironment.PRODUCTION,
-    ],
-  },
-  [DeploymentEnvironment.STAGING]: {
-    shortName: 'staging',
-    description:
-      'The staging environment is similar to the production environment, except it does not receive live traffic. A Team Blueprint package is expected to be cloned to this environment after it is cloned, published, and tested in the development environment.',
-    repositoryEnvironmentLabelValue: 'staging',
-  },
-  [DeploymentEnvironment.PRODUCTION]: {
-    shortName: 'prod',
-    description:
-      'The production environment receives live traffic. A Team Blueprint package is expected to be cloned to this environment after it is cloned, published, and tested in the staging environment.',
-    repositoryEnvironmentLabelValue: 'production',
-  },
-};
-
 const isRepositoryContent = (
   repository: Repository,
   contentType: ContentSummary,
@@ -280,36 +237,6 @@ export const getPackageDescriptor = (repository: Repository): string => {
   return 'Unknown';
 };
 
-const isDeploymentEnviroment = (
-  repository: Repository,
-  environment: DeploymentEnvironment,
-): boolean => {
-  const environmentDetails = DeploymentEnvironmentDetails[environment];
-
-  const isLabelMatch =
-    !environmentDetails.repositoryEnvironmentLabelValue ||
-    repository.metadata.labels?.[REPOSITORY_DEPLOYMENT_ENVIRONMENT_LABEL] ===
-      environmentDetails.repositoryEnvironmentLabelValue;
-
-  const isDeployment = isDeploymentRepository(repository);
-  const notContent = environmentDetails.notDeploymentEnvironment ?? [];
-  const noDisqualifiers = !notContent
-    .map(env => isDeploymentEnviroment(repository, env))
-    .includes(true);
-
-  return isDeployment && isLabelMatch && noDisqualifiers;
-};
-
-export const getDeploymentEnvironment = (repository: Repository): string => {
-  for (const env of Object.keys(DeploymentEnvironmentDetails)) {
-    if (isDeploymentEnviroment(repository, env as DeploymentEnvironment)) {
-      return env;
-    }
-  }
-
-  return 'Unknown';
-};
-
 export const getRepository = (
   allRepositories: Repository[],
   repositoryName: string,
@@ -361,7 +288,6 @@ export const getRepositoryResource = (
   repositoryAccess: RepositoryAccess,
   git?: RepositoryGitDetails,
   oci?: RepositoryOciDetails,
-  deploymentEnvironment?: DeploymentEnvironment,
 ): Repository => {
   const contentDetails = RepositoryContentDetails[contentSummary];
 
@@ -377,16 +303,6 @@ export const getRepositoryResource = (
       contentDetails.repositoryContentLabelValue;
   }
 
-  if (contentSummary === ContentSummary.DEPLOYMENT && deploymentEnvironment) {
-    const environmentDetails =
-      DeploymentEnvironmentDetails[deploymentEnvironment];
-
-    if (environmentDetails.repositoryEnvironmentLabelValue) {
-      labels[REPOSITORY_DEPLOYMENT_ENVIRONMENT_LABEL] =
-        environmentDetails.repositoryEnvironmentLabelValue;
-    }
-  }
-
   if (repositoryAccess === RepositoryAccess.READ_ONLY) {
     labels[REPOSITORY_ACCESS_LABEL] = RepositoryAccess.READ_ONLY;
   }