[CI]: Improved Detection of Wiki Page Changes (#1061)

* feat-fix(wiki): improve wiki page changed detection

* ci(wiki): mention changed files in the commit message

Author: EagleoutIce

Diff for: .github/workflows/broken-links-and-wiki.yaml

@@ -53,6 +53,7 @@ jobs:
         run: |
           npm ci
           CHANGED_ANY=false
+          CHANGED_FILES=()
           function update_wiki_page {
             # test if the file exists
             if [ -f "wiki/$1.md" ]; then
@@ -63,15 +64,16 @@ jobs:
             npm run $2 --silent > "wiki/$1.md"
             # test if the file changed, but ignore the first line which contains the time stamp
             # we additionally used sed to remove any measurement stamp for the comparison as they of course change
-            
-            tail -n +2 "wiki/$1.md" | sed -E 's/[0-9]+\.[0-9]+ ?ms//g; s/tmp-[A-Za-z0-9-]+//g' > "wiki/$1.md.tmp"
-            tail -n +2 "wiki/$1-Old.md" | sed -E 's/[0-9]+\.[0-9]+ ?ms//g; s/tmp-[A-Za-z0-9-]+//g' > "wiki/$1-Old.md.tmp"
+            # additionally, we remove any part "timing": <number>.
+            tail -n +2 "wiki/$1.md" | sed -E 's/[0-9]+(\.[0-9]+)? ?ms//g; s/tmp-[A-Za-z0-9-]+//g; s/"timing":\s*[0-9]+(\.0-9)?,?//g' > "wiki/$1.md.tmp"
+            tail -n +2 "wiki/$1-Old.md" | sed -E 's/[0-9]+(\.[0-9]+)? ?ms//g; s/tmp-[A-Za-z0-9-]+//g; s/"timing":\s*[0-9]+(\.0-9)?,?//g' > "wiki/$1-Old.md.tmp"
           
             if ! diff -q "wiki/$1.md.tmp" "wiki/$1-Old.md.tmp"; then
                 echo "$1 changed!"
                 echo "CHANGED=true" >> $GITHUB_ENV
                 CHANGED_ANY=true
                 git add -f "wiki/$1.md"
+                CHANGED_FILES+=("$1")
             else
                 echo "$1 did not change!"
             fi
@@ -88,7 +90,8 @@ jobs:
           if [ $CHANGED_ANY == "true" ]; then
               git config --local user.email "[email protected]"
               git config --local user.name "GitHub Action"
-              git commit -m "[skip ci] doc: update generated wiki pages"
+              CHANGED_FILES_STRING=$(IFS=,; echo "${CHANGED_FILES[*]}")
+              git commit -m "[skip ci] doc: update generated wiki pages ($CHANGED_FILES_STRING)"
           fi
 
       - name: "⬆️ Push changed Wiki pages"

Diff for: src/cli/repl/commands/repl-query.ts

@@ -20,6 +20,8 @@ import { BuiltIn } from '../../../dataflow/environments/built-in';
 import { graphToMermaidUrl } from '../../../util/mermaid/dfg';
 import { normalizedAstToMermaidUrl } from '../../../util/mermaid/ast';
 
+import { printAsMs } from '../../../util/time';
+
 async function getDataflow(shell: RShell, remainingLine: string) {
 	return await new PipelineExecutor(DEFAULT_DATAFLOW_PIPELINE, {
 		shell,
@@ -141,22 +143,22 @@ export function asciiSummaryOfQueryResult(formatter: OutputFormatter, totalInMs:
 		}
 		if(query === 'call-context') {
 			const out = queryResults as QueryResults<'call-context'>['call-context'];
-			result.push(`Query: ${bold(query, formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+			result.push(`Query: ${bold(query, formatter)} (${printAsMs(out['.meta'].timing, 0)})`);
 			result.push(asciiCallContext(formatter, out, processed));
 			continue;
 		} else if(query === 'dataflow') {
 			const out = queryResults as QueryResults<'dataflow'>['dataflow'];
-			result.push(`Query: ${bold(query, formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+			result.push(`Query: ${bold(query, formatter)} (${printAsMs(out['.meta'].timing, 0)})`);
 			result.push(`   ╰ [Dataflow Graph](${graphToMermaidUrl(out.graph)})`);
 			continue;
 		} else if(query === 'id-map') {
 			const out = queryResults as QueryResults<'id-map'>['id-map'];
-			result.push(`Query: ${bold(query, formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+			result.push(`Query: ${bold(query, formatter)} (${printAsMs(out['.meta'].timing, 0)})`);
 			result.push(`   ╰ Id List: {${summarizeIdsIfTooLong([...out.idMap.keys()])}}`);
 			continue;
 		} else if(query === 'normalized-ast') {
 			const out = queryResults as QueryResults<'normalized-ast'>['normalized-ast'];
-			result.push(`Query: ${bold(query, formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+			result.push(`Query: ${bold(query, formatter)} (${printAsMs(out['.meta'].timing, 0)})`);
 			result.push(`   ╰ [Normalized AST](${normalizedAstToMermaidUrl(out.normalized.ast)})`);
 			continue;
 		}
@@ -172,10 +174,10 @@ export function asciiSummaryOfQueryResult(formatter: OutputFormatter, totalInMs:
 			}
 			result.push(` ╰ ${key}: ${JSON.stringify(value)}`);
 		}
-		result.push(`  - Took ${timing.toFixed(0)}ms`);
+		result.push(`  - Took ${printAsMs(timing, 0)}`);
 	}
 
-	result.push(italic(`All queries together required ≈${results['.meta'].timing.toFixed(0)}ms (1ms accuracy, total ${totalInMs.toFixed(0)}ms)`, formatter));
+	result.push(italic(`All queries together required ≈${printAsMs(results['.meta'].timing, 0)} (1ms accuracy, total ${printAsMs(totalInMs, 0)})`, formatter));
 	return formatter.format(result.join('\n'));
 }
 

Diff for: src/documentation/doc-util/doc-dfg.ts

@@ -10,9 +10,9 @@ import { resolveDataflowGraph } from '../../dataflow/graph/resolve-graph';
 import type { DataflowDifferenceReport } from '../../dataflow/graph/diff';
 import { diffOfDataflowGraphs } from '../../dataflow/graph/diff';
 import { guard } from '../../util/assert';
-import { printAsMs } from './doc-ms';
 import { jsonReplacer } from '../../util/json';
 import type { PipelineOutput } from '../../core/steps/pipeline/pipeline';
+import { printAsMs } from '../../util/time';
 
 export function printDfGraph(graph: DataflowGraph, mark?: ReadonlySet<MermaidMarkdownMark>) {
 	return `

Diff for: src/documentation/doc-util/doc-ms.ts

@@ -9,8 +9,8 @@ import { resolveDataflowGraph } from '../../dataflow/graph/resolve-graph';
 import type { DataflowDifferenceReport } from '../../dataflow/graph/diff';
 import { diffOfDataflowGraphs } from '../../dataflow/graph/diff';
 import { guard } from '../../util/assert';
-import { printAsMs } from './doc-ms';
 import { normalizedAstToMermaid } from '../../util/mermaid/ast';
+import { printAsMs } from '../../util/time';
 
 export function printNormalizedAst(ast: RNodeWithParent, prefix = 'flowchart TD\n') {
 	return `

Diff for: src/documentation/doc-util/doc-normalized-ast.ts

@@ -4,7 +4,6 @@ import { executeQueries } from '../../queries/query';
 import { PipelineExecutor } from '../../core/pipeline-executor';
 import { DEFAULT_DATAFLOW_PIPELINE } from '../../core/steps/pipeline/default-pipelines';
 import { requestFromInput } from '../../r-bridge/retriever';
-import { printAsMs } from './doc-ms';
 import { jsonReplacer } from '../../util/json';
 import { markdownFormatter } from '../../util/ansi';
 import { asciiSummaryOfQueryResult } from '../../cli/repl/commands/repl-query';
@@ -13,6 +12,7 @@ import type { SupportedVirtualQueryTypes } from '../../queries/virtual-query/vir
 import type { VirtualCompoundConstraint } from '../../queries/virtual-query/compound-query';
 import { printDfGraphForCode } from './doc-dfg';
 import { jsonWithLimit } from './doc-code';
+import { printAsMs } from '../../util/time';
 
 export interface ShowQueryOptions {
 	readonly showCode?:       boolean;

Diff for: src/documentation/doc-util/doc-query.ts

@@ -6,8 +6,8 @@ import type { FlowrMessage, IdMessageBase, MessageDefinition } from '../../cli/r
 import type { FakeServer, FakeSocket } from '../../../test/functionality/_helper/net';
 import { withSocket } from '../../../test/functionality/_helper/net';
 import { jsonWithLimit } from './doc-code';
-import { printAsMs } from './doc-ms';
 import { guard } from '../../util/assert';
+import { printAsMs } from '../../util/time';
 
 export interface ServerMessageDescription {
 	readonly title:                  string

Diff for: src/documentation/doc-util/doc-server-message.ts

@@ -7,8 +7,8 @@ import { printNormalizedAstForCode } from './doc-util/doc-normalized-ast';
 import { mermaidHide, printHierarchy, getTypesFromFolderAsMermaid } from './doc-util/doc-types';
 import path from 'path';
 import { FlowrGithubBaseRef, FlowrWikiBaseRef, getFileContentFromRoot, getFilePathMd } from './doc-util/doc-files';
-import { printAsMs } from './doc-util/doc-ms';
 import { getReplCommand } from './doc-util/doc-cli-option';
+import { printAsMs } from '../util/time';
 
 async function getText(shell: RShell) {
 	const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';

Diff for: src/documentation/print-normalized-ast-wiki.ts

@@ -6,3 +6,11 @@
 export function date2string(date: Date = new Date()): string {
 	return `${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}-${date.getHours()}-${date.getMinutes()}-${date.getSeconds()}-${date.getMilliseconds()}`;
 }
+
+/**
+ * Print a number of milliseconds in a human-readable format including correct spacing.
+ */
+export function printAsMs(ms: number, precision = 2): string {
+	/* eslint-disable-next-line no-irregular-whitespace*/
+	return `${ms.toFixed(precision)} ms`;
+}