@ackee/create-node-app 1.0.0

package/starter/cloudrun-graphql/src/view/controller.ts

@@ -0,0 +1,42 @@
+import express from 'express'
+import { Handler, RequestHandler } from 'express'
+
+/**
+ * pipeMiddleware takes multiple middlewares and creates and merges them into
+ * one using express Router.
+ */
+export const pipeMiddleware = (...middlewares: RequestHandler[]) => {
+  const router = express.Router({ mergeParams: true })
+  middlewares.forEach(m => router.use(m))
+  return router
+}
+
+const asyncHandler =
+  (controllerHandler: Handler): Handler =>
+  async (req, res, next) => {
+    try {
+      await controllerHandler(req, res, next)
+    } catch (err) {
+      next(err)
+    }
+  }
+
+/**
+ * ctrl is a scoped object for controller functions
+ */
+export const ctrl = {
+  json: pipeMiddleware(
+    express.json(),
+    // Monkeypatch res.json to assign the body to res.out first in order
+    // to log it by pino
+    (_req, res, next) => {
+      const resJson = res.json.bind(res)
+      res.json = (body?: any) => {
+        ;(res as any).out = body
+        return resJson(body)
+      }
+      next()
+    }
+  ),
+  asyncHandler,
+}

package/starter/cloudrun-graphql/src/view/graphql/resolvers/greeting.resolver.ts

@@ -0,0 +1,5 @@
+import { QueryResolvers } from '../../../generated/graphql.js'
+
+export const greetingQueryResolver: QueryResolvers = {
+  greeting: () => 'Hello, world! 🎉',
+}

package/starter/cloudrun-graphql/src/view/graphql/resolvers.ts

@@ -0,0 +1,6 @@
+import { Resolvers } from '../../generated/graphql.js'
+import { greetingQueryResolver } from './resolvers/greeting.resolver.js'
+
+export const resolvers: Resolvers = {
+  Query: greetingQueryResolver,
+}

package/starter/cloudrun-graphql/src/view/graphql/schema/schema.graphql

@@ -0,0 +1,6 @@
+"""
+All data queries
+"""
+type Query {
+  greeting: String!
+}

package/starter/cloudrun-graphql/src/view/graphql/schema.ts

@@ -0,0 +1,7 @@
+import { loadFilesSync } from '@graphql-tools/load-files'
+import { mergeTypeDefs } from '@graphql-tools/merge'
+import path from 'path'
+
+export const schema = [
+  mergeTypeDefs(loadFilesSync(path.join(import.meta.dirname, 'schema'))),
+]

package/starter/cloudrun-graphql/src/view/server.ts

@@ -0,0 +1,45 @@
+import { ApolloServer } from '@apollo/server'
+import { makeExecutableSchema } from '@graphql-tools/schema'
+import { resolvers } from './graphql/resolvers.js'
+import { config } from '../config.js'
+import { schema } from './graphql/schema.js'
+import express from 'express'
+import { ctrl } from './controller.js'
+import { expressMiddleware } from '@as-integrations/express5'
+import { Container } from '../container.js'
+
+export const clientSchema = makeExecutableSchema({
+  typeDefs: schema,
+  resolvers,
+})
+
+export const createAppServer = () => {
+  const app = express()
+  app.disable('x-powered-by')
+
+  const server = new ApolloServer({
+    schema: clientSchema,
+    includeStacktraceInErrorResponses: config.server.allowResponseErrors,
+    introspection: config.server.enableIntrospection,
+  })
+
+  return { app, server }
+}
+
+export async function startServer({
+  app,
+  server,
+  container,
+}: ReturnType<typeof createAppServer> & { container: Container }) {
+  const { logger } = container
+
+  await server.start()
+
+  app.use('/api/graphql', ctrl.json, expressMiddleware(server))
+
+  app.listen({ port: config.server.port }, () =>
+    logger.info({}, `Server started, port=${config.server.port}`)
+  )
+
+  return { app, server }
+}

package/starter/shared/.dockerignore

@@ -0,0 +1,19 @@
+.editorconfig
+.git
+.gitignore
+.gitlab
+.gitlab-ci.yml
+.huskyrc.json
+.npm
+Dockerfile
+LICENSE
+README.md
+ci-branch-config
+commitlint.config.js
+dist
+docker-compose
+docs
+docs-output
+helm
+node_modules
+prettier.config.js

