Makefile

SHELL := /bin/bash
S3_BUCKET := openai.lawrencemcdaniel.com
CLOUDFRONT_DISTRIBUTION_ID := E3AIBM1KMSJOP1

ifeq ($(OS),Windows_NT)
    PYTHON := python.exe
    ACTIVATE_VENV := venv\Scripts\activate
else
    PYTHON := python3.11
    ACTIVATE_VENV := source venv/bin/activate
endif
PIP := $(PYTHON) -m pip

ifneq ("$(wildcard .env)","")
    include .env
else
    $(shell cp ./doc/example-dot-env .env)
endif

.PHONY: analyze pre-commit api-init api-activate api-lint api-clean api-test client-init client-lint client-update client-run client-build client-release

# Default target executed when no arguments are given to make.
all: help

clean:
	make api-clean
	make client-clean

lint:
	make api-lint
	make client-lint

init:
	make api-init
	make client-init

build:
	make api-build
	make client-build

run:
	make client-run

analyze:
	cloc . --exclude-ext=svg,json,zip --vcs=git

coverage:
	coverage run --source=api/terraform/python/openai_api \
				 -m unittest discover -s api/terraform/python/openai_api/
	coverage report -m
	coverage html

release:
	git commit -m "fix: force a new release" --allow-empty && git push

# -------------------------------------------------------------------------
# Install and run pre-commit hooks
# -------------------------------------------------------------------------
pre-commit:
	pre-commit install
	pre-commit autoupdate
	pre-commit run --all-files

# ---------------------------------------------------------
# create python virtual environments for dev as well
# as for the Lambda layer.
# ---------------------------------------------------------
api-init:
	make api-clean
	npm install && \
	$(PYTHON) -m venv venv && \
	$(ACTIVATE_VENV) && \
	$(PIP) install --upgrade pip && \
	$(PIP) install -r requirements.txt && \
	deactivate && \
	cd ./api/terraform/python/layer_genai/ && \
	$(PYTHON) -m venv venv && \
	$(ACTIVATE_VENV) && \
	$(PIP) install --upgrade pip && \
	$(PIP) install -r requirements.txt && \
	$(PYTHON) -m spacy download en_core_web_sm
	deactivate && \
	pre-commit install

api-build:
	cd ./api/terraform
	terraform init
	terraform apply

api-test:
	python -m unittest discover -s api/terraform/python/openai_api/

api-lint:
	terraform fmt -recursive
	pre-commit run --all-files
	black ./api/terraform/python/
	flake8 api/terraform/python/
	pylint api/terraform/python/openai_api/**/*.py

api-clean:
	rm -rf venv
	rm -rf ./api/terraform/python/layer_genai/venv
	rm -rf ./api/terraform/build/
	mkdir -p ./api/terraform/build/
	find ./api/terraform/python/ -name __pycache__ -type d -exec rm -rf {} +

######################
# React app
######################
client-clean:
	rm -rf node_modules
	rm -rf client/node_modules
	rm -rf client/dist

client-init:
	make client-clean
	npm install
	cd ./client && npm install && npm init @eslint/config

client-lint:
	cd ./client && npm run lint
	# npx prettier --write "src/**/*.{js,cjs,jsx,ts,tsx,json,css,scss,md}"

client-update:
	npm install -g npm
	npm install -g npm-check-updates
	ncu --upgrade --packageFile ./package.json
	ncu --upgrade --packageFile ./client/package.json
	npm update -g
	npm install ./client/

client-run:
	cd ./client && npm run dev

client-build:
	cd ./client && npm run build

client-release:
	#---------------------------------------------------------
	# usage:      deploy prouduction build of the React
	#             app to AWS S3 bucket.
	#
	#             1. Build the React application
	#             2. Upload to AWS S3
	#             3. Invalidate all items in the AWS Cloudfront CDN.
	#---------------------------------------------------------
	npm run build --prefix ./client/

	# ------------------------
	# add all built files to the S3 bucket.
	# ------------------------
	aws s3 sync ./client/dist/ s3://$(S3_BUCKET) \
				--acl public-read \
				--delete --cache-control max-age=31536000,public \
				--expires '31 Dec 2050 00:00:01 GMT'

	# ------------------------
	# remove the cache-control header created above with a "no-cache" header so that browsers never cache this page
	# ------------------------
	aws s3 cp s3://$(S3_BUCKET)/index.html s3://$(S3_BUCKET)/index.html --metadata-directive REPLACE --cache-control max-age=0,no-cache,no-store,must-revalidate --content-type text/html --acl public-read

	# invalidate the Cloudfront cache
	aws cloudfront create-invalidation --distribution-id $(CLOUDFRONT_DISTRIBUTION_ID) --paths "/*" "/index.html"

######################
# HELP
######################

help:
	@echo '===================================================================='
	@echo 'clean               - remove all build, test, coverage and Python artifacts'
	@echo 'lint                - run all code linters and formatters'
	@echo 'init                - create environments for Python, NPM and pre-commit and install dependencies'
	@echo 'build               - create and configure AWS infrastructure resources and build the React app'
	@echo 'run                 - run the web app in development mode'
	@echo 'analyze             - generate code analysis report'
	@echo 'coverage            - generate code coverage analysis report'
	@echo 'release             - force a new release'
	@echo '-- AWS API Gateway + Lambda --'
	@echo 'api-init            - create a Python virtual environment and install dependencies'
	@echo 'api-test            - run Python unit tests'
	@echo 'api-lint            - run Python linting'
	@echo 'api-clean           - destroy the Python virtual environment'
	@echo '-- React App --'
	@echo 'client-clean        - destroy npm environment'
	@echo 'client-init         - run npm install'
	@echo 'client-lint         - run npm lint'
	@echo 'client-update       - update npm packages'
	@echo 'client-run          - run the React app in development mode'
	@echo 'client-build        - build the React app for production'
	@echo 'client-release      - deploy the React app to AWS S3 and invalidate the Cloudfront CDN'