support multiple REST API versions

ukane-philemon · ukane-philemon · commit 22c07f793096 · 2024-06-06T16:47:05.000+01:00
diff --git a/api/types/v1/apicache.go b/api/types/v1/apicache.go
diff --git a/api/types/v1/apicache_test.go b/api/types/v1/apicache_test.go
diff --git a/api/types/v1/apitypes.go b/api/types/v1/apitypes.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2019-2021, The Decred developers
+// Copyright (c) 2019-2022, The Decred developers
 // Copyright (c) 2017, Jonathan Chappelow
 // See LICENSE for details.
 
diff --git a/api/types/v1/apitypes_test.go b/api/types/v1/apitypes_test.go
diff --git a/api/types/v1/insightapitypes.go b/api/types/v1/insightapitypes.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2021, The Decred developers
+// Copyright (c) 2018-2022, The Decred developers
 // Copyright (c) 2017, Jonathan Chappelow
 // See LICENSE for details.
 
diff --git a/blockdata/blockdata.go b/blockdata/blockdata.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2020-2021, The Decred developers
+// Copyright (c) 2020-2022, The Decred developers
 // Copyright (c) 2017, Jonathan Chappelow
 // See LICENSE for details.
 
@@ -16,7 +16,7 @@ import (
 	chainjson "github.com/decred/dcrd/rpc/jsonrpc/types/v4"
 	"github.com/decred/dcrd/wire"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	"github.com/decred/dcrdata/v8/stakedb"
 	"github.com/decred/dcrdata/v8/txhelpers"
diff --git a/cmd/dcrdata/internal/api/apirouter.go b/cmd/dcrdata/internal/api/apirouter.go
@@ -18,6 +18,11 @@ type apiMux struct {
 	*chi.Mux
 }
 
+// Versions returns a list of API versions supported.
+func (am *apiMux) Versions() []APIVersion {
+	return supportedAPIVersions[:]
+}
+
 type fileMux struct {
 	*chi.Mux
 }
diff --git a/cmd/dcrdata/internal/api/apiroutes.go b/cmd/dcrdata/internal/api/apiroutes.go
@@ -36,7 +36,7 @@ import (
 	"github.com/decred/dcrdata/exchanges/v3"
 	"github.com/decred/dcrdata/gov/v6/agendas"
 	"github.com/decred/dcrdata/gov/v6/politeia"
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/cache"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	"github.com/decred/dcrdata/v8/txhelpers"
@@ -160,7 +160,7 @@ func NewContext(cfg *AppContextConfig) *appContext {
 		xcBot:       cfg.XcBot,
 		AgendaDB:    cfg.AgendasDBInstance,
 		ProposalsDB: cfg.ProposalsDB,
-		Status:      apitypes.NewStatus(uint32(nodeHeight), conns, APIVersion, cfg.AppVer, cfg.Params.Name),
+		Status:      apitypes.NewStatus(uint32(nodeHeight), conns, currentAPIVersion, cfg.AppVer, cfg.Params.Name),
 		maxCSVAddrs: cfg.MaxAddrs,
 		charts:      cfg.Charts,
 	}
diff --git a/cmd/dcrdata/internal/api/insight/apimiddleware.go b/cmd/dcrdata/internal/api/insight/apimiddleware.go
@@ -15,7 +15,7 @@ import (
 	"strings"
 
 	m "github.com/decred/dcrdata/cmd/dcrdata/internal/middleware"
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/go-chi/chi/v5"
 )
 
diff --git a/cmd/dcrdata/internal/api/insight/apirouter.go b/cmd/dcrdata/internal/api/insight/apirouter.go
@@ -19,8 +19,10 @@ type ApiMux struct {
 	*chi.Mux
 }
 
-// APIVersion is an integer value, incremented for breaking changes
-const APIVersion = 0
+// Versions returns a list of API versions supported.
+func (am *ApiMux) Versions() []APIVersion {
+	return supportedAPIVersions[:]
+}
 
 // NewInsightAPIRouter returns a new HTTP path router, ApiMux, for the Insight
 // API, app.
diff --git a/cmd/dcrdata/internal/api/insight/apiroutes.go b/cmd/dcrdata/internal/api/insight/apiroutes.go
@@ -26,7 +26,7 @@ import (
 
 	m "github.com/decred/dcrdata/cmd/dcrdata/internal/middleware"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	"github.com/decred/dcrdata/v8/txhelpers"
 )
diff --git a/cmd/dcrdata/internal/api/insight/apiroutes_test.go b/cmd/dcrdata/internal/api/insight/apiroutes_test.go
@@ -8,7 +8,7 @@ import (
 	"testing"
 	"time"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 )
 
 func Test_dateFromStr(t *testing.T) {
diff --git a/cmd/dcrdata/internal/api/insight/converter.go b/cmd/dcrdata/internal/api/insight/converter.go
@@ -11,7 +11,7 @@ import (
 	"github.com/decred/dcrd/dcrutil/v4"
 	chainjson "github.com/decred/dcrd/rpc/jsonrpc/types/v4"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/txhelpers"
 )
 
diff --git a/cmd/dcrdata/internal/api/insight/version.go b/cmd/dcrdata/internal/api/insight/version.go
@@ -0,0 +1,15 @@
+// Copyright (c) 2017-2022, The dcrdata developers
+// See LICENSE for details.
+
+package insight
+
+// APIVersion is an integer value, incremented for breaking changes.
+type APIVersion int32
+
+// currentVersion is the most recent version supported.
+const currentAPIVersion = 1
+
+// supportedAPIVersions is a list of supported API versions.
+var supportedAPIVersions = [...]APIVersion{
+	currentAPIVersion,
+}
diff --git a/cmd/dcrdata/internal/api/version.go b/cmd/dcrdata/internal/api/version.go
@@ -3,8 +3,16 @@
 
 package api
 
-// APIVersion is an integer value, incremented for breaking changes
-const APIVersion = 1
+// APIVersion is an integer value, incremented for breaking changes.
+type APIVersion int32
+
+// currentVersion is the most recent version supported.
+const currentAPIVersion = 1
+
+// supportedAPIVersions is a list of supported API versions.
+var supportedAPIVersions = [...]APIVersion{
+	currentAPIVersion,
+}
 
 // CommitHash may be set on the build command line:
 // go build -ldflags "-X main.CommitHash=`git rev-parse --short HEAD`"
diff --git a/cmd/dcrdata/internal/explorer/websockethandlers.go b/cmd/dcrdata/internal/explorer/websockethandlers.go
@@ -13,7 +13,7 @@ import (
 	"strings"
 	"time"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	"github.com/decred/dcrdata/v8/explorer/types"
 	pstypes "github.com/decred/dcrdata/v8/pubsub/types"
diff --git a/cmd/dcrdata/internal/middleware/apimiddleware.go b/cmd/dcrdata/internal/middleware/apimiddleware.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2021, The Decred developers
+// Copyright (c) 2018-2022, The Decred developers
 // Copyright (c) 2017, The dcrdata developers
 // See LICENSE for details.
 
@@ -22,7 +22,7 @@ import (
 	chainjson "github.com/decred/dcrd/rpc/jsonrpc/types/v4"
 	"github.com/decred/dcrd/txscript/v4/stdaddr"
 	"github.com/decred/dcrd/wire"
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/didip/tollbooth/v6"
 	"github.com/didip/tollbooth/v6/limiter"
 	"github.com/go-chi/chi/v5"
@@ -60,6 +60,7 @@ const (
 	ctxXcToken
 	ctxStickWidth
 	ctxIndent
+	ctxAPIVersion
 )
 
 type DataSource interface {
@@ -1101,3 +1102,24 @@ func RetrieveStickWidthCtx(r *http.Request) string {
 	}
 	return bin
 }
+
+// APIVersionCtx adds supported API version to a request context.
+func APIVersionCtx(version string) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			r = r.WithContext(context.WithValue(r.Context(), ctxAPIVersion, version))
+			next.ServeHTTP(w, r)
+		})
+	}
+}
+
+// RetrieveAPIVersion pulls the API version of this request form the request's
+// context. Unused
+func RetrieveAPIVersion(r *http.Request) string {
+	version, ok := r.Context().Value(ctxAPIVersion).(string)
+	if !ok {
+		// The request was sent to the default API route, so no version was set.
+		return ""
+	}
+	return version
+}
diff --git a/cmd/dcrdata/main.go b/cmd/dcrdata/main.go
@@ -727,15 +727,28 @@ func _main(ctx context.Context) error {
 	// SyncStatusAPIIntercept returns a json response if the sync status page is
 	// enabled (no the full explorer while syncing).
 	webMux.With(explore.SyncStatusAPIIntercept).Group(func(r chi.Router) {
-		// Mount the dcrdata's REST API.
+		// Mount the default dcrdata REST API.
 		r.Mount("/api", apiMux.Mux)
-		// Setup and mount the Insight API.
+		// Mount versioned dcrdata REST API.
+		for _, version := range apiMux.Versions() {
+			versionStr := fmt.Sprintf("v%d", version)
+			r.With(mw.APIVersionCtx(versionStr)).Mount(fmt.Sprintf("/api/%s", versionStr), apiMux.Mux)
+		}
+
+		// Setup the Insight API.
 		insightApp := insight.NewInsightAPI(dcrdClient, chainDB,
 			activeChain, mpm, cfg.IndentJSON, app.Status)
 		insightApp.SetReqRateLimit(cfg.InsightReqRateLimit)
 		insightMux := insight.NewInsightAPIRouter(insightApp, cfg.UseRealIP,
 			cfg.CompressAPI, cfg.MaxCSVAddrs)
+
+		// Mount the dcrdata insight REST API.
 		r.Mount("/insight/api", insightMux.Mux)
+		// Mount the versioned insight REST API.
+		for _, version := range insightMux.Versions() {
+			versionStr := fmt.Sprintf("v%d", version)
+			r.With(mw.APIVersionCtx(versionStr)).Mount(fmt.Sprintf("/insight/api/%s", versionStr), insightMux.Mux)
+		}
 
 		if insightSocketServer != nil {
 			r.With(mw.NoOrigin).Get("/insight/socket.io/", insightSocketServer.ServeHTTP)
diff --git a/db/dcrpg/insightapi.go b/db/dcrpg/insightapi.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2021, The Decred developers
+// Copyright (c) 2018-2022, The Decred developers
 // Copyright (c) 2017, The dcrdata developers
 // See LICENSE for details.
 
@@ -14,7 +14,7 @@ import (
 	"github.com/decred/dcrd/txscript/v4/stdaddr"
 	"github.com/decred/dcrd/wire"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/cache"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	"github.com/decred/dcrdata/v8/txhelpers"
diff --git a/db/dcrpg/pgblockchain.go b/db/dcrpg/pgblockchain.go
@@ -33,7 +33,7 @@ import (
 	"github.com/lib/pq"
 
 	"github.com/decred/dcrdata/db/dcrpg/v8/internal"
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/blockdata"
 	"github.com/decred/dcrdata/v8/db/cache"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
diff --git a/db/dcrpg/queries.go b/db/dcrpg/queries.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2021, The Decred developers
+// Copyright (c) 2018-2022, The Decred developers
 // Copyright (c) 2017, The dcrdata developers
 // See LICENSE for details.
 
@@ -23,7 +23,7 @@ import (
 	"github.com/decred/dcrd/wire"
 
 	"github.com/decred/dcrdata/db/dcrpg/v8/internal"
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/cache"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	"github.com/decred/dcrdata/v8/txhelpers"
diff --git a/mempool/collector.go b/mempool/collector.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2021, The Decred developers
+// Copyright (c) 2018-2022, The Decred developers
 // Copyright (c) 2017, Jonathan Chappelow
 // See LICENSE for details.
 
@@ -17,7 +17,7 @@ import (
 	"github.com/decred/dcrd/dcrutil/v4"
 	chainjson "github.com/decred/dcrd/rpc/jsonrpc/types/v4"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	exptypes "github.com/decred/dcrdata/v8/explorer/types"
 	"github.com/decred/dcrdata/v8/txhelpers"
 )
diff --git a/mempool/mempoolcache.go b/mempool/mempoolcache.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2019-2021, The Decred developers
+// Copyright (c) 2019-2022, The Decred developers
 // Copyright (c) 2017, Jonathan Chappelow
 // See LICENSE for details.
 
@@ -11,7 +11,7 @@ import (
 	"github.com/decred/dcrd/dcrutil/v4"
 	chainjson "github.com/decred/dcrd/rpc/jsonrpc/types/v4"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/db/dbtypes"
 	exptypes "github.com/decred/dcrdata/v8/explorer/types"
 )
diff --git a/mempool/mptypes.go b/mempool/mptypes.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2019-2021, The Decred developers
+// Copyright (c) 2019-2022, The Decred developers
 // See LICENSE for details.
 
 package mempool
@@ -8,7 +8,7 @@ import (
 
 	"github.com/decred/dcrd/chaincfg/chainhash"
 	chainjson "github.com/decred/dcrd/rpc/jsonrpc/types/v4"
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 )
 
 // MempoolInfo models basic data about the node's mempool
diff --git a/stakedb/stakedb.go b/stakedb/stakedb.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2018-2021, The Decred developers
+// Copyright (c) 2018-2022, The Decred developers
 // Copyright (c) 2018, The dcrdata developers
 // Copyright (c) 2017, Jonathan Chappelow
 // See LICENSE for details.
@@ -21,7 +21,7 @@ import (
 	"github.com/decred/dcrd/dcrutil/v4"
 	"github.com/decred/dcrd/wire"
 
-	apitypes "github.com/decred/dcrdata/v8/api/types"
+	apitypes "github.com/decred/dcrdata/v8/api/types/v1"
 	"github.com/decred/dcrdata/v8/txhelpers"
 )
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2019-2021, The Decred developers`
	`1`	`+// Copyright (c) 2019-2022, The Decred developers`
`2`	`2`	`// Copyright (c) 2017, Jonathan Chappelow`
`3`	`3`	`// See LICENSE for details.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2018-2021, The Decred developers`
	`1`	`+// Copyright (c) 2018-2022, The Decred developers`
`2`	`2`	`// Copyright (c) 2017, Jonathan Chappelow`
`3`	`3`	`// See LICENSE for details.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,11 @@ type apiMux struct {`
`18`	`18`	`*chi.Mux`
`19`	`19`	`}`
`20`	`20`
	`21`	`+// Versions returns a list of API versions supported.`
	`22`	`+func (am *apiMux) Versions() []APIVersion {`
	`23`	`+ return supportedAPIVersions[:]`
	`24`	`+}`
	`25`	`+`
`21`	`26`	`type fileMux struct {`
`22`	`27`	`*chi.Mux`
`23`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import (`
`15`	`15`	`"strings"`
`16`	`16`
`17`	`17`	`m "github.com/decred/dcrdata/cmd/dcrdata/internal/middleware"`
`18`		`- apitypes "github.com/decred/dcrdata/v8/api/types"`
	`18`	`+ apitypes "github.com/decred/dcrdata/v8/api/types/v1"`
`19`	`19`	`"github.com/go-chi/chi/v5"`
`20`	`20`	`)`
`21`	`21`