Skip to content

armgit / fider

Public Imported from GitHub
0

Open platform to collect and prioritize feedback

enhancement: log UI errors (#595)

Guilherme Oenning00b86bfc20bd
diff --git a/app/cmd/routes.go b/app/cmd/routes.go
index 6d12a46e8..7242845df 100644
--- a/app/cmd/routes.go
+++ b/app/cmd/routes.go
@@ -29,6 +29,7 @@ func routes(r *web.Engine) *web.Engine {
r.Get("/-/health", handlers.Health())
r.Get("/robots.txt", handlers.RobotsTXT())
+ r.Post("/_api/log-error", handlers.LogError())
assets := r.Group()
{
diff --git a/app/handlers/common.go b/app/handlers/common.go
index 3bc6ab0fb..13bceb8cf 100644
--- a/app/handlers/common.go
+++ b/app/handlers/common.go
@@ -11,6 +11,7 @@ import (
"github.com/getfider/fider/app/models"
"github.com/getfider/fider/app/pkg/env"
"github.com/getfider/fider/app/pkg/errors"
+ "github.com/getfider/fider/app/pkg/log"
"github.com/getfider/fider/app/pkg/web"
)
@@ -88,6 +89,27 @@ func Page(title, description string) web.HandlerFunc {
}
}
+//NewLogError is the input model for UI errors
+type NewLogError struct {
+ Message string `json:"message"`
+ Data interface{} `json:"data"`
+}
+
+//LogError logs an error coming from the UI
+func LogError() web.HandlerFunc {
+ return func(c web.Context) error {
+ input := new(NewLogError)
+ err := c.Bind(input)
+ if err != nil {
+ return c.Failure(err)
+ }
+ c.Logger().Errorf(input.Message, log.Props{
+ "Data": input.Data,
+ })
+ return c.Ok(web.Map{})
+ }
+}
+
func validateKey(kind models.EmailVerificationKind, c web.Context) (*models.EmailVerification, error) {
key := c.QueryParam("k")
diff --git a/app/pkg/web/context.go b/app/pkg/web/context.go
index 8e0bd7028..d98653a23 100644
--- a/app/pkg/web/context.go
+++ b/app/pkg/web/context.go
@@ -155,6 +155,15 @@ func (ctx *Context) SetTenant(tenant *models.Tenant) {
ctx.Set(tenantContextKey, tenant)
}
+//Bind context values into given model
+func (ctx *Context) Bind(i interface{}) error {
+ err := ctx.engine.binder.Bind(i, ctx)
+ if err != nil {
+ return errors.Wrap(err, "failed to bind request to model")
+ }
+ return nil
+}
+
//BindTo context values into given model
func (ctx *Context) BindTo(i actions.Actionable) *validate.Result {
err := ctx.engine.binder.Bind(i.Initialize(), ctx)
diff --git a/public/index.tsx b/public/index.tsx
index 66e219c85..cb1149f61 100644
--- a/public/index.tsx
+++ b/public/index.tsx
@@ -3,7 +3,7 @@ import * as ReactDOM from "react-dom";
import { resolveRootComponent } from "@fider/router";
import { Header, Footer } from "@fider/components/common";
import { ErrorBoundary } from "@fider/components";
-import { analytics, classSet, Fider } from "@fider/services";
+import { classSet, Fider, actions } from "@fider/services";
import { ToastContainer, toast } from "react-toastify";
import "semantic-ui-css/components/reset.min.css";
@@ -15,12 +15,12 @@ import "@fider/assets/styles/main.scss";
const logProductionError = (err: Error) => {
if (Fider.isProduction()) {
console.error(err); // tslint:disable-line
- analytics.error(err);
+ actions.logError(err.message, err);
}
};
window.addEventListener("error", (evt: ErrorEvent) => {
- analytics.error(evt.error);
+ actions.logError(evt.message, evt.error);
});
document.addEventListener("DOMContentLoaded", () => {
diff --git a/public/services/actions/index.ts b/public/services/actions/index.ts
index 8a9e074c0..7bcfd6c86 100644
--- a/public/services/actions/index.ts
+++ b/public/services/actions/index.ts
@@ -4,4 +4,5 @@ export * from "./post";
export * from "./tenant";
export * from "./notification";
export * from "./invite";
+export * from "./infra";
export { Failure } from "@fider/services/http";
diff --git a/public/services/actions/infra.ts b/public/services/actions/infra.ts
new file mode 100644
index 000000000..b0bae657c
--- /dev/null
+++ b/public/services/actions/infra.ts
@@ -0,0 +1,13 @@
+import { http, Result, navigator, analytics } from "@fider/services";
+
+export const logError = async (message: string, err?: Error): Promise<Result> => {
+ const data = {
+ url: navigator.url(),
+ stack: err ? err.stack : "<not available>"
+ };
+
+ return http.post("/_api/log-error", { message, data }).then(response => {
+ analytics.error(err);
+ return response;
+ });
+};
diff --git a/public/services/analytics.ts b/public/services/analytics.ts
index ac2b82c16..fb94df574 100644
--- a/public/services/analytics.ts
+++ b/public/services/analytics.ts
@@ -7,10 +7,10 @@ export const analytics = {
});
}
},
- error: (err: Error): void => {
+ error: (err?: Error): void => {
if (window.ga) {
window.ga("send", "exception", {
- exDescription: err.stack,
+ exDescription: err ? err.stack : "<not available>",
exFatal: false
});
}
diff --git a/views/base.html b/views/base.html
index a3d72f6a5..39296e06d 100644
--- a/views/base.html
+++ b/views/base.html
@@ -43,9 +43,9 @@
{{template "content" .}}
- <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=default,fetch"></script>
- <script src="{{ .__vendorBundle }}"></script>
- <script src="{{ .__jsBundle }}"></script>
+ <script src="https://cdn.polyfill.io/v2/polyfill.min.js?features=default,fetch" crossorigin="anonymous"></script>
+ <script src="{{ .__vendorBundle }}" crossorigin="anonymous"></script>
+ <script src="{{ .__jsBundle }}" crossorigin="anonymous"></script>
<script type="text/javascript" nonce="{{ .__contextID }}">
{{template "javascript" .}}
</script>