development

Documentation

Index

• func CompileSchema(schema string) (*compiler.CompiledSchema, *devinterface.DeveloperError, error)
• func DistinguishGraphError(devContext *DevContext, dispatchError error, ...) (*devinterface.DeveloperError, error)
• func GenerateValidation(membershipSet *developmentmembership.Set) (string, error)
• func GetWarnings(ctx context.Context, devCtx *DevContext) ([]*devinterface.DeveloperWarning, error)
• func ParseAssertionsYAML(assertionsYaml string) (*blocks.Assertions, *devinterface.DeveloperError)
• func ParseExpectedRelationsYAML(expectedRelationsYaml string) (*blocks.ParsedExpectedRelations, *devinterface.DeveloperError)
• func RunAllAssertions(devContext *DevContext, assertions *blocks.Assertions) ([]*devinterface.DeveloperError, error)
• func RunValidation(devContext *DevContext, validation *blocks.ParsedExpectedRelations) (*developmentmembership.Set, []*devinterface.DeveloperError, error)
• type CheckResult
  • func RunCheck(devContext *DevContext, resource *core.ObjectAndRelation, ...) (CheckResult, error)
• type DevContext
  • func NewDevContext(ctx context.Context, requestContext *devinterface.RequestContext) (*DevContext, *devinterface.DeveloperErrors, error)
  • func (dc *DevContext) Dispose()
  • func (dc *DevContext) RunV1InMemoryService() (*grpc.ClientConn, func(), error)
• type ReferenceType
• type Resolver
  • func NewResolver(schema *compiler.CompiledSchema) (*Resolver, error)
  • func (r *Resolver) ReferenceAtPosition(source input.Source, position input.Position) (*SchemaReference, error)
• type SchemaReference

Functions

func CompileSchema

func CompileSchema(schema string) (*compiler.CompiledSchema, *devinterface.DeveloperError, error)

CompileSchema compiles a schema into its caveat and namespace definition(s), returning a developer error if the schema could not be compiled. The non-developer error is returned only if an internal errors occurred.

func DistinguishGraphError

func DistinguishGraphError(devContext *DevContext, dispatchError error, source devinterface.DeveloperError_Source, line uint32, column uint32, context string) (*devinterface.DeveloperError, error)

DistinguishGraphError turns an error from a dispatch call into either a user-facing DeveloperError or an internal error, based on the error raised by the dispatcher.

func GenerateValidation

func GenerateValidation(membershipSet *developmentmembership.Set) (string, error)

GenerateValidation generates the validation block based on a membership set.

func GetWarnings

func GetWarnings(ctx context.Context, devCtx *DevContext) ([]*devinterface.DeveloperWarning, error)

GetWarnings returns a list of warnings for the given developer context.

func ParseAssertionsYAML

func ParseAssertionsYAML(assertionsYaml string) (*blocks.Assertions, *devinterface.DeveloperError)

ParseAssertionsYAML parses the YAML form of an assertions block.

func ParseExpectedRelationsYAML

func ParseExpectedRelationsYAML(expectedRelationsYaml string) (*blocks.ParsedExpectedRelations, *devinterface.DeveloperError)

ParseExpectedRelationsYAML parses the YAML form of an expected relations block.

func RunAllAssertions

func RunAllAssertions(devContext *DevContext, assertions *blocks.Assertions) ([]*devinterface.DeveloperError, error)

RunAllAssertions runs all assertions found in the given assertions block against the developer context, returning whether any errors occurred.

func RunValidation

func RunValidation(devContext *DevContext, validation *blocks.ParsedExpectedRelations) (*developmentmembership.Set, []*devinterface.DeveloperError, error)

RunValidation runs the parsed validation block against the data in the dev context.

Types

type CheckResult

type CheckResult struct {
	Permissionship      v1dispatch.ResourceCheckResult_Membership
	MissingCaveatFields []string
	DispatchDebugInfo   *v1dispatch.DebugInformation
	V1DebugInfo         *v1api.DebugInformation
}

CheckResult is the result of a RunCheck operation.

func RunCheck

func RunCheck(devContext *DevContext, resource *core.ObjectAndRelation, subject *core.ObjectAndRelation, caveatContext map[string]any) (CheckResult, error)

RunCheck performs a check against the data in the development context.

Note that it is up to the caller to call DistinguishGraphError on the error if they want to distinguish between user errors and internal errors.

type DevContext

type DevContext struct {
	Ctx            context.Context
	Datastore      datastore.Datastore
	Revision       datastore.Revision
	CompiledSchema *compiler.CompiledSchema
	Dispatcher     dispatch.Dispatcher
}

DevContext holds the various helper types for running the developer calls.

func NewDevContext

func NewDevContext(ctx context.Context, requestContext *devinterface.RequestContext) (*DevContext, *devinterface.DeveloperErrors, error)

NewDevContext creates a new DevContext from the specified request context, parsing and populating the datastore as needed.

func (*DevContext) Dispose

func (dc *DevContext) Dispose()

Dispose disposes of the DevContext and its underlying datastore.

func (*DevContext) RunV1InMemoryService

func (dc *DevContext) RunV1InMemoryService() (*grpc.ClientConn, func(), error)

RunV1InMemoryService runs a V1 server in-memory on a buffconn over the given development context and returns a client connection and a function to shutdown the server. It is the responsibility of the caller to call the function to close the server.

type ReferenceType

type ReferenceType int

ReferenceType is the type of reference.

const (
	ReferenceTypeUnknown ReferenceType = iota
	ReferenceTypeDefinition
	ReferenceTypeCaveat
	ReferenceTypeRelation
	ReferenceTypePermission
	ReferenceTypeCaveatParameter
)

type Resolver

type Resolver struct {
	// contains filtered or unexported fields
}

Resolver resolves references to schema nodes from source positions.

func NewResolver

func NewResolver(schema *compiler.CompiledSchema) (*Resolver, error)

NewResolver creates a new resolver for the given schema.

func (*Resolver) ReferenceAtPosition

func (r *Resolver) ReferenceAtPosition(source input.Source, position input.Position) (*SchemaReference, error)

ReferenceAtPosition returns the reference to the schema node at the given position in the source, if any.

type SchemaReference

type SchemaReference struct {
	// Source is the source of the reference.
	Source input.Source

	// Position is the position of the reference in the source.
	Position input.Position

	// Text is the text of the reference.
	Text string

	// ReferenceType is the type of reference.
	ReferenceType ReferenceType

	// ReferenceMarkdown is the markdown representation of the reference.
	ReferenceMarkdown string

	// TargetSource is the source of the target node, if any.
	TargetSource *input.Source

	// TargetPosition is the position of the target node, if any.
	TargetPosition *input.Position

	// TargetSourceCode is the source code representation of the target, if any.
	TargetSourceCode string

	// TargetNamePositionOffset is the offset from the target position from where the
	// *name* of the target is found.
	TargetNamePositionOffset int
}

SchemaReference represents a reference to a schema node.