DEVPROD-933 Trim trailing and ending whitespace for project settings …

…fields (#2267)
evergreen-ci · Feb 28, 2024 · 588a9a7 · 588a9a7
1 parent e02a2b2
commit 588a9a7
Show file tree

Hide file tree

Showing 14 changed files with 52 additions and 1 deletion.
diff --git a/src/components/SpruceForm/customFormats.ts b/src/components/SpruceForm/customFormats.ts
@@ -6,6 +6,7 @@ const {
   validateJira,
   validateJiraURL,
   validateNoSpecialCharacters,
+  validateNoStartingOrTrailingWhitespace,
   validatePercentage,
   validateRegexp,
   validateSlack,
@@ -17,6 +18,7 @@ export const customFormats = (jiraHost: string) => ({
   noSpecialCharacters: validateNoSpecialCharacters,
   // Permit empty string but disallow whitespace
   noSpaces: /^$|^\S+$/,
+  noStartingOrTrailingWhitespace: validateNoStartingOrTrailingWhitespace,
   validDuration: validateDuration,
   validEmail: validateEmail,
   validJiraTicket: validateJira,

diff --git a/src/components/SpruceForm/errors.ts b/src/components/SpruceForm/errors.ts
@@ -62,6 +62,11 @@ export const transformErrors = (errors: AjvError[]) =>
                 ...error,
                 message: "Value should not contain spaces.",
               };
+            case "noStartingOrTrailingWhitespace":
+              return {
+                ...error,
+                message: "Value should not start or end with whitespace.",
+              };
             case "validDuration":
               return {
                 ...error,

diff --git a/src/gql/generated/types.ts b/src/gql/generated/types.ts
@@ -2949,6 +2949,7 @@ export type UserSettings = {
   region?: Maybe<Scalars["String"]["output"]>;
   slackMemberId?: Maybe<Scalars["String"]["output"]>;
   slackUsername?: Maybe<Scalars["String"]["output"]>;
+  timeFormat?: Maybe<Scalars["String"]["output"]>;
   timezone?: Maybe<Scalars["String"]["output"]>;
   useSpruceOptions?: Maybe<UseSpruceOptions>;
 };
@@ -2964,6 +2965,7 @@ export type UserSettingsInput = {
   region?: InputMaybe<Scalars["String"]["input"]>;
   slackMemberId?: InputMaybe<Scalars["String"]["input"]>;
   slackUsername?: InputMaybe<Scalars["String"]["input"]>;
+  timeFormat?: InputMaybe<Scalars["String"]["input"]>;
   timezone?: InputMaybe<Scalars["String"]["input"]>;
   useSpruceOptions?: InputMaybe<UseSpruceOptionsInput>;
 };

diff --git a/src/pages/projectSettings/index.tsx b/src/pages/projectSettings/index.tsx
@@ -60,7 +60,7 @@ const ProjectSettings: React.FC = () => {
     projectData?.projectSettings?.projectRef?.repoRefId || identifier;
 
   // Assign project type in order to show/hide elements that should only appear for repos, attached projects, etc.
-  let projectType;
+  let projectType: ProjectType;
   if (isRepo) {
     projectType = ProjectType.Repo;
   } else if (projectData?.projectSettings?.projectRef?.repoRefId) {

diff --git a/src/pages/projectSettings/tabs/AccessTab/getFormSchema.ts b/src/pages/projectSettings/tabs/AccessTab/getFormSchema.ts
@@ -38,6 +38,7 @@ export const getFormSchema = (
               title: "Username",
               default: "",
               minLength: 1,
+              format: "noStartingOrTrailingWhitespace",
             },
           },
         },

diff --git a/src/pages/projectSettings/tabs/GeneralTab/getFormSchema.tsx b/src/pages/projectSettings/tabs/GeneralTab/getFormSchema.tsx
@@ -66,6 +66,7 @@ export const getFormSchema = (
             branch: {
               type: "string" as "string",
               title: "Branch Name",
+              format: "noStartingOrTrailingWhitespace",
             },
           }),
           other: {
@@ -75,6 +76,7 @@ export const getFormSchema = (
               displayName: {
                 type: "string" as "string",
                 title: "Display Name",
+                format: "noStartingOrTrailingWhitespace",
               },
               ...(projectType !== ProjectType.Repo && {
                 identifier: {
@@ -96,10 +98,12 @@ export const getFormSchema = (
               remotePath: {
                 type: "string" as "string",
                 title: "Config File",
+                format: "noStartingOrTrailingWhitespace",
               },
               spawnHostScriptPath: {
                 type: "string" as "string",
                 title: "Spawn Host Script Path",
+                format: "noStartingOrTrailingWhitespace",
               },
               versionControlEnabled: {
                 type: ["boolean", "null"],

diff --git a/src/pages/projectSettings/tabs/GithubCommitQueueTab/getFormSchema.tsx b/src/pages/projectSettings/tabs/GithubCommitQueueTab/getFormSchema.tsx
@@ -150,6 +150,7 @@ export const getFormSchema = (
                     title: "Username",
                     default: "",
                     minLength: 1,
+                    format: "noStartingOrTrailingWhitespace",
                   },
                 },
               ),
@@ -168,6 +169,7 @@ export const getFormSchema = (
                     title: "Team",
                     default: "",
                     minLength: 1,
+                    format: "noStartingOrTrailingWhitespace",
                   },
                 },
               ),

diff --git a/src/pages/projectSettings/tabs/PatchAliasesTab/getFormSchema.tsx b/src/pages/projectSettings/tabs/PatchAliasesTab/getFormSchema.tsx
@@ -46,16 +46,19 @@ export const getFormSchema = (
                   title: "Alias",
                   default: "",
                   minLength: 1,
+                  format: "noStartingOrTrailingWhitespace",
                 },
                 childProjectIdentifier: {
                   type: "string" as "string",
                   title: "Project",
                   default: "",
                   minLength: 1,
+                  format: "noStartingOrTrailingWhitespace",
                 },
                 parentAsModule: {
                   type: "string" as "string",
                   title: "Module",
+                  format: "noStartingOrTrailingWhitespace",
                 },
                 status: {
                   type: "string" as "string",

diff --git a/src/pages/projectSettings/tabs/PeriodicBuildsTab/getFormSchema.ts b/src/pages/projectSettings/tabs/PeriodicBuildsTab/getFormSchema.ts
@@ -85,6 +85,7 @@ export const getFormSchema = (
               title: "Config File",
               minLength: 1,
               default: "",
+              format: "noStartingOrTrailingWhitespace",
             },
             alias: {
               type: "string" as "string",

diff --git a/src/pages/projectSettings/tabs/PluginsTab/getFormSchema.tsx b/src/pages/projectSettings/tabs/PluginsTab/getFormSchema.tsx
@@ -126,6 +126,7 @@ export const getFormSchema = (
                       createProject: {
                         type: "string" as "string",
                         title: "",
+                        format: "noStartingOrTrailingWhitespace",
                       },
                     },
                   },
@@ -204,6 +205,7 @@ export const getFormSchema = (
               default: "",
               minLength: 1,
               maxLength: 40,
+              format: "noStartingOrTrailingWhitespace",
             },
             urlTemplate: {
               type: "string" as "string",

diff --git a/src/pages/projectSettings/tabs/ProjectTriggersTab/getFormSchema.tsx b/src/pages/projectSettings/tabs/ProjectTriggersTab/getFormSchema.tsx
@@ -28,12 +28,14 @@ export const getFormSchema = (
               title: "Project",
               default: "",
               minLength: 1,
+              format: "noStartingOrTrailingWhitespace",
             },
             configFile: {
               type: "string" as "string",
               title: "Config File",
               default: "",
               minLength: 1,
+              format: "noStartingOrTrailingWhitespace",
             },
             level: {
               type: "string" as "string",

diff --git a/src/pages/projectSettings/tabs/VariablesTab/getFormSchema.ts b/src/pages/projectSettings/tabs/VariablesTab/getFormSchema.ts
@@ -24,6 +24,7 @@ export const getFormSchema = (
               title: "Variable Name",
               default: "",
               minLength: 1,
+              format: "noStartingOrTrailingWhitespace",
             },
             varValue: {
               type: "string" as "string",

diff --git a/src/utils/validators/index.ts b/src/utils/validators/index.ts
@@ -144,13 +144,24 @@ const validateNoSpecialCharacters = (str: string): boolean => {
   return noSpecialCharacters.test(str);
 };
 
+/**
+ * `validateNoStartingOrTrailingWhitespace` tests if a provided string contains no starting or trailing whitespace
+ * @param str - The string to test.
+ * @returns - true if the string has no starting or trailing whitespace and false otherwise
+ */
+const validateNoStartingOrTrailingWhitespace = (str: string): boolean => {
+  const noStartingOrTrailingWhitespaceRegex = /^(?! ).*(?<! )$/;
+  return noStartingOrTrailingWhitespaceRegex.test(str);
+};
+
 export {
   allowedSymbols,
   validateDuration,
   validateEmail,
   validateJira,
   validateJiraURL,
   validateNoSpecialCharacters,
+  validateNoStartingOrTrailingWhitespace,
   validateObjectId,
   validatePercentage,
   validateRegexp,

diff --git a/src/utils/validators/validators.test.ts b/src/utils/validators/validators.test.ts
@@ -2,6 +2,7 @@ import {
   validateJira,
   validateJiraURL,
   validateNoSpecialCharacters,
+  validateNoStartingOrTrailingWhitespace,
   validateObjectId,
   validateRegexp,
   validateSlack,
@@ -24,6 +25,20 @@ describe("validateNoSpecialCharacters", () => {
   });
 });
 
+describe("validateNoStartingOrTrailingWhitespace", () => {
+  it("returns true if string has no starting or trailing whitespace", () => {
+    expect(validateNoStartingOrTrailingWhitespace("")).toBe(true);
+    expect(validateNoStartingOrTrailingWhitespace("a")).toBe(true);
+    expect(validateNoStartingOrTrailingWhitespace("helloworld")).toBe(true);
+    expect(validateNoStartingOrTrailingWhitespace(" helloWorld123")).toBe(
+      false,
+    );
+    expect(validateNoStartingOrTrailingWhitespace("helloWorld123 ")).toBe(
+      false,
+    );
+  });
+});
+
 describe("validateObjectId", () => {
   it("validates object ids", () => {
     expect(validateObjectId("5f74d99ab2373627c047c5e5")).toBeTruthy();