8000
Skip to content

fix: Community packages update check (no-changelog) #15684

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
michael-radency merged 11 commits into from
May 26, 2025
Merged

fix: Community packages update check (no-changelog) #15684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9e8815d
fix
michael-radency May 26, 2025
8a48546
Merge branch 'master' of https://github.com/n8n-io/n8n into node-2919…
michael-radency May 26, 2025
0968161
update
michael-radency May 26, 2025
b5c8728
Merge branch 'master' of https://github.com/n8n-io/n8n into node-2919…
michael-radency May 26, 2025
6372b57
Merge remote-tracking branch 'origin/master' into node-2919-update-no…
netroy May 26, 2025
f37f748
ensure community nodes package.json at the application startup
netroy May 26, 2025
bcc7eec
add additional tests for ensurePackageJson and checkForMissingPackages
netroy May 26, 2025
332144a
Merge remote-tracking branch 'origin/master' into node-2919-update-no…
netroy May 26, 2025
516f2a7
fix the worker command test
netroy May 26, 2025
09d2269
ensure that the download folder exists before ensuring the package.json
netroy May 26, 2025
31626d9
Merge remote-tracking branch 'origin/master' into node-2919-update-no…
netroy May 26, 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
2 changes: 1 addition & 1 deletion packages/cli/src/commands/base-command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export abstract class BaseCommand extends Command {
const { communityPackages } = this.globalConfig.nodes;
if (communityPackages.enabled && this.needsCommunityPackages) {
const { CommunityPackagesService } = await import('@/services/community-packages.service');
await Container.get(CommunityPackagesService).checkForMissingPackages();
await Container.get(CommunityPackagesService).init();
}

if (this.needsTaskRunner && this.globalConfig.taskRunners.enabled) {
Expand Down
235 changes: 196 additions & 39 deletions packages/cli/src/services/__tests__/community-packages.service.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ import { InstalledNodesRepository } from '@n8n/db';
import { InstalledPackagesRepository } from '@n8n/db';
import axios from 'axios';
import { exec } from 'child_process';
import { mkdir as fsMkdir, readFile, writeFile, rm } from 'fs/promises';
import { mkdir, readFile, writeFile, rm, access, constants } from 'fs/promises';
import { mocked } from 'jest-mock';
import { mock } from 'jest-mock-extended';
import type { Logger, InstanceSettings, PackageDirectoryLoader } from 'n8n-core';
import type { PublicInstalledPackage } from 'n8n-workflow';
import { join } from 'node:path';

import {
NODE_PACKAGE_PREFIX,
Expand Down Expand Up @@ -53,29 +54,11 @@ describe('CommunityPackagesService', () => {
},
});
const loadNodesAndCredentials = mock<LoadNodesAndCredentials>();

const nodeName = randomName();
const installedNodesRepository = mockInstance(InstalledNodesRepository);
installedNodesRepository.create.mockImplementation(() => {
return Object.assign(new InstalledNodes(), {
name: nodeName,
type: nodeName,
latestVersion: COMMUNITY_NODE_VERSION.CURRENT.toString(),
packageName: 'test',
});
});

const installedPackageRepository = mockInstance(InstalledPackagesRepository);
installedPackageRepository.create.mockImplementation(() => {
return Object.assign(new InstalledPackages(), {
packageName: mockPackageName(),
installedVersion: COMMUNITY_PACKAGE_VERSION.CURRENT,
});
});

const instanceSettings = mock<InstanceSettings>({
nodesDownloadDir: '/tmp/n8n-jest-global-downloads',
});
const nodesDownloadDir = '/tmp/n8n-jest-global-downloads';
const instanceSettings = mock<InstanceSettings>({ nodesDownloadDir });

const logger = mock<Logger>();
const publisher = mock<Publisher>();
Expand All @@ -90,6 +73,26 @@ describe('CommunityPackagesService', () => {
globalConfig,
);

beforeEach(() => {
jest.resetAllMocks();
loadNodesAndCredentials.postProcessLoaders.mockResolvedValue(undefined);

const nodeName = randomName();
installedNodesRepository.create.mockImplementation(() => {
return Object.assign(new InstalledNodes(), {
name: nodeName,
type: nodeName,
latestVersion: COMMUNITY_NODE_VERSION.CURRENT,
});
});
installedPackageRepository.create.mockImplementation(() => {
return Object.assign(new InstalledPackages(), {
packageName: mockPackageName(),
installedVersion: COMMUNITY_PACKAGE_VERSION.CURRENT,
});
});
});

describe('parseNpmPackageName()', () => {
test('should fail with empty package name', () => {
expect(() => communityPackagesService.parseNpmPackageName('')).toThrowError();
Expand Down Expand Up @@ -139,9 +142,6 @@ describe('CommunityPackagesService', () => {

describe('executeCommand()', () => {
beforeEach(() => {
mocked(fsMkdir).mockReset();
mocked(fsMkdir).mockResolvedValue(undefined);
mocked(exec).mockReset();
mocked(exec).mockImplementation(execMock);
});

Expand All @@ -159,7 +159,6 @@ describe('CommunityPackagesService', () => {

await communityPackagesService.executeNpmCommand('ls');

expect(fsMkdir).toHaveBeenCalled();
expect(exec).toHaveBeenCalled();
});

Expand All @@ -168,7 +167,6 @@ describe('CommunityPackagesService', () => {

await communityPackagesService.executeNpmCommand('ls');

expect(fsMkdir).toHaveBeenCalled();
expect(exec).toHaveBeenCalled();
});

Expand All @@ -185,7 +183,6 @@ describe('CommunityPackagesService', () => {

await expect(call).rejects.toThrowError(RESPONSE_ERROR_MESSAGES.PACKAGE_NOT_FOUND);

expect(fsMkdir).toHaveBeenCalled();
expect(exec).toHaveBeenCalled();
});
});
Expand Down Expand Up @@ -410,7 +407,6 @@ describe('CommunityPackagesService', () => {

mocked(exec).mockImplementation(execMockForThisBlock as typeof exec);

mocked(fsMkdir).mockResolvedValue(undefined);
mocked(readFile).mockResolvedValue(
JSON.stringify({
name: PACKAGE_NAME,
Expand Down Expand Up @@ -446,10 +442,11 @@ describe('CommunityPackagesService', () => {
);

// ASSERT:
expect(exec).toHaveBeenCalledTimes(4);

expect(rm).toHaveBeenCalledWith(testBlockPackageDir, { recursive: true, force: true });
expect(rm).toHaveBeenCalledTimes(2);
expect(rm).toHaveBeenNthCalledWith(1, testBlockPackageDir, { recursive: true, force: true });
expect(rm).toHaveBeenNthCalledWith(2, `${nodesDownloadDir}/n8n-nodes-test-latest.tgz`);

expect(exec).toHaveBeenCalledTimes(3);
expect(exec).toHaveBeenNthCalledWith(
1,
`npm pack ${PACKAGE_NAME}@latest --registry=${testBlockRegistry} --quiet`,
Expand All @@ -471,14 +468,7 @@ describe('CommunityPackagesService', () => {
expect.any(Function),
);

expect(exec).toHaveBeenNthCalledWith(
4,
`rm ${testBlockTarballName}`,
{ cwd: testBlockDownloadDir },
expect.any(Function),
);

expect(fsMkdir).toHaveBeenCalledWith(testBlockPackageDir, { recursive: true });
expect(mkdir).toHaveBeenCalledWith(testBlockPackageDir, { recursive: true });
expect(readFile).toHaveBeenCalledWith(`${testBlockPackageDir}/package.json`, 'utf-8');
expect(writeFile).toHaveBeenCalledWith(
`${testBlockPackageDir}/package.json`,
Expand Down Expand Up @@ -534,4 +524,171 @@ describe('CommunityPackagesService', () => {
);
});
});

describe('ensurePackageJson', () => {
const packageJsonPath = join(nodesDownloadDir, 'package.json');

test('should not create package.json if it already exists', async () => {
mocked(access).mockResolvedValue(undefined);

await communityPackagesService.ensurePackageJson();

expect(access).toHaveBeenCalledWith(packageJsonPath, constants.F_OK);
expect(mkdir).not.toHaveBeenCalled();
expect(writeFile).not.toHaveBeenCalled();
});

test('should create package.json if it does not exist', async () => {
mocked(access).mockRejectedValue(new Error('ENOENT'));

await communityPackagesService.ensurePackageJson();

expect(access).toHaveBeenCalledWith(packageJsonPath, constants.F_OK);
expect(mkdir).toHaveBeenCalledWith(nodesDownloadDir, { recursive: true });
expect(writeFile).toHaveBeenCalledWith(
packageJsonPath,
JSON.stringify(
{
name: 'installed-nodes',
private: true,
dependencies: {},
},
null,
2,
),
'utf-8',
);
});
});

describe('checkForMissingPackages', () => {
const installedPackage1 = mock<InstalledPackages>({
packageName: 'package-1',
installedVersion: '1.0.0',
installedNodes: [{ type: 'node-type-1' }],
});
const installedPackage2 = mock<InstalledPackages>({
packageName: 'package-2',
installedVersion: '2.0.0',
installedNodes: [{ type: 'node-type-2' }],
});

beforeEach(() => {
jest
.spyOn(communityPackagesService, 'installPackage')
.mockResolvedValue({} as InstalledPackages);
});

test('should set missingPackages to empty array when no packages are missing', async () => {
const installedPackages = [installedPackage1];

installedPackageRepository.find.mockResolvedValue(installedPackages);
loadNodesAndCredentials.isKnownNode.mockReturnValue(true);

await communityPackagesService.checkForMissingPackages();

expect(communityPackagesService.missingPackages).toEqual([]);
expect(communityPackagesService.installPackage).not.toHaveBeenCalled();
expect(loadNodesAndCredentials.postProcessLoaders).not.toHaveBeenCalled();
});

test('should identify missing packages without reinstalling when reinstallMissing is false', async () => {
const installedPackages = [installedPackage1, installedPackage2];

installedPackageRepository.find.mockResolvedValue(installedPackages);
loadNodesAndCredentials.isKnownNode.mockImplementation(
(nodeType) => nodeType === 'node-type-2',
);
globalConfig.nodes.communityPackages.reinstallMissing = false;

await communityPackagesService.checkForMissingPackages();

expect(communityPackagesService.missingPackages).toEqual(['package-1@1.0.0']);
expect(communityPackagesService.installPackage).not.toHaveBeenCalled();
expect(loadNodesAndCredentials.postProcessLoaders).not.toHaveBeenCalled();
expect(logger.warn).toHaveBeenCalled();
});

test('should reinstall missing packages when reinstallMissing is true', async () => {
const installedPackages = [installedPackage1];

installedPackageRepository.find.mockResolvedValue(installedPackages);
loadNodesAndCredentials.isKnownNode.mockReturnValue(false);
globalConfig.nodes.communityPackages.reinstallMissing = true;

await communityPackagesService.checkForMissingPackages();

expect(communityPackagesService.installPackage).toHaveBeenCalledWith('package-1', '1.0.0');
expect(loadNodesAndCredentials.postProcessLoaders).toHaveBeenCalled();
expect(communityPackagesService.missingPackages).toEqual([]);
expect(logger.info).toHaveBeenCalledWith(
'Packages reinstalled successfully. Resuming regular initialization.',
);
});

test('should handle failed reinstallations and record missing packages', async () => {
const installedPackages = [installedPackage1];

installedPackageRepository.find.mockResolvedValue(installedPackages);
loadNodesAndCredentials.isKnownNode.mockReturnValue(false);
globalConfig.nodes.communityPackages.reinstallMissing = true;
communityPackagesService.installPackage = jest
.fn()
.mockRejectedValue(new Error('Installation failed'));

await communityPackagesService.checkForMissingPackages();

expect(communityPackagesService.installPackage).toHaveBeenCalledWith('package-1', '1.0.0');
expect(logger.error).toHaveBeenCalledWith('n8n was unable to install the missing packages.');
expect(communityPackagesService.missingPackages).toEqual(['package-1@1.0.0']);
});

test('should handle multiple missing packages and stop reinstalling after first failure', async () => {
const installedPackages = [installedPackage1, installedPackage2];

installedPackageRepository.find.mockResolvedValue(installedPackages);
loadNodesAndCredentials.isKnownNode.mockReturnValue(false);
globalConfig.nodes.communityPackages.reinstallMissing = true;

// First installation succeeds, second fails
communityPackagesService.installPackage = jest
.fn()
.mockResolvedValueOnce({} as InstalledPackages)
.mockRejectedValueOnce(new Error('Installation failed'));

await communityPackagesService.checkForMissingPackages();

expect(communityPackagesService.installPackage).toHaveBeenCalledWith('package-1', '1.0.0');
expect(communityPackagesService.installPackage).toHaveBeenCalledWith('package-2', '2.0.0');
expect(logger.error).toHaveBeenCalledWith('n8n was unable to install the missing packages.');
expect(communityPackagesService.missingPackages).toEqual(['package-2@2.0.0']);
});
});

describe('updatePackageJsonDependency', () => {
beforeEach(() => {
jest.clearAllMocks();
mocked(readFile).mockResolvedValue(JSON.stringify({ dependencies: {} }));
});

test('should update package dependencies', async () => {
await communityPackagesService.updatePackageJsonDependency('test-package', '1.0.0');

expect(writeFile).toHaveBeenCalledWith(
`${nodesDownloadDir}/package.json`,
JSON.stringify({ dependencies: { 'test-package': '1.0.0' } }, null, 2),
'utf-8',
);
});

test('should create file and update package dependencies', async () => {
await communityPackagesService.updatePackageJsonDependency('test-package', '1.0.0');

expect(writeFile).toHaveBeenCalledWith(
`${nodesDownloadDir}/package.json`,
JSON.stringify({ dependencies: { 'test-package': '1.0.0' } }, null, 2),
'utf-8',
);
});
});
});
Loading
Loading
0