[DAPS-1522] Authz Router Logging Improvements

[megatnt1122]

Ticket

#1522  

Description

Logging improvements to authz_router

Tasks

• - A description of the PR has been provided, and a diagram included if it is a new feature.
• - Formatter has been run
• - CHANGELOG comment has been added
• - Labels have been assigned to the pr
• - A reviwer has been added
• - A user has been assigned to work on the pr
• - If new feature a unit test has been added

Summary by Sourcery

Improve observability of the authorization router by integrating structured request logging across its endpoints and enhance test coverage for permission-related routes

Enhancements:

• Integrate structured request logging into authz_router for gridftp, perm/check, and perm/get routes, capturing start, success, and failure events
• Refactor client and result variable declarations and introduce a basePath constant to support consistent log metadata

Tests:

• Add unit tests for perm/check and perm/get endpoints, covering successful authorization checks and error cases

[sourcery-ai]

Reviewer's Guide

This PR integrates structured logging into the authz_router by importing a centralized logger, defining a basePath, hoisting client initialization, and instrumenting each endpoint with standardized logRequestStarted, logRequestSuccess, and logRequestFailure calls; it also enhances unit tests to cover the new perm/check and perm/get behaviors, including success and error cases.

Sequence diagram for logging in /gridftp endpoint

sequenceDiagram
participant Client
participant Router
participant Logger
participant g_lib
Client->>Router: GET /gridftp
Router->>g_lib: getUserFromClientID(client)
Router->>Logger: logRequestStarted(...)
alt Success
    Router->>g_lib: getUserFromClientID_noexcept(client)
    Router->>Logger: logRequestSuccess(...)
else Failure
    Router->>Logger: logRequestFailure(...)
end

Loading

Sequence diagram for logging in /perm/check endpoint

sequenceDiagram
participant Client
participant Router
participant Logger
participant g_lib
Client->>Router: GET /perm/check
Router->>g_lib: getUserFromClientID(client)
Router->>Logger: logRequestStarted(...)
alt Success
    Router->>g_lib: resolveID(id, client)
    Router->>Logger: logRequestSuccess(...)
else Failure
    Router->>Logger: logRequestFailure(...)
end

Loading

Sequence diagram for logging in /perm/get endpoint

sequenceDiagram
participant Client
participant Router
participant Logger
participant g_lib
Client->>Router: GET /perm/get
Router->>g_lib: getUserFromClientID(client)
Router->>Logger: logRequestStarted(...)
alt Success
    Router->>g_lib: resolveID(id, client)
    Router->>Logger: logRequestSuccess(...)
else Failure
    Router->>Logger: logRequestFailure(...)
end

Loading

Class diagram for new logger usage in authz_router

classDiagram
class Logger {
  +logRequestStarted(params)
  +logRequestSuccess(params)
  +logRequestFailure(params)
}
class Router {
  +get(path, handler)
}
Router --> Logger: uses

Loading

File-Level Changes

Change	Details	Files
Added structured logging to authz_router routes	Imported the logger module and defined a basePath variable Moved client declaration outside try blocks to enable reuse Instrumented each endpoint with logRequestStarted, logRequestSuccess, and logRequestFailure calls capturing client, correlationId, HTTP verb, route path, status, description, extra metadata, and errors	core/database/foxx/api/authz_router.js
Extended unit tests for perm endpoints	Added tests for /perm/check confirming granted=true for valid scenarios Added tests for /perm/get covering successful permission retrieval and output type Added a failure test for /perm/get with an invalid id parameter	core/database/foxx/tests/authz_router.test.js

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `core/database/foxx/api/authz_router.js:119-131` </location>
<code_context>
+                },
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/gridftp",
+                status: "Failure",
+                description: "Checks authorization",
+                extra: {
+                    id: client?._id,
+                    is_admin: client?.is_admin,
+                },
+                error: e,
+            });
+
</code_context>

<issue_to_address>
**🚨 suggestion (security):** Failure logging may expose sensitive error details.

Sanitize or restrict the error information before logging to prevent exposure of sensitive data, especially if logs are accessible externally.

```suggestion
            logger.logRequestFailure({
                client: client?._id,
                correlationId: req.headers["x-correlation-id"],
                httpVerb: "GET",
                routePath: basePath + "/gridftp",
                status: "Failure",
                description: "Checks authorization",
                extra: {
                    id: client?._id,
                    is_admin: client?.is_admin,
                },
                error: {
                    message: typeof e === "object" && e !== null ? e.message : String(e),
                    name: typeof e === "object" && e !== null ? e.name : undefined,
                },
            });
```
</issue_to_address>

### Comment 2
<location> `core/database/foxx/api/authz_router.js:167` </location>
<code_context>

</code_context>

<issue_to_address>
**issue (code-quality):** Use `const` or `let` instead of `var`. ([`avoid-using-var`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/JavaScript/Default-Rules/avoid-using-var))

<details><summary>Explanation</summary>`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code).
`let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than
function-scoped.

From the [Airbnb JavaScript Style Guide](https://airbnb.io/javascript/#references--prefer-const)
</details>
</issue_to_address>

### Comment 3
<location> `core/database/foxx/api/authz_router.js:267` </location>
<code_context>
            result = req.queryParams.perms ? req.queryParams.perms : permissions.PERM_ALL;

</code_context>

<issue_to_address>
**suggestion (code-quality):** Avoid unneeded ternary statements ([`simplify-ternary`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/JavaScript/Default-Rules/simplify-ternary))

```suggestion
            result = req.queryParams.perms || permissions.PERM_ALL;
```

<br/><details><summary>Explanation</summary>It is possible to simplify certain ternary statements into either use of an `||` or `!`.
This makes the code easier to read, since there is no conditional logic.
</details>
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

🚨 suggestion (security): Failure logging may expose sensitive error details.

Sanitize or restrict the error information before logging to prevent exposure of sensitive data, especially if logs are accessible externally.

Suggested change

	logger.logRequestFailure({
	client: client?._id,
	correlationId: req.headers["x-correlation-id"],
	httpVerb: "GET",
	routePath: basePath + "/gridftp",
	status: "Failure",
	description: "Checks authorization",
	extra: {
	id: client?._id,
	is_admin: client?.is_admin,
	},
	error: e,
	});
	logger.logRequestFailure({
	client: client?._id,
	correlationId: req.headers["x-correlation-id"],
	httpVerb: "GET",
	routePath: basePath + "/gridftp",
	status: "Failure",
	description: "Checks authorization",
	extra: {
	id: client?._id,
	is_admin: client?.is_admin,
	},
	error: {
	message: typeof e === "object" && e !== null ? e.message : String(e),
	name: typeof e === "object" && e !== null ? e.name : undefined,
	},
	});

[JoshuaSBrown]

We need to talk about this file together, any existing console log statements either need to be removed, formatted using the same approach you have been using or combined.