Merge pull request #26 from desci-labs/develop

promote main dpid resolver

.dockerignore

@@ -1,3 +1,10 @@
+.git
+.gitignore
+.husky
 .env
+.github/
+.vscode/
 dist/
-node_modules/
+test/
+kubernetes/
+node_modules/

.env.example

@@ -1,4 +1,37 @@
 PORT=5460
 SUPABASE_URL=
 SUPABASE_KEY=
-DPID_ENV=dev
+
+# Set these to run with a local redis instance, outside of the backend cluster
+# REDIS_HOST=localhost
+# REDIS_PORT=6379
+# Short TTL's for tinkering with history loading
+# CACHE_TTL_ANCHORED=60
+# CACHE_TTL_PENDING=10
+
+# If set to 1, the `/*` route will use the legacy handler
+FALLBACK_RESOLVER=0
+
+# Local
+# DPID_ENV=local # TODO, app prob doesn't like this yet
+# OPTIMISM_RPC_URL=http://localhost:8545
+# CERAMIC_URL=https://localhost:7007
+# IPFS_GATEWAY=http://localhost:8089/ipfs
+
+# Dev & staging
+DPID_ENV=dev
+OPTIMISM_RPC_URL=https://reverse-proxy-dev.desci.com/rpc_opt_sepolia
+CERAMIC_URL=https://ceramic-dev.desci.com
+IPFS_GATEWAY=https://ipfs.desci.com/ipfs
+
+# Staging
+# DPID_ENV=staging
+# OPTIMISM_RPC_URL=https://reverse-proxy-staging.desci.com/rpc_opt_sepolia
+# CERAMIC_URL=https://ceramic-prod.desci.com
+# IPFS_GATEWAY=https://ipfs.desci.com/ipfs
+
+# Prod
+# DPID_ENV=production
+# OPTIMISM_RPC_URL=https://reverse-proxy-prod.desci.com/rpc_opt_sepolia
+# CERAMIC_URL=https://ceramic-prod.desci.com
+# IPFS_GATEWAY=https://ipfs.desci.com/ipfs

.env.test

@@ -0,0 +1,8 @@
+# Tests run code generating destination URLs using these variables, which
+# would work locally too, but the code actually resolving manifest components
+# or drive files does not as they rely on content of dpid 46 being pinned
+
+DPID_ENV=dev
+IPFS_GATEWAY=https://ipfs.desci.com/ipfs
+OPTIMISM_RPC_URL=https://reverse-proxy-dev.desci.com/rpc_opt_sepolia
+CERAMIC_URL=https://ceramic-dev.desci.com

.github/workflows/build-dpid-resolver.yaml

@@ -1,12 +1,9 @@
-# build.yml
 on:
     push:
         branches: # array of glob patterns matching against refs/heads. Optional; defaults to all
             - main # triggers on pushes that contain changes
             - develop
 
-name: Build dpid-resolver
-
 # https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html
 env:
     AWS_DEFAULT_REGION: us-east-2
@@ -24,22 +21,21 @@ jobs:
         timeout-minutes: 10
         steps:
             - name: Prepare testing env
-              uses: actions/checkout@v2
-            - uses: actions/setup-node@v2
+              uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               with:
-                  node-version: "18"
+                  node-version-file: ".nvmrc"
+                  check-latest: false
+                  cache: npm
             - run: npm ci
-            - name: Run tests
-              run: npm run test
+            - run: npm run test
     build-and-push:
         name: Build and deploy
         runs-on: ubuntu-latest
-        # needs: test
         timeout-minutes: 10
         steps:
             - uses: hashicorp/setup-terraform@v1
-            - name: Checkout
-              uses: actions/checkout@master
+            - uses: actions/checkout@v4
 
             # Add steps here like linting, testing, minification, etc.
             - id: install-aws-cli
@@ -70,6 +66,7 @@ jobs:
               run: |
                   # Build and tag the image
                   docker build \
+                    --build-arg NODE_VERSION=$(< .nvmrc) \
                     -t $CONTAINER_IMAGE-dev:latest \
                     -t $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$CONTAINER_IMAGE-dev \
                       .
@@ -79,6 +76,7 @@ jobs:
               run: |
                   # Build and tag the image
                   docker build \
+                    --build-arg NODE_VERSION=$(< .nvmrc) \
                     -t $CONTAINER_IMAGE:latest \
                     -t $AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$CONTAINER_IMAGE \
                       .
@@ -110,11 +108,13 @@ jobs:
               # uses: steebchen/kubectl@v2.0.0
               if: github.ref == 'refs/heads/develop'
               run: | # defaults to latest kubectl binary version
