Enhance error handling and logging in QRS utility functions by mountaindude · Pull Request #1645 · ptarmiganlabs/butler

mountaindude · 2026-06-20T17:21:35Z

Introduced detailed error formatting in task metadata, task tags, and user sync task execution results functions.
Added checks for expected QRS response statuses and improved logging for unexpected responses.
Created a new module for QRS error handling with functions to format errors and results with context.
Added unit tests for the new error handling functions to ensure proper functionality and coverage.
Documented the new error handling capabilities in the relevant skill markdown files.

…tions - Introduced detailed error formatting in task metadata, task tags, and user sync task execution results functions. - Added checks for expected QRS response statuses and improved logging for unexpected responses. - Created a new module for QRS error handling with functions to format errors and results with context. - Added unit tests for the new error handling functions to ensure proper functionality and coverage. - Documented the new error handling capabilities in the relevant skill markdown files.

Copilot

Pull request overview

This PR standardizes QRS/HTTP error handling across Butler by introducing a shared formatting/validation helper (src/lib/qrs_error.js) and wiring it into multiple QRS utility functions and QSEoW modules, with expanded unit test coverage and updated documentation/skills.

Changes:

Added src/lib/qrs_error.js to format QRS/HTTP errors/results with request context and to validate expected status codes.
Updated multiple QRS utility/QSEoW modules to validate QRS responses before accessing payloads and to log richer context on failures.
Added/updated unit tests for the new helper and for the updated QRS utility functions; refreshed related documentation/skill markdown files.

Reviewed changes

Copilot reviewed 42 out of 59 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
src/qrs_util/usersync_task_execution_results.js	Use shared QRS response validation + contextual error formatting.
src/qrs_util/task_tag_util.js	Validate `task/full` responses and format QRS errors/results consistently.
src/qrs_util/task_metadata.js	Validate `task/full` responses and format QRS errors/results consistently.
src/qrs_util/task_cp_util.js	Validate QRS responses for CP queries; format errors/results with context.
src/qrs_util/sense_start_task.js	Improve non-204 logging with structured QRS response context.
src/qrs_util/reload_task_execution_results.js	Validate reload task lookup response shape/status before use.
src/qrs_util/preload_task_execution_results.js	Validate preload task lookup response shape/status before use.
src/qrs_util/get_tasks.js	Validate QRS responses for tag/CP filters; structured error formatting.
src/qrs_util/get_app_owner.js	Validate step 1/2 QRS responses before extracting owner/attributes.
src/qrs_util/externalprogram_task_execution_results.js	Validate response shape/status; structured error formatting.
src/qrs_util/does_task_exist.js	Validate response shape/status; structured error formatting.
src/qrs_util/distribute_task_execution_results.js	Validate response shape/status; structured error formatting.
src/qrs_util/app_tag_util.js	Validate response shape/status and tags payload before mapping.
src/qrs_util/app_metadata.js	Validate response shape/status before returning metadata.
src/qrs_util/tests/usersync_task_execution_results.test.js	Add coverage for unexpected HTTP status handling; adjust mocks.
src/qrs_util/tests/task_tag_util.test.js	Add coverage for unexpected non-200 QRS response handling.
src/qrs_util/tests/task_metadata.test.js	Add coverage for unexpected non-200 QRS response handling.
src/qrs_util/tests/task_cp_util.test.js	Add coverage for unexpected non-200 responses across helpers.
src/qrs_util/tests/sense_start_task.test.js	Assert structured logging contains expected/actual status metadata.
src/qrs_util/tests/reload_task_execution_results.test.js	New test suite for reload task execution results + error cases.
src/qrs_util/tests/preload_task_execution_results.test.js	Add coverage for unexpected HTTP status handling; adjust mocks.
src/qrs_util/tests/get_tasks.test.js	Add coverage for unexpected non-200 QRS response handling.
src/qrs_util/tests/get_app_owner.test.js	Add coverage for non-200 response handling in both steps.
src/qrs_util/tests/externalprogram_task_execution_results.test.js	Add coverage for non-200 responses; verify contextual logging.
src/qrs_util/tests/does_task_exist.test.js	Add coverage for unexpected non-200 response handling.
src/qrs_util/tests/distribute_task_execution_results.test.js	Add coverage for unexpected HTTP status handling; adjust mocks.
src/qrs_util/tests/app_tag_util.test.js	Add coverage for unexpected non-200 QRS response handling.
src/qrs_util/tests/app_metadata.test.js	Add coverage for unexpected non-200 QRS response handling.
src/lib/qseow/scriptlog.js	Use shared helpers to validate and log unexpected QRS responses during script log retrieval.
src/lib/qseow/qliksense_version.js	Apply shared HTTP formatting/validation for version monitor’s `/v1/systeminfo` call.
src/lib/qseow/qliksense_license.js	Replace ad-hoc formatting with shared QRS helpers and response validation.
src/lib/qseow/tests/scriptlog.test.js	Add coverage for deprecated reference lookup non-200 fallback behavior; adjust mocks.
src/lib/qseow/tests/qliksense_version.test.js	Add coverage for structured logging on unexpected HTTP responses and thrown errors.
src/lib/qrs_error.js	New shared QRS/HTTP formatting + status validation utilities.
src/lib/incident_mgmt/new_relic.js	Extract CP-account lookup into helper with structured QRS validation/logging.
src/lib/incident_mgmt/tests/new_relic.test.js	Add coverage for non-200 CP lookup logging path.
src/lib/assert/assert_config_file.js	Add structured QRS validation/logging when asserting New Relic CP configuration.
src/lib/assert/tests/assert_config_file.test.js	Add test ensuring assert fails on non-200 QRS custom property lookup.
src/lib/tests/qrs_error.test.js	New unit tests for `qrs_error` helper behavior and redaction.
docs/to-doc-site/qrs-api-error-messages.md	Document the new structured error patterns and where they apply.
CLAUDE.md	Update GitNexus index metadata references.
AGENTS.md	Update GitNexus index metadata references.
.claude/skills/generated/udp/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/smtp/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/rest-server/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/qseow/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/qrs-util/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/influxdb/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/incident-mgmt/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/handlers/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/get/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/cluster-32/SKILL.md	Add new generated cluster skill metadata.
.claude/skills/generated/cluster-30/SKILL.md	Refresh generated cluster skill metadata/line mappings.
.claude/skills/generated/cluster-29/SKILL.md	Add new generated cluster skill metadata.
.claude/skills/generated/cluster-28/SKILL.md	Remove outdated generated cluster skill metadata.
.claude/skills/generated/cluster-27/SKILL.md	Refresh generated cluster skill metadata/line mappings.
.claude/skills/generated/cluster-25/SKILL.md	Remove outdated generated cluster skill metadata.
.claude/skills/generated/assert/SKILL.md	Refresh generated skill metadata/line mappings.
.claude/skills/generated/api/SKILL.md	Refresh generated skill metadata/line mappings.

