Let applications ask whether a caller may act on a step (tm.MayAct), then move file references into core
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- go
- Área
- backend-api-design
Línea de trabajo
Start with CompleteTaskStep and checkRequiredPreResume to understand the existing write guard, then inspect how PRE_RESUME extensions are declared and executed. The first deliverable is tm.MayAct with an optional Authorizer interface and coverage for guarded steps and extensions that do or do not implement it; done means callers can check whether a command is allowed without side effects. The file reference migration is explicitly later and spans core and application interfaces.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Current Limitation
Core enforces who may complete or draft a step, but it gives an application no way to ask that same question without making the write. So an application that needs the answer while it renders a task works it out itself, from config core owns.
nsw-srilanka is the case today. GET /api/v1/tasks/{id} gives a reader file references with submit only when the reader may act on the active step. To decide that, it:
- loads the active step template and finds its
PRE_RESUMEauthzentry itself (stepCanActininternal/bootstrap/app.go,MayActOnStepininternal/tasks/extensions/authz); - evaluates that entry's rules itself, asking "may this reader run any command in this state?" rather than whether a given command would pass;
- repeats core's rule for whether a step is guarded. Core's
declaresExtension/checkRequiredPreResumerefuse a step with noauthz, and OpenNSW/nsw-srilanka#848 adds a separatedeclaredflag inMayActOnStepso that reads agree with it.
Problems with this:
- The guard is defined twice. If core changes what counts as guarded (which phase, which ids, what
WithRequiredPreResumeExtensionsis given), the write path follows and the read path doesn't. Readers would then be offered actions that are refused, or the other way round, with nothing failing. - The read reaches into write-side config. The application reads the
PRE_RESUMEentry of a step template and runs the rules itself, instead of asking the code that enforces them. - It is tied to one extension. The answer is "what the
authzrules say", not "what core would allow", so it breaks if write authorization ever moves to another or a second extension.
File references themselves (the reference format, their read/submit scopes, binding them on read and on submit/draft, and the read-only reference sent to an OGA on EXTERNAL_REVIEW) live in nsw-srilanka too (internal/storage/fileaccess, internal/tasks/file_binding.go). Yet what they protect is declared generically in the artifacts: a render config's files paths, and the rule that a submission must hand back a reference issued to the submitter with submit. Nothing about it is specific to one deployment.
Suggested Improvement
1. A dry-run authorization check on the task manager (do this first; it is small and useful on its own).
-
An optional interface a
PRE_RESUMEextension can implement besideExecute, which checks the caller without side effects:// Authorizer is a PRE_RESUME extension that can say, without side effects, // whether the caller in ctx may run command on the step. type Authorizer interface { Authorize(ctx context.Context, record store.TaskRecord, command string, properties json.RawMessage) error } -
tm.MayAct(ctx, taskID, stepID, command) error, which:- loads the active step template, as
CompleteTaskStepdoes; - applies
checkRequiredPreResume, the same guard writes use; - calls
Authorizeon each declaredPRE_RESUMEextension that implementsAuthorizer.
Extensions that only check the payload (e.g. a payload-schema check) don't implement it and are skipped, since a dry run has no payload.
- loads the active step template, as
-
The caller's identity stays in
ctx, as it is forExecute, so core stays identity-agnostic. -
The view's real question is "can they run some command?". Either add a
MayActAny, or let the caller pass the commands its render state offers. The second is more precise: it's exactly the buttons the user would see.
With this, nsw-srilanka's stepCanAct and MayActOnStep become a call to tm.MayAct, and the guard has one definition.
2. Move file references into core (later, building on 1).
Core would own:
- the reference format, its scopes and who it was issued to;
- binding on read (
GetTask, usingMayActto decide onsubmit) and on submit/draft; - the outbound reference on an
EXTERNAL_REVIEWdispatch.
The storage backend and the principal stay behind interfaces the application provides.
Version
main
Additional Context
- Came up reviewing OpenNSW/nsw-srilanka#848, which turns on
WithRequiredPreResumeExtensions("authz")(#323) and makes the read path match it. #848 is correct as it stands; this is cleanup to do afterwards, not a blocker. - File reference behaviour today: nsw-srilanka
docs/WORKFLOW_GUIDE.md, "File fields".
- Lenguaje dominante
- Go
- Estrellas
- 6
- Forks
- 8
- Merge medio
- 21 h 36 min
- PR fusionados (30 d)
- 42
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OpenNSW/core
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
payment: test fixtures hardcode real gateway names (govpay/lankapay) instead of generic placeholdersAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
nsw-sl cleanup Type/Improvement
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
Los mantenedores suelen responder en 1 día
-
remote: let the host inject a logger, and log with one consistent policyPosiblemente ocupada @mushrafmim la tomó hace 5 días. AbiertoType/Improvement
Dificultad 4/5 3-5 días Aptitud para principiantes 22/100
Los mantenedores suelen responder en 1 día
Todos los issues de OpenNSW/core
Issues similares
-
agent-research-finding chore
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
jordansmall/spindrift#7370 ·
Los mantenedores suelen responder en 1 día
-
☢️ Bug v3
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
The repo's gates check is clean and runs need no swapsPosiblemente ocupada @turbot-agent-fleet la tomó hoy. Abiertoagent:ready
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
turbot/tailpipe#677 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
needs-kind needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 2 días
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
crossplane-contrib/provider-keycloak#806 ·
Los mantenedores suelen responder en 1 día