Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 107 additions & 72 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,77 +1,112 @@
# Deployment migration: see deploy/MIGRATION.md before enabling either environment.
version: 2.1

defaults: &defaults
docker:
- image: cimg/python:3.13.2-browsers

install_dependencies: &install_dependencies
name: Install build and deployment dependencies
command: |
sudo apt-get update
sudo apt-get install -y jq python3-pip
sudo pip3 install awscli --upgrade

install_deploy_suite: &install_deploy_suite
name: Install the Topcoder deployment suite
command: |
git clone --branch v1.4.19 https://github.com/topcoder-platform/tc-deploy-scripts ../buildscript
cp ../buildscript/master_deploy.sh .
cp ../buildscript/buildenv.sh .
cp ../buildscript/awsconfiguration.sh .
cp ../buildscript/psvar-processor.sh .

build_and_deploy_steps: &build_and_deploy_steps
- checkout
- setup_remote_docker
- run: *install_dependencies
- run: *install_deploy_suite
- run:
name: Build the service image
command: docker buildx build --load --no-cache=true -t "${APPNAME}:latest" .
- run:
name: Deploy using the Topcoder deployment suite
command: |
./awsconfiguration.sh "$DEPLOY_ENV"
source awsenvconf
./psvar-processor.sh -t appenv -p "/config/${APPNAME}/deployvar"
source deployvar_env
./master_deploy.sh \
-d ECS \
-e "$DEPLOY_ENV" \
-t latest \
-j "/config/${APPNAME}/appvar,/config/common/global-appvar" \
-i "$APPNAME" \
-p FARGATE

executors:
reviewed:
docker:
- image: cimg/aws@sha256:4cf3768db00ddf9bc439b8c84e8a60c11a14edf81c8baf76f74132144f8340d5
commands:
checkout-source:
steps:
- run:
name: Check out the exact public source commit over HTTPS
command: |
set -euo pipefail
[[ "$CIRCLE_SHA1" =~ ^[0-9a-f]{40}$ ]]
export GIT_CONFIG_NOSYSTEM=1 GIT_CONFIG_GLOBAL=/dev/null GIT_TERMINAL_PROMPT=0
git init --quiet .
git remote add origin https://github.com/topcoder-platform/forums-api-v6.git
git -c credential.helper= fetch --quiet --depth 1 origin "$CIRCLE_SHA1"
git checkout --quiet --detach FETCH_HEAD
test "$(git rev-parse HEAD)" = "$CIRCLE_SHA1"
checkout-suite:
steps:
- run:
name: Verify deployment suite v2.0.6
command: |
set -euo pipefail
git init --quiet /tmp/tc-deploy-scripts
git -C /tmp/tc-deploy-scripts remote add origin https://github.com/topcoder-platform/tc-deploy-scripts.git
git -C /tmp/tc-deploy-scripts fetch --quiet --depth 1 origin refs/tags/v2.0.6
git -C /tmp/tc-deploy-scripts checkout --quiet --detach FETCH_HEAD
test "$(git -C /tmp/tc-deploy-scripts rev-parse HEAD)" = 26aaf607463d4a271c0099854c1731214215a9c5
jobs:
build-dev:
<<: *defaults
build:
executor: reviewed
steps:
- checkout-source
- setup_remote_docker
- checkout-suite
- run:
name: Build committed source without AWS or broker credentials
command: |
set -euo pipefail
python3 -I /tmp/tc-deploy-scripts/build_image.py --dockerfile Dockerfile --image forums-api-v6:candidate
mkdir -p /tmp/release
docker save --output /tmp/release/image.tar forums-api-v6:candidate
no_output_timeout: 30m
- persist_to_workspace:
root: /tmp/release
paths:
- image.tar
deploy:
executor: reviewed
parameters:
environment:
type: enum
enum:
- dev
- prod
environment:
APPNAME: forums-api-v6
DEPLOY_ENV: DEV
DEPLOYMENT_ENVIRONMENT: dev
steps: *build_and_deploy_steps

build-prod:
<<: *defaults
environment:
APPNAME: forums-api-v6
DEPLOY_ENV: PROD
DEPLOYMENT_ENVIRONMENT: prod
steps: *build_and_deploy_steps

