Refactor ConstructAPIResourceEndpoint and ConstructAPIAuthEndpoint functions in APIHandler implementations to remove the instanceName parameter

Author: ShocOne

apiintegrations/apihandler/apihandler.go

@@ -11,8 +11,8 @@ import (
 // APIHandler is an interface for encoding, decoding, and implenting contexual api functions for different API implementations.
 // It encapsulates behavior for encoding and decoding requests and responses.
 type APIHandler interface {
-	ConstructAPIResourceEndpoint(APIResourceEndpointIdentifier string, endpointPath string, log logger.Logger) string
-	ConstructAPIAuthEndpoint(APIAuthEndpointIdentifier string, endpointPath string, log logger.Logger) string
+	ConstructAPIResourceEndpoint(endpointPath string, log logger.Logger) string
+	ConstructAPIAuthEndpoint(endpointPath string, log logger.Logger) string
 	MarshalRequest(body interface{}, method string, endpoint string, log logger.Logger) ([]byte, error)
 	MarshalMultipartRequest(fields map[string]string, files map[string]string, log logger.Logger) ([]byte, string, error)
 	GetContentTypeHeader(method string, log logger.Logger) string
@@ -29,22 +29,21 @@ type APIHandler interface {
 	GetAPIRequestHeaders(endpoint string) map[string]string // Provides standard headers required for making API requests.
 }
 
-// Modify the function signature to accept instanceName, tenantID, and tenantName.
+// LoadAPIHandler loads the appropriate API handler based on the API type.
 func LoadAPIHandler(apiType, instanceName, tenantID, tenantName string, log logger.Logger) (APIHandler, error) {
 	var apiHandler APIHandler
 	switch apiType {
 	case "jamfpro":
 		apiHandler = &jamfpro.JamfAPIHandler{
 			Logger:       log,
-			InstanceName: instanceName, // Assuming you add InstanceName field to JamfAPIHandler
+			InstanceName: instanceName, // Used for constructing the resource and auth endpoints
 		}
 		log.Info("Jamf Pro API handler loaded successfully", zap.String("APIType", apiType), zap.String("InstanceName", instanceName))
 
 	case "msgraph":
 		apiHandler = &msgraph.GraphAPIHandler{
-			Logger:     log,
-			TenantID:   tenantID,   // Assuming you add TenantID field to GraphAPIHandler
-			TenantName: tenantName, // Assuming you add TenantName field to GraphAPIHandler
+			Logger:   log,
+			TenantID: tenantID, // Used for constructing the auth endpoint
 		}
 		log.Info("Microsoft Graph API handler loaded successfully", zap.String("APIType", apiType), zap.String("TenantID", tenantID), zap.String("TenantName", tenantName))
 

apiintegrations/jamfpro/jamfpro_api_url.go

@@ -18,17 +18,17 @@ func (j *JamfAPIHandler) SetBaseDomain() string {
 }
 
 // ConstructAPIResourceEndpoint constructs the full URL for a Jamf API resource endpoint path and logs the URL.
-func (j *JamfAPIHandler) ConstructAPIResourceEndpoint(instanceName string, endpointPath string, log logger.Logger) string {
+func (j *JamfAPIHandler) ConstructAPIResourceEndpoint(endpointPath string, log logger.Logger) string {
 	urlBaseDomain := j.SetBaseDomain()
-	url := fmt.Sprintf("https://%s%s%s", instanceName, urlBaseDomain, endpointPath)
+	url := fmt.Sprintf("https://%s%s%s", j.InstanceName, urlBaseDomain, endpointPath)
 	j.Logger.Debug(fmt.Sprintf("Constructed %s API resource endpoint URL", APIName), zap.String("URL", url))
 	return url
 }
 
 // ConstructAPIAuthEndpoint constructs the full URL for a Jamf API auth endpoint path and logs the URL.
-func (j *JamfAPIHandler) ConstructAPIAuthEndpoint(instanceName string, endpointPath string, log logger.Logger) string {
+func (j *JamfAPIHandler) ConstructAPIAuthEndpoint(endpointPath string, log logger.Logger) string {
 	urlBaseDomain := j.SetBaseDomain()
-	url := fmt.Sprintf("https://%s%s%s", instanceName, urlBaseDomain, endpointPath)
+	url := fmt.Sprintf("https://%s%s%s", j.InstanceName, urlBaseDomain, endpointPath)
 	j.Logger.Debug(fmt.Sprintf("Constructed %s API authentication URL", APIName), zap.String("URL", url))
 	return url
 }

apiintegrations/msgraph/msgraph_api_url.go

@@ -11,14 +11,11 @@ import (
 // SetBaseDomain returns the appropriate base domain for URL construction.
 // It uses j.OverrideBaseDomain if set, otherwise falls back to DefaultBaseDomain.
 func (g *GraphAPIHandler) SetBaseDomain() string {
-	if g.OverrideBaseDomain != "" {
-		return g.OverrideBaseDomain
-	}
 	return DefaultBaseDomain
 }
 
 // ConstructAPIResourceEndpoint constructs the full URL for a graph API resource endpoint path and logs the URL.
-func (g *GraphAPIHandler) ConstructAPIResourceEndpoint(tenantName string, endpointPath string, log logger.Logger) string {
+func (g *GraphAPIHandler) ConstructAPIResourceEndpoint(endpointPath string, log logger.Logger) string {
 	urlBaseDomain := g.SetBaseDomain()
 	url := fmt.Sprintf("https://%s%s%s", g.TenantName, urlBaseDomain, endpointPath)
 	g.Logger.Debug(fmt.Sprintf("Constructed %s API resource endpoint URL", APIName), zap.String("URL", url))
@@ -27,7 +24,7 @@ func (g *GraphAPIHandler) ConstructAPIResourceEndpoint(tenantName string, endpoi
 
 // ConstructAPIAuthEndpoint constructs the full URL for the Microsoft Graph API authentication endpoint.
 // It uses the provided tenant ID and endpoint path and logs the constructed URL.
-func (g *GraphAPIHandler) ConstructAPIAuthEndpoint(tenantID string, endpointPath string, log logger.Logger) string {
+func (g *GraphAPIHandler) ConstructAPIAuthEndpoint(endpointPath string, log logger.Logger) string {
 	// The base URL for the Microsoft Graph API authentication endpoint.
 	const baseURL = "https://login.microsoftonline.com"
 

authenticationhandler/auth_bearer_token.go

@@ -21,7 +21,7 @@ func (h *AuthTokenHandler) ObtainToken(apiHandler apihandler.APIHandler, httpCli
 	bearerTokenEndpoint := apiHandler.GetBearerTokenEndpoint()
 
 	// Construct the full authentication endpoint URL
-	authenticationEndpoint := apiHandler.ConstructAPIAuthEndpoint(h.InstanceName, bearerTokenEndpoint, h.Logger)
+	authenticationEndpoint := apiHandler.ConstructAPIAuthEndpoint(bearerTokenEndpoint, h.Logger)
 
 	h.Logger.Debug("Attempting to obtain token for user", zap.String("Username", username))
 
@@ -69,7 +69,7 @@ func (h *AuthTokenHandler) RefreshToken(apiHandler apihandler.APIHandler, httpCl
 	apiTokenRefreshEndpoint := apiHandler.GetTokenRefreshEndpoint()
 
 	// Construct the full authentication endpoint URL
-	tokenRefreshEndpoint := apiHandler.ConstructAPIAuthEndpoint(h.InstanceName, apiTokenRefreshEndpoint, h.Logger)
+	tokenRefreshEndpoint := apiHandler.ConstructAPIAuthEndpoint(apiTokenRefreshEndpoint, h.Logger)
 
 	h.Logger.Debug("Attempting to refresh token", zap.String("URL", tokenRefreshEndpoint))
 

authenticationhandler/auth_oauth.go

@@ -37,7 +37,7 @@ func (h *AuthTokenHandler) ObtainOAuthToken(apiHandler apihandler.APIHandler, ht
 	oauthTokenEndpoint := apiHandler.GetOAuthTokenEndpoint()
 
 	// Construct the full authentication endpoint URL
-	authenticationEndpoint := apiHandler.ConstructAPIAuthEndpoint(h.InstanceName, oauthTokenEndpoint, h.Logger)
+	authenticationEndpoint := apiHandler.ConstructAPIAuthEndpoint(oauthTokenEndpoint, h.Logger)
 
 	// Get the OAuth token scope from the APIHandler
 	oauthTokenScope := apiHandler.GetOAuthTokenScope()

httpclient/multipartrequest.go

@@ -60,7 +60,7 @@ func (c *Client) DoMultipartRequest(method, endpoint string, fields map[string]s
 	}
 
 	// Construct URL using the ConstructAPIResourceEndpoint function
-	url := c.APIHandler.ConstructAPIResourceEndpoint(c.clientConfig.Environment.InstanceName, endpoint, log)
+	url := c.APIHandler.ConstructAPIResourceEndpoint(endpoint, log)
 
 	// Create the request
 	req, err := http.NewRequest(method, url, bytes.NewBuffer(requestData))

httpclient/request.go

@@ -146,7 +146,7 @@ func (c *Client) executeRequestWithRetries(method, endpoint string, body, out in
 	}
 
 	// Construct URL with correct structure defined in api handler
-	url := c.APIHandler.ConstructAPIResourceEndpoint(c.clientConfig.Environment.InstanceName, endpoint, log)
+	url := c.APIHandler.ConstructAPIResourceEndpoint(endpoint, log)
 
 	// Increment total request counter within ConcurrencyHandler's metrics
 	c.ConcurrencyHandler.Metrics.Lock.Lock()
@@ -312,7 +312,7 @@ func (c *Client) executeRequest(method, endpoint string, body, out interface{})
 	}
 
 	// Construct URL using the ConstructAPIResourceEndpoint function
-	url := c.APIHandler.ConstructAPIResourceEndpoint(c.clientConfig.Environment.InstanceName, endpoint, log)
+	url := c.APIHandler.ConstructAPIResourceEndpoint(endpoint, log)
 
 	// Create a new HTTP request with the provided method, URL, and body
 	req, err := http.NewRequest(method, url, bytes.NewBuffer(requestData))