plugin_api.go

/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package plugin

import (
	"github.com/apache/incubator-devlake/core/context"
	"github.com/apache/incubator-devlake/core/errors"
	"github.com/apache/incubator-devlake/core/models/common"
	"net/http"
	"net/url"
)

// ApiResourceInput Contains api request information
type ApiResourceInput struct {
	Params  map[string]string      // path variables
	Query   url.Values             // query string
	Body    map[string]interface{} // json body
	Request *http.Request

	User *common.User
}

// GetPlugin get the plugin in context
func (input *ApiResourceInput) GetPlugin() string {
	return input.Params["plugin"]
}

// OutputFile is the file returned
type OutputFile struct {
	ContentType string
	Data        []byte
}

// ApiResourceOutput Describe response data of a api
type ApiResourceOutput struct {
	Body        interface{} // response body
	Status      int
	File        *OutputFile
	ContentType string
	Header      http.Header // optional response header
}

type ApiResourceHandler func(input *ApiResourceInput) (*ApiResourceOutput, errors.Error)

// PluginApi: Implement this interface if plugin offered API
// Code sample to register a api on `sources/:connectionId`:
//
//	func (p Jira) ApiResources() map[string]map[string]plugin.ApiResourceHandler {
//		return map[string]map[string]plugin.ApiResourceHandler{
//			"connections/:connectionId": {
//				"PUT":    api.PutConnection,
//				"DELETE": api.DeleteConnection,
//				"GET":    api.GetConnection,
//			},
//		}
//	}
type PluginApi interface {
	ApiResources() map[string]map[string]ApiResourceHandler
}

type PluginTestConnectionAPI interface {
	TestConnection(id uint64) errors.Error
}

const wrapResponseError = "WRAP_RESPONSE_ERROR"

func WrapTestConnectionErrResp(basicRes context.BasicRes, err errors.Error) errors.Error {
	if err == nil {
		return err
	}
	if !basicRes.GetConfigReader().GetBool(wrapResponseError) {
		return err
	}
	statusCode := err.GetType().GetHttpCode()
	message := "Something went wrong when testing your connection, please check your connection details."
	return errors.HttpStatus(statusCode).New(message)
}