Support runEffectInsideEffect in Effect v4 (#702)

Author: mattiamanzati

.changeset/pretty-pigs-push.md

@@ -0,0 +1,7 @@
+---
+"@effect/language-service": patch
+---
+
+Add Effect v4 support for the `runEffectInsideEffect` diagnostic so it suggests and fixes `Effect.run*With` usage based on `Effect.services`.
+
+Update the generated metadata, schema, README entry, and v4 harness examples/snapshots to document and verify the new behavior.

README.md

@@ -81,7 +81,7 @@ Some diagnostics are off by default or have a default severity of suggestion, bu
     <tr><td><code>leakingRequirements</code></td><td>💡</td><td></td><td>Detects implementation services leaked in service methods</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>multipleEffectProvide</code></td><td>⚠️</td><td>🔧</td><td>Warns against chaining Effect.provide calls which can cause service lifecycle issues</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>returnEffectInGen</code></td><td>💡</td><td>🔧</td><td>Warns when returning an Effect in a generator causes nested Effect&lt;Effect&lt;...&gt;&gt;</td><td>✓</td><td>✓</td></tr>
-    <tr><td><code>runEffectInsideEffect</code></td><td>💡</td><td>🔧</td><td>Suggests using Runtime methods instead of Effect.run* inside Effect contexts</td><td>✓</td><td></td></tr>
+    <tr><td><code>runEffectInsideEffect</code></td><td>💡</td><td>🔧</td><td>Suggests using Runtime or Effect.run*With methods instead of Effect.run* inside Effect contexts</td><td>✓</td><td>✓</td></tr>
     <tr><td><code>schemaSyncInEffect</code></td><td>💡</td><td></td><td>Suggests using Effect-based Schema methods instead of sync methods inside Effect generators</td><td>✓</td><td></td></tr>
     <tr><td><code>scopeInLayerEffect</code></td><td>⚠️</td><td>🔧</td><td>Suggests using Layer.scoped instead of Layer.effect when Scope is in requirements</td><td>✓</td><td></td></tr>
     <tr><td><code>strictEffectProvide</code></td><td>➖</td><td></td><td>Warns when using Effect.provide with layers outside of application entry points</td><td>✓</td><td>✓</td></tr>

packages/harness-effect-v4/__snapshots__/diagnostics/runEffectInsideEffect.ts.codefixes

@@ -0,0 +1,5 @@
+runEffectInsideEffect_skipNextLine from 404 to 418
+runEffectInsideEffect_skipFile from 404 to 418
+runEffectInsideEffect_fix from 702 to 719
+runEffectInsideEffect_skipNextLine from 702 to 719
+runEffectInsideEffect_skipFile from 702 to 719

packages/harness-effect-v4/__snapshots__/diagnostics/runEffectInsideEffect.ts.output

@@ -0,0 +1,6 @@
+Effect.runSync
+14:20 - 14:34 | 2 | Using Effect.runSync inside an Effect is not recommended. Effects inside generators can usually just be yielded.    effect(runEffectInsideEffect)
+
+Effect.runPromise
+22:4 - 22:21 | 2 | Using Effect.runPromise inside an Effect is not recommended. The same services should generally be used instead to run child effects.
+Consider extracting the current services by using for example Effect.services and then use Effect.runPromiseWith with the extracted services instead.    effect(runEffectInsideEffect)

packages/harness-effect-v4/__snapshots__/diagnostics/runEffectInsideEffect.ts.runEffectInsideEffect_fix.from702to719.output

@@ -0,0 +1,28 @@
+// code fix runEffectInsideEffect_fix  output for range 702 - 719
+import { Data, Effect } from "effect"
+
+class DebuggerError extends Data.TaggedError("DebuggerError")<{
+  cause: unknown
+}> {}
+
+export const program = Effect.gen(function*() {
+const effectServices = yield* Effect.services<never>()
+
+  const response = yield* Effect.tryPromise({
+    try: () => fetch("http://localhost:9229"),
+    catch: (e) => new DebuggerError({ cause: e })
+  })
+  const data = yield* Effect.promise(() => response.json())
+
+  const websocket = Effect.runSync(Effect.sync(() => new WebSocket(data.url)))
+  //                        ^- do not runSync in here
+
+  websocket.onmessage = (event) => {
+    const check = Effect.tryPromise({
+      try: () => fetch(event.data as string),
+      catch: (e) => new DebuggerError({ cause: e })
+    })
+    Effect.runPromiseWith(effectServices)(check)
+    //        ^- no runPromise, use the current services instead
+  }
+})

packages/harness-effect-v4/__snapshots__/diagnostics/runEffectInsideEffect_preview.ts.codefixes

@@ -0,0 +1,3 @@
+runEffectInsideEffect_fix from 183 to 197
+runEffectInsideEffect_skipNextLine from 183 to 197
+runEffectInsideEffect_skipFile from 183 to 197

packages/harness-effect-v4/__snapshots__/diagnostics/runEffectInsideEffect_preview.ts.output

@@ -0,0 +1,3 @@
+Effect.runSync
+6:20 - 6:34 | 0 | Using Effect.runSync inside an Effect is not recommended. The same services should generally be used instead to run child effects.
+Consider extracting the current services by using for example Effect.services and then use Effect.runSyncWith with the extracted services instead.    effect(runEffectInsideEffect)

packages/harness-effect-v4/__snapshots__/diagnostics/runEffectInsideEffect_preview.ts.runEffectInsideEffect_fix.from183to197.output

@@ -0,0 +1,11 @@
+// code fix runEffectInsideEffect_fix  output for range 183 - 197
+// @effect-diagnostics *:off
+// @effect-diagnostics runEffectInsideEffect:warning
+import { Effect } from "effect"
+
+export const preview = Effect.gen(function*() {
+const effectServices = yield* Effect.services<never>()
+
+  const run = () => Effect.runSyncWith(effectServices)(Effect.succeed(1))
+  return run()
+})

packages/harness-effect-v4/examples/diagnostics/runEffectInsideEffect.ts

@@ -0,0 +1,25 @@
+import { Data, Effect } from "effect"
+
+class DebuggerError extends Data.TaggedError("DebuggerError")<{
+  cause: unknown
+}> {}
+
+export const program = Effect.gen(function*() {
+  const response = yield* Effect.tryPromise({
+    try: () => fetch("http://localhost:9229"),
+    catch: (e) => new DebuggerError({ cause: e })
+  })
+  const data = yield* Effect.promise(() => response.json())
+
+  const websocket = Effect.runSync(Effect.sync(() => new WebSocket(data.url)))
+  //                        ^- do not runSync in here
+
+  websocket.onmessage = (event) => {
+    const check = Effect.tryPromise({
+      try: () => fetch(event.data as string),
+      catch: (e) => new DebuggerError({ cause: e })
+    })
+    Effect.runPromise(check)
+    //        ^- no runPromise, use the current services instead
+  }
+})

packages/harness-effect-v4/examples/diagnostics/runEffectInsideEffect_preview.ts

@@ -0,0 +1,8 @@
+// @effect-diagnostics *:off
+// @effect-diagnostics runEffectInsideEffect:warning
+import { Effect } from "effect"
+
+export const preview = Effect.gen(function*() {
+  const run = () => Effect.runSync(Effect.succeed(1))
+  return run()
+})