feat(api): add new field providers on softwareExternalData

refs: #296

Author: guillermau

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

@@ -49,7 +49,8 @@ export const createPgSoftwareExternalDataRepository = (db: Kysely<Database>): So
                 programmingLanguages: JSON.stringify(softwareExternalData.programmingLanguages),
                 referencePublications: JSON.stringify(softwareExternalData.referencePublications),
                 identifiers: JSON.stringify(softwareExternalData.identifiers),
-                description: JSON.stringify(softwareExternalData.description)
+                description: JSON.stringify(softwareExternalData.description),
+                providers: JSON.stringify(softwareExternalData.providers)
             })
             .executeTakeFirst();
     },
@@ -64,7 +65,8 @@ export const createPgSoftwareExternalDataRepository = (db: Kysely<Database>): So
             programmingLanguages: JSON.stringify(softwareExternalData.programmingLanguages),
             referencePublications: JSON.stringify(softwareExternalData.referencePublications),
             identifiers: JSON.stringify(softwareExternalData.identifiers),
-            description: JSON.stringify(softwareExternalData.description)
+            description: JSON.stringify(softwareExternalData.description),
+            providers: JSON.stringify(softwareExternalData.providers)
         };
 
         await db

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

@@ -152,6 +152,7 @@ export type SoftwareExternalDatasTable = {
     publicationTime: Date | null;
     identifiers: JSONColumnType<SchemaIdentifier[]> | null;
     lastDataFetchAt: number | null;
+    providers: JSONColumnType<Array<SchemaOrganization>> | null;
 };
 
 type SoftwareType =

api/src/core/adapters/dbApi/kysely/migrations/1745395147722_move-prodivers.ts

@@ -0,0 +1,9 @@
+import type { Kysely } from "kysely";
+
+export async function up(db: Kysely<any>): Promise<void> {
+    await db.schema.alterTable("software_external_datas").addColumn("providers", "jsonb").execute();
+}
+
+export async function down(db: Kysely<any>): Promise<void> {
+    await db.schema.alterTable("software_external_datas").dropColumn("providers").execute();
+}

api/src/core/adapters/dbApi/kysely/pgDbApi.integration.test.ts

@@ -70,7 +70,8 @@ const softwareExternalData: SoftwareExternalData = {
     applicationCategories: ["Software Cat I", "Software Cat II"],
     referencePublications: undefined,
     identifiers: undefined,
-    publicationTime: new Date(1561566581000)
+    publicationTime: new Date(1561566581000),
+    providers: []
 };
 
 const similarSoftwareExternalData: SoftwareExternalData = {
@@ -103,7 +104,8 @@ const similarSoftwareExternalData: SoftwareExternalData = {
     applicationCategories: ["Software Cat I", "Software Cat II"],
     referencePublications: undefined,
     identifiers: undefined,
-    publicationTime: new Date(1561566581000)
+    publicationTime: new Date(1561566581000),
+    providers: []
 };
 
 const insertedAgent = {
@@ -445,7 +447,8 @@ describe("pgDbApi", () => {
                     applicationCategories: JSON.stringify(softExtData.applicationCategories),
                     programmingLanguages: JSON.stringify(softExtData.programmingLanguages),
                     identifiers: JSON.stringify(softExtData.identifiers),
-                    referencePublications: JSON.stringify(softExtData.referencePublications)
+                    referencePublications: JSON.stringify(softExtData.referencePublications),
+                    providers: JSON.stringify(softExtData.providers)
                 }))
             )
             .execute();

api/src/core/adapters/hal/getHalSoftware.test.ts

@@ -80,7 +80,8 @@ describe("HAL", () => {
                             "swh:1:dir:424f2533fe51aa8a49d891f8413dd089995cc851;origin=https://hal.archives-ouvertes.fr/hal-01715545;visit=swh:1:snp:9f3237e88d818d975a63da2d5e04d9ad38b42581;anchor=swh:1:rev:8b71800feca2e28cc0f7f78d248e49244b554875;path=/"
                     }
                 ],
-                "publicationTime": new Date(1521545908000)
+                "publicationTime": new Date(1521545908000),
+                "providers": []
             });
         });
     });

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

@@ -229,7 +229,8 @@ export const getHalSoftwareExternalData: GetSoftwareExternalData = memoize(
                         halRawSoftware.relatedPublication_s.map(id => buildReferencePublication(parseScolarId(id), id))
                     )
                 ).filter(val => val !== undefined),
-            identifiers: identifiers
+            identifiers: identifiers,
+            providers: []
         };
     },
     {

api/src/core/ports/GetSoftwareExternalData.ts

@@ -39,6 +39,7 @@ export type SoftwareExternalData = {
     publicationTime: Date;
     referencePublications: ScholarlyArticle[];
     identifiers: SchemaIdentifier[];
+    providers: Array<SchemaOrganization>;
 }>;
 
 export type SimilarSoftwareExternalData = Pick<

api/src/core/usecases/refreshExternalData.test.ts

@@ -254,7 +254,8 @@ describe("fetches software extra data (from different providers)", () => {
                     identifiers: [],
                     softwareVersion: "5.0.1",
                     publicationTime: new Date("2022-04-12T00:00:00.000Z"),
-                    lastDataFetchAt: expect.any(Number)
+                    lastDataFetchAt: expect.any(Number),
+                    providers: []
                 },
                 {
                     applicationCategories: undefined,
@@ -289,7 +290,8 @@ describe("fetches software extra data (from different providers)", () => {
                     identifiers: [],
                     softwareVersion: expect.any(String),
                     publicationTime: expect.any(Date),
-                    lastDataFetchAt: expect.any(Number)
+                    lastDataFetchAt: expect.any(Number),
+                    providers: []
                 }
             ]);
 
@@ -373,7 +375,8 @@ describe("fetches software extra data (from different providers)", () => {
                     programmingLanguages: ["C"],
                     softwareVersion: "2.5.0-alpha",
                     publicationTime: new Date("2017-11-08T00:00:00.000Z"),
-                    lastDataFetchAt: expect.any(Number)
+                    lastDataFetchAt: expect.any(Number),
+                    providers: []
                 },
                 emptyExternalDataCleaned({
                     externalId: "Q118629387",

api/src/tools/test.helpers.ts

@@ -96,7 +96,8 @@ export const emptyExternalData = (params: { softwareId?: number; externalId: str
         identifiers: null,
         sourceSlug,
         softwareId,
-        lastDataFetchAt: null
+        lastDataFetchAt: null,
+        providers: []
     };
 };
 
@@ -122,7 +123,8 @@ export const emptyExternalDataCleaned = (params: { softwareId?: number; external
         identifiers: undefined,
         sourceSlug,
         softwareId,
-        lastDataFetchAt: undefined
+        lastDataFetchAt: undefined,
+        providers: []
     };
 };