Skip to content

Commit 679f956

Browse files
authored
Enforce Effect.fnUntraced for functions returning Effect.gen (#9506)
1 parent 23460fa commit 679f956

21 files changed

Lines changed: 1019 additions & 1053 deletions

File tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
"effect": patch
3+
"@effect/platform-node": patch
4+
"@effect/platform-bun": patch
5+
"@effect/sql-pg": patch
6+
"@effect/docgen": patch
7+
---
8+
9+
Use `Effect.fnUntraced` for internal functions that returned `Effect.gen`.

‎ai-docs/tsconfig.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@
1313
"plugins": [
1414
{
1515
"name": "@effect/language-service",
16+
"effectFn": ["untraced"],
1617
"namespaceImportPackages": [],
1718
"diagnosticSeverity": {
1819
"floatingEffect": "off",
1920
"preferSchemaOverJson": "off",
20-
"unstableApiUsage": "off"
21+
"unstableApiUsage": "off",
22+
"effectFnOpportunity": "error"
2123
}
2224
}
2325
]

‎packages/effect/src/ai/McpServer.ts‎

Lines changed: 188 additions & 192 deletions
Large diffs are not rendered by default.

‎packages/effect/src/cluster/ClusterWorkflowEngine.ts‎

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -384,26 +384,25 @@ export const make = Effect.gen(function*() {
384384
// `Suspended`. Replies are only observed on the runner that saves them, so
385385
// callers on other runners, and any failure here, leave delivery to the
386386
// caller's retry schedule.
387-
const awaitComplete = (workflow: Workflow.Any, executionId: string) =>
388-
Effect.gen(function*() {
389-
const address = entityAddressFor({ workflow, entityType: `Workflow/${workflow._tag}`, executionId })
390-
if (!sharding.hasShardId(address.shardId)) return yield* Effect.never
391-
const requestId = yield* storage.requestIdForPrimaryKey({ address, tag: "run", id: "" })
392-
if (Option.isNone(requestId)) return yield* Effect.never
393-
const request = Envelope.makeRequest<any>({
394-
requestId: requestId.value,
395-
address,
396-
tag: "run",
397-
payload: {},
398-
headers: Headers.empty
399-
})
400-
// A replay that suspends again re-arms the wait, so it does not spend a
401-
// step of the caller's retry schedule.
402-
let settled = false
403-
while (!settled) {
404-
settled = yield* awaitRunReply(workflow, request, (reply) => !isSuspendedReply(reply))
405-
}
406-
}).pipe(Effect.catchCause(() => Effect.never))
387+
const awaitComplete = Effect.fnUntraced(function*(workflow: Workflow.Any, executionId: string) {
388+
const address = entityAddressFor({ workflow, entityType: `Workflow/${workflow._tag}`, executionId })
389+
if (!sharding.hasShardId(address.shardId)) return yield* Effect.never
390+
const requestId = yield* storage.requestIdForPrimaryKey({ address, tag: "run", id: "" })
391+
if (Option.isNone(requestId)) return yield* Effect.never
392+
const request = Envelope.makeRequest<any>({
393+
requestId: requestId.value,
394+
address,
395+
tag: "run",
396+
payload: {},
397+
headers: Headers.empty
398+
})
399+
// A replay that suspends again re-arms the wait, so it does not spend a
400+
// step of the caller's retry schedule.
401+
let settled = false
402+
while (!settled) {
403+
settled = yield* awaitRunReply(workflow, request, (reply) => !isSuspendedReply(reply))
404+
}
405+
}, Effect.catchCause(() => Effect.never))
407406

408407
const interrupt = Effect.fnUntraced(
409408
function*(workflow: Workflow.Any, executionId: string) {

‎packages/effect/src/cluster/SqlMessageStorage.ts‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -967,17 +967,16 @@ export const migrations = (options?: {
967967
CREATE INDEX ${sql(requestIdLookupIndex)}
968968
ON ${messagesTableSql} (request_id);
969969
`.unprepared.pipe(Effect.ignore),
970-
pg: () =>
971-
Effect.gen(function*() {
972-
yield* sql`
970+
pg: Effect.fnUntraced(function*() {
971+
yield* sql`
973972
CREATE INDEX IF NOT EXISTS ${sql(shardLookupIndex)}
974973
ON ${messagesTableSql} (shard_id, processed, last_read, deliver_at)
975974
`
976-
yield* sql`
975+
yield* sql`
977976
CREATE INDEX IF NOT EXISTS ${sql(requestIdLookupIndex)}
978977
ON ${messagesTableSql} (request_id)
979978
`
980-
}),
979+
}),
981980
orElse: () =>
982981
// sqlite
983982
Effect.all([

‎packages/effect/src/eventlog/SqlEventJournal.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -527,16 +527,16 @@ export const make = (options?: {
527527
},
528528
withTracerDisabled
529529
),
530-
writeRemoteAcks: ({ acks, firstSequence, remoteId }) =>
531-
Effect.gen(function*() {
530+
writeRemoteAcks: Effect.fnUntraced(
531+
function*({ acks, firstSequence, remoteId }) {
532532
if (acks.length === 0) return
533533
const next = yield* readCursor(remoteId)
534534
yield* writeCursor(remoteId, EventJournal.advanceSequence(next, acks, firstSequence))
535-
}).pipe(
536-
sql.withTransaction,
537-
withTracerDisabled,
538-
Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "writeRemoteAcks" }))
539-
),
535+
},
536+
(_) => sql.withTransaction(_),
537+
(_) => withTracerDisabled(_),
538+
Effect.mapError((cause) => new EventJournal.EventJournalError({ cause, method: "writeRemoteAcks" }))
539+
),
540540
nextRemoteSequence: (remoteId) =>
541541
readCursor(remoteId).pipe(
542542
withTracerDisabled,

‎packages/effect/src/persistence/PersistedQueue.ts‎

Lines changed: 69 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -876,24 +876,23 @@ export const makeStoreRedis = Effect.fnUntraced(function*(
876876
})
877877
)
878878

879-
const scanKeys = (pattern: string) =>
880-
Effect.gen(function*() {
881-
const keys: Array<string> = []
882-
let cursor = "0"
883-
do {
884-
const [next, batch] = yield* redis.send<[string, Array<string>]>(
885-
"SCAN",
886-
cursor,
887-
"MATCH",
888-
pattern,
889-
"COUNT",
890-
"100"
891-
)
892-
cursor = next
893-
for (const key of batch) keys.push(key)
894-
} while (cursor !== "0")
895-
return keys
896-
})
879+
const scanKeys = Effect.fnUntraced(function*(pattern: string) {
880+
const keys: Array<string> = []
881+
let cursor = "0"
882+
do {
883+
const [next, batch] = yield* redis.send<[string, Array<string>]>(
884+
"SCAN",
885+
cursor,
886+
"MATCH",
887+
pattern,
888+
"COUNT",
889+
"100"
890+
)
891+
cursor = next
892+
for (const key of batch) keys.push(key)
893+
} while (cursor !== "0")
894+
return keys
895+
})
897896

898897
return PersistedQueueStore.of({
899898
offer: ({ delay, element, id, isCustomId, name }) => {
@@ -1007,8 +1006,8 @@ export const makeStoreRedis = Effect.fnUntraced(function*(
10071006
})
10081007
)
10091008
}),
1010-
cleanup: ({ failedTimeToLive, timeToLive }) =>
1011-
Effect.gen(function*() {
1009+
cleanup: Effect.fnUntraced(
1010+
function*({ failedTimeToLive, timeToLive }) {
10121011
const now = clock.currentTimeMillisUnsafe()
10131012
const idsKeys = yield* scanKeys(`${prefix}*:ids`)
10141013
const cutoff = now - Duration.toMillis(timeToLive)
@@ -1030,14 +1029,14 @@ export const makeStoreRedis = Effect.fnUntraced(function*(
10301029
{ concurrency: 16, discard: true }
10311030
)
10321031
}
1033-
}).pipe(
1034-
Effect.mapError(({ cause }) =>
1035-
new PersistedQueueError({
1036-
message: "Failed to clean up persisted queue",
1037-
cause
1038-
})
1039-
)
1032+
},
1033+
Effect.mapError(({ cause }) =>
1034+
new PersistedQueueError({
1035+
message: "Failed to clean up persisted queue",
1036+
cause
1037+
})
10401038
)
1039+
)
10411040
})
10421041
})
10431042

@@ -1905,22 +1904,22 @@ export const makeStoreSql: (
19051904
)
19061905
return loop
19071906
},
1908-
cleanup: ({ failedTimeToLive, timeToLive }) =>
1909-
Effect.gen(function*() {
1907+
cleanup: Effect.fnUntraced(
1908+
function*({ failedTimeToLive, timeToLive }) {
19101909
yield* cleanupState("completed", timeToLive)
19111910
if (failedTimeToLive !== undefined) {
19121911
yield* cleanupState("failed", failedTimeToLive)
19131912
}
1914-
}).pipe(
1915-
Effect.catchCause((cause) =>
1916-
Effect.fail(
1917-
new PersistedQueueError({
1918-
message: "Failed to clean up persisted queue",
1919-
cause
1920-
})
1921-
)
1913+
},
1914+
Effect.catchCause((cause) =>
1915+
Effect.fail(
1916+
new PersistedQueueError({
1917+
message: "Failed to clean up persisted queue",
1918+
cause
1919+
})
19221920
)
19231921
)
1922+
)
19241923
})
19251924
})
19261925

@@ -2038,46 +2037,43 @@ const sqlMigrations = (tableName: string) =>
20382037
const takeIndex = sql(`idx_${tableName}_take`)
20392038

20402039
yield* sql.onDialectOrElse({
2041-
pg: () =>
2042-
Effect.gen(function*() {
2043-
yield* sql`DROP INDEX IF EXISTS ${takeIndex}`
2044-
yield* sql`ALTER TABLE ${tableNameSql}
2040+
pg: Effect.fnUntraced(function*() {
2041+
yield* sql`DROP INDEX IF EXISTS ${takeIndex}`
2042+
yield* sql`ALTER TABLE ${tableNameSql}
20452043
ADD COLUMN state VARCHAR(10),
20462044
ADD COLUMN visible_at TIMESTAMP`
2047-
yield* sql`UPDATE ${tableNameSql}
2045+
yield* sql`UPDATE ${tableNameSql}
20482046
SET state = CASE WHEN completed THEN 'completed' ELSE 'pending' END,
20492047
visible_at = updated_at`
2050-
yield* sql`ALTER TABLE ${tableNameSql}
2048+
yield* sql`ALTER TABLE ${tableNameSql}
20512049
ALTER COLUMN sequence TYPE BIGINT,
20522050
ALTER COLUMN id TYPE VARCHAR(255),
20532051
ALTER COLUMN queue_name TYPE VARCHAR(255),
20542052
ALTER COLUMN state SET NOT NULL,
20552053
ALTER COLUMN visible_at SET NOT NULL,
20562054
DROP COLUMN completed`
2057-
}),
2058-
mysql: () =>
2059-
Effect.gen(function*() {
2060-
yield* sql`DROP INDEX ${takeIndex} ON ${tableNameSql}`
2061-
yield* sql`ALTER TABLE ${tableNameSql}
2055+
}),
2056+
mysql: Effect.fnUntraced(function*() {
2057+
yield* sql`DROP INDEX ${takeIndex} ON ${tableNameSql}`
2058+
yield* sql`ALTER TABLE ${tableNameSql}
20622059
MODIFY COLUMN id VARCHAR(255) NOT NULL,
20632060
MODIFY COLUMN queue_name VARCHAR(255) NOT NULL,
20642061
MODIFY COLUMN element MEDIUMTEXT NOT NULL,
20652062
MODIFY COLUMN last_failure MEDIUMTEXT NULL,
20662063
ADD COLUMN state VARCHAR(10) NULL,
20672064
ADD COLUMN visible_at DATETIME NULL`
2068-
yield* sql`UPDATE ${tableNameSql}
2065+
yield* sql`UPDATE ${tableNameSql}
20692066
SET state = CASE WHEN completed THEN 'completed' ELSE 'pending' END,
20702067
visible_at = updated_at`
2071-
yield* sql`ALTER TABLE ${tableNameSql}
2068+
yield* sql`ALTER TABLE ${tableNameSql}
20722069
MODIFY COLUMN state VARCHAR(10) NOT NULL,
20732070
MODIFY COLUMN visible_at DATETIME NOT NULL,
20742071
DROP COLUMN completed`
2075-
}),
2076-
mssql: () =>
2077-
Effect.gen(function*() {
2078-
const upgradedTableName = `${tableName}_upgrade`
2079-
const upgradedTable = sql(upgradedTableName)
2080-
yield* sql`CREATE TABLE ${upgradedTable} (
2072+
}),
2073+
mssql: Effect.fnUntraced(function*() {
2074+
const upgradedTableName = `${tableName}_upgrade`
2075+
const upgradedTable = sql(upgradedTableName)
2076+
yield* sql`CREATE TABLE ${upgradedTable} (
20812077
sequence BIGINT IDENTITY(1,1) PRIMARY KEY,
20822078
id NVARCHAR(255) NOT NULL,
20832079
queue_name NVARCHAR(255) NOT NULL,
@@ -2091,7 +2087,7 @@ const sqlMigrations = (tableName: string) =>
20912087
created_at DATETIME2 NOT NULL,
20922088
updated_at DATETIME2 NOT NULL
20932089
)`
2094-
yield* sql`SET IDENTITY_INSERT ${upgradedTable} ON;
2090+
yield* sql`SET IDENTITY_INSERT ${upgradedTable} ON;
20952091
INSERT INTO ${upgradedTable}
20962092
(sequence, id, queue_name, element, state, attempts, last_failure, visible_at,
20972093
acquired_at, acquired_by, created_at, updated_at)
@@ -2100,19 +2096,18 @@ const sqlMigrations = (tableName: string) =>
21002096
attempts, last_failure, updated_at, acquired_at, acquired_by, created_at, updated_at
21012097
FROM ${tableNameSql};
21022098
SET IDENTITY_INSERT ${upgradedTable} OFF`
2103-
yield* sql`DROP TABLE ${tableNameSql}`
2104-
yield* sql`EXEC sp_rename ${upgradedTableName}, ${tableName}`
2105-
yield* sql`CREATE UNIQUE INDEX ${sql(`idx_${tableName}_id`)} ON ${tableNameSql} (id, queue_name)`
2106-
yield* sql`CREATE INDEX ${sql(`idx_${tableName}_update`)} ON ${tableNameSql} (sequence, acquired_by)`
2107-
}),
2099+
yield* sql`DROP TABLE ${tableNameSql}`
2100+
yield* sql`EXEC sp_rename ${upgradedTableName}, ${tableName}`
2101+
yield* sql`CREATE UNIQUE INDEX ${sql(`idx_${tableName}_id`)} ON ${tableNameSql} (id, queue_name)`
2102+
yield* sql`CREATE INDEX ${sql(`idx_${tableName}_update`)} ON ${tableNameSql} (sequence, acquired_by)`
2103+
}),
21082104
// sqlite rebuilds the table because altering or dropping constrained
21092105
// columns is not portable across supported SQLite versions.
2110-
orElse: () =>
2111-
Effect.gen(function*() {
2112-
const upgradedTableName = `${tableName}_upgrade`
2113-
const upgradedTable = sql(upgradedTableName)
2114-
yield* sql`DROP INDEX IF EXISTS ${takeIndex}`
2115-
yield* sql`CREATE TABLE ${upgradedTable} (
2106+
orElse: Effect.fnUntraced(function*() {
2107+
const upgradedTableName = `${tableName}_upgrade`
2108+
const upgradedTable = sql(upgradedTableName)
2109+
yield* sql`DROP INDEX IF EXISTS ${takeIndex}`
2110+
yield* sql`CREATE TABLE ${upgradedTable} (
21162111
sequence INTEGER PRIMARY KEY AUTOINCREMENT,
21172112
id TEXT NOT NULL,
21182113
queue_name TEXT NOT NULL,
@@ -2126,18 +2121,18 @@ const sqlMigrations = (tableName: string) =>
21262121
created_at DATETIME NOT NULL,
21272122
updated_at DATETIME NOT NULL
21282123
)`
2129-
yield* sql`INSERT INTO ${upgradedTable}
2124+
yield* sql`INSERT INTO ${upgradedTable}
21302125
(sequence, id, queue_name, element, state, attempts, last_failure, visible_at,
21312126
acquired_at, acquired_by, created_at, updated_at)
21322127
SELECT sequence, id, queue_name, element,
21332128
CASE WHEN completed THEN 'completed' ELSE 'pending' END,
21342129
attempts, last_failure, updated_at, acquired_at, acquired_by, created_at, updated_at
21352130
FROM ${tableNameSql}`
2136-
yield* sql`DROP TABLE ${tableNameSql}`
2137-
yield* sql`ALTER TABLE ${upgradedTable} RENAME TO ${tableNameSql}`
2138-
yield* sql`CREATE UNIQUE INDEX ${sql(`idx_${tableName}_id`)} ON ${tableNameSql} (id, queue_name)`
2139-
yield* sql`CREATE INDEX ${sql(`idx_${tableName}_update`)} ON ${tableNameSql} (sequence, acquired_by)`
2140-
})
2131+
yield* sql`DROP TABLE ${tableNameSql}`
2132+
yield* sql`ALTER TABLE ${upgradedTable} RENAME TO ${tableNameSql}`
2133+
yield* sql`CREATE UNIQUE INDEX ${sql(`idx_${tableName}_id`)} ON ${tableNameSql} (id, queue_name)`
2134+
yield* sql`CREATE INDEX ${sql(`idx_${tableName}_update`)} ON ${tableNameSql} (sequence, acquired_by)`
2135+
})
21412136
})
21422137

21432138
// partial index where supported, so pollers never scan completed rows

0 commit comments

Comments
 (0)