Generate index.json

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Use filepath.Walk to find valid package content data. [#438](https://github.com/elastic/package-registry/pull/438)
 * Validate handlebarsjs stream configuration templates. [#445](https://github.com/elastic/package-registry/pull/445)
 * Serve favicon as embedded resource. [#468](https://github.com/elastic/package-registry/pull/468)
+* Generate index.json file. [#470](https://github.com/elastic/package-registry/pull/470)
 
 ### Deprecated
 

docs/api/index.json

@@ -0,0 +1,4 @@
+{
+ "service.name": "package-registry",
+ "version": "0.4.0"
+}

index.go

@@ -0,0 +1,32 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License;
+// you may not use this file except in compliance with the Elastic License.
+
+package main
+
+import (
+ "encoding/json"
+ "net/http"
+ "time"
+)
+
+type indexData struct {
+ ServiceName string `json:"service.name"`
+ Version string `json:"version"`
+}
+
+func indexHandler(cacheTime time.Duration) (func(w http.ResponseWriter, r *http.Request), error) {
+ data := indexData{
+ ServiceName: serviceName,
+ Version: version,
+ }
+ body, err := json.MarshalIndent(&data, "", " ")
+ if err != nil {
+ return nil, err
+ }
+ return func(w http.ResponseWriter, r *http.Request) {
+ w.Header().Set("Content-Type", "application/json")
+ cacheHeaders(w, cacheTime)
+ w.Write(body)
+ }, nil
+}

magefile.go

@@ -64,11 +64,6 @@ func Build() error {
  return err
  }
  }
-
- err = BuildRootFile()
- if err != nil {
- return err
- }
  return sh.Run("go", "build", ".")
 }
 
@@ -95,31 +90,6 @@ func fetchPackageStorage() error {
  packageStorageRevision)
 }
 
-// Creates the `index.json` file
-// For now only containing the version.
-func BuildRootFile() error {
- rootData := map[string]string{
- "version": "0.4.0",
- "service.name": "package-registry",
- }
- return writeJsonFile(rootData, publicDir+"/index.json")
-}
-
-// Copy Favicon to public dir
-func CopyFavicon() error {
-
- favicon, err := ioutil.ReadFile("img/favicon.ico")
- if err != nil {
- return err
- }
-
- err = ioutil.WriteFile(publicDir+"/favicon.ico", favicon, 0644)
- if err != nil {
- return err
- }
- return nil
-}
-
 func writeJsonFile(v interface{}, path string) error {
  data, err := json.MarshalIndent(v, "", " ")
  if err != nil {

main.go

@@ -25,6 +25,9 @@ import (
 
 const (
  packageDir = "package"
+
+ serviceName = "package-registry"
+ version = "0.4.0"
 )
 
 var (
@@ -121,13 +124,20 @@ func getRouter(config Config, packagesBasePath string) (*mux.Router, error) {
  if err != nil {
  return nil, err
  }
+ indexHandlerFunc, err := indexHandler(config.CacheTimeCatchAll)
+ if err != nil {
+ return nil, err
+ }
 
  router := mux.NewRouter().StrictSlash(true)
+ router.HandleFunc("/", indexHandlerFunc)
+ router.HandleFunc("/index.json", indexHandlerFunc)
  router.HandleFunc("/search", searchHandler(packagesBasePath, config.CacheTimeSearch))
  router.HandleFunc("/categories", categoriesHandler(packagesBasePath, config.CacheTimeCategories))
  router.HandleFunc("/health", healthHandler)
  router.HandleFunc("/favicon.ico", faviconHandleFunc)
- router.PathPrefix("/").HandlerFunc(catchAll(http.Dir(config.PublicDir), config.CacheTimeCatchAll))
+ router.PathPrefix("/epr").HandlerFunc(catchAll(http.Dir(config.PublicDir), config.CacheTimeCatchAll))
+ router.PathPrefix("/package").HandlerFunc(catchAll(http.Dir(config.PublicDir), config.CacheTimeCatchAll))
  router.Use(loggingMiddleware)
  return router, nil
 }

main_test.go

@@ -34,13 +34,17 @@ func TestEndpoints(t *testing.T) {
  faviconHandleFunc, err := faviconHandler(testCacheTime)
  require.NoError(t, err)
 
+ indexHandleFunc, err := indexHandler(testCacheTime)
+ require.NoError(t, err)
+
  tests := []struct {
  endpoint string
  path string
  file string
  handler func(w http.ResponseWriter, r *http.Request)
  }{
- {"/", "", "info.json", catchAll(http.Dir(publicPath), testCacheTime)},
+ {"/", "", "index.json", indexHandleFunc},
+ {"/index.json", "", "index.json", indexHandleFunc},
  {"/search", "/search", "search.json", searchHandler(packagesBasePath, testCacheTime)},
  {"/search?all=true", "/search", "search-all.json", searchHandler(packagesBasePath, testCacheTime)},
  {"/categories", "/categories", "categories.json", categoriesHandler(packagesBasePath, testCacheTime)},