joepie91
/
cvm
1
0
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

Refactor dlayer-source API to be less opinionated

Browse Source
feature/node-rewrite
Sven Slootweg 1 year ago
parent c3af4706b8
commit be5317183c
4 changed files with 134 additions and 161 deletions
Show Stats Download Patch File Download Diff File

116
src/packages/dlayer-source/index.js
Unescape Escape View File

@ -1,9 +1,8 @@
"use strict";
const Promise = require("bluebird");
const syncpipe = require("syncpipe");
const util = require("util");
const Result = require("@joepie91/result");
const mapObject = require("map-obj");
const ID = Symbol("dlayer-source object ID");
const AllowErrors = Symbol("dlayer-source allow-errors marker");
@ -11,73 +10,56 @@ const AllowErrors = Symbol("dlayer-source allow-errors marker");
// TODO: Make more readable
// TODO: Refactor allowErrors logic so that it's actually part of the internal $getProperty implementation in dlayer itself, and this abstraction uses that tool?
module.exports = {
withSources: function withSources(schemaObject) {
let { $sources, ... rest } = schemaObject;
let generatedProperties = syncpipe($sources ?? {}, [
(_) => Object.entries(_),
(_) => _.flatMap(([ source, properties ]) => {
return Object.entries(properties).map(([ property, selector ]) => {
let getter = function (_args, context) {
return Promise.try(() => {
if (properties[ID] != null) {
let dataSource = context[source];
module.exports = function dlayerSource(source, properties) {
// contextName, { targetProperty: sourceProperty }
if (dataSource != null) {
// console.log(`Calling source '${source}' with ID ${util.inspect(properties[ID])}`);
return Result.wrapAsync(() => dataSource.load(properties[ID]));
} else {
throw new Error(`Attempted to read from context property '${source}', but no such property exists`);
}
} else {
// FIXME: Better error message
throw new Error(`Must specify a dlayer-source ID`);
}
}).then((result) => {
// console.log(`Result [${source}|${util.inspect(properties[ID])}] ${util.inspect(result)}`);
return mapObject(properties, (property, selector) => {
return [
property,
async function (_args, context) {
let dataSource = context[source];
let sourceID = properties[ID];
let allowErrors = (properties[AllowErrors] === true);
let isCustomSelector = (typeof selector !== "string");
// The AllowErrors option is set when a source definition has its own way to deal with (allowable) errors. Instead of simply propagating the error for all affected attributes, it calls the attribute handlers with the Result (or returns `undefined` if only a property is specified).
// TODO: How to deal with null results? Allow them or not? Make it an option?
if (result.isOK && result.value() == null) {
// TODO: Change implementation to allow `Result.ok(null|undefined)` but not `null|undefined` directly?
throw new Error(`Null-ish result returned for ID ${util.inspect(properties[ID])} from source at context property '${source}'; this is not allowed, and there is probably a bug in your code. Please file a ticket if you have a good usecase for null-ish results!`);
} else if (properties[AllowErrors] === true && typeof selector !== "string") {
// Custom selectors always receive the Result as-is
return selector(result);
} else if (result.isError) {
if (properties[AllowErrors] === true) {
return undefined;
} else {
// This is equivalent to a `throw`, and so we just propagate it
return result;
}
} else {
// This is to support property name shorthand used in place of a selector function
if (typeof selector === "string") {
return result.value()[selector];
} else {
return selector(result.value(), context);
}
}
});
};
return [ property, getter ];
});
}),
(_) => Object.fromEntries(_)
]);
// NOTE: We always specify the generated properties first, so that properties can be overridden by explicit known values to bypass the source lookup, if needed by the implementation
return {
... generatedProperties,
... rest
};
},
ID: ID,
AllowErrors: AllowErrors
};
if (dataSource == null) {
throw new Error(`Attempted to read from context property '${source}', but no such property exists`);
} else if (sourceID == null) {
// FIXME: Better error message
throw new Error(`Must specify a dlayer-source ID`);
} else {
let result = await Result.wrapAsync(() => dataSource.load(sourceID));
// The AllowErrors option is set when a source definition has its own way to deal with (allowable) errors. Instead of simply propagating the error for all affected attributes, it calls the attribute handlers with the Result (or returns `undefined` if only a property is specified).
// TODO: How to deal with null results? Allow them or not? Make it an option?
if (result.isOK && result.value() == null) {
// TODO: Change implementation to allow `Result.ok(null|undefined)` but not `null|undefined` directly?
throw new Error(`Null-ish result returned for ID ${util.inspect(properties[ID])} from source at context property '${source}'; this is not allowed, and there is probably a bug in your code. Please file a ticket if you have a good usecase for null-ish results!`);
} else if (allowErrors === true && isCustomSelector) {
// Custom selectors always receive the Result as-is (note that this has to come before the error case handling!)
return selector(result, context);
} else if (result.isError) {
if (allowErrors === true) {
// TODO: Does this actually make sense?
return undefined;
} else {
// This is equivalent to a `throw`, and so we just propagate it
return result;
}
} else if (isCustomSelector) {
return selector(result.value(), context);
} else {
// This is to support property name shorthand used in place of a selector function
return result.value()[selector];
}
}
}
];
});
};
Object.assign(module.exports, {
ID: ID,
AllowErrors: AllowErrors
});

43
src/packages/sysquery-block-devices/index.js
Unescape Escape View File

@ -6,7 +6,6 @@ const matchValue = require("match-value");
const memoizee = require("memoizee");
const unreachable = require("@joepie91/unreachable")("@sysquery/block-devices");
// TODO: Refactor dlayerSource to be object-mergeable instead of all-encompassing
const dlayerSource = require("../dlayer-source");
const All = require("../graphql-interface/symbols/all");
const lsblk = require("../exec-lsblk");
@ -52,28 +51,26 @@ module.exports = {
},
types: {
"sysquery.blockDevices.BlockDevice": function ({ name, path }) {
return dlayerSource.withSources({
$sources: {
lsblk: {
[dlayerSource.ID]: { name, path },
name: "name",
path: (device) => fs.realpath(device.path),
type: (device) => matchValue(device.type, {
partition: "PARTITION",
disk: "DISK",
loopDevice: "LOOP_DEVICE"
}),
size: "size",
mountpoint: "mountpoint", // FIXME: Isn't this obsoleted by `mounts`?
deviceNumber: "deviceNumber",
removable: "removable",
readOnly: "readOnly",
children: (device, { $make }) => device.children.map((child) => {
return $make("sysquery.blockDevices.BlockDevice", { name: child.name });
})
}
}
});
return {
... dlayerSource("lsblk", {
[dlayerSource.ID]: { name, path },
name: "name",
path: (device) => fs.realpath(device.path),
type: (device) => matchValue(device.type, {
partition: "PARTITION",
disk: "DISK",
loopDevice: "LOOP_DEVICE"
}),
size: "size",
mountpoint: "mountpoint", // FIXME: Isn't this obsoleted by `mounts`?
deviceNumber: "deviceNumber",
removable: "removable",
readOnly: "readOnly",
children: (device, { $make }) => device.children.map((child) => {
return $make("sysquery.blockDevices.BlockDevice", { name: child.name });
})
})
};
}
},
extensions: {

78
src/packages/sysquery-lvm/index.js
Unescape Escape View File

@ -66,28 +66,26 @@ module.exports = {
},
types: {
"sysquery.lvm.PhysicalVolume": function PhysicalVolume({ path }) {
return dlayerSource.withSources({
$sources: {
physicalVolumes: {
[dlayerSource.ID]: path,
path: "path",
format: "format",
totalSpace: "totalSpace",
freeSpace: "freeSpace",
isExported: "isExported",
isMissing: "isMissing",
isAllocatable: "isAllocatable",
isDuplicate: "isDuplicate",
isUsed: "isUsed",
volumeGroup: (volume, { $make }) => {
return $make("sysquery.lvm.VolumeGroup", { name: volume.volumeGroup });
}
return {
... dlayerSource("physicalVolumes", {
[dlayerSource.ID]: path,
path: "path",
format: "format",
totalSpace: "totalSpace",
freeSpace: "freeSpace",
isExported: "isExported",
isMissing: "isMissing",
isAllocatable: "isAllocatable",
isDuplicate: "isDuplicate",
isUsed: "isUsed",
volumeGroup: (volume, { $make }) => {
return $make("sysquery.lvm.VolumeGroup", { name: volume.volumeGroup });
}
}
});
})
};
},
"sysquery.lvm.VolumeGroup": function VolumeGroup({ name }) {
return dlayerSource.withSources({
return {
physicalVolumes: function (_args, { physicalVolumes, $make }) {
return Promise.try(() => {
return physicalVolumes.load(All);
@ -106,28 +104,26 @@ module.exports = {
return $make("sysquery.lvm.LogicalVolume", { path: volume.path });
});
},
$sources: {
volumeGroups: {
[dlayerSource.ID]: name,
name: "name",
totalSpace: "totalSpace",
freeSpace: "freeSpace",
physicalVolumeCount: "physicalVolumeCount",
logicalVolumeCount: "logicalVolumeCount",
snapshotCount: "snapshotCount",
isReadOnly: "isReadOnly",
isResizeable: "isResizeable",
isExported: "isExported",
isIncomplete: "isIncomplete",
allocationPolicy: "allocationPolicy",
mode: "mode"
}
}
});
... dlayerSource("volumeGroups", {
[dlayerSource.ID]: name,
name: "name",
totalSpace: "totalSpace",
freeSpace: "freeSpace",
physicalVolumeCount: "physicalVolumeCount",
logicalVolumeCount: "logicalVolumeCount",
snapshotCount: "snapshotCount",
isReadOnly: "isReadOnly",
isResizeable: "isResizeable",
isExported: "isExported",
isIncomplete: "isIncomplete",
allocationPolicy: "allocationPolicy",
mode: "mode"
})
};
},
"sysquery.lvm.LogicalVolume": function LogicalVolume({ path }) {
return dlayerSource.withSources({
$sources: {
return {
... dlayerSource("logicalVolumes", {
logicalVolumes: {
[dlayerSource.ID]: path,
path: "path",
@ -176,8 +172,8 @@ module.exports = {
return $make("sysquery.lvm.VolumeGroup", { name: volume.volumeGroup });
}
}
}
});
})
};
}
}
};

58
src/packages/sysquery-mounts/index.js
Unescape Escape View File

@ -45,37 +45,35 @@ module.exports = {
},
types: {
"sysquery.mounts.Mount": function ({ mountpoint }) {
return dlayerSource.withSources({
return {
mountpoint: mountpoint,
$sources: {
findmnt: {
[dlayerSource.ID]: mountpoint,
id: "id",
// FIXME: Aren't we inferring the below somewhere else in the code, using the square brackets?
type: (mount) => (mount.rootPath === "/")
? "ROOT_MOUNT"
: "SUBMOUNT",
filesystem: "filesystem",
options: "options",
label: "label",
uuid: "uuid",
partitionLabel: "partitionLabel",
partitionUUID: "partitionUUID",
deviceNumber: "deviceNumber",
sourceDevicePath: "sourceDevice",
totalSpace: "totalSpace",
freeSpace: "freeSpace",
usedSpace: "usedSpace",
rootPath: "rootPath",
taskID: "taskID",
optionalFields: "optionalFields",
propagationFlags: "propagationFlags",
children: (mount, { $make }) => mount.children.map((child) => {
return $make("sysquery.mounts.Mount", { mountpoint: child.mountpoint });
})
}
}
});
... dlayerSource("findmnt", {
[dlayerSource.ID]: mountpoint,
id: "id",
// FIXME: Aren't we inferring the below somewhere else in the code, using the square brackets?
type: (mount) => (mount.rootPath === "/")
? "ROOT_MOUNT"
: "SUBMOUNT",
filesystem: "filesystem",
options: "options",
label: "label",
uuid: "uuid",
partitionLabel: "partitionLabel",
partitionUUID: "partitionUUID",
deviceNumber: "deviceNumber",
sourceDevicePath: "sourceDevice",
totalSpace: "totalSpace",
freeSpace: "freeSpace",
usedSpace: "usedSpace",
rootPath: "rootPath",
taskID: "taskID",
optionalFields: "optionalFields",
propagationFlags: "propagationFlags",
children: (mount, { $make }) => mount.children.map((child) => {
return $make("sysquery.mounts.Mount", { mountpoint: child.mountpoint });
})
})
};
},
},
extensions: {

Write Preview
Loading…
Cancel
Save