DEPLOY_ENV: << parameters.environment >>
steps:
- checkout-source
- setup_remote_docker
- checkout-suite
- attach_workspace:
at: /tmp/release
- run:
name: Promote a scanned digest with repository-bound OIDC
command: |
set +x
set -euo pipefail
test -f "deploy/${DEPLOY_ENV}.json"
docker load --input /tmp/release/image.tar
python3 -I deploy/release.py "deploy/${DEPLOY_ENV}.json"
no_output_timeout: 45m
workflows:
build-and-deploy:
release:
jobs:
- build-dev:
context: org-global
filters:
branches:
only:
- develop
- build-prod:
context: org-global
filters:
branches:
only:
- master
- build
- deploy:
name: deploy-dev
environment: dev
requires:
- build
context: forums-api-v6-dev-deploy
serial-group: << pipeline.project.slug >>/deploy-dev
filters:
branches:
only: develop
tags:
ignore: /.*/
- approve-prod:
type: approval
requires:
- build
filters:
branches:
only: master
tags:
ignore: /.*/
- deploy:
name: deploy-prod
environment: prod
requires:
- approve-prod
context: forums-api-v6-prod-deploy
serial-group: << pipeline.project.slug >>/deploy-prod
filters:
branches:
only: master
tags:
ignore: /.*/
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,7 @@ yarn-error.log*
# temp directory
.temp
.tmp

