Merge pull request #503 from shelfio/feature/fix-ci-build-job

Enable CircleCI runs, move to complete pnpm usage

Author: batovpasha

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  node: circleci/node@7.0.0
+  node: circleci/node@7.1.0
 
 parameters:
   node_version:
@@ -12,24 +12,31 @@ commands:
   install_deps:
     steps:
       - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> .npmrc
+      - node/install-pnpm:
+          version: 9.15.4
       - node/install-packages:
-          pkg-manager: yarn
-          cache-version: v1-all
+          pkg-manager: pnpm
           cache-only-lockfile: true
-          app-dir: ~/repo
-          override-ci-command: yarn install --pure-lockfile --no-progress
+          # Default command is 'pnpm install --frozen-lockfile'.
+          # 'pnpm install' fails with --frozen-lockfile option because it can't find the lockfile
+          override-ci-command: pnpm install
 
 jobs:
-  build:
+  build_and_test:
     executor:
-      name: cimg/node
+      name: node/default
       tag: << pipeline.parameters.node_version >>
     working_directory: ~/repo
     steps:
       - checkout
       - install_deps
-      - run: yarn build
-      - run: yarn test
-      - run: yarn test:repl
-      - run: yarn lint:ci
-      - run: yarn type-check
+      - run: pnpm run type-check
+      - run: pnpm run lint:ci
+      - run: pnpm run build
+      - run: pnpm run test
+      - run: pnpm run test:repl
+
+workflows:
+  build_test:
+    jobs:
+      - build_and_test

.husky/pre-commit

@@ -1,3 +1,3 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
-yarn lint-staged
+pnpm exec lint-staged

eslint.config.mjs

@@ -2,6 +2,11 @@ import rules from '@shelf/eslint-config/typescript.js';
 
 export default [
   ...rules,
+  {
+    rules: {
+      '@typescript-eslint/no-var-requires': 'off',
+    },
+  },
   {files: ['**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx', '**/*.json']},
   {
     ignores: [

package.json

@@ -21,15 +21,15 @@
     "lib/"
   ],
   "scripts": {
-    "build": "rm -rf lib/ && yarn build:types && babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts'",
+    "build": "rm -rf lib/ && pnpm run build:types && babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts'",
     "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
-    "lint": "yarn lint:ci --fix",
+    "lint": "pnpm run lint:ci --fix",
     "lint:ci": "eslint . --quiet",
-    "prepack": "yarn build",
+    "prepack": "pnpm run build",
     "test": "jest",
     "test:repl": "MONGO_MEMORY_SERVER_FILE=jest-mongodb-config-repl.js jest",
     "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch"
+    "type-check:watch": "pnpm run type-check --watch"
   },
   "lint-staged": {
     "*.{html,md,yml}": [
@@ -53,6 +53,7 @@
   "devDependencies": {
     "@babel/cli": "7.27.0",
     "@babel/core": "7.26.10",
+    "@jest/environment": "29.7.0",
     "@shelf/babel-config": "1.2.0",
     "@shelf/eslint-config": "4.2.1",
     "@shelf/prettier-config": "1.0.0",

readme.md

@@ -196,8 +196,8 @@ module.exports = {
 
 ```sh
 $ git checkout master
-$ yarn version
-$ yarn publish
+$ pnpm version
+$ pnpm publish
 $ git push origin master --tags
 ```
 

src/environment.ts

@@ -5,9 +5,8 @@ import {TestEnvironment} from 'jest-environment-node';
 import {MongoMemoryReplSet, MongoMemoryServer} from 'mongodb-memory-server';
 import type {EnvironmentContext} from '@jest/environment';
 import type {JestEnvironmentConfig} from '@jest/environment';
-import {getMongodbMemoryOptions} from './helpers';
+import {getMongodbMemoryOptions, isMongoMemoryReplSetOptions} from './helpers';
 
-// eslint-disable-next-line import/order
 const debug = require('debug')('jest-mongodb:environment');
 
 module.exports = class MongoEnvironment extends TestEnvironment {
@@ -18,7 +17,7 @@ module.exports = class MongoEnvironment extends TestEnvironment {
     this.globalConfigPath = pathJoin(config.globalConfig.rootDir, 'globalConfig.json');
 
     const options = getMongodbMemoryOptions(config.globalConfig.rootDir);
-    const isReplSet = Boolean(options.replSet);
+    const isReplSet = isMongoMemoryReplSetOptions(options);
     debug(`isReplSet`, isReplSet);
 
     this.mongo = isReplSet ? new MongoMemoryReplSet(options) : new MongoMemoryServer(options);

src/helpers.ts

@@ -1,19 +1,30 @@
 import {resolve} from 'path';
-import {Config} from './types';
+import type {MongoMemoryReplSet, MongoMemoryServer} from 'mongodb-memory-server';
+import type {Config} from './types';
 
 const configFile = process.env.MONGO_MEMORY_SERVER_FILE || 'jest-mongodb-config.js';
 
-export function getMongodbMemoryOptions(cwd: string) {
+type MongoMemoryReplSetOpts = NonNullable<ConstructorParameters<typeof MongoMemoryReplSet>[0]>;
+type MongoMemoryServerOpts = NonNullable<ConstructorParameters<typeof MongoMemoryServer>[0]>;
+
+export function isMongoMemoryReplSetOptions(
+  options?: MongoMemoryReplSetOpts | MongoMemoryServerOpts
+): options is MongoMemoryReplSetOpts {
+  return Boolean((options as MongoMemoryReplSetOpts).replSet);
+}
+
+export function getMongodbMemoryOptions(
+  cwd: string
+): MongoMemoryReplSetOpts | MongoMemoryServerOpts | undefined {
   try {
     const {mongodbMemoryServerOptions}: Config = require(resolve(cwd, configFile));
 
     return mongodbMemoryServerOptions;
-  } catch (e) {
+  } catch {
     return {
       binary: {
-        skipMD5: true,
+        checkMD5: false,
       },
-      autoStart: false,
       instance: {},
     };
   }

src/setup.ts

@@ -9,14 +9,15 @@ import {
   getMongodbMemoryOptions,
   shouldUseSharedDBForAllJestWorkers,
 } from './helpers';
+import {isMongoMemoryReplSetOptions} from './helpers';
 
 const debug = require('debug')('jest-mongodb:setup');
 
 module.exports = async (config: JestEnvironmentConfig['globalConfig']) => {
   const globalConfigPath = join(config.rootDir, 'globalConfig.json');
 
   const mongoMemoryServerOptions = getMongodbMemoryOptions(config.rootDir);
-  const isReplSet = Boolean(mongoMemoryServerOptions.replSet);
+  const isReplSet = isMongoMemoryReplSetOptions(mongoMemoryServerOptions);
 
   debug(`isReplSet ${isReplSet}`);
 
@@ -48,7 +49,7 @@ module.exports = async (config: JestEnvironmentConfig['globalConfig']) => {
     global.__MONGOD__ = mongo;
   }
 
-  mongoConfig.mongoDBName = options.instance.dbName;
+  mongoConfig.mongoDBName = isMongoMemoryReplSetOptions(options) ? '' : options?.instance?.dbName;
 
   // Write global config to disk because all tests run in different contexts.
   writeFileSync(globalConfigPath, JSON.stringify(mongoConfig));