Merge pull request #78 from judemanutd/develop

Updated Fetch all components API & Updated Docs

Author: mergify[bot]

functions/src/controllers/PortfolioController.ts

@@ -60,7 +60,12 @@ export default class PortfolioController {
           "Please specify components that need to be included in the portfolio",
         );
 
-      const result = await addPortfolio(parsedPayload.title, components, parsedPayload.description);
+      const result = await addPortfolio(
+        parsedPayload.title,
+        components,
+        payload,
+        parsedPayload.description,
+      );
       return result;
     } catch (error) {
       throw error;
@@ -117,6 +122,7 @@ export default class PortfolioController {
         portfolioId,
         parsedPayload.title,
         components,
+        payload,
         parsedPayload.description,
       );
       return result;
@@ -148,12 +154,10 @@ export default class PortfolioController {
    * ADMIN
    *
    * fetch all portfolios
-   *
-   * @param showComponents - boolean to indicate if the components should be fetched as well
    */
-  public fetchPortfolios = async (showComponents: boolean = false) => {
+  public fetchPortfolios = async () => {
     try {
-      const result = await fetchPortFolios(showComponents);
+      const result = await fetchPortFolios();
       return result;
     } catch (error) {
       throw error;

functions/src/interfaces/IPortfolioRefs.ts

@@ -0,0 +1,6 @@
+export default interface IPortfolioRefs {
+  category: FirebaseFirestore.DocumentReference[];
+  project: FirebaseFirestore.DocumentReference[];
+  technology: FirebaseFirestore.DocumentReference[];
+  component: FirebaseFirestore.DocumentReference[];
+}

functions/src/models/Portfolio.ts

@@ -3,11 +3,13 @@ import nanoid from "nanoid";
 import Component from "./Component";
 import { STATUS_ACTIVE } from "~utils/constants";
 import portfolioSchema from "~schemas/PortfolioSchema";
+import IPortfolioRefs from "~interfaces/IPortfolioRefs";
 
 class Portfolio {
   public static init = (
     title: string,
     componentIdRefs: FirebaseFirestore.DocumentReference[],
+    refs: IPortfolioRefs,
     description?: string,
   ) => {
     const id = uuid();
@@ -18,6 +20,7 @@ class Portfolio {
       description,
       code: nanoid(10),
       components: componentIdRefs,
+      refs,
       status: STATUS_ACTIVE,
       createdAt: new Date(),
       updatedAt: new Date(),

functions/src/repository/PortfolioRepo.ts

@@ -6,6 +6,7 @@ import { parseRow as parseComponentRow } from "~repository/ComponentRepo";
 import { entityNotFoundError } from "~exceptions/genericErrors";
 import APIError from "~utils/APIError";
 import { HTTP_BAD_REQUEST } from "~utils/http_code";
+import { IPortfolioPayload } from "~interfaces/IPortfolioPayload";
 
 /**
  * ADMIN
@@ -14,11 +15,13 @@ import { HTTP_BAD_REQUEST } from "~utils/http_code";
  *
  * @param title - title for the portfolio
  * @param components  - components that belong to the given portfolio
+ * @param payload  - original payload so part of it can be saved in the db for future retrieval
  * @param description - optional descrition for the portfolio
  */
 export const addPortfolio = async (
   title: string,
   components: Component[],
+  payload: IPortfolioPayload,
   description?: string,
 ) => {
   try {
@@ -28,7 +31,40 @@ export const addPortfolio = async (
         .doc(component.id),
     );
 
-    const insertObj = Portfolio.init(title, componentRefs, description);
+    const { categoryId, componentId, projectId, technologyId } = payload;
+
+    const payloadComponentRefs = componentId.map(component =>
+      getDb()
+        .collection("components")
+        .doc(component),
+    );
+
+    const payloadCategoryRefs = categoryId.map(category =>
+      getDb()
+        .collection("categories")
+        .doc(category),
+    );
+
+    const payloadProjectRefs = projectId.map(project =>
+      getDb()
+        .collection("projects")
+        .doc(project),
+    );
+
+    const payloadTechnologyRefs = technologyId.map(technology =>
+      getDb()
+        .collection("technologies")
+        .doc(technology),
+    );
+
+    const refs = {
+      category: payloadCategoryRefs,
+      project: payloadProjectRefs,
+      technology: payloadTechnologyRefs,
+      component: payloadComponentRefs,
+    };
+
+    const insertObj = Portfolio.init(title, componentRefs, refs, description);
 
     await getDb()
       .collection("portfolios")
@@ -52,12 +88,14 @@ export const addPortfolio = async (
  * @param portfolioId - id of the portfolio that needs to be updated
  * @param title - title for the portfolio
  * @param components  - components that belong to the given portfolio
+ * @param payload  - original payload so part of it can be saved in the db for future retrieval
  * @param description - optional descrition for the portfolio
  */
 export const updatePortfolio = async (
   portfolioId: string,
   title: string,
   components: Component[],
+  payload: IPortfolioPayload,
   description?: string,
 ) => {
   try {
@@ -85,6 +123,41 @@ export const updatePortfolio = async (
       throw new APIError("No attributes specified for updation", undefined, HTTP_BAD_REQUEST);
     }
 
+    const { categoryId, componentId, projectId, technologyId } = payload;
+
+    const payloadComponentRefs = componentId.map(component =>
+      getDb()
+        .collection("components")
+        .doc(component),
+    );
+
+    const payloadCategoryRefs = categoryId.map(category =>
+      getDb()
+        .collection("categories")
+        .doc(category),
+    );
+
+    const payloadProjectRefs = projectId.map(project =>
+      getDb()
+        .collection("projects")
+        .doc(project),
+    );
+
+    const payloadTechnologyRefs = technologyId.map(technology =>
+      getDb()
+        .collection("technologies")
+        .doc(technology),
+    );
+
+    const refs = {
+      category: payloadCategoryRefs,
+      project: payloadProjectRefs,
+      technology: payloadTechnologyRefs,
+      component: payloadComponentRefs,
+    };
+
+    obj.refs = refs;
+
     await getDb()
       .collection("portfolios")
       .doc(portfolioId)
@@ -159,16 +232,93 @@ export const fetchPublicPortfolio = async (portfolioCode: string) => {
  *
  * fetch all portfolios
  *
- * @param showComponents - boolean to indicate if the components should be fetched as well
  */
-export const fetchPortFolios = async (showComponents: boolean = false) => {
+export const fetchPortFolios = async () => {
   try {
     const portfolios = await getDb()
       .collection("portfolios")
       .where("status", "==", STATUS_ACTIVE)
       .get();
 
-    const promises = portfolios.docs.map(project => parseRow(project.data(), showComponents));
+    const promises = portfolios.docs.map(async item => {
+      const row = item.data();
+      const references = row.refs;
+
+      let categoryData = [];
+      let componentData = [];
+      let projectData = [];
+      let technologyData = [];
+
+      if (references) {
+        const categoryPromises = row.refs.category.map(
+          async (categoryRef: FirebaseFirestore.DocumentReference) => {
+            const category = await categoryRef.get();
+            const categoryData = category.exists ? category.data() : null;
+            return {
+              id: categoryData.id,
+              name: categoryData.name,
+            };
+          },
+        );
+
+        const componentPromises = row.refs.component.map(
+          async (componentRef: FirebaseFirestore.DocumentReference) => {
+            const component = await componentRef.get();
+            const componentData = component.exists ? component.data() : null;
+            return {
+              id: componentData.id,
+              name: componentData.name,
+            };
+          },
+        );
+
+        const projectPromises = row.refs.project.map(
+          async (projectRef: FirebaseFirestore.DocumentReference) => {
+            const project = await projectRef.get();
+            const projectData = project.exists ? project.data() : null;
+            return {
+              id: projectData.id,
+              name: projectData.name,
+            };
+          },
+        );
+
+        const technologyPromises = row.refs.technology.map(
+          async (technologyRef: FirebaseFirestore.DocumentReference) => {
+            const technology = await technologyRef.get();
+            const technologyData = technology.exists ? technology.data() : null;
+            return {
+              id: technologyData.id,
+              name: technologyData.name,
+            };
+          },
+        );
+
+        const [category, component, project, technology] = await Promise.all([
+          Promise.all(categoryPromises),
+          Promise.all(componentPromises),
+          Promise.all(projectPromises),
+          Promise.all(technologyPromises),
+        ]);
+
+        categoryData = category;
+        componentData = component;
+        projectData = project;
+        technologyData = technology;
+      }
+
+      return {
+        id: row.id,
+        title: row.title,
+        description: row.description,
+        category: categoryData,
+        component: componentData,
+        project: projectData,
+        technology: technologyData,
+        createdAt: row.createdAt.toDate(),
+        updatedAt: row.updatedAt.toDate(),
+      };
+    });
 
     return await Promise.all(promises);
   } catch (error) {

functions/src/routes/adminRoutes/portfolioRoutes.ts

@@ -62,9 +62,7 @@ router.get("/:portfolioId", async (req: Request, res: Response, next: NextFuncti
 // fetch all portfolios
 router.get("/", async (req: Request, res: Response, next: NextFunction) => {
   try {
-    const showComponents = !!req.query.showComponents;
-
-    const result = await portfolioController.fetchPortfolios(showComponents);
+    const result = await portfolioController.fetchPortfolios();
 
     return response(res, successResponse(result));
   } catch (error) {

functions/tslint.json

@@ -22,7 +22,7 @@
     "no-construct": true,
     "no-duplicate-super": true,
     "no-duplicate-variable": [true, "check-parameters"],
-    "no-shadowed-variable": true,
+    "no-shadowed-variable": false,
     "no-empty": [true, "allow-empty-catch"],
     "no-floating-promises": true,
     "no-implicit-dependencies": [

public/admin_api_doc.dev.yml

@@ -342,8 +342,58 @@ components:
           type: string
           description: long description for the portfolio
           example: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-        components:
+        category:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+                description: unique identifier for the category
+                example: 31765c4c-2606-4e1b-a613-7866212a86b6
+              name:
+                type: string
+                description: name of the category
+                example: Mobile Development
+        component:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+                description: unique identifier for the component
+                example: 31765c4c-2606-4e1b-a613-7866212a86b6
+              name:
+                type: string
+                description: name of the component
+                example: Components 1
+        project:
           type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+                description: unique identifier for the project
+                example: 31765c4c-2606-4e1b-a613-7866212a86b6
+              name:
+                type: string
+                description: name of the project
+                example: Project A
+        technology:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
+                type: string
+                description: unique identifier for the technology
+                example: 31765c4c-2606-4e1b-a613-7866212a86b6
+              name:
+                type: string
+                description: name of the technology
+                example: Node JS
         createdAt:
           type: string
           description: created at ISO string
@@ -1522,6 +1572,7 @@ paths:
                         type: string
                   required:
                     - title
+                    - description
                     - componentId
                     - technologyId
                     - categoryId
@@ -1540,12 +1591,6 @@ paths:
         - portfolio
       summary: Fetch all portfolios listed
       description: Fetch all portfolios listed in the system
-      parameters:
-        - in: query
-          name: showComponents
-          schema:
-            type: boolean
-            description: indicates if components should be returned for each portfolio or not, if false an empty components array is returned
       responses:
         200:
           description: Successful response
@@ -1603,6 +1648,7 @@ paths:
                         type: string
                   required:
                     - title
+                    - description
                     - componentId
                     - technologyId
                     - categoryId