# Infrastructure definitions and detailed AWS inventories are maintained privately.
/deploy/iam/
/deploy/*-baseline.json
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
26.5.1
26.12.1
35 changes: 26 additions & 9 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,29 +1,41 @@
# syntax=docker/dockerfile:1.7

ARG NODE_VERSION=26.5.1
ARG NODE_VERSION=26.12.1
ARG PNPM_VERSION=11.15.1

FROM node:${NODE_VERSION}-alpine AS external-clients
FROM node:${NODE_VERSION}-alpine3.24@sha256:40cd011b55415bc894e45b02fdd5a5dfde056921b7d23a64c74f80497af48797 AS external-clients

RUN apk upgrade --no-cache \
&& apk add --no-cache ca-certificates git openssh-client

RUN git clone --depth 1 https://github.com/topcoder-platform/challenge-api-v6.git /clients/challenge-api-v6 \
&& git clone --depth 1 https://github.com/topcoder-platform/identity-api-v6.git /clients/identity-api-v6 \
&& git clone --depth 1 https://github.com/topcoder-platform/member-api-v6.git /clients/member-api-v6 \
&& git clone --depth 1 https://github.com/topcoder-platform/resource-api-v6.git /clients/resource-api-v6 \
# Freeze each external generated client at the default-branch revision reviewed
# with this dependency refresh; builds must not silently follow moving HEADs.
RUN for client_spec in \
challenge-api-v6:61636c78e0703c36386838dc7b86876849fe79cf \
identity-api-v6:c7abbb671adbecbc13a969780364e9516e320faf \
member-api-v6:a8014c191e5bd2b7ce1d81620d63436628817ade \
resource-api-v6:f61b88f0f2dc90a9664136b740d8635faa0387fd; do \
client_repo="${client_spec%:*}"; client_revision="${client_spec#*:}"; \
git init -q "/clients/${client_repo}" \
&& git -C "/clients/${client_repo}" remote add origin "https://github.com/topcoder-platform/${client_repo}.git" \
&& git -C "/clients/${client_repo}" fetch --depth 1 origin "${client_revision}" \
&& git -C "/clients/${client_repo}" checkout --detach FETCH_HEAD || exit 1; \
done \
&& identity_client_version="$(node -p "require('/clients/identity-api-v6/packages/identity-prisma-client/package.json').version")" \
&& npm install --prefix /tmp/identity-engines --no-save "@prisma/engines@${identity_client_version}" \
&& cp /tmp/identity-engines/node_modules/@prisma/engines/libquery_engine-linux-musl-openssl-3.0.x.so.node \
/clients/identity-api-v6/packages/identity-prisma-client/

FROM node:${NODE_VERSION}-alpine AS build
FROM node:${NODE_VERSION}-alpine3.24@sha256:40cd011b55415bc894e45b02fdd5a5dfde056921b7d23a64c74f80497af48797 AS build
ARG PNPM_VERSION

RUN apk upgrade --no-cache
WORKDIR /usr/src/app
ENV NODE_PATH=/usr/src/app/node_modules
RUN npm install --global pnpm@${PNPM_VERSION}

COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./
COPY tools ./tools
RUN pnpm install --frozen-lockfile

COPY . .
Expand All @@ -33,16 +45,21 @@ COPY --from=external-clients /clients/member-api-v6/packages/member-prisma-clien
COPY --from=external-clients /clients/resource-api-v6/packages/resources-prisma-client /usr/src/resource-api-v6/packages/resources-prisma-client
RUN DATABASE_URL="postgresql://user:password@localhost:5432/forums" pnpm prisma:generate \
&& pnpm lint \
&& pnpm test --runInBand \
&& pnpm test:dependency-compat \
&& pnpm build \
&& rm -rf node_modules \
&& pnpm install --prod --frozen-lockfile --ignore-scripts \
&& pnpm rebuild @prisma/engines

FROM alpine:3.24 AS production
FROM alpine:3.24@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS production

ARG NODE_VERSION
# Alpine replaces old APK patch versions. Keep the configured Node major while
# accepting maintained patch releases and verify the selected runtime below.
RUN apk upgrade --no-cache \
&& apk add --no-cache nodejs-current=${NODE_VERSION}-r0 \
&& apk add --no-cache "nodejs-current~${NODE_VERSION%%.*}" \
&& test "$(node -p 'process.versions.node.split(".")[0]')" = "${NODE_VERSION%%.*}" \
&& addgroup -S app \
&& adduser -S -D -H -u 10001 -G app app

Expand Down
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ but the `/moderation` endpoints require administrator role access for humans or

## Development

The supported local and container runtime is Node.js 26.5.1 with pnpm 11.15.1.
The supported local and container runtime is Node.js 26.12.1 with pnpm 11.15.1.
The checked-in `.nvmrc` selects the required Node.js release.
The production image installs Alpine's dynamically linked Node.js package and
runs as an unprivileged application user so patched system libraries are used at
Expand Down Expand Up @@ -322,3 +322,50 @@ The forums Prisma schema defines `Topic`, `Post`, `PostReaction`, `TopicClosure`
The production image includes the Prisma schema, migration history, configuration, and CLI. Its startup script runs `prisma migrate deploy` before starting NestJS, so a deployment cannot begin serving requests against an older forums schema. Migration failure stops the container instead of leaving feature-dependent reads or writes partially available.

Topic creation is transactional: it creates the topic, starter post, closure rows, and, for human authors, read-state rows together. General topics also seed an author watch; challenge topics inherit the forum preference. M2M topic creation uses the system author and skips member watch/read-state side effects. Topic deletion is soft deletion, and post deletion preserves the post row while setting content to null for placeholder reads. Topic summary reads use side-effect-free raw queries for topic lock state, visible-post counts, nullable latest visible activity, and unread derivation, then apply centralized forums policy filtering before pagination.

## Shared authentication and bus client (v6 refresh)

This branch uses `tc-core-library-js` **4.0.0-rc.1**. Use its named
`createJwtVerifier` / `createJwtAuthenticator`, `createM2MClient`, and
`createBusApiClient` exports for shared authentication and bus API publishing.
Service-specific roles, scopes, sessions and ownership checks remain in this service.
The former bus wrapper dependency and local JWT cryptography must not be reintroduced.

RSA verification requires an exact configured issuer and audience (`JWT_AUDIENCE`
for client tokens, `AUTH0_AUDIENCE` for machine/API tokens, or this service's explicit
issuer-policy settings). HMAC secrets must be at least 32 bytes; no default secret
is supplied. Expiry is enforced. Machine identity comes from the shared verifier,
not the presence of scopes. Supply real development credentials through the service's
existing environment configuration before deployment.

Bus publishers use `createBusApiClient(config).postEvent(event)` with the existing
event envelope and optional key. Configure `BUSAPI_URL` for v6 and the existing
OAuth credentials/token provider. The client uses bounded HTTPS requests and does
not retry POSTs automatically. Application retry/outbox behavior remains local.

See the [core migration guide](https://github.com/topcoder-platform/tc-core-library-js/blob/v4.0.0-rc.1/MIGRATION.md)
for the API mapping, compatibility requirements, and rollout scope.

## Alpine Node runtime packages

Container stages that install Node through APK constrain `nodejs-current` to the
major version in `NODE_VERSION`, rather than an exact Alpine package revision.
Alpine replaces older patch packages in its repositories; the compatible pin
allows current security patches while a build-time check rejects a different
Node major. The runtime keeps Alpine's dynamically linked Node and system
libraries. Existing non-root users and application entrypoints are preserved.
Build stages using a versioned official Node image retain their configured
version, and pnpm build arguments are explicitly declared in the consuming stage.

## Security dependency checks

The November 2026 update pins the reviewed core library and external Prisma
client revisions, upgrades Prisma to 7.10.1, and patches vulnerable transitive
dependencies. Legacy glob tooling uses the tested adapter in
`tools/minimatch-compat`; run `pnpm test:dependency-compat` after updating it.
Docker builds run lint, unit tests, and compatibility checks.

Run the PostgreSQL integration suites with `TZ=UTC`, matching the container;
the importer compares timestamp-without-time-zone columns in UTC. Provide the
existing `options=-c%20search_path%3Dforums%2Cpublic` URL parameter when testing
raw forum queries against a database whose default search path is `public`.
37 changes: 37 additions & 0 deletions deploy/MIGRATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# OIDC deployment migration

This change replaces the Auth0 credential broker and SSM-to-shell deployment path with [tc-deploy-scripts v2.0.6](https://github.com/topcoder-platform/tc-deploy-scripts/releases/tag/v2.0.6), fetched by tag and verified against commit `26aaf607463d4a271c0099854c1731214215a9c5`. Build and deployment run in separate jobs. The deployer cannot read Parameter Store, Secrets Manager or decrypt KMS data, including through another assumed role. ECS continues resolving the existing runtime secret references using the execution role.

## Production target

The read-only inventory on 2026-11-03 verified account `409275337247`, cluster `tc-forums-serverless`, service `forums-api-v6`, family `forums-api-v6`, and container `forums-api-v6`. `prod.json` preserves the observed task/execution roles and names the proposed service-specific deployment role. [prod-baseline.json](https://github.com/topcoder-platform/v6-services-iac/blob/main/services/forums-api-v6/deploy/prod-baseline.json) records references only; it contains no parameter values. Do not recreate the service or replace its complete task definition from this baseline.

## Installed infrastructure and production cutover

The dev deployment role/boundary, restricted empty CircleCI context, and immutable ECR tags are installed. Existing enhanced scanning is preserved. The production OIDC provider, deployment role/boundary and restricted context are also installed; production runtime and ECR changes remain gated on dev validation. Installation evidence and remaining service-specific steps are private in [PROVISIONING.txt](https://github.com/topcoder-platform/v6-services-iac/blob/main/services/forums-api-v6/deploy/PROVISIONING.txt). Deploy roles have explicit secret-store and KMS-decryption denies. Runtime values are retrieved only by ECS using the execution role.

At production cutover, stop legacy publishers, enable unconditional tag immutability, adopt missing task health checks with the reviewed image, and use the approval-gated `master` workflow. Preserve capacity, roles, secret references and rollback. Do not run production before dev validation.

## Development acceptance

This PR targets `develop`. Administrator-installed dev prerequisites are recorded in the private IaC repository. The reviewed task health check was submitted only after confirming the existing image serves the identical healthy load-balancer endpoint.

- Dev infrastructure prerequisites are installed; merge to run the application deployment, then validate functionality.

Run the shared offline suite, validate the CircleCI config and IAM policies, and test a dev release plus an unhealthy-image rollback. Verify CloudTrail contains no SSM/Secrets Manager calls from the deployment principal. Remove its old broker grants only after migration. Check the runtime secret references and roles stayed unchanged. Production requires the manual approval job and a passing digest/scan/health verification.

The pinned executor is `cimg/aws@sha256:4cf3768db00ddf9bc439b8c84e8a60c11a14edf81c8baf76f74132144f8340d5`. Python/AWS CLI/Buildx/Git compatibility was tested with the shared offline suite. No package installation or service build runs in the deployment job. The Dockerfile retains the existing in-image quality gates. This PR does not deploy, change IAM, rotate credentials, or claim a successful live rollout.

## Infrastructure source

IAM templates and detailed AWS baselines are maintained in the private [v6-services-iac service directory](https://github.com/topcoder-platform/v6-services-iac/tree/main/services/forums-api-v6). Provision infrastructure separately with an administrator identity; application CI does not fetch that repository or install IAM. Required application manifests and health-check proposals remain here.

## Dev branch refresh

This PR targets `develop` and preserves its current application/dependency fixes. The shared suite is v2.0.6 (92 offline tests); service-specific adapters and their tests remain part of review. Use the current readiness record above for the remaining merge/deployment gates. Updating these files does not provision AWS or CircleCI resources.

Source checkout uses the public HTTPS repository and verifies the exact CircleCI commit, avoiding dependency on failing SSH checkout keys. No GitHub token is added to build or deployment contexts.

## Reviewed health-check bootstrap

The release wrapper passes the environment-specific health-check JSON to v2.0.6. A missing check is added with the new scanned image; the old image is not restarted with a new probe. An identical existing check is preserved, and a different existing check stops the release. Role, runtime-secret reference, scan, concurrency and healthy-digest checks remain enforced.
14 changes: 14 additions & 0 deletions deploy/dev-healthcheck.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"forums-api-v6": {
"command": [
"CMD",
"node",
"-e",
"const r=require('node:http').get(\"http://127.0.0.1:3000/v6/forums/health\",r=>{r.resume();process.exit(r.statusCode>=200&&r.statusCode<300?0:1)});r.setTimeout(4000,()=>{r.destroy();process.exit(1)});r.on('error',()=>process.exit(1))"
],
"interval": 30,
"timeout": 5,
"retries": 3,
"startPeriod": 120
}
}
Loading
Loading