Merge branch 'main' into otel

Author: pamelafox

.devcontainer/devcontainer.json

@@ -54,7 +54,7 @@
 		}
 	},
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "pip install -r requirements-dev.txt && pip install -e src && cp .env.sample .env && python ./src/fastapi_app/setup_postgres_database.py && python ./src/fastapi_app/setup_postgres_seeddata.py",
+	"postCreateCommand": "pip install -r requirements-dev.txt && pip install -e src/backend",
 	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
 }

.env.sample

@@ -13,11 +13,13 @@ OPENAI_EMBED_HOST=azure
 # You also need to `azd auth login` if running this locally
 AZURE_OPENAI_ENDPOINT=https://YOUR-AZURE-OPENAI-SERVICE-NAME.openai.azure.com
 AZURE_OPENAI_VERSION=2024-03-01-preview
-AZURE_OPENAI_CHAT_DEPLOYMENT=chat
+AZURE_OPENAI_CHAT_DEPLOYMENT=gpt-35-turbo
 AZURE_OPENAI_CHAT_MODEL=gpt-35-turbo
-AZURE_OPENAI_EMBED_DEPLOYMENT=embed
+AZURE_OPENAI_EMBED_DEPLOYMENT=text-embedding-ada-002
 AZURE_OPENAI_EMBED_MODEL=text-embedding-ada-002
 AZURE_OPENAI_EMBED_MODEL_DIMENSIONS=1536
+# Only needed when using key-based Azure authentication:
+AZURE_OPENAI_KEY=
 # Needed for OpenAI.com:
 OPENAICOM_KEY=YOUR-OPENAI-API-KEY
 OPENAICOM_CHAT_MODEL=gpt-3.5-turbo

.github/workflows/app-tests.yaml

@@ -5,9 +5,13 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
 
 jobs:
-  test_package:
+  test-package:
     name: Test ${{ matrix.os }} Python ${{ matrix.python_version }}
     runs-on: ${{ matrix.os }}
     strategy:
@@ -51,9 +55,22 @@ jobs:
             python -m pip install -r requirements-dev.txt
         - name: Install app as editable app
           run: |
-            python -m pip install -e src
+            python -m pip install -e src/backend
         - name: Setup local database with seed data
           run: |
             cp .env.sample .env
-            python ./src/fastapi_app/setup_postgres_database.py
-            python ./src/fastapi_app/setup_postgres_seeddata.py
+            python ./src/backend/fastapi_app/setup_postgres_database.py
+            python ./src/backend/fastapi_app/setup_postgres_seeddata.py
+        - name: Setup node
+          uses: actions/setup-node@v4
+          with:
+            node-version: 18
+        - name: Build frontend
+          run: |
+            cd ./src/frontend
+            npm install
+            npm run build
+        - name: Run MyPy
+          run: python3 -m mypy .
+        - name: Run Pytest
+          run: python3 -m pytest

.github/workflows/python-code-quality.yaml

@@ -3,23 +3,34 @@ name: Python code quality
 on:
   push:
     branches: [ main ]
+    paths:
+      - '**.py'
+
   pull_request:
     branches: [ main ]
+    paths:
+      - '**.py'
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
 
 jobs:
-  build:
+  checks-format-and-lint:
     runs-on: ubuntu-latest
     steps:
         - uses: actions/checkout@v4
         - name: Set up Python 3
           uses: actions/setup-python@v5
           with:
             python-version: "3.12"
+            cache: 'pip'
         - name: Install dependencies
           run: |
-            python -m pip install --upgrade pip
-            pip install -r requirements-dev.txt
+            python3 -m pip install --upgrade pip
+            python3 -m pip install ruff
         - name: Lint with ruff
           run: ruff check .
         - name: Check formatting with ruff
-          run: ruff format --check .
+          run: ruff format . --check

README.md

