feat(Metadata): Add parsed choice response (#583 - [LL-258](https://learningpool.atlassian.net/browse/LL-258))

https://learningpool.atlassian.net/browse/LL-258
#583

Author: crazy-grizzly

src/apps/statements/service/storeStatements/queriables/getMetadataFromStatement/getChoiceQuestionMetadata.ts

@@ -0,0 +1,22 @@
+import { get, has } from 'lodash';
+
+import ActivityInteractionType from '../../../../models/ActivityInteractionType';
+
+import Statement from '../../../../models/Statement';
+
+export const getChoiceQuestionMetadata = (statement: Statement)
+  : {readonly [key: string]: any} => {
+  if (
+    !(
+      get(statement.object, ['definition', 'interactionType']) === ActivityInteractionType.CHOICE
+      && has(statement, ['result', 'response'])
+    )
+  ) {
+    return {};
+  }
+
+  const choicesString = get(statement, ['result', 'response']);
+  const choices = choicesString.split('[,]');
+
+  return { 'https://learninglocker&46;net/choice-response': choices };
+};

src/apps/statements/service/storeStatements/queriables/getMetadataFromStatement/index.ts

@@ -1,18 +1,21 @@
 import Statement from '../../../../models/Statement';
 import { getBooleanMetadata } from './getBooleanMetadata';
+import { getChoiceQuestionMetadata } from './getChoiceQuestionMetadata';
 import { getDurationMetadata } from './getDurationMetadata';
 import { getMatchingQuestionsMetadata } from './getMatchingQuestionsMetadata';
 import { getSequencingMetadata } from './getSequencingMetadata';
 
 export default (statement: Statement): { readonly [key: string]: any } => {
   const durationMetadata = getDurationMetadata(statement);
   const sequencingMetadata = getSequencingMetadata(statement);
+  const choicesMetadata = getChoiceQuestionMetadata(statement);
   const matchingMetadata = getMatchingQuestionsMetadata(statement);
   const booleanMetadata = getBooleanMetadata(statement);
 
   return {
     ...durationMetadata,
     ...sequencingMetadata,
+    ...choicesMetadata,
     ...matchingMetadata,
     ...booleanMetadata,
   };

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/fixtures/choice-interaction.fixture.ts

@@ -0,0 +1,50 @@
+import { merge } from 'lodash';
+import ActivityInteractionType from '../../../../../models/ActivityInteractionType';
+
+import InteractionActivityDefinition from '../../../../../models/InteractionActivityDefinition';
+import Statement from '../../../../../models/Statement';
+import SubStatementObject from '../../../../../models/SubStatementObject';
+import { statementDefaults } from './statements.fixture';
+
+const singleChoice: Statement = {
+  ...statementDefaults,
+  ...{
+    result: {
+      success: true,
+      duration: 'PT0H0M3S',
+      response: 'golf',
+    },
+    object: {
+      id: 'http://www.example.com/tincan/activities/uyheHUJd76s/question2',
+      objectType: 'Activity',
+      definition: {
+        name: { 'en-US': 'Question 2' },
+        description: { 'en-US': 'Which of these prototypes are available at the beta site?' },
+        type: 'http://adlnet.gov/expapi/activities/cmi.interaction',
+        interactionType: ActivityInteractionType.CHOICE,
+        correctResponsesPattern: ['golf[,]tetris'],
+        choices: [
+          { id: 'golf', description: { 'en-US': 'Golf Example' } },
+          { id: 'facebook', description: { 'en-US': 'Facebook App' } },
+          { id: 'tetris', description: { 'en-US': 'Tetris Example' } },
+          { id: 'scrabble', description: { 'en-US': 'Scrabble Example' } },
+        ],
+      } as Partial<InteractionActivityDefinition>,
+    } as SubStatementObject,
+  } as Partial<Statement>,
+};
+
+const multipleChoices: Statement = merge(
+  {},
+  singleChoice,
+  {
+    result: {
+      response: 'golf[,]tetris',
+    },
+  } as Partial<Statement>,
+);
+
+export {
+  singleChoice,
+  multipleChoices,
+};

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/getChoiceQuestionMetadata.test.ts

@@ -0,0 +1,43 @@
+import * as assert from 'assert';
+
+import { getChoiceQuestionMetadata } from '../../../../service/storeStatements/queriables/getMetadataFromStatement/getChoiceQuestionMetadata';
+import { multipleChoices, singleChoice } from './fixtures/choice-interaction.fixture';
+
+describe('Retrieve choices metadata from statement', () => {
+  it('should return choices metadata from statement', () => {
+    const expectedEmptyMetadata = {};
+
+    const actualEmptyMetadataFromEmptyResult = getChoiceQuestionMetadata(
+      {
+        ...singleChoice,
+        ...{
+          result: {},
+        },
+      },
+    );
+
+    assert.deepEqual(actualEmptyMetadataFromEmptyResult, expectedEmptyMetadata);
+  });
+
+  it('should retrieve metadata from statement with one choice', () => {
+    const actualSingleChoiceMetadata = getChoiceQuestionMetadata(singleChoice);
+    const expectedSingleChoiceMetadata = {
+      'https://learninglocker&46;net/choice-response': ['golf'],
+    };
+
+    assert.deepEqual(actualSingleChoiceMetadata, expectedSingleChoiceMetadata);
+  });
+
+  it('should retrieve metadata from statement with multiple choices', () => {
+    const actualMultipleChoicesMetadata = getChoiceQuestionMetadata(multipleChoices);
+    const expectedMultipleChoicesMetadata = {
+      'https://learninglocker&46;net/choice-response': ['golf', 'tetris'],
+    };
+
+    assert
+      .deepEqual(
+        actualMultipleChoicesMetadata,
+        expectedMultipleChoicesMetadata,
+      );
+  });
+});

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/getMetadataFromStatement.test.ts

@@ -3,6 +3,7 @@ import { merge } from 'lodash';
 
 import getMetadataFromStatement
   from '../../../../service/storeStatements/queriables/getMetadataFromStatement';
+import { multipleChoices } from './fixtures/choice-interaction.fixture';
 import { multipleMatchingQuestions } from './fixtures/matching-interaction.fixture';
 import {
   sequencingInteractionActivityStatement,
@@ -49,6 +50,24 @@ describe('Retrieve metadata from statement', () => {
     assert.deepEqual(actualMetadata, expectedMetadata);
   });
 
+  it('should return choices metadata from statement', () => {
+    const actualMetadata = getMetadataFromStatement(
+      {
+        ...multipleChoices,
+        ...{
+          result: {
+            response: multipleChoices.result?.response,
+          },
+        },
+      },
+    );
+    const expectedMetadata = {
+      'https://learninglocker&46;net/choice-response': ['golf', 'tetris'],
+    };
+
+    assert.deepEqual(actualMetadata, expectedMetadata);
+  });
+
   it('should return matching questions metadata', () => {
     const actualMatchingQuestionsMetadata = getMetadataFromStatement(multipleMatchingQuestions);
     const expectedMatchingQuestionsMetadata = {