Online Returns OSP Event Handler Service

Overview

This repository contains 1 ECS service for Online Returns Service

Online Returns Service - This service is used to communicate with Online Return Android App. This service have four GET endpoint and one POST listed below. This service is mainly used for scanning return products

GET - https://$ENV-api.morrisons.com/ospeventhandler/v1/returns/{locationId}/products?lastupdateddate={datetime}&page={pageNumber}&pageSize={pageSize}
GET - https://$ENV-api.morrisons.com/ospeventhandler/v1/returns/{locationId}/products/@history?page={pageNumber}&pageSize={pageSize}
GET - https://$ENV-api.morrisons.com/ospeventhandler/v1/returns/healthcheck/ping
POST - https://$ENV-api.morrisons.com/ospeventhandler/v1/returns/{locationId}/products/@scanned
GET - https://$ENV-api.morrisons.com/ospeventhandler/v1/returns/stores
GET - https://$ENV-api.morrisons.com/ospeventhandler/v1/returns/validateuser

Above APIs can only be access by authorised users

Accounts Needed

AWS accounts will be required for DEV/SIT/PROD.

References

  1. Python Flask Service with infrastructure as code.

  2. Unit tests & code coverage at about 90%+.

  3. Configuration for multiple environments, DEV/SIT/PRD.

Document

Ref

Architecture Document

Solution Architecture.

Jira Story

Technical Elaboration - SPDP-5529.

Bitbucket repository

storepick-online-returns-osp-event-handler.

Testing Approach

We will be using a BDD approach where the behaviour will be tested first the code will be developed to match the tested behaviour.

Deployment strategy

The deployment is handled by a jenkins multibranch pipeline, https://jenkins.p.morconnect.com/digital/job/storepick-online-returns-osp-event-handler-service/. The commit in the develop branch will automatically deploy the application to the aws environments. The release is done by standard process of tagging the release branch, and by building and deploying from the tags. The tag format is sit-v*-<commit> for nonprod and prd-v*-<commit> for the production release. These tags are manually built on jenkins after the change request has been approved. The release branch is merged to the stable master branch after the successful production deployment.

Backout

To back out we will build off the last release in the master branch and redeploy an old tag version, this shall take around 5 minutes. This will minimise the data loss in case a problem is discovered.

Diagrams

Online Returns service Gives the overview from the Online Returns service which contains Ecstask service.

_images/online_returns.png

Swagger

Swagger for application is found in the docs section of the repository.