#291 : update type and implement score poc

Author: guillermau

api/src/core/adapters/dbApi/kysely/createPgSoftwareRepository.ts

@@ -6,6 +6,7 @@ import { ParentSoftwareExternalData } from "../../../ports/GetSoftwareExternalDa
 import { Software } from "../../../usecases/readWriteSillData";
 import { Database } from "./kysely.database";
 import { stripNullOrUndefinedValues, jsonBuildObject } from "./kysely.utils";
+import { SILL } from "../../../../types/SILL";
 
 const dateParser = (str: string | Date | undefined | null) => {
     if (str && typeof str === "string") {
@@ -17,6 +18,19 @@ const dateParser = (str: string | Date | undefined | null) => {
     }
 };
 
+const computeRepoMetadata = (repoMetadata: SILL.RepoMetadata | undefined | null): SILL.RepoMetadata | undefined => {
+    const newMedata = repoMetadata;
+    if (!newMedata || !newMedata.healthCheck) return undefined;
+
+    let score = 0;
+    if (repoMetadata.healthCheck?.lastClosedIssue) score += 1;
+    if (repoMetadata.healthCheck?.lastClosedIssuePullRequest) score += 1;
+    if (repoMetadata.healthCheck?.lastCommit) score += 1;
+    newMedata.healthCheck.score = score / 3;
+
+    return newMedata;
+};
+
 export const createPgSoftwareRepository = (db: Kysely<Database>): SoftwareRepository => {
     const getBySoftwareId = makeGetSoftwareById(db);
     return {
@@ -189,7 +203,7 @@ export const createPgSoftwareRepository = (db: Kysely<Database>): SoftwareReposi
                         programmingLanguages: softwareExternalData?.programmingLanguages ?? [],
                         referencePublications: softwareExternalData?.referencePublications,
                         identifiers: softwareExternalData?.identifiers,
-                        repoMetadata: softwareExternalData?.repoMetadata,
+                        repoMetadata: computeRepoMetadata(softwareExternalData?.repoMetadata),
                         applicationCategories: software.categories.concat(
                             softwareExternalData?.applicationCategories ?? []
                         ),
@@ -294,7 +308,7 @@ export const createPgSoftwareRepository = (db: Kysely<Database>): SoftwareReposi
                             programmingLanguages: softwareExternalData?.programmingLanguages ?? [],
                             referencePublications: softwareExternalData?.referencePublications,
                             identifiers: softwareExternalData?.identifiers,
-                            repoMetadata: softwareExternalData?.repoMetadata
+                            repoMetadata: computeRepoMetadata(softwareExternalData?.repoMetadata)
                         });
                     }
                 );
@@ -564,7 +578,7 @@ const makeGetSoftwareById =
                     programmingLanguages: softwareExternalData?.programmingLanguages ?? [],
                     referencePublications: softwareExternalData?.referencePublications,
                     identifiers: softwareExternalData?.identifiers,
-                    repoMetadata: softwareExternalData?.repoMetadata,
+                    repoMetadata: computeRepoMetadata(softwareExternalData?.repoMetadata),
                     applicationCategories: filterDuplicate(
                         software.categories.concat(softwareExternalData?.applicationCategories ?? [])
                     ),

api/src/core/adapters/dbApi/kysely/kysely.database.ts

@@ -97,13 +97,7 @@ type SoftwareExternalDatasTable = {
     referencePublications: JSONColumnType<SILL.ScholarlyArticle[]> | null;
     publicationTime: Date | null;
     identifiers: JSONColumnType<SILL.Identification[]> | null;
-    repoMetadata: JSONColumnType<{
-        healthCheck?: {
-            lastCommit?: number;
-            lastClosedIssue?: number;
-            lastClosedIssuePullRequest?: number;
-        };
-    }> | null;
+    repoMetadata: JSONColumnType<SILL.RepoMetadata> | null;
 };
 
 type SoftwareType =

api/src/core/adapters/hal/getHalSoftwareExternalData.ts

@@ -228,11 +228,11 @@ export const getHalSoftwareExternalData: GetSoftwareExternalData = memoize(
                     const lastMergeRequest = await apiProject.mergeRequests.getLast();
                     return {
                         healthCheck: {
-                            lastCommit: lastCommit ? new Date(lastCommit.created_at) : undefined,
+                            lastCommit: lastCommit ? new Date(lastCommit.created_at).valueOf() : undefined,
                             lastClosedIssue:
-                                lastIssue && lastIssue.closed_at ? new Date(lastIssue.closed_at) : undefined,
+                                lastIssue && lastIssue.closed_at ? new Date(lastIssue.closed_at).valueOf() : undefined,
                             lastClosedIssuePullRequest: lastMergeRequest
-                                ? new Date(lastMergeRequest.updated_at)
+                                ? new Date(lastMergeRequest.updated_at).valueOf()
                                 : undefined
                         }
                     };

api/src/core/ports/GetSoftwareExternalData.ts

@@ -35,9 +35,9 @@ export type SoftwareExternalData = {
     identifiers: SILL.Identification[];
     repoMetadata?: {
         healthCheck?: {
-            lastCommit?: Date;
-            lastClosedIssue?: Date;
-            lastClosedIssuePullRequest?: Date;
+            lastCommit?: number;
+            lastClosedIssue?: number;
+            lastClosedIssuePullRequest?: number;
         };
     };
 }>;

api/src/core/usecases/readWriteSillData/types.ts

@@ -61,6 +61,7 @@ export type Software = {
     programmingLanguages: string[];
     referencePublications?: SILL.ScholarlyArticle[];
     identifiers?: SILL.Identification[];
+    repoMetadata?: SILL.RepoMetadata;
 };
 
 export namespace Software {

api/src/types/SILL.ts

@@ -60,4 +60,14 @@ export namespace SILL {
         url?: string;
         affiliations?: Organization[];
     };
+
+    // Created from nowhere
+    export type RepoMetadata = {
+        healthCheck?: {
+            score?: number;
+            lastCommit?: number;
+            lastClosedIssue?: number;
+            lastClosedIssuePullRequest?: number;
+        };
+    };
 }