package/starter/shared/.gitignore_

@@ -0,0 +1,5 @@
+node_modules
+dist
+tsconfig.tsbuildinfo
+junit.xml
+coverage

package/starter/shared/.gitlab-ci.yml

@@ -0,0 +1,199 @@
+variables:
+  # Default configuration, check .export_variables job for calculated env variables based on branch config
+
+  # Node image for pipeline runner
+  NODE_BASE_IMAGE: node:24.5.0
+  # Where to store json secrets from Cloud provider
+  SECRETS_PATH: '/config/secrets.json'
+
+  ## GCP configuration ##
+  # Where to temporary store Google service account
+  GCP_SA_KEY_JSON_PATH: /tmp/key.json
+
+  ## Docker artifact registry configuration ##
+  # Project name for docker compose CI job runs
+  DOCKER_COMPOSE_PROJECT_NAME: $CI_PROJECT_NAME-job-$CI_JOB_ID
+  # Build docker version tag
+  DOCKER_IMAGE_TAG: $CI_COMMIT_SHORT_SHA
+
+default:
+  image: ackee/gitlab-builder
+  before_script:
+    - echo "//${CI_SERVER_HOST}/api/v4/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=${CI_JOB_TOKEN}" >> .npmrc
+    - echo "//${CI_SERVER_HOST}/api/v4/packages/npm/:_authToken=${CI_JOB_TOKEN}" >> .npmrc;
+
+cache: &docker_cache
+  key: "$CI_COMMIT_REF_NAME"
+  paths:
+    - app_image*.tar
+  policy: pull
+
+stages:
+  - build
+  - test
+  - deploy
+
+##
+#  HELPERS
+##
+# Before script extension that exports ci-branch-config environment variables and stores the GCP service
+# account on the disk to be used by another jobs in the CI. This should be extended by every job that uses
+# any of the branch configuration, docker image or CI SA
+.export_variables:
+  before_script:
+    - source ci-branch-config/common.env
+    - |
+      if [ -f "ci-branch-config/${CI_COMMIT_REF_NAME}.env" ]; then
+        source ci-branch-config/${CI_COMMIT_REF_NAME}.env
+      fi
+    - export DOCKER_REGISTRY_URL="$GCP_REGION-docker.pkg.dev"
+    - export DOCKER_IMAGE_NAME="$DOCKER_REGISTRY_URL/$GCP_PROJECT_ID/${GCP_PROJECT_ID}-docker/$CI_PROJECT_NAME"
+    - export DOCKER_IMAGE_BUILDER_NAME="$DOCKER_IMAGE_NAME-builder"
+    - echo "$GCP_SA_KEY" | base64 -d > "$GCP_SA_KEY_JSON_PATH"
+
+
+# Fetches built docker builder image from remote storage or cache
+.fetch_build_image: &fetch_build_image
+  - |
+    if ! docker inspect --type=image "$DOCKER_IMAGE_BUILDER_NAME:$DOCKER_IMAGE_TAG" >/dev/null; then
+      docker load -i app_image_builder.tar
+    fi
+
+##
+#  BUILD STAGE
+##
+# Builds the builder docker image that can be used for running jobs using the CI docker dependencies and
+# configuration (tests, lint, audit, ...)
+build image:
+  stage: build
+  interruptible: true
+  extends: .export_variables
+  script:
+    - |
+      echo "app_image*" >> .dockerignore
+      docker build --target builder \
+          -t "$DOCKER_IMAGE_BUILDER_NAME:$DOCKER_IMAGE_TAG" .
+    - docker save "$DOCKER_IMAGE_BUILDER_NAME:$DOCKER_IMAGE_TAG" > app_image_builder.tar
+  cache:
+    <<: *docker_cache
+    policy: push
+    when: on_success
+
+##
+#  TEST STAGE
+##
+# Performs npm ci-lint script in builder image.
+# Make sure the ci-lint outputs json file "output/checkstyle-result.json" that reports the result of the linter
+lint:
+  stage: test
+  interruptible: true
+  extends: .export_variables
+  script:
+    - if [ "$SKIP_LINT" == "true" ]; then warn "Lint skipped."; exit 0; fi
+    - *fetch_build_image
+    - cd "$CI_PROJECT_DIR/docker-compose"
+    - |
+      DOCKER_IMAGE_NAME="$DOCKER_IMAGE_BUILDER_NAME" docker-compose -p "$DOCKER_COMPOSE_PROJECT_NAME" \
+        -f docker-compose.yml -f docker-compose.ci.yml \
+        run --rm --no-deps app npm run ci-lint
+  needs:
+    - build image
+  artifacts:
+    reports:
+      codequality: output/checkstyle-result.json
+
+# Npm audit run inside of builder image
+npm audit:
+  stage: test
+  interruptible: true
+  extends: .export_variables
+  script:
+    - if [ "$SKIP_AUDIT" == "true" ]; then warn "Audit skipped."; exit 0; fi
+    - *fetch_build_image
+    - cd "$CI_PROJECT_DIR/docker-compose"
+    - |
+      DOCKER_IMAGE_NAME="$DOCKER_IMAGE_BUILDER_NAME" docker-compose -p "$DOCKER_COMPOSE_PROJECT_NAME" \
+        -f docker-compose.yml -f docker-compose.ci.yml \
+        run --rm --no-deps app npm audit --production --audit-level=high
+  needs:
+    - build image
+
+# Test job running npm ci-test script. Make sure the ci-test script exports two files on disk:
+# output/test.xml - jUnit reporter with test results
+# output/cobertura-coverage.xml - Test coverage results
+test:
+  stage: test
+  interruptible: true
+  extends: .export_variables
+  script:
+    - if [ "$SKIP_TESTS" == "true" ]; then warn "Tests skipped."; exit 0; fi
+    - *fetch_build_image
+    - cd "$CI_PROJECT_DIR/docker-compose"
+    - |
+      DOCKER_IMAGE_NAME="$DOCKER_IMAGE_BUILDER_NAME" \
+      docker-compose -p "$DOCKER_COMPOSE_PROJECT_NAME" \
+      -f docker-compose.yml -f docker-compose.ci.yml \
+      run --rm -e RUN_DOCKER_COMPOSE_DEPS=true -e DB_HOST=postgres app npm run ci-test
+  artifacts:
+    when: always
+    reports:
+      junit: output/test.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: output/cobertura-coverage.xml
+  needs:
+    - build image
+
+##
+#  DEPLOY STAGE
+##
+# Build production image and push to registry
+# Signs in with GCP SA key from pipeline, perform build of the image and pushes it to remote registry
+# Make sure /ci-branch-config-name/{branch} exists when adding new branches to "only" field
+build and push to registry:
+  stage: deploy
+  extends: .export_variables
+  script:
+    - docker login -u _json_key --password-stdin $DOCKER_REGISTRY_URL < "$GCP_SA_KEY_JSON_PATH"
+    - set -a && source ci-branch-config/${CI_COMMIT_REF_NAME}.env && set +a
+    - |
+      docker build \
+        -t "$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG" \
+        $(for var in $(cat ci-branch-config/${CI_COMMIT_REF_NAME}.env | sed 's/=.*//'); do echo "--build-arg $var=${!var} "; done) \
+        --build-arg "SECRETS_PATH=$SECRETS_PATH" \
+        .
+    - docker push "$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG"
+  needs:
+    - build image
+    - npm audit
+    - test
+  only:
+    - stage
+    - master
+
+# Deploy to Google Cloud Run based on image stored on remote registry
+deploy cloud run:
+  stage: deploy
+  image: google/cloud-sdk:slim
+  extends: .export_variables
+  script:
+    - gcloud auth activate-service-account --key-file "$GCP_SA_KEY_JSON_PATH"
+    - gcloud config set project $GCP_PROJECT_ID
+    - gcloud auth configure-docker
+    - |
+      gcloud run deploy wake-arena-project-api \
+        --image "$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG" \
+        --project "$GCP_PROJECT_ID" \
+        --platform managed \
+        --port 3000 \
+        --region "$GCP_REGION" \
+        --allow-unauthenticated \
+        --memory "$GCP_CLOUD_RUN_ALLOCATED_MEMORY" \
+        --service-account="$GCP_CLOUD_RUN_SA_NAME" \
+        --set-secrets=$SECRETS_PATH="$GCP_SECRETS_NAME:$GCP_SECRETS_VERSION" \
+        --set-cloudsql-instances="$GCP_PROJECT_ID:$GCP_REGION:$GCP_SQL_INSTANCE_NAME"
+  only:
+    - stage
+    - master
+  needs:
+    - build and push to registry

