tmi/api/version.go at 047e867dc0ef00dbce853b7be92ff87979974172 · ericfitz/tmi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
package api

import (
	"encoding/json"
	"fmt"
	"net/http"
	"strconv"
	"strings"
	"time"

	"github.com/ericfitz/tmi/internal/slogging"
	"github.com/gin-gonic/gin"
)

// Version contains versioning information for the API
type Version struct {
	Major      int    `json:"major"`
	Minor      int    `json:"minor"`
	Patch      int    `json:"patch"`
	GitCommit  string `json:"git_commit,omitempty"`
	BuildDate  string `json:"build_date,omitempty"`
	APIVersion string `json:"api_version"`
}

// These values are set during build time
var (
	// Major version number
	VersionMajor = "0"
	// Minor version number
	VersionMinor = "266"
	// Patch version number
	VersionPatch = "11"
	// GitCommit is the git commit hash from build
	GitCommit = "development"
	// BuildDate is the build timestamp
	BuildDate = "unknown"
	// APIVersion is the API version string
	APIVersion = "v1"
)

// GetVersion returns the current application version
func GetVersion() Version {
	major := parseIntOrZero(VersionMajor)
	minor := parseIntOrZero(VersionMinor)
	patch := parseIntOrZero(VersionPatch)

	return Version{
		Major:      major,
		Minor:      minor,
		Patch:      patch,
		GitCommit:  GitCommit,
		BuildDate:  BuildDate,
		APIVersion: APIVersion,
	}
}

// parseIntOrZero parses an integer from a string, returning 0 on failure
func parseIntOrZero(s string) int {
	i, err := strconv.Atoi(s)
	if err != nil {
		return 0
	}
	return i
}

// GetVersionString returns the version as a formatted string
func GetVersionString() string {
	v := GetVersion()
	return fmt.Sprintf("tmi %d.%d.%d (%s - built %s)",
		v.Major, v.Minor, v.Patch, v.GitCommit, v.BuildDate)
}

// ApiInfoHandler handles requests to the root endpoint
type ApiInfoHandler struct {
	server *Server
}

// NewApiInfoHandler creates a new handler for API info
func NewApiInfoHandler(server *Server) *ApiInfoHandler {
	return &ApiInfoHandler{
		server: server,
	}
}

// HTML template for root page when accessed from browser
const rootPageHTML = `<!DOCTYPE html>
<html>
<head>
    <title>TMI API Server</title>
		<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96" />
		<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
		<link rel="shortcut icon" href="/favicon.ico" />
		<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
		<link rel="manifest" href="/site.webmanifest" />
	    <style>
			body { font-family: Arial, sans-serif; margin: 40px; line-height: 1.6; }
			.container { max-width: 800px; margin: 0 auto; }
			h1 { color: #333; }
			pre { background: #f5f5f5; padding: 10px; border-radius: 5px; overflow-x: auto; }
		</style>
</head>
<body>
    <div class="container">
        <h1>TMI API Server</h1>
        <p>This is the API server for the Threat Modeling Improved (TMI) application.</p>
        <p>API information:</p>
        <pre id="api-info"></pre>
    </div>
    <script>
        // Format and display the API info
        const apiInfo = %s;
        document.getElementById('api-info').textContent = JSON.stringify(apiInfo, null, 2);
    </script>
</body>
</html>
`

// healthCheckTimeout is the maximum time allowed for health checks
const healthCheckTimeout = 100 * time.Millisecond