+                  kubectl apply -f kubernetes/deployment.dev.yaml
                   kubectl set image deployment/dpid-resolver-dev dpid-resolver-dev=$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$CONTAINER_IMAGE-dev:${{ github.sha }} --record
 
             - name: Deploy to EKS (PROD)
               if: github.ref == 'refs/heads/main'
               run: | # defaults to latest kubectl binary version
+                  kubectl apply -f kubernetes/deployment.prod.yaml
                   kubectl set image deployment/dpid-resolver dpid-resolver=$AWS_ACCOUNT_ID.dkr.ecr.$AWS_DEFAULT_REGION.amazonaws.com/$CONTAINER_IMAGE:${{ github.sha }} --record
 
             - name: Verify EKS Deployment (DEV)

.github/workflows/pr.yaml

@@ -0,0 +1,18 @@
+on:
+  pull_request
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          check-latest: false
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm run test

.husky/post-merge

@@ -0,0 +1 @@
+bash sanityCheckEnv.sh

.nvmrc

@@ -1 +1 @@
-18
+20.13.1

Dockerfile

@@ -1,10 +1,25 @@
-FROM node:16.17.0
+ARG NODE_VERSION
+FROM node:${NODE_VERSION}-alpine3.20 AS base
+RUN apk update && apk add --no-cache bash dumb-init
+
 WORKDIR /usr/src/app
-COPY . ./
-RUN npm install -g npm@9.5.1
-RUN npm ci --ignore-scripts
-EXPOSE 5460
-COPY .env.example .env
+COPY package*.json ./
+
+FROM base AS builder
+
+RUN --mount=type=cache,target=/usr/src/app/.npm \
+  npm set cache /usr/src/app/.npm && \
+  npm ci
+COPY . .
 RUN npm run build
-RUN apt-get install -y bash
-CMD [ "npm", "run", "start" ]
+
+FROM base AS prod
+
+COPY --chown=node:node --from=builder /usr/src/app/dist dist/
+COPY --chown=node:node --from=builder /usr/src/app/node_modules node_modules/
+COPY --chown=node:node --from=builder /usr/src/app/.env.example .env
+
+USER node
+EXPOSE 5460
+
+CMD [ "dumb-init", "node", "--no-warnings=ExperimentalWarning", "dist/index.js" ]

kubernetes/deployment.dev.yaml

@@ -25,11 +25,20 @@ spec:
                 vault.hashicorp.com/agent-inject-template-config: |
                     {{- with secret "secrets/dpid-resolver/dev" -}}
                     echo "appstart"; 
-                    export NODE_ENV=production
-                    export ENV=dev
+                    export NODE_ENV={{ .Data.NODE_ENV }}
                     export SUPABASE_URL={{ .Data.SUPABASE_URL }}
                     export SUPABASE_KEY={{ .Data.SUPABASE_KEY }}
-                    export DEBUG_TEST=0;
+
+                    export DPID_ENV={{ .Data.DPID_ENV }}
+                    export IPFS_GATEWAY={{ .Data.IPFS_GATEWAY}}
+                    export OPTIMISM_RPC_URL={{ .Data.OPTIMISM_RPC_URL }}
+                    export CERAMIC_URL={{ .Data.CERAMIC_URL }}
+                    export FALLBACK_RESOLVER={{ .Data.FALLBACK_RESOLVER }}
+
+                    export REDIS_HOST={{ .Data.REDIS_HOST }}
+                    export REDIS_PORT={{ .Data.REDIS_PORT }}
+                    export CACHE_TTL_ANCHORED={{ .Data.CACHE_TTL_ANCHORED }}
+                    export CACHE_TTL_PENDING={{ .Data.CACHE_TTL_PENDING }}
                     echo "loaded"
                     {{- end -}}
             labels:
@@ -40,7 +49,7 @@ spec:
                   name: dpid-resolver-dev
                   command: ["/bin/bash", "-c"]
                   args:
-                      - echo "SOURCING ENV"; source /vault/secrets/config; NODE_PATH=./dist node ./dist/index.js;
+                      - echo "SOURCING ENV"; source /vault/secrets/config; dumb-init node ./dist/index.js;
                   ports:
                       - containerPort: 5460
                   resources:

kubernetes/deployment.prod.yaml

@@ -21,15 +21,24 @@ spec:
                 vault.hashicorp.com/agent-inject: "true"
                 vault.hashicorp.com/agent-inject-status: "update"
                 vault.hashicorp.com/role: app-vault-reader
