API endpoint use same constant and guide not to configure /api/v1

treeverse · Sep 15, 2023 · c7b7b78 · c7b7b78
1 parent c85a71c
commit c7b7b78
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 12 deletions.
diff --git a/cmd/lakectl/cmd/config.go b/cmd/lakectl/cmd/config.go
@@ -36,6 +36,9 @@ var configCmd = &cobra.Command{
 			{Key: "credentials.secret_access_key", Prompt: &promptui.Prompt{Label: "Secret access key", Mask: '*'}},
 			{Key: "server.endpoint_url", Prompt: &promptui.Prompt{Label: "Server endpoint URL", Validate: func(rawURL string) error {
 				_, err := url.ParseRequestURI(rawURL)
+				if err != nil {
+					return fmt.Errorf("invalid URL: %w", err)
+				}
 				return err
 			}}},
 		}

diff --git a/cmd/lakectl/cmd/docs.go b/cmd/lakectl/cmd/docs.go
@@ -52,7 +52,7 @@ lakectl config
 # Config file /home/janedoe/.lakectl.yaml will be used
 # Access key ID: AKIAIOSFODNN7EXAMPLE
 # Secret access key: ****************************************
-# Server endpoint URL: http://localhost:8000/api/v1
+# Server endpoint URL: http://localhost:8000
 ` + "```" + `
 
 This will setup a ` + "`$HOME/.lakectl.yaml`" + ` file with the credentials and API endpoint you've supplied.

diff --git a/cmd/lakectl/cmd/log.go b/cmd/lakectl/cmd/log.go
@@ -56,7 +56,7 @@ func (d *dotWriter) Write(commits []apigen.Commit) {
 			label = fmt.Sprintf("<b>%s</b>", label)
 		}
 		baseURL := strings.TrimSuffix(strings.TrimSuffix(
-			string(cfg.Server.EndpointURL), "/api/v1"), "/")
+			string(cfg.Server.EndpointURL), apiutil.BaseURL), "/")
 		_, _ = fmt.Fprintf(d.w, "\n\t\"%s\" [shape=note target=\"_blank\" href=\"%s/repositories/%s/commits/%s\" label=< %s >]\n",
 			commit.Id, baseURL, repoID, commit.Id, label)
 		for _, parent := range commit.Parents {

diff --git a/docs/reference/cli.md b/docs/reference/cli.md
@@ -40,7 +40,7 @@ lakectl config
 # Config file /home/janedoe/.lakectl.yaml will be used
 # Access key ID: AKIAIOSFODNN7EXAMPLE
 # Secret access key: ****************************************
-# Server endpoint URL: http://localhost:8000/api/v1
+# Server endpoint URL: http://localhost:8000
 ```
 
 This will setup a `$HOME/.lakectl.yaml` file with the credentials and API endpoint you've supplied.

diff --git a/esti/gc_utils_test.go b/esti/gc_utils_test.go
@@ -8,22 +8,24 @@ import (
 	"os/exec"
 	"strings"
 
+	"github.com/treeverse/lakefs/pkg/api/apiutil"
 	"github.com/treeverse/lakefs/pkg/logging"
 )
 
 func getSparkSubmitArgs(entryPoint string) []string {
 	return []string{
 		"--master", "spark://localhost:7077",
 		"--conf", "spark.driver.extraJavaOptions=-Divy.cache.dir=/tmp -Divy.home=/tmp",
-		"--conf", "spark.hadoop.lakefs.api.url=http://lakefs:8000/api/v1",
+		"--conf", "spark.hadoop.lakefs.api.url=http://lakefs:8000" + apiutil.BaseURL,
 		"--conf", "spark.hadoop.lakefs.api.access_key=AKIAIOSFDNN7EXAMPLEQ",
 		"--conf", "spark.hadoop.lakefs.api.secret_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
 		"--class", entryPoint,
 	}
 }
 
 func getDockerArgs(workingDirectory string, localJar string) []string {
-	return []string{"run", "--network", "host", "--add-host", "lakefs:127.0.0.1",
+	return []string{
+		"run", "--network", "host", "--add-host", "lakefs:127.0.0.1",
 		"-v", fmt.Sprintf("%s/ivy:/opt/bitnami/spark/.ivy2", workingDirectory),
 		"-v", fmt.Sprintf("%s:/opt/metaclient/client.jar", localJar),
 		"--rm",

diff --git a/esti/lakectl_doctor_test.go b/esti/lakectl_doctor_test.go
@@ -6,12 +6,13 @@ import (
 
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/require"
+	"github.com/treeverse/lakefs/pkg/api/apiutil"
 )
 
 func TestLakectlDoctor(t *testing.T) {
 	accessKeyID := viper.GetString("access_key_id")
 	secretAccessKey := viper.GetString("secret_access_key")
-	endPointURL := viper.GetString("endpoint_url") + "/api/v1"
+	endPointURL := viper.GetString("endpoint_url") + apiutil.BaseURL
 	u, err := url.Parse(endpointURL)
 	require.NoError(t, err)
 	vars := map[string]string{

diff --git a/pkg/actions/lua.go b/pkg/actions/lua.go
@@ -14,6 +14,7 @@ import (
 	lualibs "github.com/treeverse/lakefs/pkg/actions/lua"
 	"github.com/treeverse/lakefs/pkg/actions/lua/lakefs"
 	luautil "github.com/treeverse/lakefs/pkg/actions/lua/util"
+	"github.com/treeverse/lakefs/pkg/api/apiutil"
 	"github.com/treeverse/lakefs/pkg/auth"
 	"github.com/treeverse/lakefs/pkg/auth/model"
 	"github.com/treeverse/lakefs/pkg/graveler"
@@ -95,8 +96,11 @@ func (h *LuaHook) Run(ctx context.Context, record graveler.HookRecord, buf *byte
 		if h.Endpoint == nil {
 			return fmt.Errorf("no endpoint configured, cannot request object: %s: %w", h.ScriptPath, ErrInvalidAction)
 		}
-		reqURL := fmt.Sprintf("/api/v1/repositories/%s/refs/%s/objects",
-			url.PathEscape(string(record.RepositoryID)), url.PathEscape(string(record.SourceRef)))
+		reqURL, err := url.JoinPath(apiutil.BaseURL,
+			"repositories", string(record.RepositoryID), "refs", string(record.SourceRef), "objects")
+		if err != nil {
+			return err
+		}
 		req, err := http.NewRequest(http.MethodGet, reqURL, nil)
 		if err != nil {
 			return err

diff --git a/pkg/actions/lua/lakefs/client.go b/pkg/actions/lua/lakefs/client.go
@@ -14,6 +14,7 @@ import (
 	"github.com/Shopify/go-lua"
 	"github.com/go-chi/chi/v5"
 	"github.com/treeverse/lakefs/pkg/actions/lua/util"
+	"github.com/treeverse/lakefs/pkg/api/apiutil"
 	"github.com/treeverse/lakefs/pkg/auth"
 	"github.com/treeverse/lakefs/pkg/auth/model"
 	"github.com/treeverse/lakefs/pkg/version"
@@ -31,12 +32,12 @@ func check(l *lua.State, err error) {
 
 func newLakeFSRequest(ctx context.Context, user *model.User, method, url string, data []byte) (*http.Request, error) {
 	if !strings.HasPrefix(url, "/api/") {
-		if strings.HasPrefix(url, "/") {
-			url = fmt.Sprintf("/api/v1%s", url)
-		} else {
-			url = fmt.Sprintf("/api/v1/%s", url)
+		url, err = url.JoinPath(apiutil.BaseURL, url)
+		if err != nil {
+			return nil, err
 		}
 	}
+
 	var body io.Reader
 	if data == nil {
 		body = bytes.NewReader(data)