Discussion Forum

This document describes about Discussion Forum architecture

1 Background:
2 Problem Statement:
3 Key design problems:
4 Solution:
5 API’s
- 5.1 POST: Create forum
  - 5.1.1 POST api/discussion/v1/category/create
- 5.2 POST: Creating Group
- 5.3 POST api/discussion/v1/group/create
- 5.4 POST: Add user to Group
- 5.5 POST api/discussion/v1/group/membership/
- 5.6 Note:
- 5.7 POST: User privileges
- 5.8 POST api/discussion/v1/privileges/
- 5.9 note:
- 5.10 Use authentication
- 5.11 Telemetry Events
6 Related Wiki’s:
- 6.1 Discussion forum as a solution:
  - 6.1.1 Discussion forum api's:
  - 6.1.2 How to integrate discussion forum:
  - 6.1.3 Discussion forum telemetry events:
  - 6.1.4 Discussion forum generalization integration:

Background:

Problem Statement:

Key design problems:

How to create an independent widget that will be having end-to-end functionality
How to use existing user service/DB instead of creating new users account in NodeBB
Proxy layer: List of API’s explosed & widget will communicate with these API’s

Solution:

NodeBB default UI options:

Default NodeBB UI with customization:
We built a plugin that will help to customize the UI functionality of page & new route exposed for custom logic. Similarly, any customization can be achieved with a custom plugin(Route & UI screen)

We have to handle the below privileges when we do custom UI:

Custom UI (for NodeBB)	Default UI (NodeBB)
We can have independent widgets that can be added in any page as per the requirement	We have to load the entire UI in an Iframe & handle the redirect based on URL parameters
Any new feature update by NodeBB should be implemented from fresh. If it is impacting on any existing functionality we should do again	Any feature will be available by default. All the configurations will be handled by the default UI itself
Role/Privileges management to show/hide the options has to be implemented from scratch. can post, upvote, downvote, flag, group management, adding user, topic creation etc.	Role/Privileges management is already exist.

Igot Requirement	Sunbird Requriement
Any logged in user can add post/topic in any discussion thread	Only enrolled users of the course should able to post/topic in the specific thered attached to the course
There is not nodebb groups concept. Hence any user can acees any discussion thread.	We should have groups concept to access discussion thread specific to groups. The members can only view their discussion thread. context level discussion
There is not privilege control UI. The same options will be available for Admin, Moderator, Members & Guest	Priviledge control UI required to manage Moderator & Memers. Moderator should able to do below actions View flagged threads/posts. Block/unblock users. Delete the flagged threads/posts

nodebb-Plugins:

NodeBB Censor Curse Words: https://github.com/ninenine/nodebb-plugin-beep
NodeBB Custom Route: https://github.com/vinukumar-vs/nodebb-plugin-vsv-homepage
Nodebb Plugin Quick Start: https://github.com/NodeBB/nodebb-plugin-quickstart

How to create an independent widget that will be having end-to-end functionality

Widgets list:

Categories list
1. Category list with details
2. Category list with only name(as a list)
Topics list
1. Filter options & search query should be the config for the widget (optional for now)
  Note: Think this can be independent widget itself can be used at any place
Topic thread(with new post, list of posts & reply to post)
Create a Topic
Create Category
Post/Reply
1. Post card
2. Replay to post
3. After posting the reply(expanded view)

Middleware/Proxy layer: List of API’s explosed & widget will communicate with these API’s

After review: 10/11/2020

Don’t introduce the hubs in between. The frontend should able to call directly the nodebb default API's without nodebb-plugin. It is not mandatory all the calls should go via nodebb-plugin only.

Role Management:

NodeBB will be having existing roles like Admin, Moderator, Group & User.

Based on User login(sunbird user roles) middleware will map the NodeBB role to the user. On front-end, all the widgets will behave still on nodebb role mapped by middleware(based of sunbird role).

Front-end	Middleware	Nodebb

Front-end	Middleware	Nodebb
ContentCreator(SB role)	ContentCreator → Maderator	Moderator
Anonymous/Public	Public → User	User

API’s

NodeBB API’s documentation: https://docs.nodebb.org/api/#tag/topics/paths/~1api~1popular/get

NodeBB plugin:
nodebb-plugin-write-api : https://github.com/NodeBB/nodebb-plugin-write-api/blob/master/routes/v2/readme.md

POST: Create forum

`POST api/discussion/v1/category/create`

Request

