Merge pull request #22 from planetlabs/urls

Retain double slashes when creating absolute URLs

Author: tschaub

.github/workflows/test.yml

@@ -17,6 +17,7 @@ jobs:
       - uses: golangci/golangci-lint-action@v2
         with:
           version: v1.45.2
+          args: "--out-${NO_FUTURE}format colored-line-number"
 
   test:
     runs-on: ubuntu-latest

cmd/stac/make-links-absolute.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"net/url"
 	"os"
 	"path"
 	"path/filepath"
@@ -60,8 +61,11 @@ var absoluteLinksCommand = &cli.Command{
 		if entryUrl == "" {
 			return fmt.Errorf("missing --%s", flagUrl)
 		}
-
-		baseUrl := path.Dir(entryUrl)
+		baseUrl, urlErr := url.Parse(entryUrl)
+		if urlErr != nil {
+			return fmt.Errorf("trouble parsing url %q: %w", entryUrl, urlErr)
+		}
+		baseUrl.Path = path.Dir(baseUrl.Path)
 
 		outputPath := ctx.String(flagOutput)
 		if outputPath == "" {
@@ -76,7 +80,12 @@ var absoluteLinksCommand = &cli.Command{
 
 			links := resource.Links()
 			for _, link := range links {
-				link["href"] = makeAbsolute(link["href"], filepath.ToSlash(relDir), baseUrl)
+				relUrl, err := url.Parse(link["href"])
+				if err != nil {
+					return fmt.Errorf("failed to parse link %q: %w", link["href"], err)
+				}
+				absUrl := makeAbsolute(relUrl, filepath.ToSlash(relDir), baseUrl)
+				link["href"] = absUrl.String()
 			}
 			resource["links"] = links
 
@@ -106,10 +115,18 @@ var absoluteLinksCommand = &cli.Command{
 	},
 }
 
-func makeAbsolute(linkUrl string, resourceDir string, baseUrl string) string {
-	if strings.HasPrefix(linkUrl, baseUrl+"/") {
+func cloneUrl(u *url.URL) *url.URL {
+	newUrl := *u
+	return &newUrl
+}
+
+func makeAbsolute(linkUrl *url.URL, resourceDir string, baseUrl *url.URL) *url.URL {
+	if linkUrl.IsAbs() {
 		return linkUrl
 	}
 
-	return path.Join(baseUrl, path.Join(resourceDir, linkUrl))
+	newUrl := cloneUrl(baseUrl)
+	newUrl.Path = path.Join(baseUrl.Path, path.Join(resourceDir, linkUrl.Path))
+
+	return newUrl
 }

cmd/stac/make-links-absolute_test.go

@@ -0,0 +1,69 @@
+package main
+
+import (
+	"fmt"
+	"net/url"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestMakeAbsoluteUrl(t *testing.T) {
+	cases := []struct {
+		dir  string
+		link string
+		base string
+		abs  string
+	}{
+		{
+			dir:  "some/dir",
+			link: "./item.json",
+			base: "https://example.com/stac",
+			abs:  "https://example.com/stac/some/dir/item.json",
+		},
+		{
+			dir:  "some/dir",
+			link: "item.json",
+			base: "https://example.com/stac",
+			abs:  "https://example.com/stac/some/dir/item.json",
+		},
+		{
+			dir:  "some/dir",
+			link: "../../catalog.json",
+			base: "https://example.com/stac",
+			abs:  "https://example.com/stac/catalog.json",
+		},
+		{
+			dir:  "some/dir",
+			link: "../../../../../../catalog.json",
+			base: "https://example.com/stac",
+			abs:  "https://example.com/catalog.json",
+		},
+		{
+			dir:  "../some/dir",
+			link: "other/catalog.json",
+			base: "https://example.com/stac",
+			abs:  "https://example.com/some/dir/other/catalog.json",
+		},
+		{
+			dir:  "some-dir",
+			link: "https://example.com/some-dir/item.json",
+			base: "https://other.com/stac",
+			abs:  "https://example.com/some-dir/item.json",
+		},
+	}
+
+	for i, c := range cases {
+		t.Run(fmt.Sprintf("case %d", i), func(t *testing.T) {
+			linkUrl, err := url.Parse(c.link)
+			require.NoError(t, err)
+
+			baseUrl, err := url.Parse(c.base)
+			require.NoError(t, err)
+
+			absUrl := makeAbsolute(linkUrl, c.dir, baseUrl)
+			assert.Equal(t, c.abs, absUrl.String())
+		})
+	}
+}