update hyperlinks in docs to open in new tab (#382)

aryanmehrotra · web-flow · commit 8881ba760979 · 2024-03-14T12:57:31.000+05:30
diff --git a/docs/advanced-guide/circuit-breaker/page.md b/docs/advanced-guide/circuit-breaker/page.md
@@ -43,4 +43,4 @@ func main() {
 Circuit breaker state changes to open when number of consecutive failed requests increases the threshold.
 When it is in open state, GoFr makes request to the aliveness endpoint (default being -  /.well-known/alive) at an equal interval of time provided in config.
 
-To override the default aliveness endpoint [refer](/docs/advanced-guide/monitoring-service-health)
+To override the default aliveness endpoint {% new-tab-link title="refer" href="/docs/advanced-guide/monitoring-service-health" /%}.
diff --git a/docs/advanced-guide/grpc/page.md b/docs/advanced-guide/grpc/page.md
@@ -2,7 +2,7 @@
 We have already seen how GoFr can help ease the development of HTTP servers, but there are
 cases where performance is primiraliy required sacrificing flexibility. In these types of 
 scenarios gRPC protocol comes into picture. gRPC is an open-source RPC(Remote Procedure Call)
-framework initially developed by Google. [Learn more](https://grpc.io/docs/what-is-grpc/introduction/)
+framework initially developed by Google. {% new-tab-link title="Learn more" href="https://grpc.io/docs/what-is-grpc/introduction/" /%}
 
 ## Prerequisites
 - Install the `protoc` protocol buffer compilation
@@ -28,7 +28,7 @@ framework initially developed by Google. [Learn more](https://grpc.io/docs/what-
        ```
        
 ## Creating protocol buffers
-For a detailed guide, please take a look at the [Tutorial](https://grpc.io/docs/languages/go/basics/) at official gRPC docs.
+For a detailed guide, please take a look at the {% new-tab-link title="Tutorial" href="https://grpc.io/docs/languages/go/basics/" /%} at official gRPC docs.
 
 Fistly, we need to create a `customer.proto` file to define our service and the rpc methods that the service provides.
 ```protobuf
diff --git a/docs/advanced-guide/handling-data-migrations/page.md b/docs/advanced-guide/handling-data-migrations/page.md
@@ -99,7 +99,7 @@ INFO [16:55:46] Migration 20240226153000 ran successfully
 
 
 GoFr maintains the records in the database itself which helps in tracking which migrations have already been executed and ensures that only migrations that have never been run are executed.
-This way, you only need to ensure that your migrations are properly in place. ([Learn more](https://cloud.google.com/architecture/database-migration-concepts-principles-part-1))
+This way, you only need to ensure that your migrations are properly in place. {% new-tab-link title="Learn more" href="https://cloud.google.com/architecture/database-migration-concepts-principles-part-1" /%}
 
 ## Migration Records
 
diff --git a/docs/advanced-guide/http-authentication/page.md b/docs/advanced-guide/http-authentication/page.md
@@ -10,7 +10,8 @@ GoFr offer various approaches to implement authorization.
 transmitted in the request header in a Base64-encoded format.
 
 Basic auth is the simplest way to authenticate your APIs.  It's built on
-[HTTP protocol authentication scheme](https://datatracker.ietf.org/doc/html/rfc7617). It involves sending the term 
+{% new-tab-link title="HTTP protocol authentication scheme" href="https://datatracker.ietf.org/doc/html/rfc7617" /%}. It involves sending the term
+
 `Basic` trailed by the Base64-encoded `<username>:<password>` within the standard `Authorization` header.
 
 ### Basic Authentication in GoFr
@@ -129,7 +130,7 @@ app.AddHTTPService("http-server-using-redis", "http://localhost:8000", &service.
 ## 3. OAuth 2.0
 OAuth 2.0 is the industry-standard protocol for authorization. 
 It focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices.
-To know more about it refer [here](https://www.rfc-editor.org/rfc/rfc6749)
+To know more about it refer {% new-tab-link title="here" href="https://www.rfc-editor.org/rfc/rfc6749" /%}
 
 It involves sending the term `Bearer` trailed by the encoded token within the standard `Authorization` header.
 
diff --git a/docs/advanced-guide/http-communication/page.md b/docs/advanced-guide/http-communication/page.md
@@ -5,8 +5,8 @@ Support for inter-service http calls provide the following benefits:
 
 1. Access to the method from container - GET, PUT, POST, PATCH, DELETE.
 2. Logs and traces for the request.
-3. [Circuit breaking](/docs/advanced-guide/circuit-breaker) for enhanced resilience and fault tolerance.
-4. [Custom Health Check](/docs/advanced-guide/monitoring-service-health) Endpoints
+3. {% new-tab-link title="Circuit breaking" href="/docs/advanced-guide/circuit-breaker" /%} for enhanced resilience and fault tolerance.
+4. {% new-tab-link title="Custom Health Check" href="/docs/advanced-guide/monitoring-service-health" /%} Endpoints
 
 ## Usage
 
diff --git a/docs/advanced-guide/monitoring-service-health/page.md b/docs/advanced-guide/monitoring-service-health/page.md
@@ -14,7 +14,7 @@ It is an endpoint which return the following response when the service is UP wit
 }
 ```
 
-It is also used when state of [circuit breaker](/docs/advanced-guide/circuit-breaker) is open.
+It is also used when state of {% new-tab-link title="circuit breaker" href="/docs/advanced-guide/circuit-breaker" /%} is open.
 
 To override the endpoint when registering HTTP Service pass the following option.
 
diff --git a/docs/advanced-guide/publishing-custom-metrics/page.md b/docs/advanced-guide/publishing-custom-metrics/page.md
@@ -1,9 +1,9 @@
 # Publishing Custom Metrics
 
-For GoFr default metrics refer: [observability](/docs/quick-start/observability).
+For GoFr default metrics refer: {% new-tab-link title="observability" href="/docs/quick-start/observability" /%}.
 
 GoFr can handle multiple different metrics concurrently, each uniquely identified by its name during initialization.
-It supports the following [metrics](https://opentelemetry.io/docs/specs/otel/metrics/) types in prometheus format:
+It supports the following {% new-tab-link title="metrics" href="https://opentelemetry.io/docs/specs/otel/metrics/" /%} types in prometheus format:
 
 1. Counter
 2. UpDownCounter
@@ -17,7 +17,7 @@ If any metric other than defaults provided, you can create them using custom met
 
 ## 1. Counter Metrics
 
-Counter is a [synchronous Instrument](https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api) which supports non-negative increments.
+Counter is a {% new-tab-link title="synchronous Instrument" href="https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api" /%} which supports non-negative increments.
 
 ### Usage
 
@@ -46,7 +46,7 @@ func main() {
 
 ## 2. UpDown Counter Metrics
 
-UpDownCounter is a [synchronous Instrument](https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api) which supports increments and decrements.
+UpDownCounter is a {% new-tab-link title="synchronous Instrument" href="https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api" /%} which supports increments and decrements.
 Note: if the value is monotonically increasing, use Counter instead.
 
 ### Usage
@@ -76,7 +76,7 @@ func main() {
 
 ## 3. Histogram Metrics
 
-Histogram is a [synchronous Instrument](https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api) which can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentile.
+Histogram is a {% new-tab-link title="synchronous Instrument" href="https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api" /%} which can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentile.
 
 ### Usage
 
@@ -112,7 +112,7 @@ func main() {
 
 ## 4. Gauge Metrics
 
-Gauge is a [synchronous Instrument](https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api) which can be used to record non-additive value(s)  when changes occur.
+Gauge is a {% new-tab-link title="synchronous Instrument" href="https://opentelemetry.io/docs/specs/otel/metrics/api/#synchronous-instrument-api" /%} which can be used to record non-additive value(s)  when changes occur.
 ### Usage
 
 ```go
diff --git a/docs/advanced-guide/using-publisher-subscriber/page.md b/docs/advanced-guide/using-publisher-subscriber/page.md
@@ -68,7 +68,7 @@ docker run --name=gcloud-emulator -d -p 8086:8086 \
        gcr.io/google.com/cloudsdktool/google-cloud-cli:emulators gcloud beta emulators pubsub start --project=test123 \
        --host-port=0.0.0.0:8086
 ```
-> **Note**: To set GOOGLE_APPLICATION_CREDENTIAL - refer [here](https://cloud.google.com/docs/authentication/application-default-credentials)
+> **Note**: To set GOOGLE_APPLICATION_CREDENTIAL - refer {% new-tab-link title="here" href="https://cloud.google.com/docs/authentication/application-default-credentials" /%}
 
 > **Note**: In Google PubSub only one subscription name can access one topic, framework appends the topic name and subscription name to form the
 > unique subscription name on the Google client.
@@ -89,7 +89,7 @@ MQTT_USER=username       // authentication username
 MQTT_PASSWORD=password   // authentication password 
 ```
 > **Note** : If `MQTT_HOST` config is not provided, the application will connect to a public broker
-> [HiveMQ](https://www.hivemq.com/mqtt/public-mqtt-broker/)
+> {% new-tab-link title="HiveMQ" href="https://www.hivemq.com/mqtt/public-mqtt-broker/" /%}
 
 #### Docker setup
 ```shell 
@@ -99,9 +99,7 @@ docker run -d \
   -v <path-to>/mosquitto.conf:/mosquitto/config/mosquitto.conf \
   eclipse-mosquitto:latest
 ```
-> **Note**: find the default mosquitto config file [here](https://github.com/eclipse/mosquitto/blob/master/mosquitto.conf)
-
-
+> **Note**: find the default mosquitto config file {% new-tab-link title="here" href="https://github.com/eclipse/mosquitto/blob/master/mosquitto.conf" /%}
 
 ## Subscribing to Pub/Sub
 Adding a subscriber is similar to adding an HTTP handler, which makes it easier to develop scalable applications,
diff --git a/docs/quick-start/configuration/page.md b/docs/quick-start/configuration/page.md
@@ -1,7 +1,6 @@
 # Configurations
 
-GoFr reads configuration via environment variables. It provides an easy way to manage this. Application code is decoupled from how configuration is managed as per the [12-factor](https://12factor.net/config).
-
+GoFr reads configuration via environment variables. It provides an easy way to manage this. Application code is decoupled from how configuration is managed as per the {% new-tab-link title="12-factor" href="https://12factor.net/config" /%}.
 Configs in GoFr can be used to initialise datasources, tracing. In doing so it abstract the logic and gives an easy interface to setup different things.
 
 To set configs create a `configs` directory in the project's root and add `.env` file.
diff --git a/docs/quick-start/connecting-mysql/page.md b/docs/quick-start/connecting-mysql/page.md
@@ -35,6 +35,7 @@ DB_USER=root
 DB_PASSWORD=root123
 DB_NAME=test_db
 DB_PORT=3306
+DB_DIALECT=mysql
 ```
 
 Now in the following example let's store customer data using **POST** `/customer` and then use **GET** `/customer` to retrieve the same.
@@ -104,9 +105,7 @@ func main() {
 		// return the customer
 		return customers, nil
 	})
-
-	// Starts the server, it will listen on the default port 8000.
-	// it can be over-ridden through configs
+	
 	app.Run()
 }
 ```
@@ -126,7 +125,7 @@ You will see the following output if database is successfully updated
 {}
 ```
 
-Now when we access the [http://localhost:9000/customer](http://localhost:9000/customer) we should see the following output
+Now when we access {% new-tab-link title="http://localhost:9000/customer" href="http://localhost:9000/customer" /%} we should see the following output
 
 ```json
 {
diff --git a/docs/quick-start/connecting-redis/page.md b/docs/quick-start/connecting-redis/page.md
@@ -49,7 +49,7 @@ func main() {
 	app.GET("/redis", func(ctx *gofr.Context) (interface{}, error) {
 		// Get the value using the Redis instance
 
-		val, err := ctx.Redis.Get(ctx.Context, "test").Result()
+		val, err := ctx.Redis.Get(ctx.Context, "greeting").Result()
 		if err != nil && !errors.Is(err, redis.Nil) {
 			// If the key is not found, we are not considering this an error and returning ""
 			return nil, err
diff --git a/docs/quick-start/introduction/page.md b/docs/quick-start/introduction/page.md
@@ -1,5 +1,4 @@
 # Prerequisite
-
 -  Go 1.20 or above.
    To check the version use the following command `go version`.
 
@@ -13,9 +12,9 @@ Let's start by initializing the go module by using the following command.
 go mod init github.com/example
 ```
 
-To know more about go modules refer [here](https://go.dev/ref/mod)
+To know more about go modules refer {% new-tab-link title="here" href="https://go.dev/ref/mod" /%}.
 
-Add [gofr](https://github.com/gofr-dev/gofr) package to the project using the following command
+Add {% new-tab-link title="gofr" href="https://github.com/gofr-dev/gofr" /%} package to the project using the following command
 
 ```bash
 go get gofr.dev
@@ -52,7 +51,7 @@ To run the server, use the command
 
 `go run main.go`
 
-This would start the server at 8000 port, you can access [http://localhost:8000/greet](http://localhost:8000/greet) from your browser, you would be able to see the output as following with _Status Code 200_ as per REST Standard
+This would start the server at 8000 port, you can access {% new-tab-link title="http://localhost:8000/greet" href="http://localhost:8000/greet" /%} from your browser, you would be able to see the output as following with _Status Code 200_ as per REST Standard
 
 ```json
 { "data": "Hello World!" }
@@ -71,7 +70,7 @@ The `hello-world` server involves three essential steps:
 
 2. **Attaching a Handler to a Path:**
 
-   In this step, we instruct the server to associate an HTTP request with a specific handler function. This is achieved through `app.GET("/greet", HandlerFunction)`, where _GET /hello_ maps to HandlerFunction. Likewise, `app.POST("/todo", ToDoCreationHandler)` links a _POST_ request to the /todo endpoint with _ToDoCreationHandler_.
+   In this step, we instruct the server to associate an HTTP request with a specific handler function. This is achieved through `app.GET("/greet", HandlerFunction)`, where _GET /greet_ maps to HandlerFunction. Likewise, `app.POST("/todo", ToDoCreationHandler)` links a _POST_ request to the /todo endpoint with _ToDoCreationHandler_.
 
 
    **Good To Know**
@@ -82,7 +81,7 @@ The `hello-world` server involves three essential steps:
 
    In GoFr `ctx *gofr.Context` serves as a wrapper for requests, responses, and dependencies, providing various functionalities.
 
-   For more details about context, refer [here](/docs/references/context).
+   For more details about context, refer {% new-tab-link title="here" href="/docs/references/context" /%}.
 
 3. **Starting the server**
 
diff --git a/docs/quick-start/observability/page.md b/docs/quick-start/observability/page.md
@@ -16,7 +16,8 @@ Now that you have created your server, lets see how GoFr by default manages obse
 
 {% figure src="/quick-start-logs.png" alt="Pretty Printed Logs" /%}
 
-  Logs are well-structured, they are of type JSON when exported to a file, such that they can be pushed to logging systems such as [Loki](https://grafana.com/oss/loki/), elastic search etc.
+  Logs are well-structured, they are of type JSON when exported to a file, such that they can be pushed to logging systems such as {% new-tab-link title="Loki" href="https://grafana.com/oss/loki/" /%}, elastic search etc.
+  
 
 ## Metrics
 Metrics enable performance monitoring by providing insights into response times, latency, throughput, and resource utilization.
@@ -97,10 +98,10 @@ GoFr by default publishes metrics automatically to port: _2121_ on _/metrics_ en
 
 {% /table %}
 
-For example: When running application locally, you can access /metrics endpoint on port 2121 from: [http://localhost:2121/metrics](http://localhost:2121/metrics)
-
-  GoFr also provides supports to create requirement specific metrics using [custom metrics](/docs/advanced-guide/publishing-custom-metrics).
+For example: When running application locally, you can access /metrics endpoint on port 2121 from: {% new-tab-link title="http://localhost:2121/metrics" href="http://localhost:2121/metrics" /%}
 
+  GoFr also provides supports to create requirement specific metrics using {% new-tab-link title="custom metrics" href="/docs/advanced-guide/publishing-custom-metrics" /%}.
+  
 ## Tracing
 Tracing is a powerful tool for gaining insights into your application's behaviour, identifying bottlenecks, and improving
 system performance. A trace is a tree of spans. It is a collective of observable signals showing the path of work
@@ -111,18 +112,18 @@ issues and identifying bottlenecks. Traditional logging approaches often fall sh
 the intricate interactions between components.
 
 
-To know more about Tracing click [here](https://opentelemetry.io/docs/concepts/signals/#traces).
+To know more about Tracing click {% new-tab-link title="here" href="https://opentelemetry.io/docs/concepts/signals/#traces" /%}.
 
 
 ### Automated Tracing in GoFr
 GoFr makes it easy to use tracing by automatically adding traces to all requests and responses. GoFr uses
-[OpenTelemetry](https://opentelemetry.io/docs/concepts/what-is-opentelemetry/), a popular tracing framework, to
+{% new-tab-link title="OpenTelemetry" href="https://opentelemetry.io/docs/concepts/what-is-opentelemetry/" /%} , a popular tracing framework, to
 automatically add traces to all requests and responses.
 
 **Automatic Correlation ID Propagation:**
 
 When a request enters your GoFr application, GoFr automatically generates a correlation ID X-Correlation-ID and adds it 
-to the request headers. This correlation ID is then propagated to all downstream requests. This means that you can track
+to the response headers. This correlation ID is then propagated to all downstream requests. This means that you can track
 a request as it travels through your distributed system by simply looking at the correlation ID in the request headers.
 
 
@@ -157,6 +158,5 @@ Add Tracer configs in `.env` file, your .env will be updated to
 > **NOTE:** If the value of `TRACER_PORT` is not 
 provided, gofr uses port `9411` by default.
 
-Open [zipkin](http://localhost:2005/zipkin/) and search by TraceID (correlationID) to see the trace.
-
+Open {% new-tab-link title="zipkin" href="http://localhost:2005/zipkin/" /%} and search by TraceID (correlationID) to see the trace.
 {% figure src="/quick-start-trace.png" alt="Pretty Printed Logs" /%}
diff --git a/pkg/gofr/http/middleware/oauth.go b/pkg/gofr/http/middleware/oauth.go
@@ -154,8 +154,6 @@ func publicKeyFromJWKS(jwks JWKS) map[string]*rsa.PublicKey {
 		keys[jwk.ID], _ = rsaPublicKeyStringFromJWK(&val)
 	}
 
-	// Store the result of rsaPublicKeyStringFromJWK before the next iteration
-
 	return keys
 }
 
diff --git a/pkg/gofr/http/middleware/oauth_test.go b/pkg/gofr/http/middleware/oauth_test.go
@@ -187,3 +187,11 @@ func TestOAuthJWKSKeyNotFound(t *testing.T) {
 
 	resp.Body.Close()
 }
+
+func TestPublicKeyFromJWKS_EmptyJWKS_ReturnsNil(t *testing.T) {
+	jwks := JWKS{}
+
+	result := publicKeyFromJWKS(jwks)
+
+	assert.Nil(t, result)
+}

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ It is an endpoint which return the following response when the service is UP wit`
`14`	`14`	`}`
`15`	`15`	```
`16`	`16`
`17`		`-It is also used when state of [circuit breaker](/docs/advanced-guide/circuit-breaker) is open.`
	`17`	`+It is also used when state of {% new-tab-link title="circuit breaker" href="/docs/advanced-guide/circuit-breaker" /%} is open.`
`18`	`18`
`19`	`19`	`To override the endpoint when registering HTTP Service pass the following option.`
`20`	`20`