// GetApiInfo returns service, API, and operator information
func (h *ApiInfoHandler) GetApiInfo(c *gin.Context) {
	// Get logger from context
	logger := slogging.GetContextLogger(c)

	logger.Debug("Handling root endpoint request from %s", c.ClientIP())
	// Log header names only to avoid exposing sensitive values
	headerNames := make([]string, 0, len(c.Request.Header))
	for k := range c.Request.Header {
		headerNames = append(headerNames, k)
	}
	logger.Debug("Request headers present: %v", headerNames)

	// Get user from context if available (will be "anonymous" for public paths)
	if userName, exists := c.Get("userName"); exists {
		if name, ok := userName.(string); ok {
			logger.Debug("Root endpoint accessed by user: %s", name)
		}
	} else {
		logger.Debug("No user found in context for root endpoint")
	}

	// Perform health checks on database and Redis
	healthChecker := NewHealthChecker(healthCheckTimeout)
	healthResult := healthChecker.CheckHealth(c.Request.Context())
	logger.Debug("Health check completed: overall=%s, db=%s, redis=%s",
		healthResult.Overall, healthResult.Database.Status, healthResult.Redis.Status)

	// Get version info
	v := GetVersion()
	buildString := fmt.Sprintf("%d.%d.%d-%s", v.Major, v.Minor, v.Patch, v.GitCommit)

	// Get API version from embedded OpenAPI specification
	apiVersion := "unknown"
	swagger, err := GetSwagger()
	if err != nil {
		logger.Error("Failed to load OpenAPI spec: %v", err)
	} else if swagger != nil && swagger.Info != nil {
		apiVersion = swagger.Info.Version
		logger.Debug("Loaded API version from OpenAPI spec: %s", apiVersion)
	}

	// Create ApiInfo response with health-aware status
	apiInfo := ApiInfo{
		Status: struct {
			Code ApiInfoStatusCode `json:"code"`
			Time time.Time         `json:"time"`
		}{
			Code: healthResult.Overall,
			Time: time.Now().UTC(),
		},
		Service: struct {
			Build string `json:"build"`
			Name  string `json:"name"`
		}{
			Name:  "TMI",
			Build: buildString,
		},
		Api: struct {
			Specification string `json:"specification"`
			Version       string `json:"version"`
		}{
			Version:       apiVersion,
			Specification: "https://github.com/ericfitz/tmi/blob/main/docs/reference/apis/tmi-openapi.json",
		},
	}

	// Include health details only when status is DEGRADED
	if healthResult.Overall == DEGRADED {
		apiInfo.Health = &struct {
			Database *ComponentHealth `json:"database,omitempty"`
			Redis    *ComponentHealth `json:"redis,omitempty"`
		}{
			Database: healthResult.Database.ToAPIComponentHealth(),
			Redis:    healthResult.Redis.ToAPIComponentHealth(),
		}
		logger.Warn("System health is degraded: database=%s, redis=%s",
			healthResult.Database.Status, healthResult.Redis.Status)
	}

	// Add optional operator info from config (stored in context)
	operatorName, _ := c.Get("operatorName")
	operatorContact, _ := c.Get("operatorContact")

	// Convert to strings safely
	nameStr, nameOk := operatorName.(string)
	contactStr, contactOk := operatorContact.(string)

	if (nameOk && nameStr != "") || (contactOk && contactStr != "") {
		apiInfo.Operator = &struct {
			Contact string `json:"contact"`
			Name    string `json:"name"`
		}{
			Name:    nameStr,
			Contact: contactStr,
		}
		logger.Debug("Added operator info: name=%s, contact=%s", nameStr, contactStr)
	}

	// Note: WebSocket information is now documented in AsyncAPI specification
	// WebSocket endpoints are not part of REST API info since they use different protocols

	logger.Info("Returning API info response")

	// Check if request is from a browser
	acceptHeader := c.GetHeader("Accept")
	if strings.Contains(acceptHeader, "text/html") {
		// Return HTML page for browser requests
		apiInfoJSON, err := json.Marshal(apiInfo)
		if err != nil {
			logger.Error("Failed to marshal API info: %v", err)
			c.JSON(http.StatusInternalServerError, Error{
				Error:            "server_error",
				ErrorDescription: "Failed to generate API info",
			})
			return
		}

		// Format HTML with API info as JSON - escape for JavaScript context to prevent XSS
		escapedJSON := strings.ReplaceAll(string(apiInfoJSON), "</", "<\\/")
		escapedJSON = strings.ReplaceAll(escapedJSON, "<!--", "<\\!--")
		htmlResponse := fmt.Sprintf(rootPageHTML, escapedJSON)
		c.Header("Content-Type", "text/html")
		c.String(http.StatusOK, htmlResponse)
		logger.Debug("Returned HTML response for browser")
	} else {
		// Return JSON for API clients
		c.JSON(http.StatusOK, apiInfo)
		logger.Debug("Returned JSON response for API client")
	}
}