From 648180650112fe78e6b49cc7974e86590b9e7282 Mon Sep 17 00:00:00 2001
From: jonasongg <120372506+jonasongg@users.noreply.github.com>
Date: Fri, 26 Jan 2024 16:36:20 +0800
Subject: [PATCH] [#1973] Remove redundant User class (#2093)

Remove utils/user.ts, replace with User interface from types.ts

The User class and interface are equivalent in their usage and their
redundancy seems to be a remnant when the code was migrated from JS to
TS.

Let's remove the User class for consistency and to improve runtime
performance.
---
 frontend/src/components/c-ramp.vue |  7 +++---
 frontend/src/types/vuex.d.ts       |  3 +--
 frontend/src/types/window.ts       |  7 +++---
 frontend/src/utils/api.ts          |  7 +++---
 frontend/src/utils/user.ts         | 40 ------------------------------
 frontend/src/views/c-zoom.vue      |  4 +--
 6 files changed, 12 insertions(+), 56 deletions(-)
 delete mode 100644 frontend/src/utils/user.ts

diff --git a/frontend/src/components/c-ramp.vue b/frontend/src/components/c-ramp.vue
index 7440e6d2e1..6367fc7932 100644
--- a/frontend/src/components/c-ramp.vue
+++ b/frontend/src/components/c-ramp.vue
@@ -35,10 +35,9 @@
 </template>
 
 <script lang='ts'>
-import { defineComponent } from 'vue';
+import { defineComponent, PropType } from 'vue';
 import brokenLinkDisabler from '../mixin/brokenLinkMixin';
-import User from '../utils/user';
-import { Commit, CommitResult } from '../types/types';
+import { Commit, CommitResult, User } from '../types/types';
 
 export default defineComponent({
   name: 'c-ramp',
@@ -49,7 +48,7 @@ export default defineComponent({
       default: 'groupByRepos',
     },
     user: {
-      type: User,
+      type: Object as PropType<User>,
       required: true,
     },
     tframe: {
diff --git a/frontend/src/types/vuex.d.ts b/frontend/src/types/vuex.d.ts
index 40e15a73e6..cedee8c21d 100644
--- a/frontend/src/types/vuex.d.ts
+++ b/frontend/src/types/vuex.d.ts
@@ -1,6 +1,5 @@
 import { Store } from 'vuex';
-import { AuthorshipFile } from './types';
-import User from '../utils/user';
+import { AuthorshipFile, User } from './types';
 
 interface AuthorshipInfo {
   author: string;
diff --git a/frontend/src/types/window.ts b/frontend/src/types/window.ts
index 8180527408..ffc01a5b5a 100644
--- a/frontend/src/types/window.ts
+++ b/frontend/src/types/window.ts
@@ -1,6 +1,5 @@
 import JSZip from 'jszip';
-import User from '../utils/user';
-import { Repo, User as UserType } from './types';
+import { Repo, User } from './types';
 import { AuthorshipSchema } from './zod/authorship-type';
 import { AuthorDailyContributions } from './zod/commits-type';
 import { DomainUrlMap, ErrorMessage } from './zod/summary-type';
@@ -61,8 +60,8 @@ declare global {
     getCommitLink: (repoId: string, commitHash: string) => string | undefined;
     getBlameLink: (repoId: string, branch: string, filepath: string) => string | undefined;
     getHistoryLink: (repoId: string, branch: string, filepath: string) => string | undefined;
-    getGroupName: (group: UserType[], filterGroupSelection: string) => string;
-    getAuthorDisplayName: (authorRepos: UserType[]) => string;
+    getGroupName: (group: User[], filterGroupSelection: string) => string;
+    getAuthorDisplayName: (authorRepos: User[]) => string;
     api: Api;
     sinceDate: string;
     untilDate: string;
diff --git a/frontend/src/utils/api.ts b/frontend/src/utils/api.ts
index 10cfa7d656..d3bb73e50a 100644
--- a/frontend/src/utils/api.ts
+++ b/frontend/src/utils/api.ts
@@ -1,8 +1,7 @@
-import { DailyCommit, CommitResult } from '../types/types';
+import { DailyCommit, CommitResult, User } from '../types/types';
 import { authorshipSchema } from '../types/zod/authorship-type';
 import { commitsSchema } from '../types/zod/commits-type';
 import { ErrorMessage, summarySchema } from '../types/zod/summary-type';
-import User from './user';
 
 // utility functions //
 window.$ = (id) => document.getElementById(id);
@@ -258,7 +257,7 @@ window.api = {
         ];
 
         // commits and checkedFileTypeContribution are set in c-summary
-        const user = new User({
+        const user: User = {
           name: author,
           repoId: repoName,
           variance: commits.authorContributionVariance[author],
@@ -270,7 +269,7 @@ window.api = {
           repoName: `${repo.displayName}`,
           location: `${repo.location.location}`,
           checkedFileTypeContribution: undefined,
-        });
+        };
 
         res.push(user);
       }
diff --git a/frontend/src/utils/user.ts b/frontend/src/utils/user.ts
deleted file mode 100644
index 5225aa48d9..0000000000
--- a/frontend/src/utils/user.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-import { Commit, DailyCommit, User as UserType } from '../types/types';
-import { AuthorFileTypeContributions } from '../types/zod/commits-type';
-
-export default class User implements UserType {
-  checkedFileTypeContribution: number | undefined;
-
-  commits: Commit[];
-
-  dailyCommits: DailyCommit[];
-
-  displayName: string;
-
-  fileTypeContribution: AuthorFileTypeContributions;
-
-  location: string;
-
-  name: string;
-
-  repoId: string;
-
-  repoName: string;
-
-  searchPath: string;
-
-  variance: number;
-
-  constructor(userObj: User) {
-    this.checkedFileTypeContribution = userObj.checkedFileTypeContribution;
-    this.commits = userObj.commits || [];
-    this.dailyCommits = userObj.dailyCommits || [];
-    this.displayName = userObj.displayName || '';
-    this.fileTypeContribution = userObj.fileTypeContribution || {};
-    this.location = userObj.location || '';
-    this.name = userObj.name || '';
-    this.repoId = userObj.repoId || '';
-    this.repoName = userObj.repoName || '';
-    this.searchPath = userObj.searchPath || '';
-    this.variance = userObj.variance || 0;
-  }
-}
diff --git a/frontend/src/views/c-zoom.vue b/frontend/src/views/c-zoom.vue
index 08509740b4..f8feeb6ec2 100644
--- a/frontend/src/views/c-zoom.vue
+++ b/frontend/src/views/c-zoom.vue
@@ -153,13 +153,13 @@ import brokenLinkDisabler from '../mixin/brokenLinkMixin';
 import tooltipPositioner from '../mixin/dynamicTooltipMixin';
 import cRamp from '../components/c-ramp.vue';
 import cStackedBarChart from '../components/c-stacked-bar-chart.vue';
-import User from '../utils/user';
 import {
   Bar,
   Commit,
   CommitResult,
   DailyCommit,
   WeeklyCommit,
+  User,
 } from '../types/types';
 import CommitsSortType from '../types/zoom';
 import { StoreState } from '../types/vuex.d';
@@ -237,7 +237,7 @@ export default defineComponent({
         }
         tempUser.commits.push(newCommit);
       });
-      return new User(tempUser);
+      return tempUser;
     },
 
     selectedCommits(): Commit[] {