package/starter/shared/.mocha-junit-config.json

@@ -0,0 +1,6 @@
+{
+  "reporterEnabled": "spec, mocha-junit-reporter",
+  "mochaJunitReporterReporterOptions": {
+    "mochaFile": "output/test.xml"
+  }
+}

package/starter/shared/.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "extension": ["ts"],
+  "spec": "src/**/*.test.ts",
+  "parallel": false,
+  "enable-source-maps": true,
+  "node-option": ["import=tsx"],
+  "file": ["src/test/setup.ts"]
+}

package/starter/shared/.nvmrc

@@ -0,0 +1 @@
+24.5.0

package/starter/shared/Dockerfile

@@ -0,0 +1,40 @@
+# BUILDER IMAGE
+FROM node:24.5.0 AS builder
+ARG NPM_TOKEN
+ENV NODE_PATH=.
+ENV JOBS="max"
+WORKDIR /usr/src/app
+
+ENV DOCKERIZE_VERSION v0.6.1
+RUN wget -q "https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz" && \
+  tar -C /usr/local/bin -xzvf "dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz" && \
+  rm "dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz"
+
+ENV TINI_VERSION v0.19.0
+RUN wget -q https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini -O /tini && \
+  chmod +x /tini
+
+# important, otherwise postinstall hook fails
+RUN npm set progress=false
+RUN npm set loglevel=error
+# copy all relevant files
+COPY . .
+# RUN echo "//registry.npmjs.org//:_authToken=$NPM_TOKEN" >> .npmrc
+# install dependencies
+RUN npm ci
+# compile typescript
+RUN npm run build
+
+# MAIN IMAGE
+FROM node:24.5.0-slim
+
+ENV NODE_PATH=dist
+ENV CFG_JSON_PATH="/config/secrets.json"
+WORKDIR /usr/src/app
+COPY --from=builder /usr/src/app /usr/src/app
+COPY --from=builder /tini /tini
+COPY --from=builder /usr/local/bin/dockerize /usr/local/bin/dockerize
+EXPOSE 3000
+USER node
+ENTRYPOINT ["/tini", "--", "/usr/local/bin/docker-entrypoint.sh"]
+CMD [ "node", "-r", "source-map-support/register", "dist/index.js"]

package/starter/shared/ci-branch-config/common.env

@@ -0,0 +1,7 @@
+ENVIRONMENT=development
+GCP_PROJECT_ID={{PROJECT_NAME}}-development
+GCP_REGION=europe-west3
+GCP_SECRETS_NAME={{PROJECT_NAME}}-development-config
+GCP_SECRETS_VERSION=latest
+GCP_SA_KEY=$SECRET_GCP_SA_KEY_DEVELOPMENT
+GCP_CLOUD_RUN_SA_NAME=REPLACEME

package/starter/shared/ci-branch-config/development.env

@@ -0,0 +1,7 @@
+ENVIRONMENT=development
+GCP_PROJECT_ID={{PROJECT_NAME}}-development
+GCP_REGION=europe-west3
+GCP_SECRETS_NAME={{PROJECT_NAME}}-development-config
+GCP_SECRETS_VERSION=latest
+GCP_SA_KEY=$SECRET_GCP_SA_KEY_DEVELOPMENT
+GCP_CLOUD_RUN_SA_NAME=REPLACEME

package/starter/shared/ci-branch-config/master.env

@@ -0,0 +1,7 @@
+ENVIRONMENT=production
+GCP_PROJECT_ID={{PROJECT_NAME}}-production
+GCP_REGION=europe-west3
+GCP_SECRETS_NAME={{PROJECT_NAME}}-production-config
+GCP_SECRETS_VERSION=latest
+GCP_SA_KEY=$SECRET_GCP_SA_KEY_PRODUCTION
+GCP_CLOUD_RUN_SA_NAME=REPLACEME

package/starter/shared/ci-branch-config/stage.env

