Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hmcts/wa-message-cron-service

A repository for WA Message Cronjob service
https://github.com/hmcts/wa-message-cron-service

jenkins-cft jenkins-cft-j-z

Last synced: about 1 month ago
JSON representation

A repository for WA Message Cronjob service

Awesome Lists containing this project

README 

        
# wa-message-cron-service



## Getting Started



### Prerequisites



Running the application requires the following tools to be installed in your environment:



- [Node.js](https://nodejs.org/) v18.0.0 or later

- [yarn](https://yarnpkg.com/)

- [Docker](https://www.docker.com)



### Running the application



Install dependencies by executing the following command:



```bash

$ yarn install

```



Bundle:



```bash

$ yarn webpack

```



Run:



```bash

$ yarn start

```



The applications's home page will be available at https://localhost:9988



### Running with Docker



Create docker image:



```bash

  docker-compose build

```



Run the application by executing the following command:



```bash

  docker-compose up

```



This will start the frontend container exposing the application's port

(set to `9988` in this template app).



In order to test if the application is up, you can visit https://localhost:9988 in your browser.

You should get a very basic home page (no styles, etc.).



## Developing



### Code style



We use [ESLint](https://github.com/typescript-eslint/typescript-eslint)

alongside [sass-lint](https://github.com/sasstools/sass-lint)



Running the linting with auto fix:



```bash

$ yarn lint --fix

```



### Running Tests



Due to the simplicity of this application, just checking that the application starts successfully is enough

to be confident that it will work. You should see console output similar to the below:



```

1. Ensure wa-case-event-handler service is up. 

    (Its dependent services also need to be up I.e. wa-workflow-api & wa-taskmanagement-service).



2. Set up the following environment variables on your local wa-message-cron-service path terminal.

    export ALLOW_CONFIG_MUTATIONS=true

    export WA_CASE_EVENT_HANDLER_SERVICE_URL=http://localhost:{Specify the wa-case-event-handler service port number here}

    export JOB_NAME=FIND_PROBLEM_MESSAGES



3. The s2s.secret is exclusively read from the config at runtime. For testing the application start-up locally to verify no issues:

    edit s2s-service.ts file & set the s2s.secret to the s2s.secret value in the dev.yaml file. 



4. Execute the following commands and verify the startup is successful as below;

    rm -rf node_modules

    yarn install

    yarn webpack

    yarn start:dev

    $ NODE_ENV=dev nodemon --config nodemon.json

    [nodemon] 3.1.0 // Note: this will be the version of nodemon you have in package.json

    [nodemon] to restart at any time, enter `rs`

    [nodemon] watching path(s): src/main/**/*

    [nodemon] watching extensions: ts,js

    [nodemon] starting `ts-node ./src/main/server.ts`

    ApplicationInsights:APPINSIGHTS_INSTRUMENTATIONKEY is in path of deprecation, please use APPLICATIONINSIGHTS_CONNECTION_STRING env variable to setup the SDK. []

    2022-07-15T11:21:46+01:00 - info: [applicationRunner] Attempting to read properties from volume: '/mnt/secrets/'

    2022-07-15T11:21:46+01:00 - info: [applicationRunner] Could not find properties to load, check your config, you can ignore this if you don't expect any

    Info: [services/case-event-handler-service.ts]: Attempting to create a job for task FIND_PROBLEM_MESSAGES 

    Info: [services/s2s-service.ts]: Attempting to request a S2S token 

    2024-05-13T10:18:59+01:00 - info: [server] Application started: http://localhost:9988

    Info: [services/s2s-service.ts]: Received S2S token 

    Info: [services/case-event-handler-service.ts]: Status: 200 

    Info: [services/case-event-handler-service.ts]: Response: {"jobName":"FIND_PROBLEM_MESSAGES","numberOfMessages":0,"messageIds":[]} 

    Info: [utils/exit.ts]: Job will now exit with code 0 

    [nodemon] clean exit - waiting for changes before restart



```



### Unit test



This template app uses [Jest](https://jestjs.io//) as the test engine. You can run unit tests by executing

the following command:



```bash

$ yarn test

```



Here's how to run functional tests (the template contains just one sample test):



```bash

$ yarn test:routes

```



Running accessibility tests:



```bash

$ yarn test:a11y

```



Make sure all the paths in your application are covered by accessibility tests (see [a11y.ts](src/test/a11y/a11y.ts)).



### Security



#### CSRF prevention



[Cross-Site Request Forgery](https://github.com/pillarjs/understanding-csrf) prevention has already been

set up in this template, at the application level. However, you need to make sure that CSRF token

is present in every HTML form that requires it. For that purpose you can use the `csrfProtection` macro,

included in this template app. Your njk file would look like this:



```

{% from "macros/csrf.njk" import csrfProtection %}

...



  ...

    {{ csrfProtection(csrfToken) }}

  ...



...

```



#### Helmet



This application uses [Helmet](https://helmetjs.github.io/), which adds various security-related HTTP headers

to the responses. Apart from default Helmet functions, following headers are set:



- [Referrer-Policy](https://helmetjs.github.io/docs/referrer-policy/)

- [Content-Security-Policy](https://helmetjs.github.io/docs/csp/)



There is a configuration section related with those headers, where you can specify:



- `referrerPolicy` - value of the `Referrer-Policy` header



Here's an example setup:



```json

    "security": {

      "referrerPolicy": "origin",

    }

```



Make sure you have those values set correctly for your application.



### Healthcheck



The application exposes a health endpoint (https://localhost:9988/health), created with the use of

[Nodejs Healthcheck](https://github.com/hmcts/nodejs-healthcheck) library. This endpoint is defined

in [health.ts](src/main/routes/health.ts) file. Make sure you adjust it correctly in your application.

In particular, remember to replace the sample check with checks specific to your frontend app,

e.g. the ones verifying the state of each service it depends on.



## License



This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details