[Internal Design] BMGS hardcoding in Questionset Editor

IEditorConfig is not generalised and it contains BMGS fields

board, medium, grade Level, subject, topic present in editor.ts file as:

Which defines the IEditorConfig interface

export interface IEditorConfig {
    context: Context;
    config: any;
    metadata?: any;
    data?: any;
}

export interface Context {
    ...
    ...
    board?: any;
    medium?: any;
    gradeLevel?: any;
    subject?: any;
    topic?: any;
    ...
    ...
}

This interface defines the editorConfig.
These value of board, medium, grade Level, subject, topic are getting attached as default value to question if question set does not have BMGS fields.
If question set contains BMGS fields and then BMGS present in editor config get replaced with selected BMGS in question set.

Solution to Generalise interface

export interface IEditorConfig {
    context: Context;
    config: any;
    metadata?: any;
    data?: any;
}

export interface Context {
    ...
    ...
    frameworkDefaultValues?: any
    ...
    ...
}

This frameworkDefaultValues can store board, medium, grade Level, subject, topic, etc as:

frameworkDefaultValues: {
  board: 'CBSE',
  medium: 'English',
  gradeLevel: 'Class 6'
  subject: 'Mathematics',
  ...
}

or it can also contains any values such as hospital, department, etc

frameworkDefaultValues: {
  hospital: 'Apollo',
  department: 'Cardiology',
  ...
  ...
}

Place where above passed BMGS is currently getting fetched and getting added to question metadata

File - question.component.ts

_.pick(_.get(this.editorService.editorConfig, 'context'), ['board', 'medium',
'gradeLevel', 'subject', 'topic'])

If we pass this values in context.frameworkDefaultValues

then this line can also be generalised to

_.get(this.editorService.editorConfig, 'context.frameworkDefaultValues')

BMGS and other fields hard coding in ConfigService

File - config.service.ts

sessionContext contains hard coded fields name as

public sessionContext: Array<string> = ['board', 'medium', 'gradeLevel', 'subject',
'topic', 'author', 'channel', 'framework', 'copyright', 'attributions', 'audience', 'license']

To remove these hardcoded fields name we can pass it as a config to editor as sessionContextFields

editorConfig: {
  config: {
    sessionContextFields: ['board', 'medium', 'gradeLevel', 'subject',
    'topic', 'author', 'channel', 'framework', 'copyright', 'attributions', 'audience', 'license']
  }
}

Another File which contains BMGS hard coded is File - SessionContext.ts

This file is not getting used anywhere we can remove this file.

Other files which contains BMGS are mock data for test cases in these files:

components/assign-page-number/assign-page-number.component.spec.data.ts
components/editor/editor.component.spec.data.ts
components/fancy-tree/fancy-tree.component.spec.data.ts
components/meta-form/meta-form.component.spec.data.ts
components/question/question.component.spec.data.ts
components/quml-player/quml-player.component.spec.data.ts
components/qumlplayer-page/qumlplayer-page.component.spec.data.ts
services/editor/editor.service.spec.data.ts
services/tree/tree.service.spec.data.ts

We can remove BMGS fields from these files.

Resource Library

Question in Question bank shows BMGS and various other fields which it’s not configurable

Content-player-page

Solution 1 - we can use the form config which is being used while question creation to the field code and label and display in this same above format without bringing any new UI change.

Pros

Solution 2-We can define a new form config in which these fields can be set as config. (Not Recommended)

It will add additional config to the editor.

Board value is getting displayed to the contents

library-player

library-list.component

Solution:

We can make this field configurable by passing a config to resource-library

editorConfig = {
  config: {
  ...
  ...
  libraryConfig: {
    createdByField: 'board' // board, hospital, school, etc..
    }
  }
}

Using this libraryConfig we can display whichever value we want to show in above page.

BMGS is present in SessionContext.ts file

This file is not getting used anywhere so can be removed.

BMGS is present in config.service.ts

It defines sessionContext but it is not getting used so can be removed.

So we can remove sessionContext from this file.

Other files which contains BMGS are mock data for test cases in these files:

library/library.component.spec.data.ts
library-filter/library-filter.component.spec.data.ts
library-filter/library-filter.component.spec.ts
quml-player/quml-player.component.spec.data.ts

We can remove BMGS fields from these files.

QuML Player

data.service.ts

Board,medium,grade,subject,etc present in the getContent method.

Above method is part of demo application which is running player.

As this is not part of player core code we don’t need to remove it

mock data of BMGS for unit test cases

We have mock data of board, board, medium, grade, subject in these files for unit test cases

/quml-library.service.spec.data.ts
/main-player/main-player.component.spec.data.ts
/mcq/mcq.component.spec.ts
/sa/sa.component.spec.ts
/section-player/section-player.component.spec.data.ts
/services/viewer-service/viewer-service.spec.data.ts

We can remove the board, medium, grade, subject from these mock data.