adjust version checking + enable telemetry integration tests + bump version to v3.1.8

will pankiewicz · will pankiewicz · commit b886d95fdd35 · 2024-03-20T14:55:31.000+01:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -137,6 +137,25 @@ jobs:
             export MONGO_URI="mongodb://mongodb:27017/testdb"
             yarn workspace @1kv/common test:scorekeeper:int
 
+  TelemetryIntegrationTests:
+    description: "Telemetry Integration Tests"
+    docker:
+      - image: node:18-bullseye
+      - image: mongo:6.0.9
+        name: mongodb
+
+    resource_class: xlarge
+    steps:
+      - checkout
+      - run:
+          name: Install Dependencies
+          command: yarn install --immutable
+      - run:
+          name: Run Tests
+          command: |
+            export MONGO_URI="mongodb://mongodb:27017/testdb"
+            yarn workspace @1kv/telemetry test:int
+
   helmLint:
     docker:
       - image: web3f/ci-commons:v3.2.3
@@ -296,26 +315,26 @@ workflows:
           filters:
             tags:
               ignore: /.*/
-
       - ChaindataIntegrationTests:
           filters:
             tags:
               ignore: /.*/
-
       - ApiHandlerIntegrationTests:
           filters:
             tags:
               ignore: /.*/
-
       - NominatorIntegrationTests:
           filters:
             tags:
               ignore: /.*/
-
       - ScorekeeperIntegrationTests:
           filters:
             tags:
               ignore: /.*/
+      - TelemetryIntegrationTests:
+          filters:
+            tags:
+              ignore: /.*/
       - helmLint:
           filters:
             tags:
