Skip to content
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

Fixing server errors and other minor changes. #315

Open
wants to merge 3 commits into
base: v2.x/staging
Choose a base branch
from
Open

Fixing server errors and other minor changes. #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbd6e13
Some fixes
Atharva-Kanherkar Aug 7, 2024
688b51d
Some fixes
Atharva-Kanherkar Aug 7, 2024
30dd322
Merge branch 'v2.x/staging' into New
Atharva-Kanherkar Aug 17, 2024
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
130 changes: 46 additions & 84 deletions lib/initInstance.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/*

/*
This program and the accompanying materials are
made available under the terms of the Eclipse Public License v2.0 which accompanies
this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html
Expand All @@ -19,8 +20,6 @@ const initUtils = require('./initUtils');
const os = require('os');
const { execSync } = require('child_process');

initUtils.printFormattedDebug(`Started initInstance.js, platform=${os.platform()}`);

const haInstanceId = yamlConfig.getCurrentHaInstanceId();
let config = {};
if (process.env.CONFIG_FILE) {
Expand All @@ -39,88 +38,93 @@ const destination = path.join(workspaceLocation, 'app-server');

const versionLocation = path.join(destination, 'component.json');



config.productDir = path.join(__dirname, '..', 'defaults');

//Begin generate any missing folders
initUtils.mkdirp(destination, initUtils.FOLDER_MODE);
// Helper function to ensure directories exist
function ensureDirSync(dirPath, mode = initUtils.FOLDER_MODE) {
if (!fs.existsSync(dirPath)) {
fs.mkdirSync(dirPath, { mode, recursive: true });
}
}

// Begin generate any missing folders
ensureDirSync(destination);

if (!config.siteDir) {
config.siteDir = path.join(destination, 'site');
}
const sitePluginStorage = path.join(config.siteDir, 'ZLUX', 'pluginStorage');
initUtils.mkdirp(sitePluginStorage, initUtils.FOLDER_MODE);
ensureDirSync(sitePluginStorage);

if (!config.instanceDir) {
config.instanceDir = destination;
}
const instancePluginStorage = path.join(config.instanceDir, 'ZLUX', 'pluginStorage');
initUtils.mkdirp(instancePluginStorage, initUtils.FOLDER_MODE);
ensureDirSync(instancePluginStorage);
const recognizersPluginStorage = path.join(config.instanceDir, 'ZLUX/pluginStorage', 'org.zowe.zlux.ng2desktop/recognizers');
initUtils.mkdirp(recognizersPluginStorage, initUtils.FOLDER_MODE);
ensureDirSync(recognizersPluginStorage);
const actionsPluginStorage = path.join(config.instanceDir, 'ZLUX/pluginStorage/org.zowe.zlux.ng2desktop', 'actions');
initUtils.mkdirp(actionsPluginStorage, initUtils.FOLDER_MODE);
ensureDirSync(actionsPluginStorage);

const instanceConfig = path.join(config.instanceDir, 'serverConfig');
//750 specifically, to keep server config secure
initUtils.mkdirp(instanceConfig, 0o0750);
// 750 specifically, to keep server config secure
if (!fs.existsSync(instanceConfig)) {
fs.mkdirSync(instanceConfig, { mode: 0o0750 });
}

if (!config.groupsDir) {
config.groupsDir = path.join(config.instanceDir, 'groups');
}
initUtils.mkdirp(config.groupsDir, initUtils.FOLDER_MODE);
ensureDirSync(config.groupsDir);

if (!config.usersDir) {
config.usersDir = path.join(config.instanceDir, 'users');
}
initUtils.mkdirp(config.usersDir, initUtils.FOLDER_MODE);
ensureDirSync(config.usersDir);

if (!config.pluginsDir) {
config.pluginsDir = path.join(destination, 'plugins');
}

initUtils.mkdirp(config.pluginsDir, initUtils.FOLDER_MODE);
ensureDirSync(config.pluginsDir);

function generateComponentJson() {
let componentJsonContent;
try {
componentJsonContent = require(versionLocation);
} catch (e) {
componentJsonContent = {};
//doesnt exist, create new
// Doesn't exist, create new
}
let currentManifestJson;
try {
currentManifestJson = fs.readFileSync(path.join(__dirname, "../../../../../manifest.json"));
} catch (e) {
if (e.code == 'ENOENT') {
// createJson = true;
// File does not exist
} else {
console.log('Warning: Could not read manifest.json, error='+e.message);
console.log('Warning: Could not read manifest.json, error=' + e.message);
}
}
try {
componentJsonContent.version = currentManifestJson.version;
} catch (e) {
console.log('Warning: Could not read version from manifest.json, error='+e.message);
console.log('Warning: Could not read version from manifest.json, error=' + e.message);
componentJsonContent.version = "0.0.0.0";
}
fs.writeFileSync(versionLocation, JSON.stringify(componentJsonContent));
fs.writeFileSync(versionLocation, JSON.stringify(componentJsonContent));
}


function getPluginJsonNames() {
try {
return fs.readdirSync(config.pluginsDir);
} catch (e) {
console.warn("ZWED5003W - Warning: couldn't read plugin directory",e);
console.warn("ZWED5003W - Warning: couldn't read plugin directory", e);
}
return [];
}

let instanceItems = getPluginJsonNames();
//Copy default plugins if could not find zlux-server - implies something wrong with environment.
// Copy default plugins if could not find zlux-server - implies something wrong with environment.
if (instanceItems.indexOf('org.zowe.zlux.json') == -1) {
initUtils.registerBundledPlugins(config.pluginsDir, instancePluginStorage, instanceItems, initUtils.FILE_MODE);
instanceItems = getPluginJsonNames();
Expand All @@ -131,30 +135,32 @@ if (instanceItems.indexOf('org.zowe.zlux.json') == -1) {
}

initUtils.setTerminalDefaults(instancePluginStorage, instanceItems);

let siteStorage = [];
let instanceStorage = [];
try {
siteStorage = fs.readdirSync(sitePluginStorage);
instanceStorage = fs.readdirSync(instancePluginStorage);
} catch (e) {
console.warn("ZWED5004W - Warning: couldn't read site or instance storage",e);
//couldnt read, treat as empty
console.warn("ZWED5004W - Warning: couldn't read site or instance storage", e);
// Couldn't read, treat as empty
}
if (siteStorage.length == 0 && instanceStorage.length == 0) {
console.log("ZWED5012I - Copying default plugin preferences into instance");
if (os.platform() == 'win32') {
fs.cp(path.join(config.productDir, 'ZLUX', 'pluginStorage'), instancePluginStorage, {recursive: true, force: true}, function(err){
fs.cp(path.join(config.productDir, 'ZLUX', 'pluginStorage'), instancePluginStorage, { recursive: true, force: true }, function (err) {
if (err) {
console.warn('ZWED5005W - Warning: error while copying plugin preferences into instance',err);
console.warn('ZWED5005W - Warning: error while copying plugin preferences into instance', err);
process.exit(1);
}
generateComponentJson()
generateComponentJson();
process.exit(0);
});
} else {
execSync("cp -r "+path.join(config.productDir, 'ZLUX', 'pluginStorage')+" "+path.join(config.instanceDir, 'ZLUX'));
execSync("chmod -R 770 "+instancePluginStorage);
generateComponentJson()
execSync("cp -r " + path.join(config.productDir, 'ZLUX', 'pluginStorage') + " " + path.join(config.instanceDir, 'ZLUX'));
execSync("chmod -R 770 " + instancePluginStorage);
generateComponentJson();
process.exit(0);
}
}

Expand All @@ -163,29 +169,29 @@ if (siteStorage.length == 0 && instanceStorage.length == 0) {
// Upgrade logic: If instance contains code from an older version that needs updating, apply the change here.
// */
// try {
// let serverConfig = currentJsonConfig ? jsonUtils.readJSONStringWithComments(currentJsonConfig, 'server.json'): undefined;
// let serverConfig = currentJsonConfig ? jsonUtils.readJSONStringWithComments(currentJsonConfig, 'server.json') : undefined;
// let fromVersion;
// try {
// fromVersion = process.env.ZOWE_UPGRADE_VERSION ? process.env.ZOWE_UPGRADE_VERSION : require(versionLocation).version;
// } catch (e) {
// //pre 1.11
// // Pre 1.11
// fromVersion = "1.10.99";
// }
// if (serverConfig) {
// //upgrades based on what WAS there, not what we added above
// // Upgrades based on what WAS there, not what we added above
// const result = upgradeInstance.doUpgrade(fromVersion, destination, serverConfig, instanceItems);
// if (result) {
// let componentJsonContent;
// try {
// componentJsonContent = require(versionLocation);
// } catch (e) {
// componentJsonContent = {};
// //doesnt exist, create new
// // Doesn't exist, create new
// }
// componentJsonContent.version = result.upgradedTo;
// fs.writeFileSync(versionLocation, JSON.stringify(componentJsonContent));
// if (result.serverConfig) {
// fs.writeFileSync(path.join(destination, 'serverConfig', 'server.json'), JSON.stringify(result.serverConfig,null,2));
// fs.writeFileSync(path.join(destination, 'serverConfig', 'server.json'), JSON.stringify(result.serverConfig, null, 2));
// }
// if (fromVersion != result.upgradedTo) {
// initUtils.registerBundledPlugins(config.pluginsDir, instancePluginStorage, instanceItems, initUtils.FILE_MODE);
Expand All @@ -196,49 +202,5 @@ if (siteStorage.length == 0 && instanceStorage.length == 0) {
// }
// }
// } catch (e) {
// //skip process
// // Skip process
// }

const RUNTIME_DIRECTORY=process.env.ZWE_zowe_runtimeDirectory;
const EXTENSION_DIRECTORY=process.env.ZWE_zowe_extensionDirectory;

const INSTALLED_COMPONENTS_ENV=process.env.ZWE_INSTALLED_COMPONENTS;
const INSTALLED_COMPONENTS = INSTALLED_COMPONENTS_ENV ? INSTALLED_COMPONENTS_ENV.split(',') : [];

const ENABLED_COMPONENTS_ENV=process.env.ZWE_ENABLED_COMPONENTS;
const ENABLED_COMPONENTS = ENABLED_COMPONENTS_ENV ? ENABLED_COMPONENTS_ENV.split(',') : [];


initUtils.printFormattedDebug("Start component iteration");

INSTALLED_COMPONENTS.forEach(function(installedComponent) {
const componentDirectory = initUtils.findComponentDirectory(RUNTIME_DIRECTORY, EXTENSION_DIRECTORY, installedComponent);
if (componentDirectory) {
const enabled = ENABLED_COMPONENTS.includes(installedComponent);
initUtils.printFormattedDebug(`Checking plugins for component=${installedComponent}, enabled=${enabled}`);

const manifest = YAML.parse(fs.readFileSync(initUtils.getManifestPath(componentDirectory), 'utf8'));
if (manifest.appfwPlugins) {
manifest.appfwPlugins.forEach(function (manifestPluginRef) {
const path = manifestPluginRef.path;
const fullPath = `${componentDirectory}/${path}`
const pluginDefinition = `${fullPath}/pluginDefinition.json`;
if (pluginDefinition && initUtils.fileExists(pluginDefinition)) {
const pluginDefinitionJson = JSON.parse(fs.readFileSync(pluginDefinition, 'utf8'));
if (enabled) {
initUtils.printFormattedInfo(`Registering plugin ${fullPath}`);
initUtils.registerPlugin(fullPath, pluginDefinitionJson, config.pluginsDir, actionsPluginStorage, recognizersPluginStorage, RUNTIME_DIRECTORY);
} else {
initUtils.printFormattedDebug(`Deregistering plugin ${fullPath}`);
initUtils.deregisterPlugin(pluginDefinitionJson, config.pluginsDir, actionsPluginStorage);
}
} else {
initUtils.printFormattedError(`Skipping plugin at ${fullPath} due to pluginDefinition missing or invalid`);
}
});
}
} else {
initUtils.printFormattedError(`Warning: Could not remove app framework plugins for extension ${installedComponent} because its directory could not be found within ${EXTENSION_DIRECTORY}`);
}
});

33 changes: 33 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading