@ackee/create-node-app 1.0.1 → 2.0.0

package/starter/{shared → infra/postgresql-knex}/docker-compose/docker-compose.yml

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

package/starter/infra/postgresql-knex/knexfile.ts

@@ -0,0 +1,16 @@
+import { config } from './src/config.js'
+
+module.exports = {
+  client: 'pg',
+  connection: config.db.connectionString,
+  migrations: {
+    directory: './src/db/migrations',
+    stub: './src/db/migration.template.ts',
+    extension: 'ts',
+  },
+  seeds: {
+    directory: './src/db/seeds',
+    stub: './src/db/seed.template.ts',
+    extension: 'ts',
+  },
+}

package/starter/infra/postgresql-knex/node-app.jsonc

@@ -0,0 +1,6 @@
+{
+  "module": "database",
+  "id": "postgres-knex",
+  "name": "PostgreSQL with Knex",
+  "replace": ["docker-compose/docker-compose.yml", ".env.jsonc"]
+}

package/starter/infra/postgresql-knex/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "infra-knex-postgresql",
+  "version": "1.0.0",
+  "description": "PostgreSQL infrastructure with Knex",
+  "main": "index.js",
+  "scripts": {},
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "knex": "^3.1.0",
+    "pg": "^8.13.1"
+  }
+}

package/starter/infra/postgresql-knex/src/adapters/knex.database.test.ts

@@ -0,0 +1,21 @@
+import { knexConnection } from './knex.database.js'
+import { config } from '../config.js'
+import { describe, test } from 'mocha'
+import assert from 'node:assert'
+import { Knex } from 'knex'
+
+describe('knexConnection', () => {
+  test('connects to PostgreSQL and prints version', async () => {
+    let db: Knex | undefined
+
+    await assert.doesNotReject(
+      knexConnection.connect(config.db.connectionString).then(connection => {
+        db = connection
+      })
+    )
+    assert(db)
+    const version = await db.raw('SELECT version()')
+    assert(version.rows.length === 1)
+    await assert.doesNotReject(knexConnection.disconnect(db))
+  })
+})

package/starter/infra/postgresql-knex/src/adapters/knex.database.ts

@@ -0,0 +1,14 @@
+import { DbConnection } from '../domain/ports/database.js'
+import knex, { Knex } from 'knex'
+
+export const knexConnection: DbConnection<Knex> = {
+  connect: async (connectionString: string) => {
+    return knex({
+      client: 'pg',
+      connection: connectionString,
+    })
+  },
+  disconnect: async (db: Knex) => {
+    await db.destroy()
+  },
+}

package/starter/infra/postgresql-knex/src/adapters/repositories/migration.repository.ts

@@ -0,0 +1,24 @@
+import {
+  Migration,
+  MigrationRepository,
+} from '../../domain/ports/repositories/migration.repository.js'
+import { Knex } from 'knex'
+
+const TABLE = 'knex_migrations'
+
+const mapMigrationToDomain = (migration: any): Migration => {
+  return {
+    id: migration.id,
+    name: migration.name,
+    executedAt: migration.migration_time,
+  }
+}
+
+export const createMigrationsRepository: (knex: Knex) => MigrationRepository = (
+  knex: Knex
+) => ({
+  list: async () => {
+    const migrations = await knex.select('*').from(TABLE)
+    return migrations.map(mapMigrationToDomain)
+  },
+})

package/starter/infra/postgresql-knex/src/config.ts

@@ -0,0 +1,14 @@
+import { createLoader, maskedValues, values } from 'configuru'
+
+const loader = createLoader({
+  defaultConfigPath: '.env.jsonc',
+})
+
+const configSchema = {
+  db: {
+    connectionString: loader.string('DB_CONNECTION_STRING'),
+  },
+}
+
+export const config = values(configSchema)
+export const safeConfig = maskedValues(configSchema)

package/starter/infra/postgresql-knex/src/container.ts