-                vault.hashicorp.com/agent-inject-secret-config: secrets/dpid-resolver/dev
+                vault.hashicorp.com/agent-inject-secret-config: secrets/dpid-resolver/production
                 vault.hashicorp.com/agent-inject-template-config: |
-                    {{- with secret "secrets/dpid-resolver/dev" -}}
+                    {{- with secret "secrets/dpid-resolver/production" -}}
                     echo "appstart"; 
-                    export NODE_ENV=production
-                    export DPID_ENV=production
+                    export NODE_ENV={{ .Data.NODE_ENV }}
                     export SUPABASE_URL={{ .Data.SUPABASE_URL }}
                     export SUPABASE_KEY={{ .Data.SUPABASE_KEY }}
-                    export DEBUG_TEST=0;
+
+                    export DPID_ENV={{ .Data.DPID_ENV }}
+                    export IPFS_GATEWAY={{ .Data.IPFS_GATEWAY}}
+                    export OPTIMISM_RPC_URL={{ .Data.OPTIMISM_RPC_URL }}
+                    export CERAMIC_URL={{ .Data.CERAMIC_URL }}
+                    export FALLBACK_RESOLVER={{ .Data.FALLBACK_RESOLVER }}
+
+                    export REDIS_HOST={{ .Data.REDIS_HOST }}
+                    export REDIS_PORT={{ .Data.REDIS_PORT }}
+                    export CACHE_TTL_ANCHORED={{ .Data.CACHE_TTL_ANCHORED }}
+                    export CACHE_TTL_PENDING={{ .Data.CACHE_TTL_PENDING }}
                     echo "loaded"
                     {{- end -}}
             labels:
@@ -40,7 +49,7 @@ spec:
                   name: dpid-resolver
                   command: ["/bin/bash", "-c"]
                   args:
-                      - echo "SOURCING ENV"; source /vault/secrets/config; NODE_PATH=./dist node ./dist/index.js;
+                      - echo "SOURCING ENV"; source /vault/secrets/config; dumb-init node ./dist/index.js;
                   ports:
                       - containerPort: 5460
                   resources:

kubernetes/deployment.staging.yaml

@@ -57,16 +57,24 @@ spec:
                 vault.hashicorp.com/agent-inject: "true"
                 vault.hashicorp.com/agent-inject-status: "update"
                 vault.hashicorp.com/role: app-vault-reader
-                vault.hashicorp.com/agent-inject-secret-config: secrets/dpid-resolver/dev
+                vault.hashicorp.com/agent-inject-secret-config: secrets/dpid-resolver/staging
                 vault.hashicorp.com/agent-inject-template-config: |
-                    {{- with secret "secrets/dpid-resolver/dev" -}}
+                    {{- with secret "secrets/dpid-resolver/staging" -}}
                     echo "appstart"; 
-                    export NODE_ENV=production
-                    export ENV=staging
-                    export DPID_ENV=staging
+                    export NODE_ENV={{ .Data.NODE_ENV }}
                     export SUPABASE_URL={{ .Data.SUPABASE_URL }}
                     export SUPABASE_KEY={{ .Data.SUPABASE_KEY }}
-                    export DEBUG_TEST=0;
+                    
+                    export DPID_ENV={{ .Data.DPID_ENV }}
+                    export IPFS_GATEWAY={{ .Data.IPFS_GATEWAY }}
+                    export OPTIMISM_RPC_URL={{ .Data.OPTIMISM_RPC_URL }}
+                    export CERAMIC_URL={{ .Data.CERAMIC_URL }}
+                    export FALLBACK_RESOLVER={{ .Data.FALLBACK_RESOLVER }}
+
+                    export REDIS_HOST={{ .Data.REDIS_HOST }}
+                    export REDIS_PORT={{ .Data.REDIS_PORT }}
+                    export CACHE_TTL_ANCHORED={{ .Data.CACHE_TTL_ANCHORED }}
+                    export CACHE_TTL_PENDING={{ .Data.CACHE_TTL_PENDING }}
                     echo "loaded"
                     {{- end -}}
             labels:
@@ -77,7 +85,7 @@ spec:
                   name: dpid-resolver-staging
                   command: ["/bin/bash", "-c"]
                   args:
-                      - echo "SOURCING ENV"; source /vault/secrets/config; NODE_PATH=./dist node ./dist/index.js;
+                      - echo "SOURCING ENV"; source /vault/secrets/config; dumb-init node ./dist/index.js;
                   ports:
                       - containerPort: 5460
                   resources: