belts-psd-v3

Date 2021/10/29 Updated 2023/10/05

Stores and Retrieves Particle Size Distribution Data for BeltMetrics

API Document

https://apidocs.metricsmanagerstaging.com/belts-psd-v3/

Getting started for developers

1. Copy belt-psd-v3.env from \motionmetrics.net\i2l\Bamboo_Files\MMPro_Env\I2L-Staging and rename it as .env

2. Copy .npmrc from \motionmetrics.net\i2l\Bamboo_Files\MMPro_Env\I2L-Staging

3. Install all the dependencies with the command:

    npm ci

4. Run unit test

    npm test

5. Download the tgz file for the appdynamics library from NAS to the root folder. Make sure that this tgz file is only for local testing, so any code lines related to this must not be committed. (eg: package.json, package-lock.json) If you want to know more for this step, please go to https://bitbucket.org/motionmetricsdev/npm-mmpro-apm/src/master/README.md

    For Windows OS, appdynamics-nodejs-standalone-windows-x64-v16-21.9.0.8019.0.tgz in \\motionmetrics.net\i2l\Bamboo_Files\AppDynamics\Agents\win

    For MacOS or Linux, appdynamics-nodejs-standalone-linux-x64-v16-21.9.0.8019.0.tgz in \\motionmetrics.net\i2l\Bamboo_Files\AppDynamics\Agents\linux

6. Install the appdynamics library from the tgz file downloaded from the earlier step.

    npm install (tgz file name)

7. Verify Segmentation-Service-Python is running locally or as a Docker container at localhost:7199/fmsegmentation/v2/help

   • If it is not set up on your device, follow the installation steps outlined within the segmentation-service-python repository

8. Compile the typescript to javascript and run lint

    npm run-script build

9. Start the program

    npm start

10. Test the program by going to http://localhost:8080/belts/psd/v3/help

Commit Message Format - Angular Convention

(): │ │ │ │ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. │ │ │ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core| │ elements|forms|http|language-service|localize|platform-browser| │ platform-browser-dynamic|platform-server|router|service-worker| │ upgrade|zone.js|packaging|changelog|docs-infra|migrations| │ devtools │ └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test see https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format for more details

Alternatively, you can use the module commitizen to help you format the commit message.

1. install commitizen

    npm install -g commitizen

2. making your repo commitizen-friendly

    commitizen init cz-conventional-changelog --save-dev --save-exact

3. commit your changes Simply use git cz or just cz instead of git commit when committing. You can also use git-cz, which is an alias for cz.

    git add .
    git cz

see https://github.com/commitizen/cz-cli for more details

Versioning and changeLog

semantic-release will be implemented once the node version meets the minimum required version

1. Update the CHANGELOG.md file with the new version and changes

2. Update the version new feature increment the minor version bug fix and typo increment the patch version

    npm version <major|minor|patch>

Running Integration Tests

1. Copy the npm-qc-user-credentials.env from NAS, and save it to the IntegrationTest folder and rename it as .env

2. Repeat Steps in "Getting started for developer" if you haven't done

3. Run the Integration Test:

    npm run-script integration-test

Updating API Doc

1. Grab the belts-psd-v3.json from mm-staging-openapi-definitions S3 bucket in motionmetrics-dev account

2. Update JSON accordingly

3. Ensure metadata is configured correctly under property

{
  Type: User defined,
  Key: x-amz-meta-apidoc-access,
  Value: edit
}

4. Upload the updated JSON to mm-staging-openapi-definitions in motionmetrics-dev account
5. Upload the same JSON to mm-prod-openapi-definitions in motionmetrics-prod account

Note

We are currently using Node LTS v18.13.0