request: {
    "context": {
        "type": "Batch"  // Possible types: Quiz/Resource/Course/Textbook/Batch etc..
        "identifier":"0126825293972439041",  // BatchId in this example
        "channel": 01238392   // Optional: Channel/TenantId in this example
    },
    "parentCid": 1929 // Optional: parent category Id
    "name": "Course 1- Batch 1",
    "description": ""
}

Response

{
    "id": "api.org.preferences.read",
    "ver": "v2",
    "ts": "2020-08-13 18:35:50:148+0000",
    "params": {
        "resmsgid": null,
        "msgid": "3c75d002-15a6-3d5e-8dcd-1bf6179548b2",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "categoryId": 12356 // "nodebb category id"
    }
}

POST: Creating Group

`POST api/discussion/v1/group/create`

Request

request: {
    "categoryId": 1929 // parent category Id
    "userId": [creator],
    "permissions": ["read", "vote", "post", "topic"]  // Default "member" priviledges
}

Response

{
    "id": "api.org.preferences.read",
    "ver": "v2",
    "ts": "2020-08-13 18:35:50:148+0000",
    "params": {
        "resmsgid": null,
        "msgid": "3c75d002-15a6-3d5e-8dcd-1bf6179548b2",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "group": 38301 // "nodebb group id"
    }
}

POST: Add user to Group

`POST api/discussion/v1/group/membership/`

Request

request: {
    "groupId": [2673] // GroupId
    "userId": [2345] // Nodebb UserID
}

Response

{
    "id": "api.org.preferences.read",
    "ver": "v2",
    "ts": "2020-08-13 18:35:50:148+0000",
    "params": {
        "resmsgid": null,
        "msgid": "3c75d002-15a6-3d5e-8dcd-1bf6179548b2",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "status": ok // "nodebb category id"
    }
}

Note:

By default, all the users with get guest privileges

POST: User privileges

`POST api/discussion/v1/privileges/`

Request

request: {
    "categoryId": 1929 // parent category Id
    "groupId": [2673] // Optional: GroupId
    "userId": [2345] // Optional: Nodebb UserID
    "permissions": ["read", "vote", "post", "topic", "moderate"]
}

Response

{
    "id": "api.org.preferences.read",
    "ver": "v2",
    "ts": "2020-08-13 18:35:50:148+0000",
    "params": {
        "resmsgid": null,
        "msgid": "3c75d002-15a6-3d5e-8dcd-1bf6179548b2",
        "err": null,
        "status": "success",
        "errmsg": null
    },
    "responseCode": "OK",
    "result": {
        "status": ok // "nodebb category id"
    }
}

note:

GroupId or userId either one of these is mandatory.

Use authentication

Description:

Telemetry Events

Description: Telemetry events generated by discussion forum

Event Format:

{
    eid: INTERACT,
    edata: {
        id: 'category',
        type: 'CLICK',
        pageid: 'discussion-category',
    },
    context: [
        {
            type: Category
            id: {categoryId}
        },
        {
            type: Topic
            id: {topicId}
        },
        {
            type: Post
            id: {postId}
        },
    ]    
}

Integrating events triggered by the Discussion Library:

  import { DiscussionEventsService } from 'discussion-ui';
 
  constructor(private discussionEvents: DiscussionEventsService) { }

  ngOnInit() {
    this.discussionEvents.telemetryEvent.subscribe(event => {
      console.log('telemetryEvent', event);
    });
  }

telemetryEvent:

{
    eid: INTERACT,
    edata: {
        id: 'category',
        type: 'CLICK',
        pageid: 'discussion-category',
    },
    context: [
        {
            type: 'Category'
            id: '1'
        }
    ]    
}

{
  "eid": "IMPRESSION",
  "edata": {
    "type": "view",
    "pageid": "discussion-home",
    "uri": "/discussion"
  }
}

Related Wiki’s:

Discussion Forum

Background:

Problem Statement:

Key design problems:

Solution:

nodebb-Plugins:

NodeBB Censor Curse Words: https://github.com/ninenine/nodebb-plugin-beep
NodeBB Custom Route: https://github.com/vinukumar-vs/nodebb-plugin-vsv-homepage
Nodebb Plugin Quick Start: https://github.com/NodeBB/nodebb-plugin-quickstart

How to create an independent widget that will be having end-to-end functionality

Middleware/Proxy layer: List of API’s explosed & widget will communicate with these API’s

API’s

POST: Create forum

`POST api/discussion/v1/category/create`

POST: Creating Group

`POST api/discussion/v1/group/create`

POST: Add user to Group

`POST api/discussion/v1/group/membership/`

Note:

POST: User privileges

`POST api/discussion/v1/privileges/`

note:

Use authentication

Telemetry Events

Related Wiki’s: