mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 21:47:20 +00:00
676f3f0bd5
-Modify build-static-content back-end script to implement GitHub Users API and build contributor profile information into query library pages -Remove related functionality from client-side page scripts -Add dropdown menu to select filters -Refine html and css
209 lines
14 KiB
JavaScript
Vendored
209 lines
14 KiB
JavaScript
Vendored
module.exports = {
|
||
|
||
|
||
friendlyName: 'Build static content',
|
||
|
||
|
||
description: 'Generate HTML partials from source files in fleetdm/fleet repo (e.g. docs in markdown, or queries in YAML), and configure metadata about the generated files so it is available in `sails.config.builtStaticContent`.',
|
||
|
||
|
||
inputs: {
|
||
dry: { type: 'boolean', description: 'Whether to make this a dry run. (.sailsrc file will not be overwritten. HTML files will not be generated.)' },
|
||
},
|
||
|
||
|
||
fn: async function ({ dry }) {
|
||
|
||
let path = require('path');
|
||
let YAML = require('yaml');
|
||
|
||
// FUTURE: If we ever need to gather source files from other places or branches, etc, see git history of this file circa 2021-05-19 for an example of a different strategy we might use to do that.
|
||
let topLvlRepoPath = path.resolve(sails.config.appPath, '../');
|
||
|
||
// The data we're compiling will get built into this dictionary and then written on top of the .sailsrc file.
|
||
let builtStaticContent = {};
|
||
|
||
await sails.helpers.flow.simultaneously([
|
||
async()=>{// Parse query library from YAML and bake them into the Sails app's configuration.
|
||
let RELATIVE_PATH_TO_QUERY_LIBRARY_YML_IN_FLEET_REPO = 'docs/1-Using-Fleet/standard-query-library/standard-query-library.yml';
|
||
let yaml = await sails.helpers.fs.read(path.join(topLvlRepoPath, RELATIVE_PATH_TO_QUERY_LIBRARY_YML_IN_FLEET_REPO));
|
||
|
||
let queriesWithProblematicRemediations = [];
|
||
let queriesWithProblematicContributors = [];
|
||
let queries = YAML.parseAllDocuments(yaml).map((yamlDocument)=>{
|
||
let query = yamlDocument.toJSON().spec;
|
||
query.slug = _.kebabCase(query.name);// « unique slug to use for routing to this query's detail page
|
||
if ((query.remediation !== undefined && !_.isString(query.remediation)) || (query.purpose !== 'Detection' && _.isString(query.remediation))) {
|
||
// console.log(typeof query.remediation);
|
||
queriesWithProblematicRemediations.push(query);
|
||
} else if (query.remediation === undefined) {
|
||
query.remediation = 'N/A';// « We set this to a string here so that the data type is always string. We use N/A so folks can see there's no remediation and contribute if desired.
|
||
}
|
||
|
||
// GitHub usernames may only contain alphanumeric characters or single hyphens, and cannot begin or end with a hyphen.
|
||
if (!query.contributors || (query.contributors !== undefined && !_.isString(query.contributors)) || query.contributors.split(',').some((contributor) => contributor.match('^[^A-za-z0-9].*|[^A-Za-z0-9-]|.*[^A-za-z0-9]$'))) {
|
||
queriesWithProblematicContributors.push(query);
|
||
}
|
||
|
||
return query;
|
||
});
|
||
// Report any errors that were detected along the way in one fell swoop to avoid endless resubmitting of PRs.
|
||
if (queriesWithProblematicRemediations.length >= 1) {
|
||
throw new Error('Failed parsing YAML for query library: The "remediation" of a query should either be absent (undefined) or a single string (not a list of strings). And "remediation" should only be present when a query\'s purpose is "Detection". But one or more queries have an invalid "remediation": ' + _.pluck(queriesWithProblematicRemediations, 'slug').sort());
|
||
}//•
|
||
// Assert uniqueness of slugs.
|
||
if (queries.length !== _.uniq(_.pluck(queries, 'slug')).length) {
|
||
throw new Error('Failed parsing YAML for query library: Queries as currently named would result in colliding (duplicate) slugs. To resolve, rename the queries whose names are too similar. Note the duplicates: ' + _.pluck(queries, 'slug').sort());
|
||
}//•
|
||
// Report any errors that were detected along the way in one fell swoop to avoid endless resubmitting of PRs.
|
||
if (queriesWithProblematicContributors.length >= 1) {
|
||
throw new Error('Failed parsing YAML for query library: The "contributors" of a query should be a single string of valid GitHub user names (e.g. "zwass", or "zwass,noahtalerman,mikermcneil"). But one or more queries have an invalid "contributors" value: ' + _.pluck(queriesWithProblematicContributors, 'slug').sort());
|
||
}//•
|
||
|
||
// Get a distinct list of all GitHub usernames from all of our queries.
|
||
// Map all queries to build a list of unique contributor names then build a dictionary of user profile information from the GitHub Users API
|
||
const githubUsernames = queries.reduce((list, query) => {
|
||
if (!queriesWithProblematicContributors.find((element) => element.slug === query.slug)) {
|
||
list = _.union(list, query.contributors.split(','));
|
||
}
|
||
return list;
|
||
}, []);
|
||
|
||
// Talk to GitHub and get additional information about each contributor.
|
||
let githubDataByUsername = {};
|
||
await sails.helpers.flow.simultaneouslyForEach(githubUsernames, async(username)=>{
|
||
githubDataByUsername[username] = await sails.helpers.http.get('https://api.github.com/users/' + encodeURIComponent(username), {}, { 'User-Agent': 'Fleet-Standard-Query-Library', Accept: 'application/vnd.github.v3+json' });
|
||
});//∞
|
||
|
||
// Now expand queries with relevant profile data for the contributors.
|
||
for (let query of queries) {
|
||
let usernames = query.contributors.split(',');
|
||
let contributorProfiles = [];
|
||
for (let username of usernames) {
|
||
contributorProfiles.push({
|
||
name: githubDataByUsername[username].name,
|
||
handle: githubDataByUsername[username].login,
|
||
avatarUrl: githubDataByUsername[username].avatar_url,
|
||
htmlUrl: githubDataByUsername[username].html_url,
|
||
});
|
||
}
|
||
query.contributors = contributorProfiles;
|
||
}
|
||
|
||
// Attach to Sails app configuration.
|
||
builtStaticContent.queries = queries;
|
||
builtStaticContent.queryLibraryYmlRepoPath = RELATIVE_PATH_TO_QUERY_LIBRARY_YML_IN_FLEET_REPO;
|
||
},
|
||
async()=>{// Parse markdown pages, compile & generate HTML files, and bake documentation's directory tree into the Sails app's configuration.
|
||
|
||
// Note:
|
||
// • path maths inspired by https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L107-L132
|
||
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||
// // Original way that works: (versus new stuff below)
|
||
// builtStaticContent.markdownPages = await sails.helpers.compileMarkdownContent('docs/'); // TODO remove this and helper once everything works again
|
||
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||
|
||
builtStaticContent.markdownPages = [];// « dir tree representation that will be injected into Sails app's configuration
|
||
|
||
let SECTION_REPO_PATHS = ['docs/', 'handbook/'];
|
||
for (let sectionRepoPath of SECTION_REPO_PATHS) {
|
||
let thinTree = await sails.helpers.fs.ls.with({
|
||
dir: path.join(topLvlRepoPath, sectionRepoPath),
|
||
depth: 100,
|
||
includeDirs: false,
|
||
includeSymlinks: false,
|
||
});
|
||
|
||
let rootRelativeUrlPathsSeen = [];
|
||
for (let pageSourcePath of thinTree) {
|
||
|
||
// Perform path maths (determine this using sectionRepoPath, etc)
|
||
// > Inspired by https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L308-L313
|
||
// > And https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L107-L132
|
||
let rootRelativeUrlPath = `/todo-${_.trimRight(sectionRepoPath,'/')}-${pageSourcePath.slice(-30).replace(/[^a-z0-9\-]/ig,'')}-${Math.floor(Math.random()*10000000)}`;
|
||
sails.log.verbose(`Building page ${rootRelativeUrlPath} from ${pageSourcePath} (${sectionRepoPath})`);
|
||
// ^^TODO: replace that with the actual desired root relative URL path
|
||
|
||
// Assert uniqueness of URL paths.
|
||
if (rootRelativeUrlPathsSeen.includes(rootRelativeUrlPath)) {
|
||
throw new Error('Failed compiling markdown content: Files as currently named would result in colliding (duplicate) URLs for the website. To resolve, rename the pages whose names are too similar. Duplicate detected: ' + rootRelativeUrlPath);
|
||
}//•
|
||
rootRelativeUrlPathsSeen.push(rootRelativeUrlPath);
|
||
|
||
// Get last modified timestamp using git
|
||
// > Inspired by https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L265-L273
|
||
let lastModifiedAt = Date.now();// TODO
|
||
|
||
let fallbackTitle = sails.helpers.strings.toSentenceCase(path.basename(pageSourcePath, '.ejs'));// « for clarity (the page isn't a template, necessarily, and this title is just a guess. Display title will, more likely than not, come from a <docmeta> tag -- see the bottom of the original, raw unformatted markdown of any page in the sailsjs docs for an example of how to use docmeta tags)
|
||
|
||
// If markdown: Compile to HTML and parse docpage metadata
|
||
// > Parsing docmeta tags (consider renaming them to just <meta>- or by now there's probably a more standard way of embedding semantics in markdown files; prefer to use that): https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L180-L183
|
||
// > Compiling: https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L198-L202
|
||
// TODO
|
||
|
||
// Skip this page, if appropriate
|
||
// > Inspired by https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/compile-markdown-tree-from-remote-git-repo.js#L275-L276
|
||
// TODO
|
||
|
||
// Generate HTML file
|
||
let htmlOutputPath = '';//TODO
|
||
if (dry) {
|
||
sails.log('Dry run: Would have generated file:', htmlOutputPath);
|
||
} else {
|
||
// TODO
|
||
}
|
||
|
||
// TODO: Figure out what to do about embedded images (they'll get cached by CDN so probably ok to point at github, but markdown img srcs will break if relative. Also GitHub could just change image URLs whenever.)
|
||
|
||
// Append to Sails app configuration.
|
||
builtStaticContent.markdownPages.push({
|
||
url: rootRelativeUrlPath,
|
||
title: '' || fallbackTitle,// TODO use metadata title if available
|
||
lastModifiedAt: lastModifiedAt
|
||
});
|
||
}//∞ </each source file>
|
||
}//∞ </each section repo path>
|
||
|
||
// Decorate markdownPages tree with easier-to-use properties related to metadata embedded in the markdown and parent/child relationships.
|
||
// Note: Maybe skip the parent/child relationships.
|
||
// > Inspired by https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/helpers/marshal-doc-page-metadata.js
|
||
// > And https://github.com/uncletammy/doc-templater/blob/2969726b598b39aa78648c5379e4d9503b65685e/lib/build-jsmenu.js
|
||
// TODO
|
||
|
||
// Sort siblings in the markdownPages tree so it's ready to use in menus.
|
||
// > Note: consider doing this on the frontend-- though there's a reason it was here. See:
|
||
// > • https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/helpers/compare-doc-page-metadatas.js
|
||
// > • https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/helpers/marshal-doc-page-metadata.js#L191-L208
|
||
// TODO
|
||
},
|
||
]);
|
||
|
||
// ██████╗ ███████╗██████╗ ██╗ █████╗ ██████╗███████╗ ███████╗ █████╗ ██╗██╗ ███████╗██████╗ ██████╗
|
||
// ██╔══██╗██╔════╝██╔══██╗██║ ██╔══██╗██╔════╝██╔════╝ ██╔════╝██╔══██╗██║██║ ██╔════╝██╔══██╗██╔════╝██╗
|
||
// ██████╔╝█████╗ ██████╔╝██║ ███████║██║ █████╗ ███████╗███████║██║██║ ███████╗██████╔╝██║ ╚═╝
|
||
// ██╔══██╗██╔══╝ ██╔═══╝ ██║ ██╔══██║██║ ██╔══╝ ╚════██║██╔══██║██║██║ ╚════██║██╔══██╗██║ ██╗
|
||
// ██║ ██║███████╗██║ ███████╗██║ ██║╚██████╗███████╗ ██╗███████║██║ ██║██║███████╗███████║██║ ██║╚██████╗╚═╝
|
||
// ╚═╝ ╚═╝╚══════╝╚═╝ ╚══════╝╚═╝ ╚═╝ ╚═════╝╚══════╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═╝╚══════╝╚══════╝╚═╝ ╚═╝ ╚═════╝
|
||
//
|
||
// Replace .sailsrc file.
|
||
// > This takes the compiled menu file from doc-templater and injects it into the .sailsrc file so it
|
||
// > can be accessed for the purposes of config using `sails.config.builtStaticContent`.
|
||
if (dry) {
|
||
sails.log('Dry run: Would have folded the following onto .sailsrc as "builtStaticContent":', builtStaticContent);
|
||
} else {
|
||
let sailsrcPath = path.resolve(sails.config.appPath, '.sailsrc');
|
||
let oldSailsrcJson = await sails.helpers.fs.readJson(sailsrcPath);
|
||
await sails.helpers.fs.writeJson.with({
|
||
force: true,
|
||
destination: sailsrcPath,
|
||
json: {
|
||
...oldSailsrcJson,
|
||
builtStaticContent: builtStaticContent,
|
||
}
|
||
});
|
||
}
|
||
|
||
}
|
||
|
||
|
||
};
|