mirror of
https://github.com/fleetdm/fleet
synced 2026-05-17 14:08:25 +00:00
c1ed73a8b4
Closes: #23516 Closes: #23517 Changes: - Updated the headings on the /queries page to be clickable links - Updated the query detail page to highlight osquery tables/columns in queries - Updated code blocks on the query details page to prevent the copy button from covering the content in the code block.
77 lines
3.4 KiB
JavaScript
Vendored
77 lines
3.4 KiB
JavaScript
Vendored
module.exports = {
|
|
|
|
|
|
friendlyName: 'View query detail',
|
|
|
|
|
|
description: 'Display "Query detail" page.',
|
|
|
|
|
|
inputs: {
|
|
slug: { type: 'string', required: true, description: 'A slug uniquely identifying this query in the library.', example: 'get-macos-disk-free-space-percentage' },
|
|
},
|
|
|
|
|
|
exits: {
|
|
success: { viewTemplatePath: 'pages/query-detail' },
|
|
notFound: { responseType: 'notFound' },
|
|
badConfig: { responseType: 'badConfig' },
|
|
},
|
|
|
|
|
|
fn: async function ({ slug }) {
|
|
|
|
if (!_.isObject(sails.config.builtStaticContent) || !_.isArray(sails.config.builtStaticContent.queries)) {
|
|
throw {badConfig: 'builtStaticContent.queries'};
|
|
} else if (!_.isString(sails.config.builtStaticContent.queryLibraryYmlRepoPath)) {
|
|
throw {badConfig: 'builtStaticContent.queryLibraryYmlRepoPath'};
|
|
}
|
|
|
|
// Serve appropriate content for query.
|
|
// > Inspired by https://github.com/sailshq/sailsjs.com/blob/b53c6e6a90c9afdf89e5cae00b9c9dd3f391b0e7/api/controllers/documentation/view-documentation.js
|
|
let query = _.find(sails.config.builtStaticContent.queries, { slug: slug });
|
|
if (!query) {
|
|
throw 'notFound';
|
|
}
|
|
|
|
// Find the related osquery table documentation for tables used in this query, and grab the keywordsForSyntaxHighlighting from each table used.
|
|
let allTablesInformation = _.filter(sails.config.builtStaticContent.markdownPages, (pageInfo)=>{
|
|
return _.startsWith(pageInfo.url, '/tables/');
|
|
});
|
|
// Get all the osquery table names, we'll use this list to determine which tables are used.
|
|
let allTableNames = _.pluck(allTablesInformation, 'title');
|
|
// Create an array of words in the query.
|
|
let queryWords = _.words(query.query, /[^ ]+/g);
|
|
let columnNamesForSyntaxHighlighting = [];
|
|
let tableNamesForSyntaxHighlighting = [];
|
|
// Get all of the words that appear in both arrays
|
|
let intersectionBetweenQueryWordsAndTableNames = _.intersection(queryWords, allTableNames);
|
|
// For each matched osquery table, add the keywordsForSyntaxHighlighting and the names of the tables used into two arrays.
|
|
for(let tableName of intersectionBetweenQueryWordsAndTableNames) {
|
|
let tableMentionedInThisQuery = _.find(sails.config.builtStaticContent.markdownPages, {title: tableName});
|
|
tableNamesForSyntaxHighlighting.push(tableMentionedInThisQuery.title);
|
|
let keyWordsForThisTable = tableMentionedInThisQuery.keywordsForSyntaxHighlighting;
|
|
columnNamesForSyntaxHighlighting = columnNamesForSyntaxHighlighting.concat(keyWordsForThisTable);
|
|
}
|
|
// Remove the table names from the array of column names to highlight.
|
|
columnNamesForSyntaxHighlighting = _.difference(columnNamesForSyntaxHighlighting, tableNamesForSyntaxHighlighting);
|
|
|
|
|
|
// Setting the meta title and description of this page using the query object, and falling back to a generic title or description if query.name or query.description are missing.
|
|
let pageTitleForMeta = query.name ? query.name + ' | Query details' : 'Query details';
|
|
let pageDescriptionForMeta = query.description ? query.description : 'View more information about a query in Fleet\'s standard query library';
|
|
// Respond with view.
|
|
return {
|
|
query,
|
|
queryLibraryYmlRepoPath: sails.config.builtStaticContent.queryLibraryYmlRepoPath,
|
|
pageTitleForMeta,
|
|
pageDescriptionForMeta,
|
|
columnNamesForSyntaxHighlighting,
|
|
tableNamesForSyntaxHighlighting,
|
|
algoliaPublicKey: sails.config.custom.algoliaPublicKey,
|
|
};
|
|
|
|
}
|
|
|
|
|
|
};
|