feat: deprecate inflight intrinsic

winglang · Aug 5, 2024 · 2804210 · 2804210
1 parent 9c36ce5
commit 2804210
Show file tree

Hide file tree

Showing 22 changed files with 5 additions and 1,077 deletions.
diff --git a/docs/api/03-language/10-using-javascript.md b/docs/api/03-language/10-using-javascript.md
@@ -4,75 +4,6 @@ id: using-javascript
 keywords: [example, javascript, extern, typescript, js, ts]
 ---
 
-## Creating inflight function from JavaScript/TypeScript file
-
-Inflight closures are an extremely important Wing functionality. Consider the following simple wing program:
-
-```wing example
-// main.w
-bring cloud;
-let bucket = new cloud.Bucket();
-
-bucket.onCreate(inflight (file) => {
-  log(file);
-});
-```
-
-Being able to write inflight wing alongside the preflight code is beautiful, but you may want to write the inflight function in a separate file and *language*. The `@inflight` intrinsic function can be used to create an inflight closure from a JavaScript/TypeScript:
-
-```wing
-// main.w
-bring cloud;
-let bucket = new cloud.Bucket();
-
-bucket.onCreate(@inflight("./bucket_create.ts"));
-//              ^ onCreate expects an `inflight (str): void` function, so the file must export a function with a typescript signature that matches
-//                        ^ Relative (to current file) path to javascript or typescript file
-//                          Note: This must be a static string
-```
-
-`wing compile` will generate `.bucket_create.inflight.ts` which will contain all of the information needed for TypeScript type checking and IDE support.
-With that, you can create the `bucket_create.ts` file:
-
-```ts
-// bucket_create.ts
-import inflight from "./.bucket_create.inflight";
-
-export default inflight(async ({}, file) => {
-//                                 ^ This is known to be a string, the first positional argument needed for `onCreate`
-  console.log(file);
-});
-```
-
-Something missing here is the ability to reference preflight resources inside an inflight function.
-Let's create a Queue and pass it to the inflight function while exploring other options:
-
-```wing
-// main.w
-bring cloud;
-let bucket = new cloud.Bucket();
-let queue = new cloud.Queue();
-
-bucket.onCreate(@inflight("./bucket_create.ts",
-  export: "default",
-//        ^ Optional named export from the file, "default" is the default export
-  lifts:[{ obj: queue, alias: "myQueue", ops: ["push"] }],
-//       ^ object to lift, can be any preflight expression
-//                     ^ Optional alias, by default, this will be the variable name passed to obj
-//                                     ^ methods to lift, if not provided then all methods will be granted
-));
-``` 
-
-```ts
-// bucket_create.ts
-import inflight from "./bucket_create.inflight";
-
-export default inflight(async ({ myQueue }, file) => {
-//                               ^ inflight interface to your preflight queue
-  await myQueue.push(file);
-});
-```
-
 ## Using `extern` to expose JavaScript/TypeScript functions in preflight and inflight
 
 When you want to use a JavaScript/TypeScript file anywhere in Wing, you can use the `extern` keyword to expose functions from that file.

diff --git a/docs/api/04-standard-library/std/resource.md b/docs/api/04-standard-library/std/resource.md
@@ -9,51 +9,6 @@ id: resource
 
 ## Structs <a name="Structs" id="Structs"></a>
 
-### ImportInflightOptions <a name="ImportInflightOptions" id="@winglang/sdk.std.ImportInflightOptions"></a>
-
-Options for the `@inflight` intrinsic.
-
-#### Initializer <a name="Initializer" id="@winglang/sdk.std.ImportInflightOptions.Initializer"></a>
-
-```wing
-let ImportInflightOptions = ImportInflightOptions{ ... };
-```
-
-#### Properties <a name="Properties" id="Properties"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@winglang/sdk.std.ImportInflightOptions.property.export">export</a></code> | <code>str</code> | Name of exported function. |
-| <code><a href="#@winglang/sdk.std.ImportInflightOptions.property.lifts">lifts</a></code> | <code>MutArray&lt;<a href="#@winglang/sdk.std.LiftAnnotation">LiftAnnotation</a>&gt;</code> | Mapping of available symbols to a lift declaration. |
-
----
-
-##### `export`<sup>Optional</sup> <a name="export" id="@winglang/sdk.std.ImportInflightOptions.property.export"></a>
-
-```wing
-export: str;
-```
-
-- *Type:* str
-- *Default:* "default"
-
-Name of exported function.
-
----
-
-##### `lifts`<sup>Optional</sup> <a name="lifts" id="@winglang/sdk.std.ImportInflightOptions.property.lifts"></a>
-
-```wing
-lifts: MutArray<LiftAnnotation>;
-```
-
-- *Type:* MutArray&lt;<a href="#@winglang/sdk.std.LiftAnnotation">LiftAnnotation</a>&gt;
-- *Default:* * All possible operations will be available
-
-Mapping of available symbols to a lift declaration.
-
----
-
 ### LiftAnnotation <a name="LiftAnnotation" id="@winglang/sdk.std.LiftAnnotation"></a>
 
 Annotations about preflight data and desired inflight operations.

