Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize LogView exception handling #403

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Standardize LogView exception handling #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions grails-app/controllers/io/xh/hoist/admin/cluster/LogViewerAdminController.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import io.xh.hoist.BaseController
import io.xh.hoist.cluster.ClusterRequest
import io.xh.hoist.configuration.LogbackConfig
import io.xh.hoist.security.Access
import io.xh.hoist.exception.RoutineRuntimeException

import static io.xh.hoist.util.Utils.getAppContext

Expand Down Expand Up @@ -65,15 +66,12 @@ class LogViewerAdminController extends BaseController {
Boolean caseSensitive

def doCall() {
if (!availableFiles[filename]) throwUnavailable()

// Catch any exceptions and render clean failure - the admin client auto-polls for log file
// updates, and we don't want to spam the logs with a repeated stacktrace.
if (!availableFiles[filename]) throwUnavailable(filename)
try {
def content = appContext.logReaderService.readFile(filename, startLine, maxLines, pattern, caseSensitive)
return [success: true, filename: filename, content: content]
} catch (Exception e) {
return [success: false, filename: filename, content: [], exception: e.message]
} catch (FileNotFoundException ignored) {
throwUnavailable(filename)
}
}
}
Expand All @@ -99,7 +97,7 @@ class LogViewerAdminController extends BaseController {
String filename

File doCall() {
if (!availableFiles[filename]) throwUnavailable()
if (!availableFiles[filename]) throwUnavailable(filename)
return appContext.logReaderService.get(filename)
}
}
Expand All @@ -122,7 +120,7 @@ class LogViewerAdminController extends BaseController {

filenames.each { filename ->
def toDelete = available[filename]
if (!toDelete) throwUnavailable()
if (!toDelete) throwUnavailable(filename)

def deleted = toDelete.delete()
if (!deleted) logWarn("Failed to delete log: '$filename'.")
Expand Down Expand Up @@ -167,7 +165,7 @@ class LogViewerAdminController extends BaseController {
}
}

static void throwUnavailable() {
throw new RuntimeException('Filename not valid or available')
static void throwUnavailable(String filename) {
throw new RoutineRuntimeException("Filename not valid or available: $filename")
}
}
Loading