Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nice-digital/consultations

Provides a simple and consistent way of contributing to and collecting stakeholder comments from NICE consultations
https://github.com/nice-digital/consultations

Last synced: 12 months ago
JSON representation

Provides a simple and consistent way of contributing to and collecting stakeholder comments from NICE consultations

Awesome Lists containing this project

README 

          



# Comment collection



> Our goal is to provide a simple and consistent way of contributing to and collecting stakeholder comments from NICE consultations



Table of contents



- [What is it?](#what-is-it)

  - [Background](#background)

  - [Why are we doing this?](#why-are-we-doing-this)

  - [Who are our users?](#who-are-our-users)

  - [What outcome will users get from this service?](#what-outcome-will-users-get-from-this-service)

  - [What outcome are we looking for?](#what-outcome-are-we-looking-for)

  - [What are our key metrics?](#what-are-our-key-metrics)

- [Stack](#stack)

  - [Architecture](#architecture)

  - [Technical stack](#technical-stack)

- [Set up](#set-up)

  - [Other README files](#other-readme-files)

  - [Secrets](#secrets)

  - [Redis server](#redis-server)

  - [Gotchas](#gotchas)

- [Tests](#tests)

- [Entity Framework Migrations](#entity-framework-migrations)

- [Good to know](#good-to-know)

  - [Further info](#further-info)

  - [Environments](#environments)

  - [Supported by](#supported-by)

  - [Regenerate the Table of Contents](#regenerate-the-table-of-contents)



  

## What is it?

This service provides a way for NICE stakeholders to comment directly on NICE consultations and documents to provide their viewpoint; and a way for NICE teams to request comments and process them for response which doesn’t require repetitive manual handling.



### Background



Consultation is a key part of developing NICE guidance, including NICE quality standards. The consultation processes enable external organisations and individuals to comment on guidance content at specific stages in the development process, and feed into the decision-making process.



### Why are we doing this?



What is our motivation for building this product or service?



- NICE efficiencies

- Increase stakeholder engagement

- Improve quality of responses given by NICE



### Who are our users?



- Internal teams at NICE who consult on the guidance they are producing by collecting comments from external stakeholders

- Our external stakeholders are the people who the guidance and standards that NICE produces affect and who want to provide their views on the development of these, so that their needs and priorities are reflected in the final guidance



### What outcome will users get from this service?



What problem will it solve for people?



- Less manual handling when collating comments

- Less variation for stakeholders between different types of consultation - Secondary

- Able to comment against specific parts of a document or more generically

- Easier for NICE to tell which part of the document is being commented on



### What outcome are we looking for?



What problem will it solve for our organisation?



- Efficiency savings for NICE by reducing manual handling during collation



### What are our key metrics?



What do we need to measure against these outcomes?



- Time taken to collate results

- End to end time taken for consultation process

- Number of comments received

- Number of distinct organisations commenting

- Improved quality of responses / lower error rate



## Stack



### Architecture



Consultations sits below [Varnish](https://github.com/nice-digital/varnish) so is under the main niceorg domain. It pulls data from [InDev](https://github.com/nice-digital/publicationsindev) via an API and stores data in SQL Server.




                  +---------+                                          

        +---------- Varnish -------------+                             

        |         +----|----+            |                             

        |              |                 |                             

        |              |                 |                             

+-------v------+  +----v----+    +-------v-------+    +---------------+

| Guidance Web |  | Orchard |    | Consultations -----> SQL Server DB |

+--------------+  +---------+    +-------^-------+    +---------------+

                                         |                             

                                         |                             

                                         |                             

                                     +---|---+                         

                                     | InDev |                         

                                     +-------+                         




### Technical stack



- [Varnish](https://varnish-cache.org/) for infrastructure-level routing

- [.NET Core 2](https://github.com/dotnet/core) on the server

  - [xUnit.net](https://xunit.net/) for .NET unit tests

  - [Moq](https://github.com/moq/moq4) for mocking in .NET

  - [Shouldly](https://github.com/shouldly/shouldly) for .NET assertions

  - [KDiff](http://kdiff3.sourceforge.net/) for diffing approvals tests

- [SQL Server](https://www.microsoft.com/en-gb/sql-server/sql-server-2017) as our database

  - [Entity Framework Core](https://github.com/aspnet/EntityFrameworkCore) as an ORM

  - [EF Core In-Memory Database Provider](https://docs.microsoft.com/en-us/ef/core/providers/in-memory/) for integration tests

- [React](https://reactjs.org/) for the UI library

  - [Create React App](https://github.com/facebook/create-react-app) for configless React

  - [Jest](https://facebook.github.io/jest/) for JavaScript tests

  - [ASP.NET Core JavaScript Services](https://github.com/aspnet/JavaScriptServices) for rendering JavaScript server side in .NET

  - [ESLint](https://eslint.org/) for JavaScript linting

- [SASS](https://sass-lang.com/) as a CSS pre-processor

- [Modernizr](https://modernizr.com/) for feature detection

- [WebdriverIO](http://webdriver.io/) for automated functional testing

- [NICE Design System](https://nice-digital.github.io/nice-design-system/) for NICE styling

  - [NICE Icons](https://github.com/nice-digital/nice-icons) for icon webfont



## Set up



1. Install [KDiff](http://kdiff3.sourceforge.net/) to be able see diffs from integration tests

2. Install [SQL Server](https://www.microsoft.com/sql-server) and [SQL Server Management Studio (SSMS)](https://docs.microsoft.com/sql/ssms/download-sql-server-management-studio-ssms)

3. Restore Consultations database in SSMS and set account running visual studio as db_owner (Your domain username or SUDO account if running as administrator)

4. Clone the project `git clone git@github.com:nice-digital/consultations.git`

5. Open _Consultations.sln_

6. Paste database connection string into DefaultConnection in secrets.json file (see "Secrets" below for format)

   - right click on project

   - select 'manage user secrets'

   - paste contents of secrets.json (from another dev) to replace the defualt text here.

7. Press F5 to run the project in debug mode

8. Dependencies will download (npm and NuGet) so be patient on first run

9. The app will run in IIS Express on http://localhost:52679/

10. cd into _consultations\Comments\ClientApp_

    run 'npm install --only=dev'

    run 'npm run build'

    run `npm start` if Startup is using `UseProxyToSpaDevelopmentServer`. This runs a react dev server on http://localhost:3000/.

11. Run `npm test` in a separate window to run client side tests in watch mode

12. If the application has a URL like https://niceorg:44306/ You may need to add a line to your hosts file (C:\Windows\System32\drivers\etc\hosts) pointing "niceorg" at 127.0.0.1

13. If you don't have it already, you will need to go into Identity Management for the environment you are working in e.g. https://test-identityadmin.nice.org.uk/ and give youself Administrator access to Consultations.

14. Install Redis locally on your machine. Instructions below.



### Other README files



-There is another README file in _consultations\Comments\ClientApp_ which goes into more detail if `npm start` does not work immediately.



### Secrets



- First try to copy the secrets file from another developer who has had comment collection working before.

- If you cannot find another developer with a secrets file, you can copy the format below.



```

{

  "ConnectionStrings": {

    "DefaultConnection": ""

  },

  "Logging": {

    "RabbitMQHost": "",

    "RabbitMQPort": "",

    "IncludeScopes": false,

    "LogFilePath": "",

    "LogLevel": {

      "Default": "Debug",

      "System": "Information",

      "Microsoft": "Information"

    },

    "UseRabbit": false,

    "UseFile": true

  },

  "AppSettings": {

    "Environment": {

      "Name": "local",

      "SecureSite": "false"

    }

  },

  "Feeds": {

    "ApiKey": "",

    "IndevBasePath": "",

    "IndevPublishedChapterFeedPath": "",

    "IndevDraftPreviewChapterFeedPath": "",

    "IndevPublishedDetailFeedPath": "",

    "IndevDraftPreviewDetailFeedPath": "",

    "IndevPublishedPreviewDetailFeedPath": "",

    "IndevListFeedPath": "",

    "CacheDurationSeconds": 60,

    "IndevIDAMConfig": {

      "Domain": "",

      "ClientId": "",

      "ClientSecret": "",

      "APIIdentifier": ""

    }

  },

  "WebAppConfiguration": {

    "ApiIdentifier": "",

    "ClientId": "",

    "ClientSecret": "",

    "AuthorisationServiceUri": "",

    "Domain": "",

    "PostLogoutRedirectUri": "",

    "RedirectUri": "",

    "CallBackPath": "",

    "GoogleTrackingId": "",

    "RedisServiceConfiguration": {

      "ConnectionString": "",

      "Enabled": true

    }

  },

  "Encryption": {

    "Key": "",

    "IV": ""

  },

  "PDF": {

    "PDFDocGenServer": ""

  },

  "ConsultationList": {

    "DownloadRoles": {

      "AdminRoles": [ "", "" ],

      "TeamRoles": [ "", "", "" ]

    }

  },

  "AWS": {

    "Profile": "",

    "Region": ""

  }

}



```



### Redis server



This application uses a data store called Redis to capture and store Tokens from Auth0. You will need to run a local version of Redis using Chocolatey, A docker/podman container or via WSL at a command prompt. Go to [https://redis.io/docs/getting-started/](https://redis.io/docs/getting-started/) to get started, the instructions are well written.



### Gotchas



- `spa.UseReactDevelopmentServer` can be slow so try using `spa.UseProxyToSpaDevelopmentServer("http://localhost:3000");` instead within [Startup.cs](Comments/Startup.cs).

- Need to ensure that nothing else is running on port 80, otherwise you will encounter a socket exception error when running in debug.

- Exception: OpenIdConnectAuthenticationHandler: message.State is null or empty. -- caused if login is attempted without redis, clear your cookies and login again.

- It might take a few F5's, visual studio restarts and cookie clears to get all the various services/applications to start co-operating



## Tests



The project uses serveral layers of tests:



- C# low-level unit tests, run via xUnit, asserted with Shouldly. See [Comments.Test/UnitTests](Comments.Test/UnitTests).

- C# 'integration' tests (approval based of server rendered HTML), run via xUnit, asserted with Shouldly, diffed with Kdiff. See [Comments.Test/IntegrationTests](Comments.Test/IntegrationTests).

- JavaScript unit tests via jest. See [Comments/ClientApp/src](Comments/ClientApp/src).

- Functional high-level tests, via webdriver.io.



## Entity Framework Migrations



We use Code first Entity Framework migrations to update the consultations database



To update the database



- add a new property to the relevent class in Consultations > Comments > Models > EF

- in visual studio go to Tools > NuGet Package Manager > Package Manager Console

- in the package manager console window run the command Add-Migration [give your migration a useful name] eg Add-Migration AddCommentCreationDate  

  This will create a new migrations script in Consultations > Comments > Migrations

- when the comment collection is next hit the changes in the migration script will be applied to SQL.  

  A new column will be created in \_\_EFMigrationHistory to flag that the migration has been run.



## Good to know



### Further info



See the [Consultations Sharepoint site](https://niceuk.sharepoint.com/sites/External_Consultations)



### Environments



| Environment | URL                                      |

| ----------- | ---------------------------------------- |

| local       | https://local.nice.org.uk/consultations/ |

| Alpha       | https://alpha.nice.org.uk/consultations/ |

| Live        | https://www.nice.org.uk/consultations/   |



### Supported by



BrowserStack Logo

We're using BrowserStack's support of open source projects for our day-to-day cross-browser and cross-device testing, and as part of an automated CI environment. See their support for open source projects.



### Regenerate the Table of Contents



For further information about the recommended ReadMe structure plus a 'how to' for regenerating the table of contents, follow the instructions in [DIT Engineering - ReadMes](https://niceuk.sharepoint.com/sites/DIT_Engineering/SitePages/Readmes.aspx)