diff --git a/examples/tests/doc_examples/valid/10-using-javascript.md_example_1/main.w b/examples/tests/doc_examples/valid/10-using-javascript.md_example_1/main.w
diff --git a/examples/tests/invalid/inflight_intrinsic.test.w b/examples/tests/invalid/inflight_intrinsic.test.w
diff --git a/examples/tests/valid/inflight_ts/.example1.inflight.ts b/examples/tests/valid/inflight_ts/.example1.inflight.ts
diff --git a/examples/tests/valid/inflight_ts/.example2.inflight.ts b/examples/tests/valid/inflight_ts/.example2.inflight.ts
diff --git a/examples/tests/valid/inflight_ts/.example3.inflight.ts b/examples/tests/valid/inflight_ts/.example3.inflight.ts
diff --git a/examples/tests/valid/inflight_ts/example1.ts b/examples/tests/valid/inflight_ts/example1.ts
diff --git a/examples/tests/valid/inflight_ts/example2.ts b/examples/tests/valid/inflight_ts/example2.ts
diff --git a/examples/tests/valid/inflight_ts/example3.ts b/examples/tests/valid/inflight_ts/example3.ts
diff --git a/examples/tests/valid/intrinsics.test.w b/examples/tests/valid/intrinsics.test.w
@@ -13,47 +13,3 @@ let currentFile = fs.join(@dirname, filename);
 expect.equal(filename, fs.basename(currentFile));
 expect.equal(@dirname, fs.dirname(currentFile));
 expect.equal(bar.Bar.getSubdir(), fs.join(@dirname, "subdir"));
-
-// @inflight
-
-let counter = new cloud.Counter();
-pub class Example {
-  pub inflight getMessage(): str {
-    return "message";
-  }
-  pub inflight done() {
-    counter.inc();
-  }
-}
-
-let echo: inflight (str): str = @inflight("./inflight_ts/example1.ts");
-
-let example = new Example();
-let funcFunction = @inflight("./inflight_ts/example2.ts",
-  export: "main",
-  lifts: [
-    { obj: example },
-    { obj: example, alias: "exampleCopy", ops: ["getMessage"]},
-    { obj: [1, 2, 3], alias: "numbers" },
-  ],
-);
-let func = new cloud.Function(funcFunction);
-
-let defaultMessage: inflight (): str = @inflight("./inflight_ts/example3.ts",
-  // Intentionally use { } instead of struct expansion
-  { lifts: [{ obj: example }] }
-);
-
-
-test "invoke default function" {
-  expect.equal(echo("message"), "message");
-}
-
-test "invoke inflight function" {
-  funcFunction("message");
-  func.invoke("message");
-}
-
-test "invoke default with lift" {
-  expect.equal(defaultMessage(), "message");
-}
diff --git a/libs/wingc/src/ast.rs b/libs/wingc/src/ast.rs
@@ -584,15 +584,13 @@ pub enum IntrinsicKind {
 	/// Error state
 	Unknown,
 	Dirname,
-	Inflight,
 }
 
 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::Inflight => write!(f, "@inflight"),
 		}
 	}
 }
@@ -601,7 +599,6 @@ impl IntrinsicKind {
 	pub fn from_str(s: &str) -> Self {
 		match s {
 			"@dirname" => IntrinsicKind::Dirname,
-			"@inflight" => IntrinsicKind::Inflight,
 			_ => IntrinsicKind::Unknown,
 		}
 	}
@@ -613,10 +610,6 @@ impl IntrinsicKind {
 				Phase::Preflight => true,
 				_ => false,
 			},
-			IntrinsicKind::Inflight => match phase {
-				Phase::Preflight => true,
-				_ => false,
-			},
 		}
 	}
 }
@@ -717,20 +710,6 @@ impl Expr {
 		let id = EXPR_COUNTER.fetch_add(1, Ordering::SeqCst);
 		Self { id, kind, span }
 	}
-
-	pub fn as_static_string(&self) -> Option<&str> {
-		match &self.kind {
-			ExprKind::Literal(Literal::String(s)) => {
-				// strip the quotes ("data")
-				Some(&s[1..s.len() - 1])
-			}
-			ExprKind::Literal(Literal::NonInterpolatedString(s)) => {
-				// strip the quotes (#"data")
-				Some(&s[2..s.len() - 1])
-			}
-			_ => None,
-		}
-	}
 }
 
 pub type ArgListId = usize;