space-poc

README

space-poc

Research repository to test and try things this code later needs to be rewritten or moved to the actual repositories that will be used for implementation.

Local Development

POC Package Structure

Loosely based on these resources: https://github.com/golang-standards/project-layout

Note: For POC purposes the package structure is not as important but when we do migrate to a real folder we want to structure as much as possible following standards

• /api Folder structure for REST API.
• /cmd Entry point directory for all binaries this repo handles. E.g cmd/{binary-name}/main.go
• /config Global Config code
• /core Directory for core stuff like watcher service and threads watcher
• /logger Directory for app logging
• /examples Directory playground for general examples and drafts

Other Potential directories to consider adding /shared or /common In case we want to share libs or logic among several binaries like ipfs logic and other interactions.

Generating Mocks

Mocks are generated using https://github.com/vektra/mockery.

For Linux it needs to be built from source.

mockery -name InterfaceToMock -dir path/to/go/files

Protobuf

Make sure Protobuf gen tool is in your path: export PATH="$PATH:$(go env GOPATH)/bin"

Run the generation: protoc -I grpc/pb/ grpc/pb/space.proto --go_out=plugins=grpc:grpc/pb

Running the Space Binary

Building

Set the required env variables:

IPFS_ADDR=/ip4/127.0.0.1/tcp/5001
MONGO_PW=mongpw
MONGO_USR=mongousr
MONGO_HOST=mongohost

Run make. This will put the binary in the bin folder.

Running

Binary should run in a folder with a space.json config file with the following settings:

{
  "space": {
    "textileHubTarget": "textile-hub-dev.fleek.co:3006",
    "textileThreadsTarget": "textile-hub-dev.fleek.co:3006",
    "rpcPort": 9999,
    "storePath": "~/.fleek-space"
  }
}

If you still have issues, try setting the env var SPACE_APP_DIR export SPACE_APP_DIR=/path/to/the/space/binary

Debugging Space Binary

The following flags can be run with the binary to output profiling files for debugging. Flags support a full path to a file. -cpuprofile cpu.prof -memprofile mem.prof

By default, the binary runs in debug mode (this may change after release) and it boots a pprof server in localhost:6060. See docs how to interact with pprof server here: https://github.com/google/pprof/blob/master/doc/README.md

To disable debug mode add this flag to binary arguments -debug=false