@@ -0,0 +1,7 @@
+ENVIRONMENT=stage
+GCP_PROJECT_ID={{PROJECT_NAME}}-stage
+GCP_REGION=europe-west3
+GCP_SECRETS_NAME={{PROJECT_NAME}}-stage-config
+GCP_SECRETS_VERSION=latest
+GCP_SA_KEY=$SECRET_GCP_SA_KEY_PRODUCTION
+GCP_CLOUD_RUN_SA_NAME=REPLACEME

package/starter/shared/docker-compose/docker-compose-entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+if [ "$RUN_DOCKER_COMPOSE_DEPS" == true ]; then
+  dockerize -wait tcp://postgres:5432 -timeout 5m "$@"
+else
+  exec $@
+fi

package/starter/shared/docker-compose/docker-compose.ci.yml

@@ -0,0 +1,19 @@
+version: '3.8'
+services:
+  app:
+    build:
+      context: ..
+    image: '$DOCKER_IMAGE_NAME:$DOCKER_IMAGE_TAG'
+    user: root
+    depends_on:
+      - postgres
+    volumes:
+      - '$CI_PROJECT_DIR/docs-output:/usr/src/app/docs-output'
+      - '$CI_PROJECT_DIR/output:/usr/src/app/output'
+      - '$CI_PROJECT_DIR/secrets-test.json:/usr/src/app/secrets-test.json:ro'
+      - '$PWD/docker-compose-entrypoint.sh:/docker-entrypoint.sh:ro'
+    entrypoint: /docker-entrypoint.sh
+    environment:
+      - NODE_PATH=.
+      - ENABLE_TESTS=true
+      - CFG_JSON_PATH=secrets-test.json

package/starter/shared/docker-compose/docker-compose.local.yml

@@ -0,0 +1,5 @@
+version: '3.8'
+services:
+  postgres:
+    ports:
+      - 5432:5432

package/starter/shared/docker-compose/docker-compose.override.yml

@@ -0,0 +1,5 @@
+version: '3.8'
+services:
+  postgres:
+    ports:
+      - 5432:5432

package/starter/shared/docker-compose/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3.8'
+services:
+  postgres:
+    image: postgres:15
+    environment:
+      - POSTGRES_DB={{PROJECT_NAME}}_docker
+      - POSTGRES_USER={{PROJECT_NAME}}_docker
+      - POSTGRES_PASSWORD={{PROJECT_NAME}}_docker

package/starter/shared/jest.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  preset: 'ts-jest',
+  roots: ['<rootDir>/src'],
+  transform: {
+    '^.+\\.(t|j)sx?$': 'ts-jest',
+  },
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/src/**/*.test.ts'],
+  collectCoverageFrom: ['<rootDir>/src/app/**/*.(t|j)s'],
+  moduleFileExtensions: ['ts', 'js', 'json', 'node'],
+  modulePaths: ['<rootDir>/src/'],
+}

package/starter/shared/prettier.config.cjs

@@ -0,0 +1 @@
+module.exports = require('@ackee/styleguide-backend-config/prettier')

package/starter/shared/src/test/setup.ts

@@ -0,0 +1 @@
+// Add setup for tests (db connection, ...) if needed

package/starter/shared/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "include": ["src/**/*"],
+  "exclude": ["dangerfile.ts"],
+  "ts-node": {
+    "files": true
+  },
+  "compilerOptions": {
+    "target": "ES2021",
+    "module": "node16",
+    "lib": ["ES2021", "DOM"],
+    "allowJs": true,
+    "incremental": true,
+    "checkJs": true,
+    "sourceMap": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "moduleResolution": "node16",
+    "useUnknownInCatchVariables": false,
+    "esModuleInterop": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "include": ["src/**/*"],
+  "exclude": ["dangerfile.ts"],
+  "compilerOptions": {
+    "target": "ES2021",
+    "module": "node16",
+    "lib": ["ES2021", "DOM"],
+    "allowJs": true,
+    "incremental": true,
+    "checkJs": true,
+    "sourceMap": true,
+    "outDir": "lib",
+    "rootDir": "src",
+    "strict": true,
+    "moduleResolution": "node16",
+    "useUnknownInCatchVariables": false,
+    "esModuleInterop": true
+  }
+}