Fix functional options, add OpenTelemetry example (#221)

* fix(api): propagate options for non-standard API endpoints

* docs(otel): add OpenTelemetry example

Author: pandatix

.github/dependabot.yaml

@@ -14,9 +14,10 @@ updates:
     assignees:
       - "pandatix"
 
-  # Functional tests Go module
+  # Specific examples
   - package-ecosystem: "gomod"
-    directory: "/deploy"
+    directories:
+      - "examples/opentelemetry"
     schedule:
       interval: "weekly"
     assignees:

api/export.go

@@ -34,6 +34,7 @@ func (client *Client) ExportRaw(params *ExportRawParams, opts ...Option) ([]byte
 	// Build request and execute it manunally
 	req, _ := http.NewRequest(http.MethodPost, "/api/v1/exports/raw", bytes.NewBuffer(i))
 	req.Header.Set("Content-Type", "application/json")
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return nil, err

api/login.go

@@ -27,6 +27,7 @@ func (client *Client) Login(params *LoginParams, opts ...Option) error {
 
 	req, _ := http.NewRequest(http.MethodPost, "/login", bytes.NewBufferString(val.Encode()))
 	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return err

api/logout.go

@@ -8,6 +8,7 @@ import (
 
 func (client *Client) Logout(opts ...Option) error {
 	req, _ := http.NewRequest(http.MethodGet, "/logout", nil)
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return err

api/notifications.go

@@ -1,7 +1,6 @@
 package api
 
 import (
-	"context"
 	"fmt"
 	"net/http"
 	"net/url"
@@ -68,16 +67,8 @@ func (client *Client) HeadNotifications(params *HeadNotificationsParams, opts ..
 		req.URL.RawQuery = val.Encode()
 	}
 
-	// Compile options
-	reqopts := &options{
-		Ctx: context.Background(),
-	}
-	for _, opt := range opts {
-		opt.apply(reqopts)
-	}
-	req = req.WithContext(reqopts.Ctx)
-
 	// Issue HTTP request
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return 0, err

api/register.go

@@ -23,6 +23,7 @@ func (client *Client) Register(params *RegisterParams, opts ...Option) error {
 
 	req, _ := http.NewRequest(http.MethodPost, "/register", bytes.NewBufferString(val.Encode()))
 	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return err
@@ -37,6 +38,7 @@ func (client *Client) Register(params *RegisterParams, opts ...Option) error {
 
 	// Update session to track user then fetch nonce for later API calls
 	req, _ = http.NewRequest(http.MethodGet, "/", nil)
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err = client.Do(req)
 	if err != nil {
 		return err

api/reset.go

@@ -38,7 +38,7 @@ func (client *Client) Reset(params *ResetParams, opts ...Option) error {
 	}
 	req, _ := http.NewRequest(http.MethodPost, "/admin/reset", strings.NewReader(str))
 	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
-
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return errors.Wrap(err, "CTFd responded with error")

api/setup.go

@@ -70,6 +70,7 @@ func (client *Client) Setup(params *SetupParams, opts ...Option) error {
 		client.sub.CheckRedirect = oldCR
 	}()
 
+	req, client.sub.Transport = applyOpts(req, opts...)
 	res, err := client.Do(req)
 	if err != nil {
 		return err

api/utils.go

@@ -14,7 +14,9 @@ var nonceRegex = regexp.MustCompile(`([0-9a-f]{64})`)
 // It uses the default HTTP client under the hood.
 func GetNonceAndSession(url string, opts ...Option) (nonce string, session string, err error) {
 	req, _ := http.NewRequest(http.MethodGet, url+"/setup", nil)
-	res, err := http.DefaultClient.Do(req)
+	client := http.DefaultClient
+	req, client.Transport = applyOpts(req, opts...)
+	res, err := client.Do(req)
 	if err != nil {
 		return "", "", err
 	}

examples/opentelemetry/README.md

@@ -0,0 +1,27 @@
+# Example - OpenTelemetry
+
+At scale, understanding what led your CTFd to its current state can help you understand an incident, or how many interactions are happening under the hood in your distributed system.
+
+This is something we want to provide, first for our own usage, but secondly as a proof-of-concept for the community to see how it can be technically achieved.
+
+## Try it out!
+
+- Run an OpenTelemetry Collector to capture signals (here we focus on traces), Jaeger for distributed traces visualization, and our [instrumented and repackaged CTFd](https://github.com/ctfer-io/ctfd-packaged) for OpenTelemetry support.
+    ```bash
+    docker compose up
+    ```
+
+- Run the example, with OpenTelemetry exporters settings.
+    ```bash
+    OTEL_EXPORTER_OTLP_ENDPOINT=dns://localhost:4317 OTEL_EXPORTER_OTLP_INSECURE=true go run main.go
+    ```
+
+- Open Jaeger and visualize traces: [`http://localhost:16686`](http://localhost:16686)
+<div align="center">
+    <img src="jaeger.png" width="1000px">
+</div>
+
+- You can delete the infra :wink:
+    ```bash
+    docker compose down -v
+    ```