Skip to content

fix(ci): make bumping mongosh apply only to mongosh packages #2356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gagik merged 3 commits into from
Feb 4, 2025
Merged

fix(ci): make bumping mongosh apply only to mongosh packages #2356

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8ff157
fix(ci): make bumping mongosh apply only to mongosh packages and add …
gagik Feb 4, 2025
184979b
feat: add a package-lock update step
gagik Feb 4, 2025
b45333e
fix: use path builder to fix windows tests
gagik Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 118 additions & 10 deletions packages/build/src/npm-packages/bump.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@ import path from 'path';
import { PROJECT_ROOT } from './constants';

describe('npm-packages bump', function () {
let fsReadFile: SinonStub;
let fsWriteFile: SinonStub;
const shellApiSrc = path.join(
PROJECT_ROOT,
'packages',
'shell-api',
'src',
'mongosh-version.ts'
);

beforeEach(function () {
fsReadFile = sinon.stub(fs, 'readFile');

fsWriteFile = sinon.stub(fs, 'writeFile');
fsWriteFile.resolves();
});
Expand All @@ -25,6 +29,13 @@ describe('npm-packages bump', function () {
});

describe('bumpMongoshReleasePackages', function () {
let fsReadFile: SinonStub;
let getPackagesInTopologicalOrder: sinon.SinonStub;
beforeEach(function () {
fsReadFile = sinon.stub(fs, 'readFile');
getPackagesInTopologicalOrder = sinon.stub();
});

it('warns and does not run if version is not set', async function () {
const consoleWarnSpy = sinon.spy(console, 'warn');
await bumpMongoshReleasePackages('');
Expand All @@ -35,9 +46,112 @@ describe('npm-packages bump', function () {
expect(fsWriteFile).not.called;
consoleWarnSpy.restore();
});

it('bumps only mongosh packages', async function () {
getPackagesInTopologicalOrder.resolves([
{ name: 'mongosh', location: 'packages/mongosh' },
{ name: '@mongosh/autocomplete', location: 'packages/autocomplete' },
]);

const rootProjectJson = `${PROJECT_ROOT}/package.json`;
const mockPackageJson = [
[
rootProjectJson,
{
name: 'mongosh',
devDependencies: {
mongosh: '0.1.2',
'@mongosh/cli-repl': '0.1.2',
'@mongosh/autocomplete': '1.2.3',
},
},
],
[
'packages/mongosh/package.json',
{
name: 'mongosh',
version: '0.1.2',
devDependencies: {
'@mongosh/cli-repl': '9.9.9',
'@mongosh/autocomplete': '1.2.3',
},
},
],
[
'packages/autocomplete/package.json',
{
name: '@mongosh/autocomplete',
version: '1.2.3',
devDependencies: {
'@mongosh/cli-repl': '0.1.2',
'@mongosh/config': '3.3.3',
},
},
],
];

fsReadFile.throws('Unknown file');
for (const [file, json] of mockPackageJson) {
fsReadFile.withArgs(file, 'utf8').resolves(JSON.stringify(json));
}

const updateShellApiMongoshVersion = sinon.stub();
await bumpMongoshReleasePackages(
'9.9.9',
getPackagesInTopologicalOrder,
updateShellApiMongoshVersion
);
expect(fsWriteFile).callCount(3);

expect(
JSON.parse(
fsWriteFile.withArgs(rootProjectJson).firstCall.args[1] as string
)
).deep.equals({
name: 'mongosh',
devDependencies: {
mongosh: '9.9.9',
'@mongosh/cli-repl': '9.9.9',
'@mongosh/autocomplete': '1.2.3',
},
});

expect(
JSON.parse(
fsWriteFile.withArgs('packages/mongosh/package.json').firstCall
.args[1] as string
)
).deep.equals({
name: 'mongosh',
version: '9.9.9',
devDependencies: {
'@mongosh/cli-repl': '9.9.9',
'@mongosh/autocomplete': '1.2.3',
},
});

expect(
JSON.parse(
fsWriteFile.withArgs('packages/autocomplete/package.json').firstCall
.args[1] as string
)
).deep.equals({
name: '@mongosh/autocomplete',
version: '1.2.3',
Copy link
Collaborator

@addaleax addaleax Feb 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do want to bump these packages, just not with the same version as mongosh, right?

Otherwise the published @mongosh/cli-repl package.json would specify a version that's not actually the same code as the one in the compiled executable?

Copy link
Contributor Author

@gagik gagik Feb 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, this happens at the previous step with bumpAuxiliaryPackages

Copy link
Contributor Author

@gagik gagik Feb 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that said, it'd be good to have a test mixing the two. just a bit harder to do it in a clean way because the monorepo bumping helper isn't too easy to control, something more E2E might work but don't know if we want to do that now.
I tried running bump together locally with some overrides for the mongosh bump and seems to work.

devDependencies: {
'@mongosh/cli-repl': '9.9.9',
'@mongosh/config': '3.3.3',
},
});
});
});

describe('updateShellApiMongoshVersion', function () {
let fsReadFile: SinonStub;
beforeEach(function () {
fsReadFile = sinon.stub(fs, 'readFile');
});

it('updates the file to the set version', async function () {
fsReadFile.resolves(`
/** Current mongosh cli-repl version. */
Expand All @@ -47,13 +161,7 @@ describe('npm-packages bump', function () {
await updateShellApiMongoshVersion(newVersion);

expect(fsWriteFile).calledWith(
path.join(
PROJECT_ROOT,
'packages',
'shell-api',
'src',
'mongosh-version.ts'
),
shellApiSrc,
`
/** Current mongosh cli-repl version. */
export const MONGOSH_VERSION = '${newVersion}';`,
Expand Down
23 changes: 14 additions & 9 deletions packages/build/src/npm-packages/bump.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ import {
import { promises as fs } from 'fs';
import path from 'path';
import { spawnSync as spawnSyncFn } from '../helpers';
import { getPackagesInTopologicalOrder } from '@mongodb-js/monorepo-tools';
import { getPackagesInTopologicalOrder as getPackagesInTopologicalOrderFn } from '@mongodb-js/monorepo-tools';

/** Bumps only the main mongosh release packages to the set version. */
export async function bumpMongoshReleasePackages(
version: string
version: string,
getPackagesInTopologicalOrder: typeof getPackagesInTopologicalOrderFn = getPackagesInTopologicalOrderFn,
updateShellApiMongoshVersionFn: typeof updateShellApiMongoshVersion = updateShellApiMongoshVersion
): Promise<void> {
if (!version) {
console.warn(
Expand All @@ -22,20 +24,23 @@ export async function bumpMongoshReleasePackages(
}

console.info(`mongosh: Bumping mongosh release packages to ${version}`);
const monorepoRootPath = path.resolve(__dirname, '..', '..', '..', '..');
const monorepoRootPath = PROJECT_ROOT;
const packages = await getPackagesInTopologicalOrder(monorepoRootPath);

const workspaceNames = packages
.map((p) => p.name)
.filter((name) => MONGOSH_RELEASE_PACKAGES.includes(name));
const bumpedPackages = MONGOSH_RELEASE_PACKAGES;

const locations = [monorepoRootPath, ...packages.map((p) => p.location)];

for (const location of locations) {
const packageJsonPath = path.join(location, 'package.json');
const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));

packageJson.version = version;
if (
bumpedPackages.includes(packageJson.name as string) &&
location !== monorepoRootPath
) {
packageJson.version = version;
}
for (const grouping of [
'dependencies',
'devDependencies',
Expand All @@ -47,7 +52,7 @@ export async function bumpMongoshReleasePackages(
}

for (const name of Object.keys(packageJson[grouping])) {
if (!workspaceNames.includes(name)) {
if (!bumpedPackages.includes(name)) {
continue;
}
packageJson[grouping][name] = version;
Expand All @@ -60,7 +65,7 @@ export async function bumpMongoshReleasePackages(
);
}

await updateShellApiMongoshVersion(version);
await updateShellApiMongoshVersionFn(version);
}

/** Updates the shell-api constant to match the mongosh version. */
Expand Down
Loading