Skip to content

improve pos-cli modules install and update #711

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

Open
Slashek wants to merge 1 commit into
base: master
Choose a base branch
from
Open

improve pos-cli modules install and update #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
91 changes: 0 additions & 91 deletions TESTING.md
View file
Open in desktop

This file was deleted.

41 changes: 11 additions & 30 deletions bin/pos-cli-modules-install.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,13 @@

import { program } from '../lib/program.js';
import logger from '../lib/logger.js';
import { posConfigDirectory, posModulesFilePath, posModulesLockFilePath, readLocalModules, writePosModules, writePosModulesLock } from '../lib/modules/configFiles.js';
import { findModuleVersion, resolveDependencies } from '../lib/modules/dependencies.js';
import { downloadAllModules } from '../lib/modules/downloadModule.js';
import { posConfigDirectory, posModulesFilePath, readLocalModules, readRepositoryUrl, writePosModules } from '../lib/modules/configFiles.js';
import { addNewModule, resolveAndDownload } from '../lib/modules/installModule.js';
import Portal from '../lib/portal.js';
import path from 'path';
import { createDirectory } from '../lib/utils/create-directory.js';
import ora from 'ora';

const addNewModule = async (moduleName, moduleVersion, localModules, getVersions) => {
const newModule = await findModuleVersion(moduleName, moduleVersion, getVersions);
let modules;
if(newModule){
if (moduleVersion || !localModules[moduleName]) {
modules = {...localModules, ...newModule};
} else {
modules = {...localModules };
}
return modules;
} else {
throw new Error(`Can't find module ${moduleName} with version ${moduleVersion}`);
}
};

program
.name('pos-cli modules install')
.arguments('[module-name]', 'name of the module. Example: core. You can also pass version number: core@1.0.0')
Expand All @@ -37,29 +21,26 @@ program
spinner.start();

