This issue won't be fixed for the 1st assignment

This task is for adding sample data to the database on API request.
Sample data will require being created and stored in the backend, like in config/ somewhere, for example.

There is an existing route for this in routes/db.server.routes.js:

app.route('/api/v1/resample')
    .post(database.resampleDB);

While database.resampleDB can be found in controllers/db.server.controller.js

FIx the continuous integration workflow pipeline for pushes and manual workflow dispatches to the main branch in the main repository.

The conditional statement checks if the GITHUB_REF environment vairable is 'main' when it should check if the GITHUB_REF_NAME environment variable is 'main'.

The following fix requires being applied to line 110 in .github/workflows/node.js.yml:

if: github.event_name != 'pull_request_target' && github.repository == 'SE701-T5/Backend' && github.ref_name == 'main'

Until this is fix is implemented the CI and CD for the main branch in the main repository will be skipped.

Make a backlog of issues for Team 4 to develop for assignment 2.

The project for adding the Issues to is:

SE701-T5/Backend/projects/2

The WikI page the backlog is listed:

SE701-T5/Backend/wiki/Purposed-future-work

Update the README.md with recent changes, links to the Wiki.

TODO

Create our database schema for Forum Posts using Mongoose.

Add the Code of Conduct as a markdown file named CODE_OF_CONDUCT.md in /.github directory for GitHub to link to (refer to the bottom right of Issues when creating them).

This Code of Conduct uses the Citizen Code of Conduct template.

This issue and subsequent Pull Request are intended for the team to review and approve the contribution guidelines before @R055A merges them.

On 21/03/2022 do a demonstration for the backend side of things for this project.

TODO

Possibly make sub-issues:

• General search - “key words”
• Direct search - id

Currently the automated continuous integration workflow is not accessing secrets for pull requests when they are opened. This causes the CI tests to fail as the environment variables stored as secrets are required for successfully running and passing the automated tests. This can be misleading if the changes in the pull requests are not failing the same CI workflow tests in the development branches.

This feature should reset and resample a database with a sample dataset in response to a HTTP POST request to
/api/v1/resample

This feature should return document data for forum posts that contain field(s) matching key word(s) in response to a HTTP GET request to /api/v1/posts

Currently, much of the existing test suite is using a test database and is consistently deleting all data in the database before each test case. This can cause conflict between test cases executed in parallel sharing the same test database resources. This is why the CI workflow is sequentially executing automated testing.

To remove the requirement of a database from the test suite would allow parallel workflow testing, would optimise test performance time, and would resolve the chance of push and pull request event driven CI workflows failing because of conflict between workflows executed by separate events that could share the same resources, such as a commit push event starting a new workflow before another workflow from a prior push event to the same repository branch has completed.

To remove sequential CI testing following removing the requirement of a database for testing, remove occurences of
max-parallel: 1 from the .github/workflows/node.js.yml

Implement user authentication and login functionality for creating, editing and deleting forum post data, and for editing and deleting forum user data.

Add a brief description of the project to the About section on the repository main page, including the team name and a note that the project is associated with the University of Auckland SOFTENG 701.

Implement an update feature that responds to HTTP PATCH requests for updates of any valid editable forum post document field(s) with the updated forum post data.

TODO

Implement logging out a user; verifying they are logged in and removing the authorization token. This is dependent on Issue #21

Create a password hashing method that will intake a plaintext password given by the user and return a hashedPassword.
This method will be used for user creation, login, and other verifications.

Create a wiki to share detailed, long-form information about our project.

• Contains descriptions of what our product does
• A list of technologies and architectures used
• Contact information if support is required
• Any relevant links
• Version numbers/descriptions of different builds we have (if applicable)

Create our database schema for Forum Users using Mongoose.

Implement the removal of an existing forum post document in the database forum collection that matches a given ID in an HTTP DELETE request.

Connect to the MongoDB database in server.js using config/db.server.config.js

If connection is unsuccessful:

• an error message should be printed to console
• the process should be terminated with process.exit(1)

If connection is successful:

• a message should be printed to console with any relevant information

Dependent on Issue #13

Implement an update feature that responds to HTTP PATCH requests for updates of any valid editable forum user document field(s) with the updated forum user data.

The link to the Contributions Guideline at the bottom of the pull_request_template.md file is broken.

It will be replaced with:

For more information, refer to the Contributing Guidelines and Code of Conduct links at the bottom of this page.