+                    })}`,
+                );
+                return false;
+            } else


+    if (typeof body === 'string' || typeof body === 'number' || typeof body === 'boolean') {
+        parts.push(`body: ${body}`);
+        return;
+    }


Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 42 out of 59 changed files in this pull request and generated 7 comments.

            if (filter.tag) {
-                globals.logger.debug(`GETTASKS 1: task/full?filter=tags.name eq '${filter.tag}'`);
+                endpoint = `task/full?filter=tags.name eq '${filter.tag}'`;
+                globals.logger.debug(`GETTASKS 1: ${endpoint}`);


            if (filter.customProperty) {
-                globals.logger.debug(
-                    `GETTASKS 2: task/full?filter=(customProperties.definition.name eq '${filter.customProperty.name}') and (customProperties.value eq '${filter.customProperty.value}')`,
-                );
+                endpoint = `task/full?filter=(customProperties.definition.name eq '${filter.customProperty.name}') and (customProperties.value eq '${filter.customProperty.value}')`;
+                globals.logger.debug(`GETTASKS 2: ${endpoint}`);


+            if (!hasExpectedQrsStatus(result) || !result.body?.owner) {
+                globals.logger.error(
+                    `APPOWNER: Unexpected app owner response: ${formatQrsResultWithContext(result, appEndpoint, qrsConfig, {
+                        method: 'GET',
+                        expectedStatusCodes: [200],


+        const originalMockResolvedValue = mockQrsClient.Get.mockResolvedValue.bind(mockQrsClient.Get);
+        const originalMockResolvedValueOnce = mockQrsClient.Get.mockResolvedValueOnce.bind(mockQrsClient.Get);
+
+        mockQrsClient.Get.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+        mockQrsClient.Get.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


+        const originalMockResolvedValue = mockQrsGet.mockResolvedValue.bind(mockQrsGet);
+        const originalMockResolvedValueOnce = mockQrsGet.mockResolvedValueOnce.bind(mockQrsGet);
+
+        mockQrsGet.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+        mockQrsGet.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


+        const originalMockResolvedValue = mockQrsGet.mockResolvedValue.bind(mockQrsGet);
+        const originalMockResolvedValueOnce = mockQrsGet.mockResolvedValueOnce.bind(mockQrsGet);
+
+        mockQrsGet.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+        mockQrsGet.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


+    const originalMockResolvedValue = qrsGetMock.mockResolvedValue.bind(qrsGetMock);
+    const originalMockResolvedValueOnce = qrsGetMock.mockResolvedValueOnce.bind(qrsGetMock);
+
+    qrsGetMock.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+    qrsGetMock.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 42 out of 59 changed files in this pull request and generated 7 comments.

            if (filter.tag) {
-                globals.logger.debug(`GETTASKS 1: task/full?filter=tags.name eq '${filter.tag}'`);
+                endpoint = `task/full?filter=tags.name eq '${filter.tag}'`;
+                globals.logger.debug(`GETTASKS 1: ${endpoint}`);


+    let qrsConfig;
+    const endpoint = `task/full?filter=id eq ${taskId} and customProperties.definition.name eq '${cpName}' and customProperties.value eq '${cpValue}'`;


+    let qrsConfig;
+    const endpoint = `task/full?filter=id eq ${taskId} and customProperties.definition.name eq '${cpName}'`;
+


+        const originalMockResolvedValue = mockQrsClient.Get.mockResolvedValue.bind(mockQrsClient.Get);
+        const originalMockResolvedValueOnce = mockQrsClient.Get.mockResolvedValueOnce.bind(mockQrsClient.Get);
+
+        mockQrsClient.Get.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+        mockQrsClient.Get.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


+        const originalMockResolvedValue = mockQrsGet.mockResolvedValue.bind(mockQrsGet);
+        const originalMockResolvedValueOnce = mockQrsGet.mockResolvedValueOnce.bind(mockQrsGet);
+
+        mockQrsGet.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+        mockQrsGet.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


+        const originalMockResolvedValue = mockQrsGet.mockResolvedValue.bind(mockQrsGet);
+        const originalMockResolvedValueOnce = mockQrsGet.mockResolvedValueOnce.bind(mockQrsGet);
+
+        mockQrsGet.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+        mockQrsGet.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


+    const originalMockResolvedValue = qrsGetMock.mockResolvedValue.bind(qrsGetMock);
+    const originalMockResolvedValueOnce = qrsGetMock.mockResolvedValueOnce.bind(qrsGetMock);
+
+    qrsGetMock.mockResolvedValue = (value) => originalMockResolvedValue({ statusCode: 200, ...value });
+    qrsGetMock.mockResolvedValueOnce = (value) => originalMockResolvedValueOnce({ statusCode: 200, ...value });


Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 42 out of 59 changed files in this pull request and generated 8 comments.

Copilot · 2026-06-20T18:19:09Z

            if (filter.tag) {
-                globals.logger.debug(`GETTASKS 1: task/full?filter=tags.name eq '${filter.tag}'`);
+                const tagName = filter.tag.replaceAll("'", "''");
+                endpoint = `task/full?filter=tags.name eq '${tagName}'`;
+                globals.logger.debug(`GETTASKS 1: ${endpoint}`);


Fixed in 90c8d2b.

Copilot · 2026-06-20T18:19:09Z

            if (filter.customProperty) {
-                globals.logger.debug(
-                    `GETTASKS 2: task/full?filter=(customProperties.definition.name eq '${filter.customProperty.name}') and (customProperties.value eq '${filter.customProperty.value}')`,
-                );
+                const customPropertyName = filter.customProperty.name.replaceAll("'", "''");
+                const customPropertyValue = filter.customProperty.value.replaceAll("'", "''");
+                endpoint = `task/full?filter=(customProperties.definition.name eq '${customPropertyName}') and (customProperties.value eq '${customPropertyValue}')`;
+                globals.logger.debug(`GETTASKS 2: ${endpoint}`);


Fixed in 90c8d2b.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 42 out of 59 changed files in this pull request and generated 1 comment.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 42 out of 59 changed files in this pull request and generated 4 comments.

    } catch (err) {
-        globals.logger.error(`GETAPPTAGS: Error while getting tags: ${globals.getErrorMessage(err)}`);
+        globals.logger.error(`GETAPPTAGS: Error while getting tags: ${formatQrsErrorWithContext(err, endpoint, qrsConfig)}`);
        return false;


+function getVersionMonitorRequestContext() {
+    const hostname = globals.config.get('Butler.qlikSenseVersion.versionMonitor.host');
+    const portNumber = 9032;
+
+    return {
+        hostname,
+        portNumber,
+        baseURL: `https://${hostname}:${portNumber}`,
+        timeout: HTTP_TIMEOUT_SHORT_MS,
+    };
+}


@@ -21,9 +41,9 @@ async function checkQlikSenseVersion(config, logger) {
        });


    } catch (err) {
-        if (globals.isSea) {
-            logger.error(`[QSEOW] QLIKSENSE VERSION MONITOR INIT: ${globals.getErrorMessage(err)}`);
-        } else {
-            logger.error(`[QSEOW] QLIKSENSE VERSION MONITOR INIT: ${globals.getErrorMessage(err)}`);
-        }
+        logger.error(
+            `[QSEOW] QLIKSENSE VERSION MONITOR INIT: ${formatHttpErrorWithContext(err, '/v1/systeminfo', getVersionMonitorRequestContext(), {
+                method: 'GET',
+            })}`,
+        );


sonarqubecloud · 2026-06-20T19:05:56Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

mountaindude requested a review from Copilot June 20, 2026 17:21

Copilot started reviewing on behalf of mountaindude June 20, 2026 17:22 View session

Copilot AI reviewed Jun 20, 2026

View reviewed changes

Copilot started work on behalf of mountaindude June 20, 2026 17:26 View session

fix(lib): address review feedback in QRS logging

71929a8

Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

Copilot finished work on behalf of mountaindude June 20, 2026 17:31

mountaindude requested a review from Copilot June 20, 2026 17:32

Copilot started reviewing on behalf of mountaindude June 20, 2026 17:32 View session

Copilot AI reviewed Jun 20, 2026

View reviewed changes

Copilot started work on behalf of mountaindude June 20, 2026 17:39 View session

fix(qrs-util): escape custom property filter quotes

e58e28c

Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

Copilot finished work on behalf of mountaindude June 20, 2026 17:42

mountaindude requested a review from Copilot June 20, 2026 17:42

Copilot started reviewing on behalf of mountaindude June 20, 2026 17:43 View session

Copilot AI reviewed Jun 20, 2026

View reviewed changes

Copilot started work on behalf of mountaindude June 20, 2026 17:48 View session

fix(qrs-util): address review feedback

2f85015

Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

mountaindude requested a review from Copilot June 20, 2026 17:56

Copilot started reviewing on behalf of mountaindude June 20, 2026 17:56 View session

Copilot finished work on behalf of mountaindude June 20, 2026 17:56

Copilot AI reviewed Jun 20, 2026

View reviewed changes

mountaindude and others added 6 commits June 20, 2026 20:08

Potential fix for pull request finding

630440c

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

475cd08

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

24d63de

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

86675f4

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

b99d68a

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

0b7965b

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot started work on behalf of mountaindude June 20, 2026 18:11 View session

fix(qrs-util): preserve filter value coercion

90c8d2b

Co-authored-by: mountaindude <1029262+mountaindude@users.noreply.github.com>

mountaindude requested a review from Copilot June 20, 2026 18:19

Copilot finished work on behalf of mountaindude June 20, 2026 18:19

Copilot started reviewing on behalf of mountaindude June 20, 2026 18:19 View session

Copilot AI reviewed Jun 20, 2026

View reviewed changes

Comment thread docs/to-doc-site/qrs-api-error-messages.md Outdated

Potential fix for pull request finding

1454e64

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mountaindude requested a review from Copilot June 20, 2026 18:25

Copilot started reviewing on behalf of mountaindude June 20, 2026 18:25 View session

Copilot AI reviewed Jun 20, 2026

View reviewed changes

fix: Fix various linting and style issues in the codebase

ade6a79

mountaindude merged commit 0ee07bc into master Jun 20, 2026
6 of 7 checks passed

		let qrsConfig;
		const endpoint = `task/full?filter=id eq ${taskId} and customProperties.definition.name eq '${cpName}' and customProperties.value eq '${cpValue}'`;

		@@ -21,9 +41,9 @@ async function checkQlikSenseVersion(config, logger) {
		});

Uh oh!

Uh oh!

Conversation

mountaindude commented Jun 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jun 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jun 20, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants