Products Service
The Products web service provides a RESTful API for retrieving product information. The Web UI makes calls to this service when a user is viewing products and categories and the Personalize workshop connects to this service to retrieve product information for building the items dataset.
When deployed to AWS, CodePipeline is used to build and deploy the Products service as a Docker container in Amazon ECS behind an Application Load Balancer. The Products service can also be run locally in a Docker container. This makes it easier to iterate on and test changes locally before commiting.
Local Development
The Products service can be built and run locally (in Docker) using Docker Compose. See the local development instructions for details. Since the Products service has a dependency on DynamoDB as its datastore, you can either connect to DynamoDB in your AWS account or run DynamoDB locally (default). The docker-compose.yml and template .env (.env.template) is already setup to run DynamoDB locally in Docker. If you want to connect to the real DynamoDB instead, you will need to configure your AWS credentials and comment the DDB_ENDPOINT_OVERRIDE environment variable since it is checked first. From the ../src directory, run the following command to build and deploy the service locally.
foo@bar:~$ docker compose up --build products
Once the container is up and running, you can access it in your browser or with a utility such as Postman at http://localhost:8001.
Alternatively, you can run the Products service directly, although you will need to setup the required environment variables (See the .env.template file mentioned above) and setup DynamoDB locally or through your AWS account.
From the (src/products/src) directory setup a virtual env:
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
FLASK_CONFIG env variable to Development
export FLASK_CONFIG=Development
flask run
python3 wsgi.py
8001, you can change this by setting the FLASK_RUN_PORT environment variable, e.g:
set FLASK_RUN_PORT=xxxx
Initializing the Database
The DynamoDB tables can be created and loaded with sample data by calling the init endpoint:
POST http://localhost:8001/init
Products API
The following entrypoints are supported by the Products service
GET /
Displays the service welcome page.
GET /products/all
Returns details on all products.
GET /products/id/{productIDs}
Returns details on the product(s) identified by {productIDs}. Multiple product IDs can be specified by separating each product ID by a comma. If a single product ID is specified, a single product will be returned. Otherwise, if multiple product IDs are specified, an array of products will be returned.
GET /products/featured
Returns details on all featured products. Featured products are those with featured attribute equal to true.
GET /products/category/{categoryName}
Returns details on all products within the category with the name {categoryName}.
PUT /products/id/{productID}
Updates the product identified by {productID}.
DELETE /products/id/{productID}
Deletes the product identified by {productID}.
POST /products
Creates a new product.
PUT /products/id/{productID}/inventory
Updates the current inventory value for the product identified by {productID}.
GET /categories/all
Returns details on all categories.
GET /categories/id/{categoryID}
Returns details on the category identified by {categoryID}.
Testing
To run integration tests for the Products service a Python virtual environment is required. You must have Python 3.8+ installed on your system to run the commands below. The commands are written to be ran from the test directory of the products service (src/products/test).
The following command will create a virtual environment.
python3 -m venv .venv
Some environment variables are required to run the tests and need to be added to the virtual environment. The example below will work for local development. Change as required depending on environment.
echo '
export PRODUCTS_API_URL="http://localhost:8001"
export TEST_PRODUCT_ID="8bffb5fb-624f-48a8-a99f-b8e9c64bbe29"
export TEST_CATEGORY_NAME="tools"
export TEST_CATEGORY_ID="16"' >> .venv/bin/activate
To activate and enter the virtual environment.
source .venv/bin/activate
To install requirements for the integration tests.
pip install -r integ/requirements.txt
To run the tests.
pytest integ/test-products.py
You can exit the virtual environment with deactivate.
If you want to edit the request bodies for any of the PUT or POST request tests you can do so in json_request_bodies.json