permission.test.ts 12 KB

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