This feature should return all forum posts associated with a given category search in response to a HTTP GET request to
/api/v1/posts

Create and add a Node.js continuous integration (CI) workflow that is automated using GitHub actions for:

• clean install of dependencies
• building the Backend project
• running automated testing

CI workflow automation is run when triggered:

• by changes pushed to any remote branch in any forked repo
• by pull requests to the main branch in the main repository
• manually using the GitHub website for the repository
• on schedule every day at 5 am NZT (or 4 pm UTC)

This task is for removing all data from the database on API request.

There is an existing route for this in routes/db.server.routes.js:

app.route('/api/v1/reset')
    .post(database.resetDB);

While database.resetDB can be found in controllers/db.server.controller.js

Setup continuous deployment using Heroku that will be run using workflow actions by GitHub and using the tutorial: Getting Started on Heroku with Node.js

Change the script to use node instead of nodemon.

Store, modify and display view statistics for forum posts so that when a forum post is viewed so too is the current view count for that post.

Create an HTTP POST request to create a new forum user.

This feature should return all comment data associated with a given forum post ID in response to a HTTP GET request to /api/v1/posts/:id/comments

Implement HTTP POST request for creating new comments for a forum post.

Follow the following comment schema:
{
postID: …
authorID:...
authorDisplayName: …
bodytext: …
date: …
upvotes: …
downvotes: …
}

Setup the backend server:

• create MVC layout with module files
• setup empty MongoDB database

Dependent on Issue #5

This issue won't be fixed for the 1st assignment

Change the forum user's DB schema to make the name field optional.
Implement when creating a user, randomly generate their default name. (e.g. User0001)

This feature should add a new document to the database for a comment associated with an existing comment it is in response to rather than associated with the forum post the comment it responds to is associated with.

A CODEOWNERS file is used by GitHub to define who is automatically requested to review pull requests with changes to code they are responsible for.

The CODEOWNERS file in the SE701-T5/Backend repository will define the @SE701-T5/backend team as responsible by default for all changes with exception to:

• README.md
• LICENSE
• .github/*

which all the @SE701-T5/team5 is responsible for as these are documents and changes to these are team-related.

The CODEOWNERS file will be located in the .github/ directory.

There is a missing statement for setting sequential testing that should be in line 118 in .github/workflows/node.js.yml:

max-parallel: 1

This is the result from hours of trying different strategies for deploying to Heroku when push and manual workflows dispatch events are triggered in the main branch of the main repository while also keeping different strategies for pull request events to the main branch in the main repository and for push events to any branch in fork repositories.

Implement adding a new forum post to the database by API request and returning a status code for success or failure

The new forum post HTTP POST request body being sent from the client:

{
  userID: string,
  title: string,
  communityID: string,
  text: string,
  images: [string]
}

Refatctor the setup and teardown for test suites accessing the database for optimal testing time.

Add a pull request (PR) template to the ./github directory so contributors can automatically see the expected contents for the project in a new PR body.

The PR template will be based on these linked examples provided by @axolo-co but modified to better suit this project.

Currently, forum posts are associated with a category ID, but this is just represented as a string. The category feature is yet to be developed. The category ID will be a mongoDB document ID and there will be a document for each category that each forum post is associated with. Refer to the frontend respository for more information regarding forum post categories.

The most recent merge caused the CI to fail. This is although the CI for the pull request passed. It is unknown why this has happened. There was no indication in the pull request that the merge was going to fail. Even if it could have been seen there was no option provided on GitHub to fix the merge issue.

• Fix the failing testing for logging out a user
• Fix the CI workflow for forked repositories
• Add missing documentation

Add Project information, requirements and instructions for running the server locally and in a repository, including instructions for connecting to the MongoDB database and for deploying to Heroku.

This feature should update the field(s) of a forum post comment that has a matching document ID to an ID passed as a parameter in response to a HTTP PATCH request to /api/v1/posts/:id/comments/:id

Add in a communityID field which would be of string type to indicate which community the post will categorize into.

This task was created during discussion with the front team regarding task #15 when it was in progress. Because this task was resolved for completing task #15 when it was in progress, this task has been labelled duplicate and wontfix.

Add the contribution guideline as a markdown file named CONTRIBUTING.md in /.github directory for GitHub to link to (refer to the bottom right of Issues when creating them).

This issue and subsequent Pull Request are intended for the team to review and approve the contribution guidelines before @christopher-alba merges them, and also as an example on how to make and use an Issue and Pull Request using a GitHub Kanban project board.