github.com/haapjari/repository-search-api

Greetings

Hello! I am Jari Haapasaari (mail), and I originally developed the initial version of this project as a part of my thesis - and as my first project written in Go. Later I cleared and cleaned up the project, as the original version also looked like my very first Go project.

• Original Version Released: 20th October 2023.
• Cleaner Version Released: 29th April 2024.

If you're interested into reproduce the research, please see: repository-analysis-orchestration repository.

---

About

This tool is meant to be an abstraction for a set of different GitHub API's that offer ability to query metadata from different repositories. You can see the API's within this file: repository_service.go. For the OpenAPI, please refer to the openapi.yaml.

NOTE: Third-Party LOC Reporting works only with projects, written in Go.

---

How-To

Run

• You require go and make to run this project. Tested with go-1.22.0.
• Setup PORT as Environment Variable, and execute make run or just PORT=8080 make run.

Build and Run as a Docker Container

• Build the Image: docker build -t repository-search-api:latest .
• Run the Image (On the Host, for Simplicity): docker run -idt -e PORT=8080 --network=host repository-search-api:latest

Example Query

• You need to have Personal Access Token exposed as a GITHUB_TOKEN environment variable to be able to run this command.

curl "localhost:8000/api/v1/repos/search?firstCreationDate=2008-01-01&lastCreationDate=2009-01-01&language=Go&minStars=100&maxStars=1000&order=desc" --header "Authorization: Bearer $GITHUB_TOKEN"

Debug

Enable Profiling

• Set ENABLE_PPROF=true on environment variables. This enables profiling endpoints.

  mux.HandleFunc("/debug/pprof/", pprof.Index)
  mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
  mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
  mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
  mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
  mux.HandleFunc("/debug/pprof/heap", pprof.Handler("heap").ServeHTTP)
  mux.HandleFunc("/debug/pprof/goroutine", pprof.Handler("goroutine").ServeHTTP)
  mux.HandleFunc("/debug/pprof/threadcreate", pprof.Handler("threadcreate").ServeHTTP)
  mux.HandleFunc("/debug/pprof/block", pprof.Handler("block").ServeHTTP)
  mux.HandleFunc("/debug/pprof/mutex", pprof.Handler("mutex").ServeHTTP)
  mux.HandleFunc("/debug/pprof/allocs", pprof.Handler("allocs").ServeHTTP)

• Then you can access the profiling endpoints, for example with curl: curl -o cpu.pprof http://host:port/debug/pprof/profile?seconds=30