Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[draft] HTTP server with connection to database #247

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 124 additions & 0 deletions reefd/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
package main
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you would like to apply go fmt to the file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


import (
"database/sql"
"flag"
"fmt"
"log"
"net/http"
"os"
_ "github.com/mattn/go-sqlite3"
aslonnie marked this conversation as resolved.
Show resolved Hide resolved
"encoding/json"
)

type MachineConfigInput struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't need to cap MachineConfigInput. it can be just machineConfigInput.

starting with cap means it is "public"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Name string `json:"name"`
Configuration string `json:"configuration"`
}

type MachineConfig struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here: machineConfig.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

id int
name string
configuration string
}

// a function to connect to database given a path to .db file
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// connectToDatabase connects to database ...

func connectToDatabase(dbPath string) (*sql.DB, error) {
db, err := sql.Open("sqlite3", dbPath)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return sql.Open("sqlite3", dbPath)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed this func and used sql.Open("sqlite3", dbPath) instead

if err != nil {
return nil, err
}
return db, nil
}

// a function to handle GET request to /machine/configuration that query the machine config based on name
func handleGetRequest(db *sql.DB, w http.ResponseWriter, r *http.Request) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you define a server struct/class, with db wrapped in it? and make this a method of that server?

// Parse the query parameter
name := r.URL.Query().Get("name")

var rows *sql.Rows
var err error
// If name is specified, query the machine config with that name
if name != "" {
rows, err = db.Query("SELECT id, name, configuration FROM machine_config WHERE name = ?", name)
} else {
rows, err = db.Query("SELECT id, name, configuration FROM machine_config")
}
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you do not want to return internal sql errors directly to user.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. I send the sql errors to log instead and only mention internal error

return
}
defer rows.Close()

// Iterate through the queried rows and print out
var machineConfigs []MachineConfig
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use []*MachineConfig. this avoids copy.

in general, use struct pointers for most cases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

for rows.Next() {
var machineConfig MachineConfig
err := rows.Scan(&machineConfig.id, &machineConfig.name, &machineConfig.configuration)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
machineConfigs = append(machineConfigs, machineConfig)
}
if err = rows.Err(); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
for _, machineConfig := range machineConfigs {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use single char var name for machineConfig, like c.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

fmt.Fprintf(w, "ID: %d, Name: %s, Configuration: %s\n", machineConfig.id, machineConfig.name, machineConfig.configuration)
}
}

//a function to handle POST request in MachineConfig format to add a machine configuration to the database
func handlePostRequestMachineConfig(db *sql.DB, w http.ResponseWriter, r *http.Request) {
// Make sure the content type is JSON
if r.Header.Get("Content-Type") != "application/json" {
http.Error(w, "Content-Type must be application/json", http.StatusUnsupportedMediaType)
return
}

// Parse the JSON body
config := &MachineConfigInput{}
err := json.NewDecoder(r.Body).Decode(config)
if err != nil {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if err := xxxx ; err != nil {
}

this limits the scope of err

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

http.Error(w, "Invalid JSON format: "+err.Error(), http.StatusBadRequest)
return
}

// Insert into database
_, err = db.Exec("INSERT INTO machine_config (name, configuration) VALUES (?, ?)",
config.Name, config.Configuration)
if err != nil {
http.Error(w, "Database error: "+err.Error(), http.StatusInternalServerError)
return
}
}

func main() {
dbPath := flag.String("db", "reef.db", "Path to .db file")
flag.Parse()
if _, err := os.Stat(*dbPath); os.IsNotExist(err) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you want to handle other types of error too; don't drop error

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if _, err := os.Stat(*dbPath); err != nil {
   if os.IsNotExist(err) {
      log.Fatal("not exist")
   } else {
      log.Fatalf("stat %q db file: %s", *dbPath, err)
   }
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

log.Fatalf("File %s does not exist", *dbPath)
}

db, err := connectToDatabase(*dbPath)
if err != nil {
log.Fatalf("Error connecting to database: %s", err)
}
defer db.Close()

// handle both GET and POST request to /machine/configuration
http.HandleFunc("/machine/configuration", func(w http.ResponseWriter, r *http.Request) {
switch r.Method {
case http.MethodGet:
handleGetRequest(db, w, r)
case http.MethodPost:
handlePostRequestMachineConfig(db, w, r)
default:
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
}
})
log.Printf("Starting server")
http.ListenAndServe(":1234", nil)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

handle the err being returned.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

}