feat: @app and @filename intrinsics (#7078)

Co-authored-by: wingbot <[email protected]> Co-authored-by: monada-bot[bot] <[email protected]> Co-authored-by: Elad Ben-Israel <[email protected]>
winglang · Sep 6, 2024 · 07e2faf · 07e2faf
1 parent 9adaea0
commit 07e2faf
Show file tree

Hide file tree

Showing 48 changed files with 598 additions and 284 deletions.
diff --git a/docs/api/04-standard-library/std/node.md b/docs/api/04-standard-library/std/node.md
@@ -701,10 +701,10 @@ prepended to the unique identifier.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@winglang/sdk.std.IApp.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
-| <code><a href="#@winglang/sdk.std.IApp.property.entrypointDir">entrypointDir</a></code> | <code>str</code> | The directory of the entrypoint of the current program. |
+| <code><a href="#@winglang/sdk.std.IApp.property.entrypointDir">entrypointDir</a></code> | <code>str</code> | The directory of the entrypoint of the current Wing application. |
 | <code><a href="#@winglang/sdk.std.IApp.property.isTestEnvironment">isTestEnvironment</a></code> | <code>bool</code> | `true` if this is a testing environment. |
 | <code><a href="#@winglang/sdk.std.IApp.property.parameters">parameters</a></code> | <code><a href="#@winglang/sdk.platform.ParameterRegistrar">ParameterRegistrar</a></code> | The application's parameter registrar. |
-| <code><a href="#@winglang/sdk.std.IApp.property.workdir">workdir</a></code> | <code>str</code> | The `.wing` directory into which you can emit artifacts during preflight. |
+| <code><a href="#@winglang/sdk.std.IApp.property.workdir">workdir</a></code> | <code>str</code> | The `.wing` directory into which you can emit intermediate artifacts during preflight. |
 
 ---
 
@@ -728,7 +728,7 @@ entrypointDir: str;
 
 - *Type:* str
 
-The directory of the entrypoint of the current program.
+The directory of the entrypoint of the current Wing application.
 
 ---
 
@@ -764,7 +764,7 @@ workdir: str;
 
 - *Type:* str
 
-The `.wing` directory into which you can emit artifacts during preflight.
+The `.wing` directory into which you can emit intermediate artifacts during preflight.
 
 ---
 
diff --git a/docs/api/05-language-reference.md b/docs/api/05-language-reference.md
@@ -591,10 +591,12 @@ the following properties (given an example intrinsic `@x`):
 | --------------- | ------------------------------------------------------------------------------------------------------------------------- |
 | `@log()`        | logs str                                                                                                                  |
 | `@assert()`     | checks a condition and _throws_ if evaluated to false                                                                     |
-| `@dirname`      | current source directory                                                                                                  |
+| `@filename`     | absolute path of the source file                                                                                          |
+| `@dirname`      | absolute path of the source file's directory                                                                              |
+| `@app`          | the root of the construct tree                                                                                            |
 | `@unsafeCast()` | cast a value into a different type                                                                                        |
-| `@nodeof()`     | obtain the [tree node](/docs/concepts/application-tree) of a preflight object                                        |
-| `@lift()`       | explicitly qualify a [lift](/docs/concepts/inflights) of a preflight object |
+| `@nodeof()`     | obtain the [tree node](/docs/concepts/application-tree) of a preflight object                                             |
+| `@lift()`       | explicitly qualify a [lift](/docs/concepts/inflights) of a preflight object                                               |
 
 > ```TS
 > @log("Hello {name}");

diff --git a/packages/@winglang/sdk/src/helpers.ts b/packages/@winglang/sdk/src/helpers.ts
@@ -164,11 +164,8 @@ export function createExternRequire(dirname: string) {
   };
 }
 
-export function resolveDirname(
-  outdir: string,
-  relativeSourceDir: string
-): string {
-  return normalPath(path.resolve(outdir, relativeSourceDir));
+export function resolve(outdir: string, relativeSourcePath: string): string {
+  return normalPath(path.resolve(outdir, relativeSourcePath));
 }
 
 /**

diff --git a/packages/@winglang/sdk/src/std/node.ts b/packages/@winglang/sdk/src/std/node.ts
@@ -472,7 +472,7 @@ export interface IApp extends IConstruct {
   readonly [APP_SYMBOL]: true;
 
   /**
-   * The `.wing` directory into which you can emit artifacts during preflight.
+   * The `.wing` directory into which you can emit intermediate artifacts during preflight.
    */
   readonly workdir: string;
 
@@ -482,7 +482,7 @@ export interface IApp extends IConstruct {
   readonly isTestEnvironment: boolean;
 
   /**
-   * The directory of the entrypoint of the current program.
+   * The directory of the entrypoint of the current Wing application.
    */
   readonly entrypointDir: string;
 

diff --git a/packages/@winglang/wingc/src/ast.rs b/packages/@winglang/wingc/src/ast.rs
@@ -588,13 +588,17 @@ pub enum IntrinsicKind {
 	/// Error state
 	Unknown,
 	Dirname,
+	Filename,
+	App,
 }
 
 impl Display for IntrinsicKind {
 	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 		match self {
 			IntrinsicKind::Unknown => write!(f, "@"),
 			IntrinsicKind::Dirname => write!(f, "@dirname"),
+			IntrinsicKind::Filename => write!(f, "@filename"),
+			IntrinsicKind::App => write!(f, "@app"),
 		}
 	}
 }
@@ -603,6 +607,8 @@ impl IntrinsicKind {
 	pub fn from_str(s: &str) -> Self {
 		match s {
 			"@dirname" => IntrinsicKind::Dirname,
+			"@filename" => IntrinsicKind::Filename,
+			"@app" => IntrinsicKind::App,
 			_ => IntrinsicKind::Unknown,
 		}
 	}
@@ -614,6 +620,14 @@ impl IntrinsicKind {
 				Phase::Preflight => true,
 				_ => false,
 			},
+			IntrinsicKind::Filename => match phase {
+				Phase::Preflight => true,
+				_ => false,
+			},
+			IntrinsicKind::App => match phase {
+				Phase::Preflight => true,
+				_ => false,
+			},
 		}
 	}
 }

diff --git a/packages/@winglang/wingc/src/jsify.rs b/packages/@winglang/wingc/src/jsify.rs
@@ -683,24 +683,49 @@ impl<'a> JSifier<'a> {
 						// Only happens inflight, so we can assume an error was caught earlier
 						return new_code!(expr_span, "");
 					};
-					let relative_source_path = make_relative_path(
-						self.out_dir.as_str(),
-						source_path
-							.path
-							.parent()
-							.expect("source path is file in a directory")
-							.as_str(),
-					);
+					let source_dir = source_path.path.parent().expect("source path is file in a directory");
+
+					// Calculate the path of "if I'm at <outdir>, how do I get to <source_dir>"
+					// This relative path is what we will write inside the js file, with the motivation that
+					// the output is more stable across different users' machines than an absolute path.
+					let relative_source_path = make_relative_path(self.out_dir.as_str(), source_dir.as_str());
+
+					// At runtime, $helpers.resolve will normalize the path for Windows or Unix, and then convert it to an absolute path
 					new_code!(
 						expr_span,
 						HELPERS_VAR,
-						".resolveDirname(",
+						".resolve(",
 						__DIRNAME,
 						", \"",
 						relative_source_path,
 						"\")"
 					)
 				}
+				IntrinsicKind::Filename => {
+					let Some(source_path) = ctx.source_file else {
+						// Only happens inflight, so we can assume an error was caught earlier
+						return new_code!(expr_span, "");
+					};
+
+					// Calculate the path of "if I'm at <outdir>, how do I get to <source_path>"
+					// This relative path is what we will write inside the js file, with the motivation that
+					// the output is more stable across different users' machines than an absolute path.
+					let relative_source_path = make_relative_path(self.out_dir.as_str(), source_path.path.as_str());
+
+					// At runtime, $helpers.resolve will normalize the path for Windows or Unix, and then convert it to an absolute path
+					new_code!(
+						expr_span,
+						HELPERS_VAR,
+						".resolve(",
+						__DIRNAME,
+						", \"",
+						relative_source_path,
+						"\")"
+					)
+				}
+				IntrinsicKind::App => {
+					new_code!(expr_span, HELPERS_VAR, ".nodeof(this).app")
+				}
 			},
 			ExprKind::Call { callee, arg_list } => {
 				let function_type = match callee {

diff --git a/packages/@winglang/wingc/src/jsify/snapshots/fails_when_referencing_this_from_static.snap b/packages/@winglang/wingc/src/jsify/snapshots/fails_when_referencing_this_from_static.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/jsify/tests.rs
+source: packages/@winglang/wingc/src/jsify/tests.rs
 ---
 ## Errors
 Member "print" does not exist in "Construct" 3:13
diff --git a/packages/@winglang/wingc/src/lib.rs b/packages/@winglang/wingc/src/lib.rs
@@ -123,6 +123,7 @@ const WINGSDK_AUTOID_RESOURCE: &'static str = "std.AutoIdResource";
 const WINGSDK_STRUCT: &'static str = "std.Struct";
 const WINGSDK_TEST_CLASS_NAME: &'static str = "Test";
 const WINGSDK_NODE: &'static str = "std.Node";
+const WINGSDK_APP: &'static str = "std.IApp";
 
 const WINGSDK_SIM_IRESOURCE: &'static str = "sim.IResource";
 const WINGSDK_SIM_IRESOURCE_FQN: &'static str = formatcp!(
@@ -289,7 +290,6 @@ pub fn type_check_file(
 		None,
 	);
 	tc.add_builtins(scope);
-	tc.patch_constructs();
 
 	// If the file is an entrypoint file, we add "this" to its symbol environment
 	if is_entrypoint_file(&file.path) {

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/call_struct_expansion.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/call_struct_expansion.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: "a:"
   kind: 5

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/call_struct_expansion_partial.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/call_struct_expansion_partial.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: "two:"
   kind: 5

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/empty.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/empty.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: this
   kind: 6

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/intrinsics.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/intrinsics.snap
@@ -1,11 +1,25 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
+- label: "@app"
+  kind: 6
+  detail: IApp
+  documentation:
+    kind: markdown
+    value: "Get the root application node.\n\nThe application node is the root of the construct tree and all other resources are children (or grandchildren) of this node.\nSee https://www.winglang.io/docs/concepts/application-tree for more information."
+  sortText: bb|@app
 - label: "@dirname"
   kind: 6
   detail: str
   documentation:
     kind: markdown
-    value: "Get the normalized absolute path of the current source file's directory.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight.\nIt should primarily be used in preflight or in inflights that are guaranteed to be executed in the same filesystem where preflight executed."
+    value: "Get the normalized absolute path of the current Wing source file's directory.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight."
   sortText: bb|@dirname
+- label: "@filename"
+  kind: 6
+  detail: str
+  documentation:
+    kind: markdown
+    value: "Get the normalized absolute path of the current Wing source file.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight."
+  sortText: bb|@filename
 
diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/intrinsics_partial.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/intrinsics_partial.snap
@@ -1,11 +1,25 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
+- label: "@app"
+  kind: 6
+  detail: IApp
+  documentation:
+    kind: markdown
+    value: "Get the root application node.\n\nThe application node is the root of the construct tree and all other resources are children (or grandchildren) of this node.\nSee https://www.winglang.io/docs/concepts/application-tree for more information."
+  sortText: bb|@app
 - label: "@dirname"
   kind: 6
   detail: str
   documentation:
     kind: markdown
-    value: "Get the normalized absolute path of the current source file's directory.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight.\nIt should primarily be used in preflight or in inflights that are guaranteed to be executed in the same filesystem where preflight executed."
+    value: "Get the normalized absolute path of the current Wing source file's directory.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight."
   sortText: bb|@dirname
+- label: "@filename"
+  kind: 6
+  detail: str
+  documentation:
+    kind: markdown
+    value: "Get the normalized absolute path of the current Wing source file.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight."
+  sortText: bb|@filename
 
diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/only_show_symbols_in_scope.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/only_show_symbols_in_scope.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: a
   kind: 6

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/struct_arg_expansion_partial.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/struct_arg_expansion_partial.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: "a1:"
   kind: 5

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/struct_literal_value.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/struct_literal_value.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: this
   kind: 6

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/completions/struct_show_values.snap b/packages/@winglang/wingc/src/lsp/snapshots/completions/struct_show_values.snap
@@ -1,5 +1,5 @@
 ---
-source: libs/wingc/src/lsp/completions.rs
+source: packages/@winglang/wingc/src/lsp/completions.rs
 ---
 - label: this
   kind: 6

diff --git a/packages/@winglang/wingc/src/lsp/snapshots/hovers/intrinsics.snap b/packages/@winglang/wingc/src/lsp/snapshots/hovers/intrinsics.snap
@@ -1,9 +1,9 @@
 ---
-source: libs/wingc/src/lsp/hover.rs
+source: packages/@winglang/wingc/src/lsp/hover.rs
 ---
 contents:
   kind: markdown
-  value: "```wing\nstatic preflight @dirname: str\n```\n---\nGet the normalized absolute path of the current source file's directory.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight.\nIt should primarily be used in preflight or in inflights that are guaranteed to be executed in the same filesystem where preflight executed."
+  value: "```wing\nstatic preflight @dirname: str\n```\n---\nGet the normalized absolute path of the current Wing source file's directory.\n\nThe resolved path represents a path during preflight only and is not guaranteed to be valid while inflight."
 range:
   start:
     line: 1