try {
const repositoryUrl = readRepositoryUrl();
const getVersions = (names) => Portal.moduleVersions(names, repositoryUrl);
let localModules = readLocalModules();
if(moduleNameWithVersion){
const [moduleName, moduleVersion] = moduleNameWithVersion.split('@');
localModules = await addNewModule(moduleName, moduleVersion, localModules, Portal.moduleVersions);
writePosModules(localModules);
spinner.succeed(`Added module: ${moduleName}@${localModules[moduleName]} to ${posModulesFilePath}`);
const updated = await addNewModule(moduleName, moduleVersion, localModules, getVersions, repositoryUrl);
if (updated) {
localModules = updated;
writePosModules(localModules, repositoryUrl);
spinner.succeed(`Added module: ${moduleName}@${localModules[moduleName]} to ${posModulesFilePath}`);
}
}

if(Object.keys(localModules).length === 0) {
spinner.stop();
} else {
spinner.start('Resolving module dependencies');
const modulesLocked = await resolveDependencies(localModules, Portal.moduleVersions);
writePosModulesLock(modulesLocked);
spinner.succeed(`Modules lock file updated: ${posModulesLockFilePath}`);

spinner.start('Downloading modules');
await downloadAllModules(modulesLocked);
spinner.succeed('Modules downloaded successfully');
await resolveAndDownload(spinner, localModules, repositoryUrl, getVersions);
}
} catch(e) {
logger.Debug(e);
spinner.stopAndPersist();
spinner.fail(e.message);
}
} catch {
Expand Down
49 changes: 18 additions & 31 deletions bin/pos-cli-modules-update.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,16 @@

import { program } from '../lib/program.js';
import logger from '../lib/logger.js';
import { posConfigDirectory, posModulesLockFilePath, readLocalModules, writePosModules, writePosModulesLock } from '../lib/modules/configFiles.js';
import { findModuleVersion, resolveDependencies } from '../lib/modules/dependencies.js';
import { downloadAllModules } from '../lib/modules/downloadModule.js';
import { posConfigDirectory, readLocalModules, readRepositoryUrl, writePosModules } from '../lib/modules/configFiles.js';
import { updateModule, updateAllModules, resolveAndDownload } from '../lib/modules/installModule.js';
import Portal from '../lib/portal.js';
import path from 'path';
import { createDirectory } from '../lib/utils/create-directory.js';
import ora from 'ora';

const updateModule = async (moduleName, moduleVersion, localModules, getVersions) => {
const newModule = await findModuleVersion(moduleName, moduleVersion, getVersions);
if(newModule){
const modules = {...localModules, ...newModule};
return modules;
} else {
throw new Error(`Can't find module ${moduleName} with version ${moduleVersion}`);
}
};


program
.name('pos-cli modules update')
.arguments('<module-name>', 'name of the module. Example: core. You can also pass version number: core@1.0.0')
.arguments('[module-name]', 'name of the module. Example: core. You can also pass version number: core@1.0.0. Omit to update all modules.')
.action(async (moduleNameWithVersion) => {
try {
await createDirectory(path.join(process.cwd(), posConfigDirectory));
Expand All @@ -32,29 +20,28 @@ program
spinner.start();

try{
const repositoryUrl = readRepositoryUrl();
const getVersions = (names) => Portal.moduleVersions(names, repositoryUrl);
let localModules = readLocalModules();
if(moduleNameWithVersion){

if (moduleNameWithVersion) {
const [moduleName, moduleVersion] = moduleNameWithVersion.split('@');
localModules = await updateModule(moduleName, moduleVersion, localModules, Portal.moduleVersions);
writePosModules(localModules);
localModules = await updateModule(moduleName, moduleVersion, localModules, getVersions, repositoryUrl);
writePosModules(localModules, repositoryUrl);
spinner.succeed(`Updated module: ${moduleName}@${localModules[moduleName]}`);
}

if(Object.keys(localModules).length === 0) {
spinner.stop();
} else {
spinner.start('Resolving module dependencies');
const modulesLocked = await resolveDependencies(localModules, Portal.moduleVersions);
writePosModulesLock(modulesLocked);
spinner.succeed(`Modules lock file generated: ${posModulesLockFilePath}`);

spinner.start('Downloading modules');
await downloadAllModules(modulesLocked);
spinner.succeed('Modules downloaded successfully');
if (Object.keys(localModules).length === 0) {
spinner.warn('No modules to update');
return;
}
localModules = await updateAllModules(localModules, getVersions, repositoryUrl);
writePosModules(localModules, repositoryUrl);
spinner.succeed('Updated all modules to latest versions');
}

await resolveAndDownload(spinner, localModules, repositoryUrl, getVersions);
} catch(e) {
logger.Debug(e);
spinner.stopAndPersist();
spinner.fail(e.message);
}
} catch {
Expand Down
27 changes: 22 additions & 5 deletions lib/modules/configFiles.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,41 @@ import path from 'path';
const posConfigDirectory = 'app';
const posModulesFilePath = `${posConfigDirectory}/pos-modules.json`;
const posModulesLockFilePath = `${posConfigDirectory}/pos-modules.lock.json`;
const DEFAULT_REPOSITORY_URL = 'https://partners.platformos.com';

const readLocalModules = () => {
const config = files.readJSON(posModulesFilePath, { throwDoesNotExistError: false });
return config['modules'] || {};
};

const writePosModules = (modules) => {
/**
* Returns the repository URL for the module registry.
* Reads from pos-modules.json, falling back to the default Partners Portal URL.
* The PARTNER_PORTAL_HOST environment variable takes precedence over both.
*/
const readRepositoryUrl = () => {
if (process.env.PARTNER_PORTAL_HOST) return process.env.PARTNER_PORTAL_HOST;
const config = files.readJSON(posModulesFilePath, { throwDoesNotExistError: false });
return config['repository_url'] || DEFAULT_REPOSITORY_URL;
};

const readPosModulesLock = () => {
const config = files.readJSON(posModulesLockFilePath, { throwDoesNotExistError: false });
return config['modules'] || {};
};

const writePosModules = (modules, repositoryUrl = DEFAULT_REPOSITORY_URL) => {
fs.writeFileSync(
path.join(process.cwd(), posModulesFilePath),
JSON.stringify({ modules: modules }, null, 2)
JSON.stringify({ repository_url: repositoryUrl, modules }, null, 2)
);
};

const writePosModulesLock = (modules) => {
const writePosModulesLock = (modules, repositoryUrl = DEFAULT_REPOSITORY_URL) => {
fs.writeFileSync(
path.join(process.cwd(), posModulesLockFilePath),
JSON.stringify({ modules: modules }, null, 2)
JSON.stringify({ repository_url: repositoryUrl, modules }, null, 2)
);
};

export { posModulesFilePath, posModulesLockFilePath, readLocalModules, writePosModules, writePosModulesLock, posConfigDirectory };
export { posModulesFilePath, posModulesLockFilePath, DEFAULT_REPOSITORY_URL, readLocalModules, readRepositoryUrl, readPosModulesLock, writePosModules, writePosModulesLock, posConfigDirectory };
Loading
Loading