feat: serve swagger doc from server binary/improved error handling

Streamfair · Feb 20, 2024 · 4b0495b · 4b0495b
1 parent 54414da
commit 4b0495b
Show file tree

Hide file tree

Showing 30 changed files with 1,479 additions and 68 deletions.
diff --git a/Makefile b/Makefile
@@ -61,6 +61,9 @@ ENTRY_POINT := main.go
 MOCK_SOURCE := db/sqlc/store.go
 MOCK_DEST := db/mock/store_mock.go
 
+# Documentation
+SWAGGER_DIR := doc/swagger
+SWAGGER_DOC_NAME := streamfair_session_service
 
 ###  TARGETS  ###
 # DB Management
@@ -128,7 +131,9 @@ proto_core: clean_pb
 	protoc --proto_path=$(PROTO_DIR) --go_out=$(PB_DIR) --go_opt=paths=source_relative \
 	--go-grpc_out=$(PB_DIR) --go-grpc_opt=paths=source_relative \
 	--grpc-gateway_out=$(PB_DIR) --grpc-gateway_opt=paths=source_relative \
-	$(PROTO_DIR)/*.proto
+	--openapiv2_out=$(SWAGGER_DIR) --openapiv2_opt=allow_merge=true,merge_file_name=${SWAGGER_DOC_NAME},preserve_rpc_order=true \
+	${PROTO_DIR}/*.proto
+	statik -src=./$(SWAGGER_DIR) -dest=./doc
 
 proto_session: clean_session_dir
 	protoc --proto_path=$(PROTO_DIR) --go_out=$(PB_DIR) --go_opt=paths=source_relative \
@@ -138,6 +143,7 @@ proto_session: clean_session_dir
 
 clean_pb:
 	rm -f $(PB_DIR)/*.go
+	rm -f $(SWAGGER_DIR)/*.swagger.json
 
 clean_session_dir:
 	rm -f $(PB_DIR)/$(SESSION_DIR)/*.go

diff --git a/doc/statik/statik.go b/doc/statik/statik.go
diff --git a/doc/swagger/favicon-16x16.png b/doc/swagger/favicon-16x16.png
diff --git a/doc/swagger/favicon-32x32.png b/doc/swagger/favicon-32x32.png
diff --git a/doc/swagger/index.css b/doc/swagger/index.css
@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}
diff --git a/doc/swagger/index.html b/doc/swagger/index.html
@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="index.css" />
+    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>
diff --git a/doc/swagger/oauth2-redirect.html b/doc/swagger/oauth2-redirect.html
@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1).replace('?', '&');
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>