feat(API): Add contextActivities property to fullActivities collection (LLC-293) (#686)

PrinceWaune · web-flow · commit 4bcc8d97918c · 2020-12-07T16:50:32.000+02:00
diff --git a/src/apps/statements/app.ts b/src/apps/statements/app.ts
@@ -73,7 +73,8 @@ export default (appConfig: AppConfig): Result => {
     repo,
     tracker: appConfig.tracker,
   });
-  const presenter = presenterFactory({
+
+  return presenterFactory({
     allowFormBody: appConfig.presenter.express.allowFormBody,
     allowUndefinedMethod: appConfig.presenter.express.allowUndefinedMethod,
     bodyParserLimit: appConfig.presenter.express.bodyParserLimit,
@@ -86,5 +87,4 @@ export default (appConfig: AppConfig): Result => {
     tracker: appConfig.tracker,
     translator,
   });
-  return presenter;
 };
diff --git a/src/apps/statements/models/FullActivity.ts b/src/apps/statements/models/FullActivity.ts
@@ -1,15 +1,15 @@
 import Extensions from './Extensions';
 import LanguageMap from './LanguageMap';
 
-interface FullActivityModel {
+interface FullActivity {
   readonly activityId: string;
+  readonly organisationId: string;
+  readonly lrsId: string;
   readonly name: LanguageMap;
   readonly description: LanguageMap;
   readonly moreInfo?: string;
   readonly type?: string;
   readonly extensions: Extensions;
-  readonly organisationId: string;
-  readonly lrsId: string;
 }
 
-export default FullActivityModel;
+export default FullActivity;
diff --git a/src/apps/statements/models/FullActivityClient.ts b/src/apps/statements/models/FullActivityClient.ts
@@ -0,0 +1,8 @@
+import Context from './Context';
+import FullActivity from './FullActivity';
+
+interface FullActivityClient extends FullActivity {
+  readonly context?: Context;
+}
+
+export default FullActivityClient;
diff --git a/src/apps/statements/models/FullActivityContext.ts b/src/apps/statements/models/FullActivityContext.ts
@@ -0,0 +1,7 @@
+import FullActivityContextActivities from './FullActivityContextActivities';
+
+interface FullActivityContext {
+  readonly contextActivities?: FullActivityContextActivities;
+}
+
+export default FullActivityContext;
diff --git a/src/apps/statements/models/FullActivityContextActivities.ts b/src/apps/statements/models/FullActivityContextActivities.ts
@@ -0,0 +1,8 @@
+interface FullActivityContextActivities {
+  readonly parent?: string[];
+  readonly grouping?: string[];
+  readonly category?: string[];
+  readonly other?: string[];
+}
+
+export default FullActivityContextActivities;
diff --git a/src/apps/statements/models/FullActivityDatabase.ts b/src/apps/statements/models/FullActivityDatabase.ts
@@ -0,0 +1,8 @@
+import FullActivity from './FullActivity';
+import FullActivityContext from './FullActivityContext';
+
+interface FullActivityDatabase extends FullActivity {
+  readonly context?: FullActivityContext;
+}
+
+export default FullActivityDatabase;
diff --git a/src/apps/statements/repo/modelsRepo/getFullActivity/Signature.ts b/src/apps/statements/repo/modelsRepo/getFullActivity/Signature.ts
@@ -1,6 +1,7 @@
 import Member from 'jscommons/dist/utils/Member';
 import ClientModel from '../../../models/ClientModel';
 import Extensions from '../../../models/Extensions';
+import FullActivityContext from '../../../models/FullActivityContext';
 import LanguageMap from '../../../models/LanguageMap';
 
 export interface Opts {
@@ -15,6 +16,7 @@ export interface Result {
   readonly extensions: Extensions;
   readonly type?: string;
   readonly moreInfo?: string;
+  readonly context?: FullActivityContext;
 }
 
 type Signature = Member<Opts, Result>;
diff --git a/src/apps/statements/repo/modelsRepo/getFullActivity/mongo.ts b/src/apps/statements/repo/modelsRepo/getFullActivity/mongo.ts
@@ -19,6 +19,7 @@ export default (config: FacadeConfig): Signature => {
       extensions: 1,
       moreInfo: 1,
       type: 1,
+      context: 1,
     };
 
     const result = await collection.findOne(query, { fields });
@@ -37,8 +38,19 @@ export default (config: FacadeConfig): Signature => {
       name: result.name,
       description: result.description,
       extensions: replaceDotsInExtensions(/&46;/g, '.')(result.extensions),
-      ...(result.type === undefined ? {} : { type: result.type }),
-      ...(result.moreInfo === undefined ? {} : { moreInfo: result.moreInfo }),
+      ...(
+        result.type === undefined
+          ? {}
+          : { type: result.type }),
+      ...(
+        result.moreInfo === undefined
+          ? {}
+          : { moreInfo: result.moreInfo }),
+      ...(
+        result.context === undefined
+          ? {}
+          : { context: result.context }
+      ),
     };
   };
 };
diff --git a/src/apps/statements/repo/modelsRepo/updateFullActivities/Signature.ts b/src/apps/statements/repo/modelsRepo/updateFullActivities/Signature.ts
@@ -1,19 +1,8 @@
 import Member from 'jscommons/dist/utils/Member';
-import ClientModel from '../../../models/ClientModel';
-import LanguageMap from '../../../models/LanguageMap';
-
-export interface Update {
-  readonly activityId: string;
-  readonly name: LanguageMap;
-  readonly description: LanguageMap;
-  readonly extensions: LanguageMap;
-  readonly moreInfo?: string;
-  readonly type?: string;
-}
+import FullActivityDatabase from '../../../models/FullActivityDatabase';
 
 export interface Opts {
-  readonly updates: Update[];
-  readonly client: ClientModel;
+  readonly fullActivities: FullActivityDatabase[];
 }
 
 type Signature = Member<Opts, void>;
diff --git a/src/apps/statements/repo/modelsRepo/updateFullActivities/mongo.ts b/src/apps/statements/repo/modelsRepo/updateFullActivities/mongo.ts
@@ -1,47 +1,107 @@
 import { Dictionary, mapKeys } from 'lodash';
-import { ObjectID } from 'mongodb';
+import { isEmpty } from 'lodash';
+import { ObjectID, UnorderedBulkOperation } from 'mongodb';
+import FullActivityDatabase from '../../../models/FullActivityDatabase';
 import { FULL_ACTIVITIES_COLLECTION_NAME } from '../utils/mongoModels/constants';
 import FacadeConfig from '../utils/mongoModels/FacadeConfig';
 import matchesFullActivity from '../utils/mongoModels/matchesFullActivity';
 import { replaceDotsInExtensions } from '../utils/mongoModels/replaceDotsInStatement';
 import Signature from './Signature';
 
-const getPatchUpdate = <T>(patch: Dictionary<T>, parentKeys: string[]) => {
-  return mapKeys<T>(patch as any, (_value: T, key: number) => {
-    const parentPath = parentKeys.join('.');
-    return `${parentPath}.${key}`;
+const getPatchUpdate = <T>(patch: Dictionary<T>, parentKeys: string[]) =>
+  mapKeys<T>(
+    patch as any,
+    (_value: T, key: number) => `${parentKeys.join('.')}.${key}`,
+  );
+
+const createMongoAddToSet = (fullActivity: FullActivityDatabase) => (
+  {
+    ...(fullActivity.context?.contextActivities?.parent !== undefined
+        ? {
+          'context.contextActivities.parent': {
+            $each: fullActivity.context.contextActivities.parent,
+          },
+        }
+        : {}
+    ),
+    ...(fullActivity.context?.contextActivities?.category !== undefined
+        ? {
+          'context.contextActivities.category': {
+            $each: fullActivity.context.contextActivities.category,
+          },
+        }
+        : {}
+    ),
+    ...(fullActivity.context?.contextActivities?.other !== undefined
+        ? {
+          'context.contextActivities.other': {
+            $each: fullActivity.context.contextActivities.other,
+          },
+        }
+        : {}
+    ),
+    ...(fullActivity.context?.contextActivities?.grouping !== undefined
+        ? {
+          'context.contextActivities.grouping': {
+            $each: fullActivity.context.contextActivities.grouping,
+          },
+        }
+        : {}
+    ),
+  }
+);
+
+const createMongoSet = (fullActivity: FullActivityDatabase) => {
+  const extensions = replaceDotsInExtensions(/\./g, '&46;')(fullActivity.extensions);
+
+  return {
+    ...getPatchUpdate(fullActivity.name, ['name']),
+    ...getPatchUpdate(fullActivity.description, ['description']),
+    ...getPatchUpdate(extensions, ['extensions']),
+    ...(
+      fullActivity.moreInfo !== undefined
+        ? { moreInfo: fullActivity.moreInfo }
+        : {}
+    ),
+    ...(
+      fullActivity.type !== undefined
+        ? { type: fullActivity.type }
+        : {}
+    ),
+  };
+};
+
+const createMongoQuery = (fullActivity: FullActivityDatabase) => {
+  const activityId = fullActivity.activityId;
+  const lrsId = new ObjectID(fullActivity.lrsId);
+  const organisationId = new ObjectID(fullActivity.organisationId);
+
+  return matchesFullActivity({ activityId, lrsId, organisationId });
+};
+
+const creatBatchQuery = (batch: UnorderedBulkOperation) => (fullActivity: FullActivityDatabase) => {
+  const mongoQuery = createMongoQuery(fullActivity);
+  // tslint:disable:no-inferred-empty-object-type
+  const mongoSet = createMongoSet(fullActivity);
+  const mongoAddToSet = createMongoAddToSet(fullActivity);
+  // tslint:enable:no-inferred-empty-object-type
+
+  batch.find(mongoQuery).upsert().updateOne({
+    ...(!isEmpty(mongoSet) ? { $set: mongoSet } : {}),
+    ...(!isEmpty(mongoAddToSet) ? { $addToSet: mongoAddToSet } : {}),
   });
 };
 
-export default (config: FacadeConfig): Signature => {
-  return async ({ client, updates }) => {
+export default (config: FacadeConfig): Signature =>
+  async ({ fullActivities }) => {
+    if (fullActivities.length < 1) {
+      return;
+    }
+
     const collection = (await config.db()).collection(FULL_ACTIVITIES_COLLECTION_NAME);
-    const lrsId = new ObjectID(client.lrs_id);
-    const organisationId = new ObjectID(client.organisation);
     const batch = collection.initializeUnorderedBulkOp();
 
-    updates.forEach((update) => {
-      const activityId = update.activityId;
-      const extensions = replaceDotsInExtensions(/\./g, '&46;')(update.extensions);
-      const mongoQuery = matchesFullActivity({ activityId, lrsId, organisationId });
-      const mongoSet = {
-        ...getPatchUpdate(update.name, ['name']),
-        ...getPatchUpdate(update.description, ['description']),
-        ...getPatchUpdate(extensions, ['extensions']),
-        ...(update.moreInfo !== undefined ? { moreInfo: update.moreInfo } : {}),
-        ...(update.type !== undefined ? { type: update.type } : {}),
-      };
-      if (Object.keys(mongoSet).length === 0) {
-        /* istanbul ignore next */
-        return;
-      }
-      const mongoUpdate = { $set: mongoSet };
-
-      batch.find(mongoQuery).upsert().updateOne(mongoUpdate);
-    });
-
-    if (updates.length > 0) {
-      await batch.execute();
-    }
+    fullActivities.forEach(creatBatchQuery(batch));
+    await batch.execute();
+    // tslint:disable-next-line:max-file-line-count
   };
-};
diff --git a/src/apps/statements/service/getFullActivity.ts b/src/apps/statements/service/getFullActivity.ts
@@ -16,15 +16,20 @@ export default (config: Config) => {
         extensions: fullActivityResult.extensions,
         ...(
           fullActivityResult.moreInfo !== undefined
-          ? { moreInfo: fullActivityResult.moreInfo }
-          : {}
+            ? { moreInfo: fullActivityResult.moreInfo }
+            : {}
         ),
         ...(
           fullActivityResult.type !== undefined
-          ? { type: fullActivityResult.type }
-          : {}
+            ? { type: fullActivityResult.type }
+            : {}
         ),
       },
+      ...(
+        fullActivityResult.context !== undefined
+          ? { context: fullActivityResult.context }
+          : {}
+      ),
     };
   };
 };
diff --git a/src/apps/statements/service/storeStatements/getUnstoredModels.ts b/src/apps/statements/service/storeStatements/getUnstoredModels.ts
@@ -52,13 +52,16 @@ const repoConflicts = async (
   }), 'statementId');
   return values(modelsMap).filter((model: UnstoredStatementModel) => {
     const statementId = model.statement.id;
-    if (has(hashesMap, statementId)) {
-      if (model.hash !== hashesMap[statementId][0].hash) {
-        throw new Conflict(statementId);
-      }
-      return false;
+
+    if (!has(hashesMap, statementId)) {
+      return true;
+    }
+
+    if (model.hash !== hashesMap[statementId][0].hash) {
+      throw new Conflict(statementId);
     }
-    return true;
+
+    return false;
   });
 };
 
diff --git a/src/apps/statements/service/storeStatements/postValidationSetup/index.ts b/src/apps/statements/service/storeStatements/postValidationSetup/index.ts
@@ -76,6 +76,5 @@ export default async (
     },
   );
 
-  const unstoredModels = await Promise.all(unstoredModelPromises);
-  return unstoredModels;
+  return await Promise.all(unstoredModelPromises);
 };
diff --git a/src/apps/statements/service/storeStatements/preValidationSetup/preValidationSetup.ts b/src/apps/statements/service/storeStatements/preValidationSetup/preValidationSetup.ts
@@ -11,7 +11,7 @@ export default (config: Config, models: any[]): any[] => {
       lowerCaseActors(config),
       wrapContextActivitiesInArrays,
     ]);
-    const setupModel = setup(model);
-    return setupModel;
+
+    return setup(model);
   });
 };
diff --git a/src/apps/statements/service/storeStatements/updateFullActivities.ts b/src/apps/statements/service/storeStatements/updateFullActivities.ts
diff --git a/src/apps/statements/serviceFactory/results/GetFullActivityResult.ts b/src/apps/statements/serviceFactory/results/GetFullActivityResult.ts
diff --git a/src/apps/statements/tests/getFullActivity/getFullActivity.test.ts b/src/apps/statements/tests/getFullActivity/getFullActivity.test.ts
diff --git a/src/apps/statements/tests/getFullActivity/utils/testValues.ts b/src/apps/statements/tests/getFullActivity/utils/testValues.ts
