is_effects 0.3.0
is_effects: ^0.3.0 copied to clipboard
The shared vocabulary of intersyntactic's actions: what reading, writing, starting a program and reaching the world take and give back, and the drivers that carry them out.
Changelog #
0.3.0 #
- Breaking:
WebDriver.sendis nowcarryOutWebRequest;Sentis nowWebRequestOutcome. Nick ruled out tiny words for complex things on 16 Nov (sendandrenderernamed as examples): "longer names are ok". No deprecated alias kept, so the old word doesn't survive through the types every session reads.
0.2.3 #
- Depends on
is_path_confinementsoFileDriver's doc comment can point atisInsideTreeconcretely, instead of describing confinement only in prose. Purely additive:FileDriveris still just an interface, no behaviour changes.
0.2.2 #
ProgramMessage: what a program driver sends back about one run,Reported(Progress)while it is underway, then oneFinished(Outcome<ExecResult>).Progressis unchanged.- Codecs for a program run across a wire:
encodeStart/decodeStart(whatProgramDriver.startis given),encodeProgress/decodeProgressandencodeProgramMessage/decodeProgramMessage. For the airlock ↔ program driver service. Purely additive. - Fixed
RelativePath.folderon a path made entirely of..segments (e.g.RelativePath('..')): it was returning root instead of one level further up again. Shipped broken since 0.1.0, but unreachable until the rename let an escaping path be constructed at all; no known caller hits it, fixed now to close the gap before one does.
0.2.1 #
- JSON codecs for every type:
RelativePath,FileText,ProgramName,Args,ReadResult,Wrote,ExecResult,Origin,Method,WebPath,SignIn, headers,Request,Sent,Outcome<O>. Encode to a plain JSON value; decode re-runs the type's own validation and throwsFormatExceptionon bad input. For the agent loop ↔ airlock and airlock ↔ driver wire (is_airlock_api0.5.0'sCarry). Purely additive, no breaking changes. isCredentialHeaderexported alongsidevalidatedHeaders, so a caller that needs to check a header without catchingArgumentError(anError, never caught by this repo's own convention) can.
0.2.0 #
- Breaking:
Request.pathis now aWebPath, not a plainString.WebPath.parserefuses anything without a leading/, a//authority, a..segment, or an@— ways a path could make a request reach somewhere other than the origin it was decided for.WebPath.rootreplaces the old default of''. - Pulled the credential-header check out of
Request's constructor into an exportedvalidatedHeaders, sois_airlock_api'sPostcan apply the same guarantee to its own headers instead of re-declaring the forbidden-header list. - From issue #1147's design discussion (
enspyrco/intersyntactic#1147):WebPathis web-driver-0b's finding,validatedHeadersis shared with effects-98's.
0.1.3 #
- Genericize destination examples in
web.dart's doc comments (smba.trafficmanager.net,hart-bot): a shared vocabulary shouldn't carry one consumer's deployment details in its examples.
0.1.2 #
- Fix
refusedBecause's doc comment: a refused sign-in (an AADSTS code, nothing sent) isRefused, notSent.refusedBecause, which is only for a destination's own refusal of something that did go out.
0.1.1 #
SentgainsrefusedBecause, the destination's own reason for a non-2xx reply (a Teams 400 body, an AADSTS code), so a failure's why reaches the record instead of staying in the driver's own logs.- Reworded
Request.bodyandSent's doc comments: no body is kept because what a reader needs back is already elsewhere in the record, not because of a by-reference ruling (there is none).
0.1.0 #
- First release: the vocabulary of effects and the driver interfaces, moved
out of
is_airlock_apiso a driver depends on effects alone.PathInRepo,ProgramName,FileText,Args,ReadResult,Wrote,ExecResult(Exited,Killed),Outcome(Ran,Refused),Progress(Printed), andFileDriver,ProgramDriver.