permission.test.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. import { describe, expect } from "bun:test"
  2. import { Cause, Deferred, Effect, Fiber, Layer } from "effect"
  3. import { AgentV2 } from "@opencode-ai/core/agent"
  4. import { Database } from "@opencode-ai/core/database/database"
  5. import { AppNodeBuilder } from "@opencode-ai/core/effect/app-node-builder"
  6. import { LayerNode } from "@opencode-ai/core/effect/layer-node"
  7. import { EventV2 } from "@opencode-ai/core/event"
  8. import { Location } from "@opencode-ai/core/location"
  9. import { PermissionV2 } from "@opencode-ai/core/permission"
  10. import { PermissionTable } from "@opencode-ai/core/permission/sql"
  11. import { PermissionSaved } from "@opencode-ai/core/permission/saved"
  12. import { Project } from "@opencode-ai/core/project"
  13. import { ProjectTable } from "@opencode-ai/core/project/sql"
  14. import { AbsolutePath } from "@opencode-ai/core/schema"
  15. import { SessionV2 } from "@opencode-ai/core/session"
  16. import { SessionTable } from "@opencode-ai/core/session/sql"
  17. import { SessionStore } from "@opencode-ai/core/session/store"
  18. import { eq } from "drizzle-orm"
  19. import { location } from "./fixture/location"
  20. import { testEffect } from "./lib/effect"
  21. const current = Layer.succeed(
  22. Location.Service,
  23. Location.Service.of(location({ directory: AbsolutePath.make("/project") })),
  24. )
  25. const it = testEffect(
  26. AppNodeBuilder.build(
  27. LayerNode.group([
  28. Database.node,
  29. EventV2.node,
  30. SessionStore.node,
  31. PermissionSaved.node,
  32. AgentV2.node,
  33. PermissionV2.node,
  34. ]),
  35. [[Location.node, current]],
  36. ),
  37. )
  38. function setup(rules: PermissionV2.Ruleset = []) {
  39. return Effect.gen(function* () {
  40. const { db } = yield* Database.Service
  41. yield* db
  42. .insert(ProjectTable)
  43. .values({ id: Project.ID.global, worktree: AbsolutePath.make("/project"), sandboxes: [] })
  44. .onConflictDoNothing()
  45. .run()
  46. .pipe(Effect.orDie)
  47. yield* db
  48. .insert(SessionTable)
  49. .values({
  50. id: SessionV2.ID.make("ses_test"),
  51. project_id: Project.ID.global,
  52. slug: "test",
  53. directory: "/project",
  54. title: "test",
  55. version: "test",
  56. agent: "test",
  57. })
  58. .onConflictDoNothing()
  59. .run()
  60. .pipe(Effect.orDie)
  61. yield* setRules(rules)
  62. })
  63. }
  64. function setRules(rules: PermissionV2.Ruleset) {
  65. return Effect.gen(function* () {
  66. const agents = yield* AgentV2.Service
  67. yield* agents.transform((editor) =>
  68. editor.update(AgentV2.ID.make("test"), (agent) => {
  69. agent.permissions = [...rules]
  70. }),
  71. )
  72. })
  73. }
  74. function assertion(input: Partial<PermissionV2.AssertInput> = {}) {
  75. return {
  76. id: PermissionV2.ID.create("per_test"),
  77. sessionID: SessionV2.ID.make("ses_test"),
  78. action: "read",
  79. resources: ["src/index.ts"],
  80. ...input,
  81. } satisfies PermissionV2.AssertInput
  82. }
  83. function waitForRequest() {
  84. return Effect.gen(function* () {
  85. const service = yield* PermissionV2.Service
  86. const events = yield* EventV2.Service
  87. const asked = yield* Deferred.make<PermissionV2.Request>()
  88. const unsubscribe = yield* events.listen((event) =>
  89. event.type === PermissionV2.Event.Asked.type
  90. ? Deferred.succeed(asked, event.data as PermissionV2.Request).pipe(Effect.asVoid)
  91. : Effect.void,
  92. )
  93. yield* Effect.addFinalizer(() => unsubscribe)
  94. const fiber = yield* service.assert(assertion()).pipe(Effect.forkScoped)
  95. const request = yield* Deferred.await(asked)
  96. return { service, fiber, request }
  97. })
  98. }
  99. describe("PermissionV2", () => {
  100. it.effect("returns the evaluated effect and only queues prompts", () =>
  101. Effect.gen(function* () {
  102. yield* setup([{ action: "read", resource: "*", effect: "allow" }])
  103. const service = yield* PermissionV2.Service
  104. expect(yield* service.ask(assertion())).toEqual({ id: PermissionV2.ID.create("per_test"), effect: "allow" })
  105. expect(yield* service.list()).toEqual([])
  106. yield* setRules([{ action: "read", resource: "*", effect: "deny" }])
  107. expect(yield* service.ask(assertion())).toEqual({ id: PermissionV2.ID.create("per_test"), effect: "deny" })
  108. expect(yield* service.list()).toEqual([])
  109. yield* setRules([])
  110. expect(yield* service.ask(assertion())).toEqual({ id: PermissionV2.ID.create("per_test"), effect: "ask" })
  111. expect(yield* service.get(PermissionV2.ID.create("per_test"))).toBeDefined()
  112. }),
  113. )
  114. it.effect("evaluates against an explicit provider-turn agent", () =>
  115. Effect.gen(function* () {
  116. yield* setup([{ action: "read", resource: "*", effect: "allow" }])
  117. const agents = yield* AgentV2.Service
  118. yield* agents.transform((editor) =>
  119. editor.update(AgentV2.ID.make("reviewer"), (agent) => {
  120. agent.permissions.push({ action: "read", resource: "*", effect: "deny" })
  121. }),
  122. )
  123. const service = yield* PermissionV2.Service
  124. expect(yield* service.ask(assertion())).toMatchObject({ effect: "allow" })
  125. expect(yield* service.ask(assertion({ agent: AgentV2.ID.make("reviewer") }))).toMatchObject({ effect: "deny" })
  126. yield* agents.transform((editor) =>
  127. editor.update(AgentV2.ID.make("reviewer"), (agent) => {
  128. agent.permissions = []
  129. }),
  130. )
  131. expect(yield* service.ask(assertion({ agent: AgentV2.ID.make("reviewer") }))).toMatchObject({ effect: "ask" })
  132. expect(yield* service.get(PermissionV2.ID.create("per_test"))).not.toHaveProperty("agent")
  133. }),
  134. )
  135. it.effect("allows and denies from explicit rules without asking", () =>
  136. Effect.gen(function* () {
  137. yield* setup([{ action: "read", resource: "*", effect: "allow" }])
  138. const service = yield* PermissionV2.Service
  139. yield* service.assert(assertion())
  140. yield* setRules([{ action: "read", resource: "*", effect: "deny" }])
  141. const blocked = yield* service.assert(assertion()).pipe(Effect.flip)
  142. expect(blocked).toBeInstanceOf(PermissionV2.BlockedError)
  143. expect(yield* service.list()).toEqual([])
  144. }),
  145. )
  146. it.effect("allows managed output reads without granting external directory access", () =>
  147. Effect.gen(function* () {
  148. yield* setup([
  149. { action: "*", resource: "*", effect: "deny" },
  150. { action: "read", resource: "*", effect: "allow" },
  151. ])
  152. const service = yield* PermissionV2.Service
  153. expect(yield* service.ask(assertion({ resources: ["tool_123"] }))).toMatchObject({ effect: "allow" })
  154. expect(
  155. yield* service.ask(assertion({ action: "external_directory", resources: ["/tmp/tool-output/*"] })),
  156. ).toMatchObject({ effect: "deny" })
  157. }),
  158. )
  159. it.effect("uses build permissions when the Session agent is omitted", () =>
  160. Effect.gen(function* () {
  161. yield* setup()
  162. const { db } = yield* Database.Service
  163. yield* db
  164. .update(SessionTable)
  165. .set({ agent: null })
  166. .where(eq(SessionTable.id, SessionV2.ID.make("ses_test")))
  167. .run()
  168. .pipe(Effect.orDie)
  169. const agents = yield* AgentV2.Service
  170. yield* agents.transform((editor) =>
  171. editor.update(AgentV2.ID.make("build"), (agent) => {
  172. agent.permissions = [{ action: "todowrite", resource: "*", effect: "allow" }]
  173. }),
  174. )
  175. const service = yield* PermissionV2.Service
  176. expect(yield* service.ask(assertion({ action: "todowrite", resources: ["*"] }))).toEqual({
  177. id: PermissionV2.ID.create("per_test"),
  178. effect: "allow",
  179. })
  180. expect(yield* service.list()).toEqual([])
  181. }),
  182. )
  183. it.effect("denies omitted-agent permissions when no primary default agent exists", () =>
  184. Effect.gen(function* () {
  185. yield* setup()
  186. const { db } = yield* Database.Service
  187. yield* db
  188. .update(SessionTable)
  189. .set({ agent: null })
  190. .where(eq(SessionTable.id, SessionV2.ID.make("ses_test")))
  191. .run()
  192. .pipe(Effect.orDie)
  193. const agents = yield* AgentV2.Service
  194. yield* agents.transform((editor) => {
  195. editor.remove(AgentV2.ID.make("test"))
  196. editor.remove(AgentV2.ID.make("build"))
  197. })
  198. const service = yield* PermissionV2.Service
  199. expect(yield* service.ask(assertion())).toEqual({ id: PermissionV2.ID.create("per_test"), effect: "deny" })
  200. expect(yield* service.list()).toEqual([])
  201. }),
  202. )
  203. it.effect("evaluates bash with the normal configured-rule semantics", () =>
  204. Effect.gen(function* () {
  205. yield* setup([{ action: "*", resource: "*", effect: "allow" }])
  206. const service = yield* PermissionV2.Service
  207. const bash = assertion({ action: "bash", resources: ["pwd"] })
  208. expect(yield* service.ask(bash)).toEqual({ id: PermissionV2.ID.create("per_test"), effect: "allow" })
  209. yield* setRules([])
  210. expect(yield* service.ask(bash)).toEqual({ id: PermissionV2.ID.create("per_test"), effect: "ask" })
  211. expect(yield* service.get(PermissionV2.ID.create("per_test"))).toBeDefined()
  212. }),
  213. )
  214. it.effect("uses saved bash approvals while preserving configured deny precedence", () =>
  215. Effect.gen(function* () {
  216. yield* setup()
  217. const saved = yield* PermissionSaved.Service
  218. yield* saved.add({ projectID: Project.ID.global, action: "bash", resources: ["pwd"] })
  219. const service = yield* PermissionV2.Service
  220. expect(yield* service.ask(assertion({ action: "bash", resources: ["pwd"] }))).toEqual({
  221. id: PermissionV2.ID.create("per_test"),
  222. effect: "allow",
  223. })
  224. expect(yield* service.list()).toEqual([])
  225. yield* setRules([{ action: "bash", resource: "*", effect: "deny" }])
  226. expect(yield* service.ask(assertion({ action: "bash", resources: ["pwd"] }))).toEqual({
  227. id: PermissionV2.ID.create("per_test"),
  228. effect: "deny",
  229. })
  230. }),
  231. )
  232. it.effect("resolves an asked permission once", () =>
  233. Effect.gen(function* () {
  234. yield* setup()
  235. const { service, fiber, request } = yield* waitForRequest()
  236. expect(yield* service.list()).toEqual([request])
  237. expect(yield* service.forSession(request.sessionID)).toEqual([request])
  238. expect(yield* service.forSession(SessionV2.ID.make("ses_other"))).toEqual([])
  239. expect(yield* service.get(request.id)).toEqual(request)
  240. yield* service.reply({ requestID: request.id, reply: "once" })
  241. yield* Fiber.join(fiber)
  242. expect(yield* service.list()).toEqual([])
  243. expect(yield* service.get(request.id)).toBeUndefined()
  244. }),
  245. )
  246. it.effect("defects when an asked permission is declined", () =>
  247. Effect.gen(function* () {
  248. yield* setup()
  249. const { service, fiber, request } = yield* waitForRequest()
  250. yield* service.reply({ requestID: request.id, reply: "reject" })
  251. const exit = yield* Fiber.await(fiber)
  252. expect(exit._tag).toBe("Failure")
  253. if (exit._tag === "Failure")
  254. expect(
  255. exit.cause.reasons.some(
  256. (reason) => Cause.isDieReason(reason) && reason.defect instanceof PermissionV2.DeclinedError,
  257. ),
  258. ).toBe(true)
  259. expect(yield* service.list()).toEqual([])
  260. }),
  261. )
  262. it.effect("stores and removes saved resources for a project", () =>
  263. Effect.gen(function* () {
  264. yield* setup()
  265. const service = yield* PermissionV2.Service
  266. const asked = yield* Deferred.make<PermissionV2.Request>()
  267. const events = yield* EventV2.Service
  268. const unsubscribe = yield* events.listen((event) =>
  269. event.type === PermissionV2.Event.Asked.type
  270. ? Deferred.succeed(asked, event.data as PermissionV2.Request).pipe(Effect.asVoid)
  271. : Effect.void,
  272. )
  273. yield* Effect.addFinalizer(() => unsubscribe)
  274. const fiber = yield* service.assert(assertion({ save: ["src/*"] })).pipe(Effect.forkScoped)
  275. const request = yield* Deferred.await(asked)
  276. yield* service.reply({ requestID: request.id, reply: "always" })
  277. yield* Fiber.join(fiber)
  278. const { db } = yield* Database.Service
  279. expect(
  280. yield* db.select().from(PermissionTable).where(eq(PermissionTable.project_id, Project.ID.global)).all(),
  281. ).toMatchObject([{ action: "read", resource: "src/*" }])
  282. const saved = yield* PermissionSaved.Service
  283. const id = (yield* saved.list())[0]!.id
  284. expect(yield* saved.list()).toEqual([{ id, projectID: Project.ID.global, action: "read", resource: "src/*" }])
  285. yield* service.assert(assertion({ id: PermissionV2.ID.create("per_next"), resources: ["src/next.ts"] }))
  286. yield* saved.remove(id)
  287. expect(yield* saved.list()).toEqual([])
  288. }),
  289. )
  290. })