Use devcontainers for AvaTax app (#1729)

Author: krzysztofzuraw

.devcontainer/avatax/Dockerfile

@@ -0,0 +1,13 @@
+FROM mcr.microsoft.com/devcontainers/typescript-node:22
+
+ENV PNPM_HOME="/home/node/.pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
+WORKDIR /app
+
+# This is needed so pnpm-store volume is created with correct permissions (see docker-compose.yml)
+RUN mkdir -p /app/.pnpm-store
+RUN chown -R node:node /app/.pnpm-store
+
+RUN pnpm install --frozen-lockfile --filter=app-avatax

.devcontainer/avatax/devcontainer.json

@@ -0,0 +1,19 @@
+{
+  "name": "AvaTax app",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "avatax",
+  "workspaceFolder": "/app/apps/avatax",
+  "forwardPorts": [3000, "dynamodb:8000"],
+  "portsAttributes": {
+    "3000": {
+      "label": "AvaTax app"
+    },
+    "dynamodb:8000": {
+      "label": "Local DynamoDB"
+    }
+  },
+  "postCreateCommand": "./scripts/setup-dynamodb.sh",
+  "features": {
+    "ghcr.io/devcontainers/features/aws-cli": {}
+  }
+}

.devcontainer/avatax/docker-compose.yml

@@ -0,0 +1,25 @@
+services:
+  avatax:
+    image: avatax
+    command: sleep infinity # keeps docker container running
+    build:
+      context: ../..
+      dockerfile: .devcontainer/avatax/Dockerfile
+    volumes:
+      - "../..:/app"
+      - "pnpm-store:/app/.pnpm-store"
+
+  dynamodb:
+    image: "amazon/dynamodb-local:latest"
+    ports:
+      - 8000:8000
+    volumes:
+      - "dynamodb-data:/home/dynamodblocal/data"
+    command: "-jar DynamoDBLocal.jar -sharedDb -dbPath /home/dynamodblocal/data"
+    user: root # needed to write to volume
+
+volumes:
+  dynamodb-data:
+    driver: local
+  pnpm-store:
+    driver: local

.gitignore

@@ -4,6 +4,7 @@
 node_modules
 .pnp
 .pnp.js
+.pnpm-store
 
 # testing
 coverage

Dockerfile.avatax.dev

@@ -18,32 +18,51 @@
   <a href="https://twitter.com/getsaleor">🐦 Twitter</a>
 </div>
 
-## Documentation
+## Running app locally in development containers
+
+The easiest way of running Saleor for local development is to use [development containers](https://containers.dev/).
+If you have Visual Studio Code follow their [guide](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container) on how to open existing folder in container.
+
+Development container only creates container, you still need to start the server. See [common-commands](#common-commands) section to learn more.
+
+Development container will have two ports opened:
+
+1. `3000` - were AvaTax app dev server will listen to requests
+2. `8000` - were local DynamoDB will listen to requests and allow [NoSQL Workbench for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/workbench.html) to connect
+
+### Common commands
+
+Running app in development server:
+
+```shell
+pnpm run dev
+```
+
+Running tests:
 
-Visit [AvaTax App documentation](https://docs.saleor.io/docs/3.x/developer/app-store/apps/avatax/overview) to learn how to configure and develop the app locally.
+```shell
+pnpm run test
+```
 
-### DynamoDB
+## DynamoDB
 
-DynamoDB is used to store Client-side logs. To develop this feature locally:
+DynamoDB is used to store Client-side logs. To develop this feature locally use development containers or use [docker-compose](../../.devcontainer/avatax/docker-compose.yml) from `.devcontainer`:
 
 1. Run `docker compose up` for local DynamoDB instance
-2. Run `bash scripts/setup-dynamodb.sh` to describe DynamoDB table
+2. Run `./scripts/setup-dynamodb.sh` to describe DynamoDB table
 
 Ensure following env variables are set
 
 ```dotenv
-FF_ENABLE_EXPERIMENTAL_LOGS=true
 DYNAMODB_LOGS_ITEM_TTL_IN_DAYS=30
 DYNAMODB_LOGS_TABLE_NAME=avatax-client-logs # must match scripts/setup-dynamodb.sh
 ```
 
 Alternatively, you can connect to AWS-based DynamoDB:
 
-1. Create table in your AWS, based on parameters in `scripts/setup-dynamodb.sh`
+1. Create table in your AWS, based on parameters in [`scripts/setup-dynamodb.sh`](./scripts/setup-dynamodb.sh)
 2. Set AWS-specific [env variables](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html)
 
-If `FF_ENABLE_EXPERIMENTAL_LOGS` is not set, you don't have to provide anything - feature will be disabled
-
 ## Testing
 
 ### E2E tests
@@ -119,7 +138,7 @@ PROMO_CODE=
 
 The app has an example environment for `localhost` in `environments/localhost.bru`. You can copy it to bootstrap your own environment e.g `cloud.bru` (which will be ignored by git).
 
-### Webhook migration scripts
+## Webhook migration scripts
 
 > [!NOTE]
 > This section refers to apps hosted by Saleor or using REST APL. If you self host AvaTax app you need to write your own logic for updating migration scripts.
@@ -139,16 +158,6 @@ To start the migration run command:
 pnpm migrate
 ```
 
-### Running the app in docker
-
-To run the app in docker, you need to build the image first (run this command in the root directory of the monorepo):
-
-```shell
-docker build --tag saleor-app-avatax-docker --file Dockerfile.avatax.dev .
-```
-
-Then you can run the image (run this command in the root directory of the monorepo):
+## Documentation
 
-```shell
-docker run -p 3000:3000 --env-file apps/avatax/.env saleor-app-avatax-docker
-```
+Visit [AvaTax App documentation](https://docs.saleor.io/docs/3.x/developer/app-store/apps/avatax/overview) to learn how to configure the app.

apps/avatax/README.md

@@ -1,11 +1,18 @@
 #!/bin/bash
-if ! aws dynamodb describe-table --table-name avatax-client-logs --endpoint-url http://localhost:8000 --region localhost >/dev/null 2>&1; then
-	aws dynamodb create-table --table-name avatax-client-logs \
+set -e
+
+# needed for aws-cli to work with local dynamodb
+aws configure set aws_access_key_id test
+aws configure set aws_secret_access_key test
+aws configure set region localhost
+
+if ! aws dynamodb describe-table --table-name avatax-logs --endpoint-url http://dynamodb:8000 --region localhost >/dev/null 2>&1; then
+	aws dynamodb create-table --table-name avatax-logs \
 		--attribute-definitions AttributeName=PK,AttributeType=S AttributeName=SK,AttributeType=S \
 		--key-schema AttributeName=PK,KeyType=HASH AttributeName=SK,KeyType=RANGE \
 		--provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 \
-		--endpoint-url http://localhost:8000 \
+		--endpoint-url http://dynamodb:8000 \
 		--region localhost
 else
-	echo "Table avatax-client-logs already exists - creation is skipped"
+	echo "Table avatax-logs already exists - creation is skipped"
 fi