@@ -58,6 +58,7 @@ A related option is VS Code Dev Containers, which will open the project in your
 1. Make sure the following tools are installed:
 
     * [Azure Developer CLI (azd)](https://aka.ms/install-azd)
+    * [Node.js 18+](https://nodejs.org/download/)
     * [Python 3.10+](https://www.python.org/downloads/)
     * [PostgreSQL 14+](https://www.postgresql.org/download/)
     * [pgvector](https://github.com/pgvector/pgvector)
@@ -99,6 +100,8 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
 
     This will create a folder under `.azure/` in your project to store the configuration for this deployment. You may have multiple azd environments if desired.
 
+3. (Optional) If you would like to customize the deployment to [use existing Azure resources](docs/deploy_existing.md), you can set the values now.
+
 3. Provision the resources and deploy the code:
 
     ```shell
@@ -128,24 +131,23 @@ Since the local app uses OpenAI models, you should first deploy it for the optim
 1. Run these commands to install the web app as a local package (named `fastapi_app`), set up the local database, and seed it with test data:
 
     ```bash
-    python3 -m pip install -e src
-    python ./src/fastapi_app/setup_postgres_database.py
-    python ./src/fastapi_app/setup_postgres_seeddata.p
+    python3 -m pip install -e src/backend
+    python ./src/backend/fastapi_app/setup_postgres_database.py
+    python ./src/backend/fastapi_app/setup_postgres_seeddata.py
     ```
 
-    If you opened the project in Codespaces or a Dev Container, these commands will already have been run for you.
-
 2. Build the frontend:
 
     ```bash
     cd src/frontend
     npm install
     npm run build
+    cd ../../
     ```
 
     There must be an initial build of static assets before running the backend, since the backend serves static files from the `src/static` directory.
 
-3. Run the FastAPI backend (with hot reloading):
+3. Run the FastAPI backend (with hot reloading). This should be run from the root of the project:
 
     ```shell
     python3 -m uvicorn fastapi_app:create_app --factory --reload

azure.yaml

@@ -4,20 +4,20 @@ metadata:
     template: rag-postgres-openai-python@0.0.1
 services:
     web:
-        project: ./src
+        project: ./src/backend
         language: py
         module: web
         host: containerapp
         hooks:
-            prepackage:
+            prebuild:
                 windows:
                     shell: pwsh
-                    run:  cd frontend;npm install;npm run build
+                    run:  cd ../frontend;npm install;npm run build
                     interactive: false
                     continueOnError: false
                 posix:
                     shell: sh
-                    run:  cd frontend;npm install;npm run build
+                    run:  cd ../frontend;npm install;npm run build
                     interactive: false
                     continueOnError: false
 hooks:

docs/deploy_existing.md

@@ -0,0 +1,18 @@
+# Deploying with existing Azure resources
+
+If you already have existing Azure resources, or if you want to specify the exact name of new Azure Resource, you can do so by setting `azd` environment values.
+You should set these values before running `azd up`. Once you've set them, return to the [deployment steps](../README.md#deployment).
+
+### Openai.com OpenAI account
+
+1. Run `azd env set DEPLOY_AZURE_OPENAI false`
+1. Run `azd env set OPENAI_CHAT_HOST openaicom`
+2. Run `azd env set OPENAI_EMBED_HOST openaicom`
+3. Run `azd env set OPENAICOM_KEY {Your OpenAI API key}`
+4. Run `azd up`
+
+You can retrieve your OpenAI key by checking [your user page](https://platform.openai.com/account/api-keys).
+Learn more about creating an OpenAI free trial at [this link](https://openai.com/pricing).
+Do *not* check your key into source control.
+
+When you run `azd up` after and are prompted to select a value for `openAiResourceGroupLocation`, you can select any location as it will not be used.

infra/core/host/container-app-upsert.bicep

@@ -75,10 +75,6 @@ param serviceBinds array = []
 @description('The target port for the container')
 param targetPort int = 80
 
-// Service options
-@description('PostgreSQL service ID')
-param postgresServiceId string = ''
-
 resource existingApp 'Microsoft.App/containerApps@2023-05-02-preview' existing = if (exists) {
   name: name
 }
@@ -103,7 +99,6 @@ module app 'container-app.bicep' = {
     daprEnabled: daprEnabled
     daprAppId: daprAppId
     daprAppProtocol: daprAppProtocol
-    postgresServiceId: postgresServiceId
     secrets: secrets
     keyvaultIdentities: keyvaultIdentities
     external: external

infra/core/host/container-app.bicep

@@ -31,10 +31,6 @@ param containerRegistryName string = ''
 @description('Hostname suffix for container registry. Set when deploying to sovereign clouds')
 param containerRegistryHostSuffix string = 'azurecr.io'
 
-// Service options
-@description('PostgreSQL service ID')
-param postgresServiceId string = ''
-
 @description('The protocol used by Dapr to connect to the app, e.g., http or grpc')
 @allowed([ 'http', 'grpc' ])
 param daprAppProtocol string = 'http'
@@ -102,7 +98,7 @@ var keyvaultIdentitySecrets = [for secret in items(keyvaultIdentities): {
   name: secret.key
   keyVaultUrl: secret.value.keyVaultUrl
   identity: secret.value.identity
-}] 
+}]
 
 module containerRegistryAccess '../security/registry-access.bicep' = if (usePrivateRegistry) {
   name: '${deployment().name}-registry-access'
@@ -118,7 +114,7 @@ resource app 'Microsoft.App/containerApps@2023-05-02-preview' = {
   tags: tags
   // It is critical that the identity is granted ACR pull access before the app is created
   // otherwise the container app will throw a provision error
-  // This also forces us to use an user assigned managed identity since there would no way to 
+  // This also forces us to use an user assigned managed identity since there would no way to
   // provide the system assigned identity with the ACR pull access before the app is created
   dependsOn: usePrivateRegistry ? [ containerRegistryAccess ] : []
   identity: {