workers.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. package cloudflare
  2. import (
  3. "encoding/json"
  4. "net/http"
  5. "time"
  6. "github.com/pkg/errors"
  7. )
  8. // WorkerRequestParams provides parameters for worker requests for both enterprise and standard requests
  9. type WorkerRequestParams struct {
  10. ZoneID string
  11. ScriptName string
  12. }
  13. // WorkerRoute aka filters are patterns used to enable or disable workers that match requests.
  14. //
  15. // API reference: https://api.cloudflare.com/#worker-filters-properties
  16. type WorkerRoute struct {
  17. ID string `json:"id,omitempty"`
  18. Pattern string `json:"pattern"`
  19. Enabled bool `json:"enabled"`
  20. Script string `json:"script,omitempty"`
  21. }
  22. // WorkerRoutesResponse embeds Response struct and slice of WorkerRoutes
  23. type WorkerRoutesResponse struct {
  24. Response
  25. Routes []WorkerRoute `json:"result"`
  26. }
  27. // WorkerRouteResponse embeds Response struct and a single WorkerRoute
  28. type WorkerRouteResponse struct {
  29. Response
  30. WorkerRoute `json:"result"`
  31. }
  32. // WorkerScript Cloudflare Worker struct with metadata
  33. type WorkerScript struct {
  34. WorkerMetaData
  35. Script string `json:"script"`
  36. }
  37. // WorkerMetaData contains worker script information such as size, creation & modification dates
  38. type WorkerMetaData struct {
  39. ID string `json:"id,omitempty"`
  40. ETAG string `json:"etag,omitempty"`
  41. Size int `json:"size,omitempty"`
  42. CreatedOn time.Time `json:"created_on,omitempty"`
  43. ModifiedOn time.Time `json:"modified_on,omitempty"`
  44. }
  45. // WorkerListResponse wrapper struct for API response to worker script list API call
  46. type WorkerListResponse struct {
  47. Response
  48. WorkerList []WorkerMetaData `json:"result"`
  49. }
  50. // WorkerScriptResponse wrapper struct for API response to worker script calls
  51. type WorkerScriptResponse struct {
  52. Response
  53. WorkerScript `json:"result"`
  54. }
  55. // DeleteWorker deletes worker for a zone.
  56. //
  57. // API reference: https://api.cloudflare.com/#worker-script-delete-worker
  58. func (api *API) DeleteWorker(requestParams *WorkerRequestParams) (WorkerScriptResponse, error) {
  59. // if ScriptName is provided we will treat as org request
  60. if requestParams.ScriptName != "" {
  61. return api.deleteWorkerWithName(requestParams.ScriptName)
  62. }
  63. uri := "/zones/" + requestParams.ZoneID + "/workers/script"
  64. res, err := api.makeRequest("DELETE", uri, nil)
  65. var r WorkerScriptResponse
  66. if err != nil {
  67. return r, errors.Wrap(err, errMakeRequestError)
  68. }
  69. err = json.Unmarshal(res, &r)
  70. if err != nil {
  71. return r, errors.Wrap(err, errUnmarshalError)
  72. }
  73. return r, nil
  74. }
  75. // DeleteWorkerWithName deletes worker for a zone.
  76. // This is an enterprise only feature https://developers.cloudflare.com/workers/api/config-api-for-enterprise
  77. // account must be specified as api option https://godoc.org/github.com/cloudflare/cloudflare-go#UsingAccount
  78. //
  79. // API reference: https://api.cloudflare.com/#worker-script-delete-worker
  80. func (api *API) deleteWorkerWithName(scriptName string) (WorkerScriptResponse, error) {
  81. if api.AccountID == "" {
  82. return WorkerScriptResponse{}, errors.New("account ID required for enterprise only request")
  83. }
  84. uri := "/accounts/" + api.AccountID + "/workers/scripts/" + scriptName
  85. res, err := api.makeRequest("DELETE", uri, nil)
  86. var r WorkerScriptResponse
  87. if err != nil {
  88. return r, errors.Wrap(err, errMakeRequestError)
  89. }
  90. err = json.Unmarshal(res, &r)
  91. if err != nil {
  92. return r, errors.Wrap(err, errUnmarshalError)
  93. }
  94. return r, nil
  95. }
  96. // DownloadWorker fetch raw script content for your worker returns []byte containing worker code js
  97. //
  98. // API reference: https://api.cloudflare.com/#worker-script-download-worker
  99. func (api *API) DownloadWorker(requestParams *WorkerRequestParams) (WorkerScriptResponse, error) {
  100. if requestParams.ScriptName != "" {
  101. return api.downloadWorkerWithName(requestParams.ScriptName)
  102. }
  103. uri := "/zones/" + requestParams.ZoneID + "/workers/script"
  104. res, err := api.makeRequest("GET", uri, nil)
  105. var r WorkerScriptResponse
  106. if err != nil {
  107. return r, errors.Wrap(err, errMakeRequestError)
  108. }
  109. r.Script = string(res)
  110. r.Success = true
  111. return r, nil
  112. }
  113. // DownloadWorkerWithName fetch raw script content for your worker returns string containing worker code js
  114. // This is an enterprise only feature https://developers.cloudflare.com/workers/api/config-api-for-enterprise/
  115. //
  116. // API reference: https://api.cloudflare.com/#worker-script-download-worker
  117. func (api *API) downloadWorkerWithName(scriptName string) (WorkerScriptResponse, error) {
  118. if api.AccountID == "" {
  119. return WorkerScriptResponse{}, errors.New("account ID required for enterprise only request")
  120. }
  121. uri := "/accounts/" + api.AccountID + "/workers/scripts/" + scriptName
  122. res, err := api.makeRequest("GET", uri, nil)
  123. var r WorkerScriptResponse
  124. if err != nil {
  125. return r, errors.Wrap(err, errMakeRequestError)
  126. }
  127. r.Script = string(res)
  128. r.Success = true
  129. return r, nil
  130. }
  131. // ListWorkerScripts returns list of worker scripts for given account.
  132. //
  133. // This is an enterprise only feature https://developers.cloudflare.com/workers/api/config-api-for-enterprise
  134. //
  135. // API reference: https://developers.cloudflare.com/workers/api/config-api-for-enterprise/
  136. func (api *API) ListWorkerScripts() (WorkerListResponse, error) {
  137. if api.AccountID == "" {
  138. return WorkerListResponse{}, errors.New("account ID required for enterprise only request")
  139. }
  140. uri := "/accounts/" + api.AccountID + "/workers/scripts"
  141. res, err := api.makeRequest("GET", uri, nil)
  142. if err != nil {
  143. return WorkerListResponse{}, errors.Wrap(err, errMakeRequestError)
  144. }
  145. var r WorkerListResponse
  146. err = json.Unmarshal(res, &r)
  147. if err != nil {
  148. return WorkerListResponse{}, errors.Wrap(err, errUnmarshalError)
  149. }
  150. return r, nil
  151. }
  152. // UploadWorker push raw script content for your worker.
  153. //
  154. // API reference: https://api.cloudflare.com/#worker-script-upload-worker
  155. func (api *API) UploadWorker(requestParams *WorkerRequestParams, data string) (WorkerScriptResponse, error) {
  156. if requestParams.ScriptName != "" {
  157. return api.uploadWorkerWithName(requestParams.ScriptName, data)
  158. }
  159. uri := "/zones/" + requestParams.ZoneID + "/workers/script"
  160. headers := make(http.Header)
  161. headers.Set("Content-Type", "application/javascript")
  162. res, err := api.makeRequestWithHeaders("PUT", uri, []byte(data), headers)
  163. var r WorkerScriptResponse
  164. if err != nil {
  165. return r, errors.Wrap(err, errMakeRequestError)
  166. }
  167. err = json.Unmarshal(res, &r)
  168. if err != nil {
  169. return r, errors.Wrap(err, errUnmarshalError)
  170. }
  171. return r, nil
  172. }
  173. // UploadWorkerWithName push raw script content for your worker.
  174. //
  175. // This is an enterprise only feature https://developers.cloudflare.com/workers/api/config-api-for-enterprise/
  176. //
  177. // API reference: https://api.cloudflare.com/#worker-script-upload-worker
  178. func (api *API) uploadWorkerWithName(scriptName string, data string) (WorkerScriptResponse, error) {
  179. if api.AccountID == "" {
  180. return WorkerScriptResponse{}, errors.New("account ID required for enterprise only request")
  181. }
  182. uri := "/accounts/" + api.AccountID + "/workers/scripts/" + scriptName
  183. headers := make(http.Header)
  184. headers.Set("Content-Type", "application/javascript")
  185. res, err := api.makeRequestWithHeaders("PUT", uri, []byte(data), headers)
  186. var r WorkerScriptResponse
  187. if err != nil {
  188. return r, errors.Wrap(err, errMakeRequestError)
  189. }
  190. err = json.Unmarshal(res, &r)
  191. if err != nil {
  192. return r, errors.Wrap(err, errUnmarshalError)
  193. }
  194. return r, nil
  195. }
  196. // CreateWorkerRoute creates worker route for a zone
  197. //
  198. // API reference: https://api.cloudflare.com/#worker-filters-create-filter
  199. func (api *API) CreateWorkerRoute(zoneID string, route WorkerRoute) (WorkerRouteResponse, error) {
  200. // Check whether a script name is defined in order to determine whether
  201. // to use the single-script or multi-script endpoint.
  202. pathComponent := "filters"
  203. if route.Script != "" {
  204. if api.AccountID == "" {
  205. return WorkerRouteResponse{}, errors.New("account ID required for enterprise only request")
  206. }
  207. pathComponent = "routes"
  208. }
  209. uri := "/zones/" + zoneID + "/workers/" + pathComponent
  210. res, err := api.makeRequest("POST", uri, route)
  211. if err != nil {
  212. return WorkerRouteResponse{}, errors.Wrap(err, errMakeRequestError)
  213. }
  214. var r WorkerRouteResponse
  215. err = json.Unmarshal(res, &r)
  216. if err != nil {
  217. return WorkerRouteResponse{}, errors.Wrap(err, errUnmarshalError)
  218. }
  219. return r, nil
  220. }
  221. // DeleteWorkerRoute deletes worker route for a zone
  222. //
  223. // API reference: https://api.cloudflare.com/#worker-filters-delete-filter
  224. func (api *API) DeleteWorkerRoute(zoneID string, routeID string) (WorkerRouteResponse, error) {
  225. // For deleting a route, it doesn't matter whether we use the
  226. // single-script or multi-script endpoint
  227. uri := "/zones/" + zoneID + "/workers/filters/" + routeID
  228. res, err := api.makeRequest("DELETE", uri, nil)
  229. if err != nil {
  230. return WorkerRouteResponse{}, errors.Wrap(err, errMakeRequestError)
  231. }
  232. var r WorkerRouteResponse
  233. err = json.Unmarshal(res, &r)
  234. if err != nil {
  235. return WorkerRouteResponse{}, errors.Wrap(err, errUnmarshalError)
  236. }
  237. return r, nil
  238. }
  239. // ListWorkerRoutes returns list of worker routes
  240. //
  241. // API reference: https://api.cloudflare.com/#worker-filters-list-filters
  242. func (api *API) ListWorkerRoutes(zoneID string) (WorkerRoutesResponse, error) {
  243. pathComponent := "filters"
  244. if api.AccountID != "" {
  245. pathComponent = "routes"
  246. }
  247. uri := "/zones/" + zoneID + "/workers/" + pathComponent
  248. res, err := api.makeRequest("GET", uri, nil)
  249. if err != nil {
  250. return WorkerRoutesResponse{}, errors.Wrap(err, errMakeRequestError)
  251. }
  252. var r WorkerRoutesResponse
  253. err = json.Unmarshal(res, &r)
  254. if err != nil {
  255. return WorkerRoutesResponse{}, errors.Wrap(err, errUnmarshalError)
  256. }
  257. for i := range r.Routes {
  258. route := &r.Routes[i]
  259. // The Enabled flag will not be set in the multi-script API response
  260. // so we manually set it to true if the script name is not empty
  261. // in case any multi-script customers rely on the Enabled field
  262. if route.Script != "" {
  263. route.Enabled = true
  264. }
  265. }
  266. return r, nil
  267. }
  268. // UpdateWorkerRoute updates worker route for a zone.
  269. //
  270. // API reference: https://api.cloudflare.com/#worker-filters-update-filter
  271. func (api *API) UpdateWorkerRoute(zoneID string, routeID string, route WorkerRoute) (WorkerRouteResponse, error) {
  272. // Check whether a script name is defined in order to determine whether
  273. // to use the single-script or multi-script endpoint.
  274. pathComponent := "filters"
  275. if route.Script != "" {
  276. if api.AccountID == "" {
  277. return WorkerRouteResponse{}, errors.New("account ID required for enterprise only request")
  278. }
  279. pathComponent = "routes"
  280. }
  281. uri := "/zones/" + zoneID + "/workers/" + pathComponent + "/" + routeID
  282. res, err := api.makeRequest("PUT", uri, route)
  283. if err != nil {
  284. return WorkerRouteResponse{}, errors.Wrap(err, errMakeRequestError)
  285. }
  286. var r WorkerRouteResponse
  287. err = json.Unmarshal(res, &r)
  288. if err != nil {
  289. return WorkerRouteResponse{}, errors.Wrap(err, errUnmarshalError)
  290. }
  291. return r, nil
  292. }