diff --git a/.gitignore b/.gitignore
@@ -41,4 +41,5 @@ docs/.DS_Store
 .turbo
 build/**
 dist/**
-.next/**
+.next/**
+coverage/**
diff --git a/apps/1kv-backend-staging/templates/kusama-otv-backend.yaml b/apps/1kv-backend-staging/templates/kusama-otv-backend.yaml
@@ -57,7 +57,6 @@ spec:
                   "skipConnectionTime": true,
                   "skipIdentity": false,
                   "skipClientUpgrade": false,
-                  "forceClientVersion": "v0.9.39",
                   "skipUnclaimed": true,
                   "minSelfStake": 10000000000000,
                   "commission": 150000000,
diff --git a/apps/1kv-backend-staging/templates/polkadot-otv-backend.yaml b/apps/1kv-backend-staging/templates/polkadot-otv-backend.yaml
@@ -56,7 +56,6 @@ spec:
                   "skipConnectionTime": false,
                   "skipIdentity": false,
                   "skipClientUpgrade": false,
-                  "forceClientVersion": "v0.9.39",
                   "skipUnclaimed": true,
                   "minSelfStake": 50000000000000,
                   "commission": 50000000,
diff --git a/apps/1kv-backend/templates/kusama-otv-backend.yaml b/apps/1kv-backend/templates/kusama-otv-backend.yaml
@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.1.7
+    targetRevision: v3.1.8
     plugin:
       env:
         - name: HELM_VALUES
@@ -55,7 +55,6 @@ spec:
                   "skipIdentity": false,
                   "skipStakedDestination": true,
                   "skipClientUpgrade": false,
-                  "forceClientVersion": "v0.9.39",
                   "skipUnclaimed": true,
                   "minSelfStake": 10000000000000,
                   "commission": 150000000,
diff --git a/apps/1kv-backend/templates/polkadot-otv-backend.yaml b/apps/1kv-backend/templates/polkadot-otv-backend.yaml
@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.1.7
+    targetRevision: v3.1.8
     plugin:
       env:
         - name: HELM_VALUES
@@ -54,7 +54,6 @@ spec:
                   "skipIdentity": false,
                   "skipStakedDestination": true,
                   "skipClientUpgrade": false,
-                  "forceClientVersion": "v0.9.39",
                   "skipUnclaimed": true,
                   "minSelfStake": 50000000000000,
                   "commission": 50000000,
diff --git a/charts/otv-backend/Chart.yaml b/charts/otv-backend/Chart.yaml
@@ -1,5 +1,5 @@
 description: 1K Validators Backend
 name: otv-backend
-version: v3.1.7
-appVersion: v3.1.7
+version: v3.1.8
+appVersion: v3.1.8
 apiVersion: v2
diff --git a/package.json b/package.json
@@ -64,6 +64,8 @@
     "test:common:int:apihandler:ci": "circleci local execute ApiHandlerIntegrationTests",
     "test:common:int:nominator:ci": "circleci local execute NominatorIntegrationTests",
     "test:common:int:ci": "yarn test:common:int:scorekeeper:ci && yarn test:common:int:chaindata:ci && yarn test:common:int:apihandler:ci && yarn test:common:int:nominator:ci",
+    "test:telemetry:int:ci": "circleci local execute TelemetryIntegrationTests",
+    "test:ci:all": "yarn test:common:int:ci && yarn test:telemetry:int:ci",
     "test:all": "yarn workspaces foreach run test",
     "test": "LOG_LEVEL=warn yarn build && vitest run --coverage --config vitest.config.mts",
     "test:ui": "LOG_LEVEL=warn vitest --ui --config vitest.config.mts --coverage",
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@1kv/common",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "description": "Services for running the Thousand Validator Program.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
diff --git a/packages/common/src/constraints/ValidityChecks.ts b/packages/common/src/constraints/ValidityChecks.ts
@@ -21,6 +21,7 @@ import axios from "axios";
 import semver from "semver";
 import logger from "../logger";
 import { constraintsLabel } from "./constraints";
+import { getLatestTaggedRelease } from "../scorekeeper/jobs/specificJobs";
 
 export const checkOnline = async (candidate: any): Promise<boolean> => {
   try {
@@ -89,43 +90,66 @@ export const checkLatestClientVersion = async (
 ): Promise<boolean> => {
   try {
     const skipClientUpgrade = config.constraints?.skipClientUpgrade || false;
-    if (!skipClientUpgrade) {
-      if (candidate?.implementation == "Kagome Node") {
-        await setLatestClientReleaseValidity(candidate.stash, true);
-        return true;
+    if (skipClientUpgrade || candidate?.implementation === "Kagome Node") {
+      // Skip the check if the node is a Kagome Client or if skipping client upgrade is enabled
+      await setLatestClientReleaseValidity(candidate.stash, true);
+      return true;
+    }
+
+    // The latest release that is manually set in the config (set if there's reasons for people to downgrade)
+    const forceLatestRelease = config.constraints.forceClientVersion;
+
+    // Get the latest release from the db or github
+    let latestRelease = await getLatestRelease();
+    if (!latestRelease) {
+      logger.info(
+        `No latest release found, fetching from GitHub`,
+        constraintsLabel,
+      );
+      latestRelease = await getLatestTaggedRelease();
+      logger.info(
+        `Latest release fetched from GitHub: ${latestRelease}`,
+        constraintsLabel,
+      );
+    }
+
+    // Check if there is a latest release and if the current time is past the grace window
+    const isPastGraceWindow =
+      latestRelease &&
+      Date.now() > latestRelease.publishedAt + Constants.SIXTEEN_HOURS;
+
+    if (latestRelease && isPastGraceWindow) {
+      const nodeVersion = semver.coerce(candidate.version);
+      const latestVersion = forceLatestRelease
+        ? semver.clean(forceLatestRelease)
+        : semver.clean(latestRelease.name);
+
+      logger.info(
+        `Checking latest client version: ${nodeVersion} >= ${latestVersion}`,
+        constraintsLabel,
+      );
+
+      // If cannot parse the version, set the release as invalid
+      if (!nodeVersion || !latestVersion) {
+        await setLatestClientReleaseValidity(candidate.stash, false);
+        return false;
       }
 
-      const forceLatestRelease = config.constraints.forceClientVersion;
-      const latestRelease = await getLatestRelease();
-      if (
-        candidate.version &&
-        latestRelease &&
-        Date.now() > latestRelease.publishedAt + Constants.SIXTEEN_HOURS
-      ) {
-        const nodeVersion = semver.coerce(candidate.version);
-        const latestVersion = forceLatestRelease
-          ? semver.clean(forceLatestRelease)
-          : semver.clean(latestRelease.name);
-        if (!nodeVersion || !latestVersion) {
-          await setLatestClientReleaseValidity(candidate.stash, false);
-          return false;
-        }
+      const isUpgraded = semver.gte(nodeVersion, latestVersion);
 
-        const isUpgraded = semver.gte(nodeVersion, latestVersion);
-        if (!isUpgraded) {
-          await setLatestClientReleaseValidity(candidate.stash, false);
-          return false;
-        } else {
-          await setLatestClientReleaseValidity(candidate.stash, true);
-          return true;
-        }
-      } else {
+      // If they are not upgrade, set the validity as invalid
+      if (!isUpgraded) {
         await setLatestClientReleaseValidity(candidate.stash, false);
         return false;
       }
-    } else {
+
+      // If the current version is the latest release, set the release as valid
       await setLatestClientReleaseValidity(candidate.stash, true);
       return true;
+    } else {
+      // If there is no latest release or if not past the grace window, set the release as invalid
+      await setLatestClientReleaseValidity(candidate.stash, false);
+      return false;
     }
   } catch (e) {
     logger.error(
diff --git a/packages/common/src/db/queries/Candidate.ts b/packages/common/src/db/queries/Candidate.ts
@@ -636,7 +636,7 @@ export const reportOffline = async (name: string): Promise<boolean> => {
           {
             offlineSince: Date.now(),
             onlineSince: 0,
-            $inc: { nodeRefs: -1 },
+            nodeRefs: 0,
           },
         ).exec();
         await updateCandidateOfflineValidity(name);
diff --git a/packages/common/src/monitor.ts b/packages/common/src/monitor.ts
@@ -41,21 +41,24 @@ export default class Monitor {
 
     await queries.setRelease(tag_name, publishedAt);
 
+    const tagParts = tag_name.split("-");
+    const version = tagParts[tagParts.length - 1];
+
     if (
       this.latestTaggedRelease &&
-      tag_name === this.latestTaggedRelease!.name
+      version === this.latestTaggedRelease!.name
     ) {
       logger.info("(Monitor::getLatestTaggedRelease) No new release found");
       return null;
     }
 
     this.latestTaggedRelease = {
-      name: tag_name.split(`-`)[1],
+      name: version,
       publishedAt,
     };
 
     logger.info(
-      `(Monitor::getLatestTaggedRelease) Latest release updated: ${tag_name} | Published at: ${publishedAt}`,
+      `(Monitor::getLatestTaggedRelease) Latest release updated: ${version} | Published at: ${publishedAt}`,
     );
 
     return this.latestTaggedRelease;
diff --git a/packages/common/test/testUtils/dbUtils.ts b/packages/common/test/testUtils/dbUtils.ts
@@ -122,6 +122,7 @@ export const initTestServerBeforeAll = () => {
   afterEach(async () => {});
 
   afterAll(async () => {
+    await mongoose.connection.dropDatabase();
     await mongoose.disconnect();
   });
 };
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@1kv/core",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "description": "Services for running the Thousand Validator Program.",
   "main": "index.js",
   "scripts": {
diff --git a/packages/gateway/package.json b/packages/gateway/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@1kv/gateway",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "description": "Services for running the Thousand Validator Program.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
diff --git a/packages/scorekeeper-status-ui/package.json b/packages/scorekeeper-status-ui/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@1kv/scorekeeper-status-ui",
   "private": true,
-  "version": "3.1.7",
+  "version": "3.1.8",
   "type": "module",
   "scripts": {
     "dev": "vite",
diff --git a/packages/telemetry/package.json b/packages/telemetry/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@1kv/telemetry",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "description": "Services for running the Thousand Validator Program.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -20,6 +20,7 @@
     "start:watch": "NODE_OPTIONS='--max-old-space-size=6096' nodemon --watch build --exec node build/run.js",
     "start:dev": "concurrently \"tsc -w\"  \"yarn start:watch\"",
     "js:start": "NODE_OPTIONS='--max-old-space-size=6096' node build/run.js start",
+    "test": "SKIP_MD5=true LOG_LEVEL=info ../../node_modules/.bin/vitest --config vitest.int.config.mts --no-file-parallelism",
     "test:int": "SKIP_MD5=true LOG_LEVEL=info ../../node_modules/.bin/vitest --config vitest.int.config.mts --no-file-parallelism",
     "test:int:silent": "SKIP_MD5=true LOG_LEVEL=warn ../../node_modules/.bin/vitest --config vitest.int.config.mts --no-file-parallelism"
   },
diff --git a/packages/telemetry/test/utils.ts b/packages/telemetry/test/utils.ts
@@ -28,10 +28,14 @@ export const initTestServerBeforeAll = () => {
     await createTestServer();
   });
 
-  beforeEach(async () => {});
+  beforeEach(async () => {
+    const dbName = `testdb_${Date.now()}`;
+    await mongoose.connection.useDb(dbName);
+  });
   afterEach(async () => {});
 
   afterAll(async () => {
+    await mongoose.connection.dropDatabase();
     await mongoose.disconnect();
   });
 };
diff --git a/packages/telemetry/vitest.int.config.mts b/packages/telemetry/vitest.int.config.mts
@@ -7,5 +7,6 @@ export default defineConfig({
         testTimeout: 130000,
         retry: 1,
         setupFiles: ["test/vitest.setup.ts"],
+        maxConcurrency: 1,
     },
 });
diff --git a/packages/worker/package.json b/packages/worker/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@1kv/worker",
-  "version": "3.1.7",
+  "version": "3.1.8",
   "description": "Services for running the Thousand Validator Program.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
diff --git a/vitest.config.mts b/vitest.config.mts
@@ -1,5 +1,6 @@
 import {defineConfig} from "vitest/config";
 
+
 export default defineConfig({
   test: {
     globals: true,
@@ -12,10 +13,20 @@ export default defineConfig({
       exclude: ['/docs/**', 'node_modules/**']
     },
 
-    include: ["src/**/*.ts"],
 
-    exclude: ["node_modules/**", "dist/**", "packages/scorekeeper-status-ui/**", "docs/**"],
+    // @ts-ignore
+    common: {
+      include: ["packages/common/**/*.test.ts"],
+      setupFiles: ["packages/common/test/vitest.setup.ts"],
+      exclude: ["node_modules/**", "dist/**", "packages/scorekeeper-status-ui/**", "docs/**"],
+    },
 
+    // @ts-ignore
+    telemetry: {
+      include: ["packages/telemetry/**/*.test.ts"],
+      setupFiles: ["packages/telemetry/test/vitest.setup.ts"],
+      exclude: ["node_modules/**", "dist/**", "packages/scorekeeper-status-ui/**", "docs/**"],
+    },
 
   },
 });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@1kv/common",`
`3`		`- "version": "3.1.7",`
	`3`	`+ "version": "3.1.8",`
`4`	`4`	`"description": "Services for running the Thousand Validator Program.",`
`5`	`5`	`"main": "build/index.js",`
`6`	`6`	`"types": "build/index.d.ts",`