add file location to error messages

Author: mProjectsCode

jsEngine/JsMDRC.ts

@@ -1,4 +1,5 @@
-import type { JsExecutionContext, JsExecution } from 'jsEngine/engine/JsExecution';
+import type { ExecutionContext, JsExecution } from 'jsEngine/engine/JsExecution';
+import { ExecutionSource } from 'jsEngine/engine/JsExecution';
 import { ResultRenderer } from 'jsEngine/engine/ResultRenderer';
 import type JsEnginePlugin from 'jsEngine/main';
 import type { MarkdownPostProcessorContext, TAbstractFile } from 'obsidian';
@@ -34,17 +35,21 @@ export class JsMDRC extends MarkdownRenderChild {
 		}
 	}
 
-	buildExecutionContext(): JsExecutionContext {
+	buildExecutionContext(): ExecutionContext {
 		// console.log(this.ctx);
 		const file = this.getExecutionFile();
+		if (file === undefined) {
+			throw new Error('Could not find file for execution context.');
+		}
 		return {
+			executionSource: ExecutionSource.MarkdownCodeBlock,
 			file: file,
-			metadata: file === undefined ? undefined : (this.plugin.app.metadataCache.getFileCache(file) ?? undefined),
+			metadata: this.plugin.app.metadataCache.getFileCache(file) ?? undefined,
 			block: undefined,
 		};
 	}
 
-	async tryRun(context: JsExecutionContext): Promise<JsExecution> {
+	async tryRun(context: ExecutionContext): Promise<JsExecution> {
 		return this.plugin.jsEngine.execute({
 			code: this.content,
 			context: context,

jsEngine/api/InstanceId.ts

@@ -1,3 +1,5 @@
+import type { ExecutionContext } from 'jsEngine/engine/JsExecution';
+
 export enum InstanceType {
 	JS_EXECUTION = 'JS_EXECUTION',
 	PLUGIN = 'PLUGIN',
@@ -11,10 +13,12 @@ export enum InstanceType {
 export class InstanceId {
 	readonly name: InstanceType | string;
 	readonly id: string;
+	readonly executionContext: ExecutionContext | undefined;
 
-	constructor(name: InstanceType | string, id: string) {
+	constructor(name: InstanceType | string, id: string, executionContext?: ExecutionContext) {
 		this.name = name;
 		this.id = id;
+		this.executionContext = executionContext;
 	}
 
 	toString(): string {

jsEngine/api/Internal.ts

@@ -1,6 +1,15 @@
 import type { API } from 'jsEngine/api/API';
 import type { EngineExecutionParams } from 'jsEngine/engine/Engine';
-import type { JsExecution, JsExecutionContext, JsExecutionGlobals, JsExecutionGlobalsConstructionOptions } from 'jsEngine/engine/JsExecution';
+import type {
+	JsExecution,
+	ExecutionContext,
+	JsExecutionGlobals,
+	JsExecutionGlobalsConstructionOptions,
+	CodeBlockExecutionContext,
+	JSFileExecutionContext,
+	UnknownExecutionContext,
+} from 'jsEngine/engine/JsExecution';
+import { ExecutionSource } from 'jsEngine/engine/JsExecution';
 import { ResultRenderer } from 'jsEngine/engine/ResultRenderer';
 import { validateAPIArgs } from 'jsEngine/utils/Validators';
 import { Component, TFile } from 'obsidian';
@@ -50,16 +59,21 @@ export class InternalAPI {
 	 * @param path
 	 * @param params
 	 */
-	public async executeFile(path: string, params: Omit<EngineExecutionParams, 'code'>): Promise<JsExecution> {
-		validateAPIArgs(z.object({ path: z.string(), params: this.apiInstance.validators.engineExecutionParamsNoCode }), { path, params });
+	public async executeFile(path: string, params: Omit<EngineExecutionParams, 'code' | 'context'>): Promise<JsExecution> {
+		validateAPIArgs(z.object({ path: z.string(), params: this.apiInstance.validators.engineExecutionParamsFile }), { path, params });
 
 		const file = this.apiInstance.app.vault.getAbstractFileByPath(path);
 		if (!file || !(file instanceof TFile)) {
 			throw new Error(`File ${path} not found.`);
 		}
-		const fullParams = params as EngineExecutionParams;
-		fullParams.code = await this.apiInstance.app.vault.read(file);
-		return await this.execute(fullParams);
+		return await this.execute({
+			...params,
+			code: await this.apiInstance.app.vault.read(file),
+			context: {
+				executionSource: ExecutionSource.JSFile,
+				file: file,
+			},
+		});
 	}
 
 	/**
@@ -70,16 +84,19 @@ export class InternalAPI {
 	 * @param path
 	 * @param params
 	 */
-	public async executeFileSimple(path: string, params?: Omit<EngineExecutionParams, 'code' | 'component'>): Promise<JsExecution> {
-		validateAPIArgs(z.object({ path: z.string(), params: this.apiInstance.validators.engineExecutionParamsNoCodeAndComponent.optional() }), {
+	public async executeFileSimple(path: string, params?: Omit<EngineExecutionParams, 'code' | 'component' | 'context'>): Promise<JsExecution> {
+		validateAPIArgs(z.object({ path: z.string(), params: this.apiInstance.validators.engineExecutionParamsFileSimple.optional() }), {
 			path,
 			params,
 		});
 
 		const component = new Component();
 		component.load();
 		try {
-			return await this.executeFile(path, { component: component, ...params });
+			return await this.executeFile(path, {
+				component: component,
+				...params,
+			});
 		} finally {
 			component.unload();
 		}
@@ -89,24 +106,102 @@ export class InternalAPI {
 	 * Gets the execution context for a specific file, throws when the file does not exist.
 	 *
 	 * @param path
+	 * @deprecated use {@link getContextForMarkdownCodeBlock}, {@link getContextForJSFile}, or {@link getContextForUnknown} instead
+	 */
+	public async getContextForFile(path: string): Promise<ExecutionContext> {
+		validateAPIArgs(z.object({ path: z.string() }), { path });
+
+		const file = this.apiInstance.app.vault.getAbstractFileByPath(path);
+		if (!file || !(file instanceof TFile)) {
+			throw new Error(`File ${path} not found.`);
+		}
+
+		const metadata = this.apiInstance.app.metadataCache.getFileCache(file);
+
+		return {
+			executionSource: ExecutionSource.MarkdownCodeBlock,
+			file: file,
+			metadata: metadata ?? undefined,
+			block: undefined,
+		};
+	}
+
+	/**
+	 * Gets the execution context for a markdown code block.
+	 *
+	 * @param path The file path of the markdown file the code block is in.
+	 * @returns
 	 */
-	public async getContextForFile(path: string): Promise<JsExecutionContext> {
+	public async getContextForMarkdownCodeBlock(path: string): Promise<CodeBlockExecutionContext> {
 		validateAPIArgs(z.object({ path: z.string() }), { path });
 
 		const file = this.apiInstance.app.vault.getAbstractFileByPath(path);
 		if (!file || !(file instanceof TFile)) {
 			throw new Error(`File ${path} not found.`);
 		}
+		if (file.extension !== 'md' && file.extension !== '.md') {
+			throw new Error(`File ${path} is not a markdown file. Expected file extension to be ".md".`);
+		}
 
 		const metadata = this.apiInstance.app.metadataCache.getFileCache(file);
 
 		return {
+			executionSource: ExecutionSource.MarkdownCodeBlock,
 			file: file,
 			metadata: metadata ?? undefined,
 			block: undefined,
 		};
 	}
 
+	/**
+	 * Gets the execution context for a JS file.
+	 *
+	 * @param path The file path of the JS file.
+	 * @returns
+	 */
+	public async getContextForJSFile(path: string): Promise<JSFileExecutionContext> {
+		validateAPIArgs(z.object({ path: z.string() }), { path });
+
+		const file = this.apiInstance.app.vault.getAbstractFileByPath(path);
+		if (!file || !(file instanceof TFile)) {
+			throw new Error(`File ${path} not found.`);
+		}
+		if (file.extension !== 'js' && file.extension !== '.js') {
+			throw new Error(`File ${path} is not a JS file. Expected file extension to be ".js".`);
+		}
+
+		return {
+			executionSource: ExecutionSource.JSFile,
+			file: file,
+		};
+	}
+
+	/**
+	 * Gets an unknown execution context for anything that is not a markdown code block or a JS file.
+	 *
+	 * @param path An optional file path that will get resolved to a {@link TFile}.
+	 * @returns
+	 */
+	public async getContextForUnknown(path?: string): Promise<UnknownExecutionContext> {
+		validateAPIArgs(z.object({ path: z.string().optional() }), { path });
+
+		if (path) {
+			const file = this.apiInstance.app.vault.getAbstractFileByPath(path);
+			if (!file || !(file instanceof TFile)) {
+				throw new Error(`File ${path} not found.`);
+			}
+
+			return {
+				executionSource: ExecutionSource.Unknown,
+				file: file,
+			};
+		} else {
+			return {
+				executionSource: ExecutionSource.Unknown,
+			};
+		}
+	}
+
 	/**
 	 * Creates execution globals.
 	 *

jsEngine/engine/Engine.ts

@@ -1,5 +1,5 @@
 import { ExecutionStatsModal } from 'jsEngine/engine/ExecutionStatsModal';
-import type { JsExecutionContext } from 'jsEngine/engine/JsExecution';
+import type { ExecutionContext } from 'jsEngine/engine/JsExecution';
 import { JsExecution } from 'jsEngine/engine/JsExecution';
 import type JsEnginePlugin from 'jsEngine/main';
 import type { App, Component } from 'obsidian';
@@ -21,9 +21,9 @@ export interface EngineExecutionParams {
 	 */
 	container?: HTMLElement | undefined;
 	/**
-	 * Optional context to provide to the JavaScript code.
+	 * Context about the location the code was executed from.
 	 */
-	context?: JsExecutionContext | undefined;
+	context: ExecutionContext;
 	/**
 	 * Optional extra context variables to provide to the JavaScript code.
 	 */

jsEngine/engine/JsExecution.ts

@@ -12,16 +12,20 @@ import type * as Obsidian from 'obsidian';
  */
 export type JsFunc = (...args: unknown[]) => Promise<unknown>;
 
-/**
- * Context provided to a {@link JsExecution}.
- */
-export interface JsExecutionContext {
+export enum ExecutionSource {
+	MarkdownCodeBlock = 'markdown-code-block',
+	JSFile = 'js-file',
+	Unknown = 'unknown',
+}
+
+export interface CodeBlockExecutionContext {
+	executionSource: ExecutionSource.MarkdownCodeBlock;
 	/**
-	 * The file that the execution was triggered from.
+	 * The file that the code block is in.
 	 */
-	file?: TFile | undefined;
+	file: TFile;
 	/**
-	 * The metadata of the file that the execution was triggered from.
+	 * The metadata of the file.
 	 */
 	metadata?: CachedMetadata | undefined;
 	/**
@@ -35,6 +39,27 @@ export interface Block {
 	to: number;
 }
 
+export interface JSFileExecutionContext {
+	executionSource: ExecutionSource.JSFile;
+	/**
+	 * The JS that is being executed.
+	 */
+	file: TFile;
+}
+
+export interface UnknownExecutionContext {
+	executionSource: ExecutionSource.Unknown;
+	/**
+	 * The file that the execution was triggered from.
+	 */
+	file?: TFile | undefined;
+}
+
+/**
+ * Context provided to a {@link JsExecution}.
+ */
+export type ExecutionContext = CodeBlockExecutionContext | JSFileExecutionContext | UnknownExecutionContext;
+
 /**
  * Global variables provided to a {@link JsExecution}.
  */
@@ -54,7 +79,7 @@ export interface JsExecutionGlobals {
 	/**
 	 * The context provided. This can be undefined and extended by other properties.
 	 */
-	context: (JsExecutionContext | undefined) & Record<string, unknown>;
+	context: ExecutionContext & Record<string, unknown>;
 	/**
 	 * The container element that the execution can render to. This can be undefined.
 	 */
@@ -81,7 +106,7 @@ export interface JsExecutionGlobalsConstructionOptions {
 	/**
 	 * The context provided. This can be undefined and extended by other properties.
 	 */
-	context: (JsExecutionContext | undefined) & Record<string, unknown>;
+	context: ExecutionContext & Record<string, unknown>;
 	/**
 	 * The container element that the execution can render to. This can be undefined.
 	 */
@@ -103,7 +128,7 @@ export class JsExecution {
 	readonly app: App;
 	readonly plugin: JsEnginePlugin;
 
-	private readonly context: (JsExecutionContext | undefined) & Record<string, unknown>;
+	private readonly context: (ExecutionContext | undefined) & Record<string, unknown>;
 	private readonly apiInstance: API;
 	private messages: MessageWrapper[];
 	private func: JsFunc | undefined;
@@ -124,10 +149,13 @@ export class JsExecution {
 		this.plugin = params.plugin;
 
 		this.code = params.code;
-		this.context = Object.assign({}, params.context, params.contextOverrides);
+		this.context = {
+			...params.context,
+			...params.contextOverrides,
+		};
 
 		this.uuid = self.crypto.randomUUID();
-		this.apiInstance = new API(this.app, this.plugin, new InstanceId(InstanceType.JS_EXECUTION, this.uuid));
+		this.apiInstance = new API(this.app, this.plugin, new InstanceId(InstanceType.JS_EXECUTION, this.uuid, params.context));
 		this.messages = [];
 
 		this.func = undefined;

jsEngine/messages/MessageComponent.svelte

@@ -15,6 +15,8 @@
 		showMessageSource?: boolean;
 	} = $props();
 
+	console.log(messageWrapper.source.executionContext);
+
 	let showMore: boolean = $state(false);
 </script>
 
@@ -63,6 +65,11 @@
 					{#if showMessageSource}
 						<p>Source Name: {messageWrapper.source.name}</p>
 						<p>Source ID: {messageWrapper.source.id}</p>
+						{@const executionContext = messageWrapper.source.executionContext}
+						{#if executionContext}
+							<p>Execution Context Type: {executionContext.executionSource}</p>
+							<p>Execution Context File: {executionContext.file?.path ?? 'none'}</p>
+						{/if}
 					{/if}
 				</div>
 			{/if}