[Refactor:System] Set empty preferred names to NULL (Submitty#11359)

### Please check if the PR fulfills these requirements:

* [ ] Tests for the changes have been added/updated (if possible)
* [ ] Documentation has been updated/added if relevant
* [ ] Screenshots are attached to Github PR if visual/UI changes were
made

### What is the current behavior?
<!-- List issue if it fixes/closes/implements one using the "Fixes
#<number>" or "Closes #<number>" syntax -->
Preferred names can both be empty strings or null to indicate the user
does not have a desired preferred name

### What is the new behavior?
All existing empty preferred names will be set to null and constraints
are added to the database to ensure that empty preferred names cannot be
added to the database in the future.

### Other information?
<!-- Is this a breaking change? -->
<!-- How did you test -->
This is part of a series of changes starting with
Submitty/SysadminTools#37 and will be followed
up by more PRs to remove the handling of empty strings in the database
to be able to further simplify the code to not have to handle 2 cases
that both mean the user does not have a preferred name.

Author: lavalleeale

migration/migrator/data/submitty_db.sql

@@ -686,6 +686,8 @@ CREATE TABLE public.users (
     display_name_order character varying(255) DEFAULT 'GIVEN_F'::character varying NOT NULL,
     display_pronouns boolean DEFAULT false,
     user_preferred_locale character varying,
+    CONSTRAINT user_preferred_familyname_not_empty CHECK (((user_preferred_familyname)::text <> ''::text)),
+    CONSTRAINT user_preferred_givenname_not_empty CHECK (((user_preferred_givenname)::text <> ''::text)),
     CONSTRAINT users_user_access_level_check CHECK (((user_access_level >= 1) AND (user_access_level <= 3))),
     CONSTRAINT users_user_last_initial_format_check CHECK (((user_last_initial_format >= 0) AND (user_last_initial_format <= 3)))
 );

migration/migrator/migrations/master/20250121144600_make_empty_preferred_names_null.py

@@ -0,0 +1,55 @@
+"""Migration for the Submitty master database."""
+
+
+def up(config, database):
+    """
+    Run up migration.
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    :param database: Object for interacting with given database for environment
+    :type database: migrator.db.Database
+    """
+
+    database.execute("""
+    UPDATE users SET user_preferred_givenname = NULL 
+    WHERE user_preferred_givenname = ''
+    """)
+    database.execute("""
+    UPDATE users SET user_preferred_familyname = NULL 
+    WHERE user_preferred_familyname = ''
+    """)
+    database.execute("""
+    ALTER TABLE users ADD CONSTRAINT user_preferred_givenname_not_empty 
+    CHECK (user_preferred_givenname <> '')
+    """)
+    database.execute("""
+    ALTER TABLE users ADD CONSTRAINT user_preferred_familyname_not_empty 
+    CHECK (user_preferred_familyname <> '')
+    """)
+
+
+def down(config, database):
+    """
+    Run down migration (rollback).
+
+    :param config: Object holding configuration details about Submitty
+    :type config: migrator.config.Config
+    :param database: Object for interacting with given database for environment
+    :type database: migrator.db.Database
+    """
+
+    database.execute("""
+    ALTER TABLE users DROP CONSTRAINT user_preferred_givenname_not_empty
+    """)
+    database.execute("""
+    ALTER TABLE users DROP CONSTRAINT user_preferred_familyname_not_empty
+    """)
+    database.execute("""
+    UPDATE users SET user_preferred_givenname = '' 
+    WHERE user_preferred_givenname IS NULL
+    """)
+    database.execute("""
+    UPDATE users SET user_preferred_familyname = '' 
+    WHERE user_preferred_familyname IS NULL
+    """)

site/app/models/User.php

@@ -17,8 +17,8 @@
  * @method void setNumericId(string $id)
  * @method string getPassword()
  * @method string getLegalGivenName() Get the given name of the loaded user
- * @method string getPreferredGivenName() Get the preferred given name of the loaded user
- * @method string getDisplayedGivenName() Returns the preferred given name if one exists and is not null or blank,
+ * @method string|null getPreferredGivenName() Get the preferred given name of the loaded user
+ * @method string|null getDisplayedGivenName() Returns the preferred given name if one exists and is not null or blank,
  *                                        otherwise return the legal given name field for the user.
  * @method string getLegalFamilyName() Get the family name of the loaded user
  * @method string getPreferredFamilyName()  Get the preferred family name of the loaded user
@@ -107,17 +107,17 @@ class User extends AbstractModel {
      * @var string The given name of the user */
     protected $legal_given_name;
     /** @prop
-     * @var string The preferred given name of the user */
-    protected $preferred_given_name = "";
+     * @var ?string The preferred given name of the user */
+    protected $preferred_given_name;
     /** @prop
      * @var  string The given name to be displayed by the system (either given name or preferred given name) */
     protected $displayed_given_name;
     /** @prop
      * @var string The family name of the user */
     protected $legal_family_name;
     /** @prop
-     * @var string The preferred family name of the user */
-    protected $preferred_family_name = "";
+     * @var ?string The preferred family name of the user */
+    protected $preferred_family_name;
     /** @prop
      * @var  string The family name to be displayed by the system (either family name or preferred family name) */
     protected $displayed_family_name;

site/app/views/UserProfileView.php

@@ -23,10 +23,10 @@ public function showUserProfile(
         string $csrf_token
     ) {
         $autofill_preferred_name = [$user->getLegalGivenName(), $user->getLegalFamilyName()];
-        if ($user->getPreferredGivenName() != "") {
+        if (!is_null($user->getPreferredGivenName())) {
             $autofill_preferred_name[0] = $user->getPreferredGivenName();
         }
-        if ($user->getPreferredFamilyName() != "") {
+        if (!is_null($user->getPreferredFamilyName())) {
             $autofill_preferred_name[1] = $user->getPreferredFamilyName();
         }
 

site/phpstan-baseline.neon

@@ -11546,11 +11546,6 @@ parameters:
 			count: 1
 			path: app/views/PollView.php
 
-		-
-			message: "#^Loose comparison via \"\\!\\=\" is not allowed\\.$#"
-			count: 2
-			path: app/views/UserProfileView.php
-
 		-
 			message: "#^Method app\\\\views\\\\admin\\\\ConfigurationView\\:\\:viewConfig\\(\\) has no return type specified\\.$#"
 			count: 1