[monorepo] migrate build scripts to Jenkins (#29019)

* [monorepo] migrate build scripts to Jenkins * [fraud-dash] fix integration with monorepo GitOrigin-RevId: 6a30ec5ea68a1eae9b663faf9ccdc741ec7f9cf8
2026-05-23 09:09:36 +02:00 · 2025-10-13 07:59:10 +02:00
parent 9813bc4b51
commit fd0d21fbbd
142 changed files with 3298 additions and 219 deletions
--- a/services/contacts/.mocharc.cjs
+++ b/services/contacts/.mocharc.cjs
@@ -0,0 +1,13 @@
+let reporterOptions = {}
+if (process.env.CI) {
+  reporterOptions = {
+    reporter: '/overleaf/node_modules/mocha-multi-reporters',
+    'reporter-options': ['configFile=./test/mocha-multi-reporters.cjs'],
+  }
+}
+const all = {
+  require: 'test/setup.js',
+  ...reporterOptions,
+}
+
+module.exports = all
--- a/services/contacts/.mocharc.json
+++ b/services/contacts/.mocharc.json
@@ -1,3 +0,0 @@
-{
-  "require": "test/setup.js"
-}
--- a/services/contacts/Dockerfile
+++ b/services/contacts/Dockerfile
@@ -13,12 +13,22 @@ RUN mkdir /home/node/.config && chown node:node /home/node/.config
 FROM base AS app

 COPY package.json package-lock.json /overleaf/
-COPY services/contacts/package.json /overleaf/services/contacts/
-COPY libraries/ /overleaf/libraries/
+COPY libraries/fetch-utils/package.json /overleaf/libraries/fetch-utils/package.json
+COPY libraries/logger/package.json /overleaf/libraries/logger/package.json
+COPY libraries/metrics/package.json /overleaf/libraries/metrics/package.json
+COPY libraries/mongo-utils/package.json /overleaf/libraries/mongo-utils/package.json
+COPY libraries/o-error/package.json /overleaf/libraries/o-error/package.json
+COPY libraries/settings/package.json /overleaf/libraries/settings/package.json
+COPY services/contacts/package.json /overleaf/services/contacts/package.json
 COPY patches/ /overleaf/patches/

 RUN cd /overleaf && npm ci --quiet
-
+COPY libraries/fetch-utils/ /overleaf/libraries/fetch-utils/
+COPY libraries/logger/ /overleaf/libraries/logger/
+COPY libraries/metrics/ /overleaf/libraries/metrics/
+COPY libraries/mongo-utils/ /overleaf/libraries/mongo-utils/
+COPY libraries/o-error/ /overleaf/libraries/o-error/
+COPY libraries/settings/ /overleaf/libraries/settings/
 COPY services/contacts/ /overleaf/services/contacts/

 FROM app
--- a/services/contacts/Jenkinsfile
+++ b/services/contacts/Jenkinsfile
@@ -1,3 +1,5 @@
+// Autogenerated by build scripts. Do not edit.
+
 pipeline {
  agent {
    node {
@@ -7,16 +9,9 @@ pipeline {
  }
  options {
    timestamps()
-    parallelsAlwaysFailFast()
-    retry(3)
    timeout(time: 15, unit: 'MINUTES')
  }
  environment {
-    IMAGE_NAME = 'contacts'
-    PROJECT_NAME = 'contacts'
-    IMAGE_REPO = 'us-east1-docker.pkg.dev/overleaf-ops/ol-docker/contacts'
-    AR_REPO_LOCATION = 'us-east1'
-    AR_URL = 'us-east1-docker.pkg.dev/overleaf-ops/ol-docker'
    BRANCH_NAME = "${env.CHANGE_BRANCH ? env.CHANGE_BRANCH : env.BRANCH_NAME}"
    JENKINS_BUILD_NUMBER = "${BUILD_NUMBER}"
    BUILD_NUMBER = "${SHORT_SHA}_${BUILD_NUMBER}"
@@ -25,61 +20,84 @@ pipeline {
    SHORT_SHA = "${GIT_COMMIT.take(7)}"
  }
  stages {
-    stage ('Build') {
-      steps {
-        dir ('services/contacts') {
-          sh 'make build'
-        }
-      }
-    }
-    stage ('Tests') {
+    stage('Stage 1') {
      parallel {
-        stage ('Push Branch Image') {
+        stage('Build') {
          steps {
-            dir ('services/contacts') {
-              sh 'docker push ${AR_URL}/${IMAGE_NAME}:${BRANCH_NAME}'
+            dir('services/contacts') {
+              retry(count: 3) {
+                sh 'make build'
+              }
            }
          }
        }
-        stage ('Shellcheck') {
+        stage('Create reports folder') {
          steps {
-            dir ('services/contacts') {
+            sh 'mkdir services/contacts/reports'
+          }
+        }
+      }
+    }
+    stage('Stage 2') {
+      parallel {
+        stage('Push Branch Image') {
+          steps {
+            dir('services/contacts') {
+              sh 'make push_branch'
+            }
+          }
+        }
+        stage('Shellcheck') {
+          steps {
+            dir('services/contacts') {
              sh 'make shellcheck'
            }
          }
        }
-        stage ('Lint') {
+        stage('Lint') {
          steps {
-            dir ('services/contacts') {
+            dir('services/contacts') {
              sh 'make lint_ci'
            }
          }
+          post {
+            always {
+              recordIssues checksAnnotationScope: 'ALL', enabledForFailure: true, failOnError: true, id: 'contacts-eslint', name: 'contacts eslint', qualityGates: [[integerThreshold: 1, threshold: 1.0, type: 'TOTAL']], sourceCodeRetention: 'LAST_BUILD', tools: [esLint(pattern: 'services/contacts/reports/eslint.json')]
+            }
+          }
        }
-        stage ('Format') {
+        stage('Format') {
          steps {
-            dir ('services/contacts') {
+            dir('services/contacts') {
              sh 'make format_ci'
            }
          }
        }
-        stage ('Typecheck') {
+        stage('Typecheck') {
          steps {
-            dir ('services/contacts') {
+            dir('services/contacts') {
              sh 'make typecheck_ci'
            }
          }
        }
-        stage ('Test Unit') {
+        stage('Test Unit') {
          steps {
-            dir ('services/contacts') {
-              sh 'make test_unit'
+            dir('services/contacts') {
+              retry(count: 3) {
+                sh 'make test_unit'
+              }
            }
          }
        }
-        stage ('Test Acceptance') {
+        stage('Test Acceptance') {
+          environment {
+            COMPOSE_PROJECT_NAME_TEST_ACCEPTANCE = "test_acceptance"
+          }
          steps {
-            dir ('services/contacts') {
-              sh 'make test_acceptance'
+            dir('services/contacts') {
+              retry(count: 3) {
+                sh 'make test_acceptance'
+              }
            }
          }
        }
@@ -88,12 +106,15 @@ pipeline {
    stage('Push Production') {
      steps {
        dir('services/contacts') {
-          sh 'docker push ${AR_URL}/${IMAGE_NAME}:${BRANCH_NAME}-${BUILD_NUMBER}'
+          sh 'make push'
        }
      }
    }
  }
  post {
+    always {
+      junit checksName: 'contacts test results', testResults: 'services/contacts/reports/junit-*.xml'
+    }
    cleanup {
      dir('services/contacts') {
        sh 'make clean'
--- a/services/contacts/Makefile
+++ b/services/contacts/Makefile
@@ -27,14 +27,15 @@ clean:
 	-docker rmi us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
 	-$(DOCKER_COMPOSE_TEST_UNIT) down --remove-orphans --rmi local --timeout 0 --volumes
 	-$(DOCKER_COMPOSE_TEST_ACCEPTANCE) down --remove-orphans --rmi local --timeout 0 --volumes
+	-rm -rf reports/

 HERE=$(shell pwd)
-MONOREPO=$(shell cd ../../ && pwd)
+export MONOREPO ?= $(shell cd ../../ && pwd)
 # Run the linting commands in the scope of the monorepo.
 # Eslint and prettier (plus some configs) are on the root.
 RUN_LINTING = docker run --rm -v $(MONOREPO):$(MONOREPO) -w $(HERE) node:22.18.0 npm run --silent

-RUN_LINTING_CI = docker run --rm --volume $(MONOREPO)/.editorconfig:/overleaf/.editorconfig --volume $(MONOREPO)/.eslintignore:/overleaf/.eslintignore --volume $(MONOREPO)/.eslintrc:/overleaf/.eslintrc --volume $(MONOREPO)/.prettierignore:/overleaf/.prettierignore --volume $(MONOREPO)/.prettierrc:/overleaf/.prettierrc --volume $(MONOREPO)/tsconfig.backend.json:/overleaf/tsconfig.backend.json ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) npm run --silent
+RUN_LINTING_CI = docker run --rm --volume $(MONOREPO)/.editorconfig:/overleaf/.editorconfig --volume $(MONOREPO)/.eslintignore:/overleaf/.eslintignore --volume $(MONOREPO)/.eslintrc:/overleaf/.eslintrc --volume $(MONOREPO)/.prettierignore:/overleaf/.prettierignore --volume $(MONOREPO)/.prettierrc:/overleaf/.prettierrc --volume $(MONOREPO)/tsconfig.backend.json:/overleaf/tsconfig.backend.json --volume $(MONOREPO)/services/contacts/reports:/overleaf/services/contacts/reports ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) npm run --silent

 # Same but from the top of the monorepo
 RUN_LINTING_MONOREPO = docker run --rm -v $(MONOREPO):$(MONOREPO) -w $(MONOREPO) node:22.18.0 npm run --silent
@@ -70,7 +71,8 @@ lint:
 	$(RUN_LINTING) lint

 lint_ci:
-	$(RUN_LINTING_CI) lint
+	-$(RUN_LINTING_CI) lint -- --format json --output-file reports/eslint.json
+	sed -i 's_"filePath":"/overleaf_"filePath":"$(MONOREPO)_g' reports/eslint.json

 lint_fix:
 	$(RUN_LINTING) lint:fix
@@ -137,10 +139,11 @@ build:
 tar:
 	$(DOCKER_COMPOSE) up tar

-publish:
-
-	docker push $(DOCKER_REPO)/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
+push:
+	docker push us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)

+push_branch:
+	docker push us-east1-docker.pkg.dev/overleaf-ops/ol-docker/$(PROJECT_NAME):$(BRANCH_NAME)

 .PHONY: clean \
 	format format_fix \
--- a/services/contacts/docker-compose.ci.yml
+++ b/services/contacts/docker-compose.ci.yml
@@ -7,10 +7,12 @@ services:
    image: ci/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
    user: node
    volumes:
+      - ./reports:/overleaf/services/contacts/reports
      - ../../bin/shared/wait_for_it:/overleaf/bin/shared/wait_for_it
    entrypoint: /overleaf/bin/shared/wait_for_it mongo:27017 --timeout=60 --
    command: npm run test:unit:_run
    environment:
+      CI:
      MONGO_CONNECTION_STRING: mongodb://mongo/test-overleaf
      NODE_ENV: test
      NODE_OPTIONS: "--unhandled-rejections=strict"
@@ -23,6 +25,7 @@ services:
    build: .
    image: ci/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
    environment:
+      CI:
      ELASTIC_SEARCH_DSN: es:9200
      MONGO_HOST: mongo
      POSTGRES_HOST: postgres
@@ -30,6 +33,7 @@ services:
      NODE_ENV: test
      NODE_OPTIONS: "--unhandled-rejections=strict"
    volumes:
+      - ./reports:/overleaf/services/contacts/reports
      - ../../bin/shared/wait_for_it:/overleaf/bin/shared/wait_for_it
    depends_on:
      mongo:
--- a/services/contacts/package.json
+++ b/services/contacts/package.json
@@ -6,9 +6,9 @@
  "main": "app.js",
  "scripts": {
    "start": "node app.js",
-    "test:acceptance:_run": "mocha --loader=esmock --recursive --reporter spec --timeout 15000 --exit $@ test/acceptance/js",
+    "test:acceptance:_run": "mocha --loader=esmock --recursive --timeout 15000 --exit $@ test/acceptance/js",
    "test:acceptance": "npm run test:acceptance:_run -- --grep=$MOCHA_GREP",
-    "test:unit:_run": "mocha --loader=esmock --recursive --reporter spec --exit $@ test/unit/js",
+    "test:unit:_run": "mocha --loader=esmock --recursive --exit $@ test/unit/js",
    "test:unit": "npm run test:unit:_run -- --grep=$MOCHA_GREP",
    "nodemon": "node --watch app.js",
    "lint": "eslint --max-warnings 0 --format unix .",
@@ -35,6 +35,8 @@
    "chai-as-promised": "^7.1.1",
    "esmock": "^2.6.3",
    "mocha": "^11.1.0",
+    "mocha-junit-reporter": "^2.2.1",
+    "mocha-multi-reporters": "^1.5.1",
    "sinon": "~9.0.1",
    "sinon-chai": "^3.7.0",
    "typescript": "^5.0.4"
--- a/services/contacts/test/mocha-multi-reporters.cjs
+++ b/services/contacts/test/mocha-multi-reporters.cjs
@@ -0,0 +1,8 @@
+module.exports = {
+  reporterEnabled: 'spec, mocha-junit-reporter',
+  mochaJunitReporterReporterOptions: {
+    mochaFile: `reports/junit-mocha-${process.env.MOCHA_GREP}.xml`,
+    includePending: true,
+    jenkinsMode: true,
+  },
+}