@@ -0,0 +1,23 @@
+import { Knex } from 'knex'
+import { knexConnection } from './adapters/knex.database.js'
+import { createMigrationsRepository } from './adapters/repositories/migration.repository.js'
+import { config } from './config.js'
+import { MigrationRepository } from './domain/ports/repositories/migration.repository.js'
+
+export interface Container {
+  database: Knex
+  repositories: {
+    migrations: MigrationRepository
+  }
+}
+
+export const createContainer = async (): Promise<Container> => {
+  const database = await knexConnection.connect(config.db.connectionString)
+
+  return {
+    database,
+    repositories: {
+      migrations: createMigrationsRepository(database),
+    },
+  }
+}

package/starter/infra/postgresql-knex/src/db/migration.template.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex'
+
+export const up = (knex: Knex) => knex
+export const down = () => Promise.resolve(/* no-op */)

package/starter/infra/postgresql-knex/src/db/seed.template.ts

@@ -0,0 +1,3 @@
+import { Knex } from 'knex'
+
+export const seed = (knex: Knex) => knex

package/starter/infra/postgresql-knex/src/domain/ports/database.d.ts

@@ -0,0 +1,4 @@
+export interface DbConnection<Db> {
+  connect: (connectionString: string) => Promise<Db>
+  disconnect: (db: Db) => Promise<void>
+}

package/starter/infra/postgresql-knex/src/domain/ports/repositories/migration.repository.d.ts

@@ -0,0 +1,9 @@
+export interface Migration {
+  id: number
+  name: string
+  executedAt: Date
+}
+
+export interface MigrationRepository {
+  list: () => Promise<Migration[]>
+}

package/starter/infra/postgresql-knex/src/test/setup.ts

@@ -0,0 +1,16 @@
+import { knexConnection } from '../adapters/knex.database.js'
+import { config } from '../config.js'
+import { Knex } from 'knex'
+import { before, after } from 'mocha'
+
+let db: Knex
+
+before(async () => {
+  db = await knexConnection.connect(config.db.connectionString)
+})
+
+after(async () => {
+  if (db) {
+    await knexConnection.disconnect(db)
+  }
+})

package/starter/{shared → pipeline/cloudrun-gitlab}/.gitlab-ci.yml

@@ -1,6 +1,14 @@
+# Define environments in GitLab UI with vars according to the branches for the pipeline
+# ENVIRONMENT={{develpoment/stage/production}}
+# GCP_PROJECT_ID={{PROJECT_NAME}}
+# GCP_REGION={{europe-west3}}
+# GCP_SECRETS_NAME={{PROJECT_NAME}}
+# GCP_SECRETS_VERSION=latest
+# GCP_SA_KEY={{base64 encoded string with SA key to deploy Cloud Run}}
+# GCP_CLOUD_RUN_SA_NAME={{name of the service account for Cloud Run}}
+
 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
@@ -41,11 +49,6 @@ stages:
 # 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"
@@ -167,7 +170,10 @@ build and push to registry:
     - build image
     - npm audit
     - test
+  environment:
+    name: $CI_COMMIT_REF_NAME
   only:
+    - development
     - stage
     - master
 
@@ -193,7 +199,10 @@ deploy cloud run:
         --set-secrets=$SECRETS_PATH="$GCP_SECRETS_NAME:$GCP_SECRETS_VERSION" \
         --set-cloudsql-instances="$GCP_PROJECT_ID:$GCP_REGION:$GCP_SQL_INSTANCE_NAME"
   only:
+    - development
     - stage
     - master
+  environment:
+    name: $CI_COMMIT_REF_NAME
   needs:
     - build and push to registry

package/starter/pipeline/cloudrun-gitlab/node-app.jsonc

@@ -0,0 +1,6 @@
+{
+  "module": "pipeline",
+  "id": "cloudrun-gitlab",
+  "name": "CloudRun for GitLab",
+  "replace": [".gitlab-ci.yml"]
+}