feat: add directory structure to readme and improve structure (#132)

Signed-off-by: Zike Yang <zike@apache.org>

Author: RobertIndie

README.md

@@ -45,7 +45,7 @@ integration with Apache Pulsar, allowing users to take full advantage of its rob
    executing code across different hardware architectures seamlessly. It provides compatibility and portability,
    allowing developers to run their code on various platforms without concerns about underlying hardware dependencies.
 
-### Architecture and Components
+## Architecture and Components
 
 Function Stream is composed of three main components: the WebAssembly runtime engine, the Pulsar client, and the
 Function Stream service. The following figure shows the overview of the Function Stream architecture.
@@ -64,6 +64,29 @@ and the processing guarantees of the messages.
 
 **The Function Stream service** is responsible for managing the lifecycle and coordination of the WebAssembly instances.
 
+## Directory Structure
+
+The Function Stream project is organized as follows:
+.
+├── LICENSE                 # The license for Function Stream
+├── Makefile                # Contains build automation and commands
+├── README.md               # README file for the project
+├── benchmark               # Contains benchmarking tools or results
+├── bin                     # Contains compiled binary files
+├── cmd                     # Contains the command line executable source files
+├── common                  # Contains common utilities and libraries used across the project
+├── docs                    # Documentation for the project
+├── examples                # Example configurations, scripts, and other reference materials
+├── go.mod                  # Defines the module's module path and its dependency requirements
+├── go.sum                  # Contains the expected cryptographic checksums of the content of specific module versions
+├── fs                      # Core library files for Function Stream
+├── license-checker         # Tools related to checking license compliance
+├── openapi.yaml            # API definition file
+├── perf                    # Performance testing scripts
+├── restclient              # REST client library
+├── server                  # Server-side application source files
+└── tests                   # Contains test scripts and test data
+
 ## Building Instructions
 
 To compile Function Stream, use this command:

benchmark/bench_test.go

@@ -21,8 +21,8 @@ import (
 	"github.com/apache/pulsar-client-go/pulsaradmin"
 	"github.com/apache/pulsar-client-go/pulsaradmin/pkg/utils"
 	"github.com/functionstream/functionstream/common"
-	"github.com/functionstream/functionstream/lib"
-	"github.com/functionstream/functionstream/lib/contube"
+	"github.com/functionstream/functionstream/fs"
+	"github.com/functionstream/functionstream/fs/contube"
 	"github.com/functionstream/functionstream/perf"
 	"github.com/functionstream/functionstream/restclient"
 	"github.com/functionstream/functionstream/server"
@@ -103,9 +103,9 @@ func BenchmarkStressForBasicFunc(b *testing.B) {
 func BenchmarkStressForBasicFuncWithMemoryQueue(b *testing.B) {
 	memoryQueueFactory := contube.NewMemoryQueueFactory(context.Background())
 
-	svrConf := &lib.Config{
+	svrConf := &fs.Config{
 		ListenAddr: common.DefaultAddr,
-		QueueBuilder: func(ctx context.Context, config *lib.Config) (contube.TubeFactory, error) {
+		QueueBuilder: func(ctx context.Context, config *fs.Config) (contube.TubeFactory, error) {
 			return memoryQueueFactory, nil
 		},
 	}
@@ -130,7 +130,7 @@ func BenchmarkStressForBasicFuncWithMemoryQueue(b *testing.B) {
 			Output:   outputTopic,
 			Replicas: &replicas,
 		},
-		QueueBuilder: func(ctx context.Context, c *lib.Config) (contube.TubeFactory, error) {
+		QueueBuilder: func(ctx context.Context, c *fs.Config) (contube.TubeFactory, error) {
 			return memoryQueueFactory, nil
 		},
 	}

lib/config.go fs/config.golib/config.go renamed to fs/config.go

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package lib
+package fs
 
 import (
 	"context"
-	"github.com/functionstream/functionstream/lib/contube"
+	"github.com/functionstream/functionstream/fs/contube"
 )
 
 type QueueBuilder func(ctx context.Context, config *Config) (contube.TubeFactory, error)

lib/contube/event_tube.go fs/contube/event_tube.golib/contube/event_tube.go renamed to fs/contube/event_tube.go

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-package lib
+package fs
 
 import (
 	"context"
 	"fmt"
 	"github.com/functionstream/functionstream/common"
 	"github.com/functionstream/functionstream/common/model"
-	"github.com/functionstream/functionstream/lib/contube"
+	"github.com/functionstream/functionstream/fs/contube"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"github.com/tetratelabs/wazero"

lib/contube/memory_tube.go fs/contube/memory_tube.golib/contube/memory_tube.go renamed to fs/contube/memory_tube.go

@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-package lib
+package fs
 
 import (
 	"context"
 	"github.com/functionstream/functionstream/common"
 	"github.com/functionstream/functionstream/common/model"
-	"github.com/functionstream/functionstream/lib/contube"
+	"github.com/functionstream/functionstream/fs/contube"
 	"log/slog"
 	"math/rand"
 	"strconv"

lib/contube/pulsar_tube.go fs/contube/pulsar_tube.golib/contube/pulsar_tube.go renamed to fs/contube/pulsar_tube.go

@@ -22,8 +22,8 @@ import (
 	"fmt"
 	"github.com/bmizerany/perks/quantile"
 	"github.com/functionstream/functionstream/common"
-	"github.com/functionstream/functionstream/lib"
-	"github.com/functionstream/functionstream/lib/contube"
+	"github.com/functionstream/functionstream/fs"
+	"github.com/functionstream/functionstream/fs/contube"
 	"github.com/functionstream/functionstream/restclient"
 	"golang.org/x/time/rate"
 	"log/slog"
@@ -38,7 +38,7 @@ type Config struct {
 	PulsarURL    string
 	RequestRate  float64
 	Func         *restclient.Function
-	QueueBuilder lib.QueueBuilder
+	QueueBuilder fs.QueueBuilder
 }
 
 type Perf interface {
@@ -49,15 +49,15 @@ type perf struct {
 	config       *Config
 	input        chan<- contube.Record
 	output       <-chan contube.Record
-	queueBuilder lib.QueueBuilder
+	queueBuilder fs.QueueBuilder
 }
 
 func New(config *Config) Perf {
 	p := &perf{
 		config: config,
 	}
 	if config.QueueBuilder == nil {
-		p.queueBuilder = func(ctx context.Context, c *lib.Config) (contube.TubeFactory, error) {
+		p.queueBuilder = func(ctx context.Context, c *fs.Config) (contube.TubeFactory, error) {
 			return contube.NewPulsarEventQueueFactory(ctx, (&contube.PulsarTubeFactoryConfig{
 				PulsarURL: config.PulsarURL,
 			}).ToConfigMap())
@@ -92,7 +92,7 @@ func (p *perf) Run(ctx context.Context) {
 		}
 	}
 
-	config := &lib.Config{
+	config := &fs.Config{
 		PulsarURL: p.config.PulsarURL,
 	}
 

lib/instance.go fs/instance.golib/instance.go renamed to fs/instance.go

@@ -19,27 +19,27 @@ package server
 import (
 	"context"
 	"github.com/functionstream/functionstream/common"
-	"github.com/functionstream/functionstream/lib/contube"
+	"github.com/functionstream/functionstream/fs/contube"
 	"log/slog"
 	"os"
 	"sync"
 
-	"github.com/functionstream/functionstream/lib"
+	"github.com/functionstream/functionstream/fs"
 )
 
-var loadedConfig *lib.Config
+var loadedConfig *fs.Config
 var initConfig = sync.Once{}
 
-func LoadConfigFromEnv() *lib.Config {
+func LoadConfigFromEnv() *fs.Config {
 	initConfig.Do(func() {
-		loadedConfig = &lib.Config{
+		loadedConfig = &fs.Config{
 			ListenAddr: getEnvWithDefault("LISTEN_ADDR", common.DefaultAddr),
 			PulsarURL:  getEnvWithDefault("PULSAR_URL", common.DefaultPulsarURL),
 		}
 		queueType := getEnvWithDefault("QUEUE_TYPE", common.DefaultQueueType)
 		switch queueType {
 		case common.PulsarQueueType:
-			loadedConfig.QueueBuilder = func(ctx context.Context, c *lib.Config) (contube.TubeFactory, error) {
+			loadedConfig.QueueBuilder = func(ctx context.Context, c *fs.Config) (contube.TubeFactory, error) {
 				return contube.NewPulsarEventQueueFactory(ctx, (&contube.PulsarTubeFactoryConfig{
 					PulsarURL: c.PulsarURL,
 				}).ToConfigMap())
@@ -49,12 +49,12 @@ func LoadConfigFromEnv() *lib.Config {
 	return loadedConfig
 }
 
-func LoadStandaloneConfigFromEnv() *lib.Config {
+func LoadStandaloneConfigFromEnv() *fs.Config {
 	initConfig.Do(func() {
-		loadedConfig = &lib.Config{
+		loadedConfig = &fs.Config{
 			ListenAddr: getEnvWithDefault("LISTEN_ADDR", common.DefaultAddr),
 		}
-		loadedConfig.QueueBuilder = func(ctx context.Context, c *lib.Config) (contube.TubeFactory, error) {
+		loadedConfig.QueueBuilder = func(ctx context.Context, c *fs.Config) (contube.TubeFactory, error) {
 			return contube.NewMemoryQueueFactory(ctx), nil
 		}
 	})