Merge pull request #370 from pagopa/IOPAE-1117-featured-items-api-mock

[IOPAE-1117] Add services `/featured` api mock

src/config.ts

@@ -190,7 +190,9 @@ const defaultConfig: IoDevServerConfig = {
       sessionTTLinMS: 60000
     },
     service: {
+      featuredItemsSize: 5,
       response: {
+        featuredItemsResponseCode: 200,
         institutionsResponseCode: 200
       }
     },

src/features/services/payloads/get-featured-items.ts

@@ -0,0 +1,67 @@
+import * as A from "fp-ts/lib/Array";
+import { pipe } from "fp-ts/lib/function";
+import _ from "lodash";
+import { FeaturedItem } from "../../../../generated/definitions/services/FeaturedItem";
+import { FeaturedItems } from "../../../../generated/definitions/services/FeaturedItems";
+import { ioDevServerConfig } from "../../../config";
+import ServicesDB from "../../../persistence/services";
+import { getInstitutionsResponsePayload } from "./get-institutions";
+
+const featuredItemsSize = ioDevServerConfig.features.service.featuredItemsSize;
+
+export const getFeaturedItemsResponsePayload = (): FeaturedItems => {
+  // take some casual national service
+  const selectedNationalServices = _.sampleSize(
+    ServicesDB.getNationalServices(),
+    1
+  );
+  // take some casual special service
+  const selectedSpecialServices = _.sampleSize(
+    ServicesDB.getSpecialServices(),
+    3
+  );
+  // take some casual institutions
+  const featuredIntitutions = _.sampleSize(
+    Array.from(getInstitutionsResponsePayload().institutions),
+    1
+  );
+
+  /**
+   * Map national services to FeaturedService[] (add organization_name for layout testing purpose)
+   */
+  const featuredNationalServices: FeaturedItem[] = pipe(
+    selectedNationalServices,
+    A.map(service => ({
+      id: service.service_id,
+      name: service.service_name,
+      version: service.version,
+      organization_name: service.organization_name
+    }))
+  );
+
+  /**
+   * Reduce special services to FeaturedService[]
+   */
+  const featuredSpecialServices: FeaturedItem[] = pipe(
+    selectedSpecialServices,
+    A.map(service => ({
+      id: service.service_id,
+      name: service.service_name,
+      version: service.version
+    }))
+  );
+
+  // returns randomly ordered featured items
+  const featuredItems = _.sampleSize(
+    [
+      ...featuredSpecialServices,
+      ...featuredIntitutions,
+      ...featuredNationalServices
+    ],
+    featuredItemsSize
+  );
+
+  return {
+    items: featuredItems
+  };
+};

src/features/services/routers/featured.ts

@@ -0,0 +1,27 @@
+import * as O from "fp-ts/lib/Option";
+import { pipe } from "fp-ts/lib/function";
+import { ioDevServerConfig } from "../../../config";
+import { addHandler } from "../../../payloads/response";
+import { getFeaturedItemsResponsePayload } from "../payloads/get-featured-items";
+import { addApiV2Prefix, serviceRouter } from "./router";
+
+const serviceConfig = ioDevServerConfig.features.service;
+
+// Retrieve featured items
+addHandler(serviceRouter, "get", addApiV2Prefix("/featured"), (_, res) =>
+  pipe(
+    serviceConfig.response.featuredItemsResponseCode,
+    O.fromPredicate(statusCode => statusCode !== 200),
+    O.fold(
+      () =>
+        pipe(
+          O.of(getFeaturedItemsResponsePayload()),
+          O.fold(
+            () => res.status(404),
+            featuredItems => res.status(200).json(featuredItems)
+          )
+        ),
+      statusCode => res.sendStatus(statusCode)
+    )
+  )
+);

src/features/services/routers/index.ts

@@ -1,3 +1,4 @@
+import "./featured";
 import "./institutions";
 
 export { serviceRouter } from "./router";

src/features/services/types/configuration.ts

@@ -1,10 +1,14 @@
+import { WithinRangeNumber } from "@pagopa/ts-commons/lib/numbers";
 import * as t from "io-ts";
 import { HttpResponseCode } from "../../../types/httpResponseCode";
 
-export const ServiceConfiguration = t.interface({
+export const ServiceConfiguration = t.type({
+  // configure number of featured items
+  featuredItemsSize: WithinRangeNumber(0, 6),
   // configure some API response error code
-  response: t.interface({
+  response: t.type({
     // 200 success with payload
+    featuredItemsResponseCode: HttpResponseCode,
     institutionsResponseCode: HttpResponseCode
   })
 });

src/persistence/services.ts

@@ -97,6 +97,8 @@ const getAllServices = () => [
 ];
 
 const getLocalServices = () => localServices.map(ls => ({ ...ls }));
+const getNationalServices = () => nationalServices.map(ls => ({ ...ls }));
+const getSpecialServices = () => specialServices.map(ls => ({ ...ls }));
 
 const getPreference = (
   serviceId: ServiceId
@@ -166,6 +168,8 @@ export default {
   deleteServices,
   getAllServices,
   getLocalServices,
+  getNationalServices,
+  getSpecialServices,
   getPreference,
   getService,
   getSummaries,