Refactored service binding

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to Fastbelt
+
+Issues and pull requests are welcome.
+
+## Performance Benchmarking
+
+Use the following command as the standard end-to-end benchmark:
+
+```bash
+go test -run '^$' -bench '^BenchmarkWorkspaceCycle$' ./examples/statemachine
+```
+
+For more targeted changes (for example in the lexer or parser), other benchmarks may be more suitable.
+
+When running benchmarks, execute them at least 5 times and use the average `ms/resource` value as the standard metric. This helps reduce noise from other processes running on your machine, especially because Fastbelt makes heavy use of multithreading. You should also limit the number of CPU cores to 1 (`go test -cpu=1`) unless you need to compare in a multicore scenario.
+
+For convenience, you can run the internal benchmark helper:
+
+```bash
+go run ./internal/bench -runs 30 -cpu 1
+```
+
+Except for changes where the expected performance impact is negligible, contributors should run benchmarks both with and without their changes (for example by comparing their branch with `main`) and include the results in the Pull Request description.

README.md

@@ -66,7 +66,7 @@ For editor integration, see the VS Code extension in `internal/vscode-extensions
 
 ## Contributing
 
-Issues and pull requests are welcome.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
 
 ## License
 

cmd/fastbelt/main.go

@@ -17,6 +17,8 @@ import (
 	"typefox.dev/fastbelt/internal/generator"
 	"typefox.dev/fastbelt/internal/grammar"
 	"typefox.dev/fastbelt/textdoc"
+	"typefox.dev/fastbelt/util/service"
+	"typefox.dev/fastbelt/workspace"
 	"typefox.dev/lsp"
 )
 
@@ -86,12 +88,20 @@ func runLegacyGenerate(args []string) error {
 		return err
 	}
 
-	srv := grammar.CreateServices()
+	sc := grammar.CreateServices()
 	file, _ := textdoc.NewFile(lsp.URIFromPath(grammarPath), "fb", 0, string(grammarText))
 
 	document := core.NewDocument(file)
-	srv.Workspace().DocumentManager.Set(document)
-	if err := srv.Workspace().Builder.Build(context.Background(), []*core.Document{document}, func() {}); err != nil {
+	documents, err := service.Get[workspace.DocumentManager](sc)
+	if err != nil {
+		return err
+	}
+	documents.Set(document)
+	builder, err := service.Get[workspace.Builder](sc)
+	if err != nil {
+		return err
+	}
+	if err := builder.Build(context.Background(), []*core.Document{document}, func() {}); err != nil {
 		return err
 	}
 

examples/statemachine/benchmark_test.go

@@ -13,6 +13,9 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"typefox.dev/fastbelt"
+	"typefox.dev/fastbelt/lexer"
+	"typefox.dev/fastbelt/parser"
+	"typefox.dev/fastbelt/util/service"
 	"typefox.dev/fastbelt/workspace"
 )
 
@@ -28,14 +31,16 @@ func BenchmarkWorkspaceCycle(b *testing.B) {
 		length += len(contents[i])
 	}
 	srv := CreateServices()
+	docManager := service.MustGet[workspace.DocumentManager](srv)
+	lock := service.MustGet[workspace.Lock](srv)
+	builder := service.MustGet[workspace.Builder](srv)
 
 	var totalNs int64
 	b.SetBytes(int64(length))
 	b.ResetTimer()
 	for range b.N {
 		// Fresh document manager per cycle so each build starts from a clean state.
-		srv.Workspace().DocumentManager = workspace.NewDefaultDocumentManager()
-		docManager := srv.Workspace().DocumentManager
+		docManager.Clear()
 
 		docs := make([]*fastbelt.Document, resourceCount)
 		for i, content := range contents {
@@ -49,8 +54,8 @@ func BenchmarkWorkspaceCycle(b *testing.B) {
 		}
 
 		start := time.Now()
-		srv.Workspace().Lock.Write(context.Background(), func(ctx context.Context, downgrade func()) {
-			if err := srv.Workspace().Builder.Build(ctx, docs, downgrade); err != nil {
+		lock.Write(context.Background(), func(ctx context.Context, downgrade func()) {
+			if err := builder.Build(ctx, docs, downgrade); err != nil {
 				b.Errorf("build failed: %v", err)
 			}
 		})
@@ -66,11 +71,12 @@ func BenchmarkWorkspaceCycle(b *testing.B) {
 func BenchmarkTraverseContentSeq(b *testing.B) {
 	content, _ := generateStatemachineContent(0)
 	srv := CreateServices()
+	documentParser := service.MustGet[workspace.DocumentParser](srv)
 	doc, err := fastbelt.NewDocumentFromString("file:///workspace/statemachine_0.statemachine", "statemachine", content)
 	if err != nil {
 		b.Fatal(err)
 	}
-	srv.Workspace().DocumentParser.Parse(doc)
+	documentParser.Parse(doc)
 
 	for b.Loop() {
 		count := 0
@@ -84,11 +90,12 @@ func BenchmarkTraverseContentSeq(b *testing.B) {
 func TestAllNodesEquivalence(t *testing.T) {
 	content, elementCount := generateStatemachineContent(0)
 	srv := CreateServices()
+	documentParser := service.MustGet[workspace.DocumentParser](srv)
 	doc, err := fastbelt.NewDocumentFromString("file:///workspace/statemachine_0.statemachine", "statemachine", content)
 	if err != nil {
 		t.Fatal(err)
 	}
-	srv.Workspace().DocumentParser.Parse(doc)
+	documentParser.Parse(doc)
 	nodeCount := 0
 	for range fastbelt.AllNodes(doc.Root) {
 		nodeCount++
@@ -100,11 +107,12 @@ func TestAllChildrenEquivalence(t *testing.T) {
 	content, elementCount := generateStatemachineContent(0)
 	totalCount := elementCount - 1 // AllChildren does not include the root node, so we subtract 1 from the total count
 	srv := CreateServices()
+	documentParser := service.MustGet[workspace.DocumentParser](srv)
 	doc, err := fastbelt.NewDocumentFromString("file:///workspace/statemachine_0.statemachine", "statemachine", content)
 	if err != nil {
 		t.Fatal(err)
 	}
-	srv.Workspace().DocumentParser.Parse(doc)
+	documentParser.Parse(doc)
 	childCount := 0
 	for range fastbelt.AllChildren(doc.Root) {
 		childCount++
@@ -117,7 +125,9 @@ func TestAllChildrenEquivalence(t *testing.T) {
 func BenchmarkParser(b *testing.B) {
 	content, _ := generateStatemachineContent(0)
 	srv := CreateServices()
-	tokens := srv.Generated().Lexer.Lex(content).Tokens
+	lexerService := service.MustGet[lexer.Lexer](srv)
+	parserService := service.MustGet[parser.Parser](srv)
+	tokens := lexerService.Lex(content).Tokens
 	doc, err := fastbelt.NewDocumentFromString("file:///workspace/statemachine_0.statemachine", "statemachine", content)
 	if err != nil {
 		b.Fatal(err)
@@ -126,7 +136,7 @@ func BenchmarkParser(b *testing.B) {
 	b.SetBytes(int64(len(content)))
 	b.ResetTimer()
 	for b.Loop() {
-		result := srv.Generated().Parser.Parse(doc)
+		result := parserService.Parse(doc)
 		doc.Root = result.Node
 	}
 }