[jslib] Refactored Acknowledgements with Enhanced HTTP Utilities #9999

HenriRabalais · 2025-09-08T18:39:10Z

This PR refactors the acknowledgements page to use a new, more robust and reusable API client and a suite of custom error classes. This change modernizes our data fetching approach by moving away from raw fetch requests and adopting a structured, type-safe methodology.

Key Changes

Introduced a new Core Library: Added a new directory at jslib/core containing:

Client.ts: A generic, extensible class for handling API requests (GET, POST, PUT). It includes robust error handling for network issues, HTTP response statuses (e.g., 404), and JSON parsing errors.
Query.ts: A class for building type-safe URL query strings, supporting various operators and parameters.
Added Custom Error Classes: A comprehensive set of custom error classes are now available at jslib/core/errors to provide more context for debugging API failures. This includes ApiNetworkError, ApiResponseError, JsonParseError, and more.

Introduced a Entities Library: Added a new directory at jslib/entities containing:

Acknowledgment entity and affiliated type and client
This will eventually house all LORIS entities, and contexts they provide, specific errors, hooks, components, etc.

Updated Acknowledgements Module

The acknowledgementsIndex.js file has been refactored to use the new AcknowledgementClient instead of a raw fetch call. This significantly cleans up the component's logic and separates concerns.
The AcknowledgementClient is a specialized client that extends the new generic Client.ts, providing an interface for interacting with the acknowledgements API.

Misc

Module and Path Configuration: Updated package.json, tsconfig.json, and webpack.config.ts to support the new libraries, including:
New dependencies: stream-browserify, pbkdf2, and transliteration.

HenriRabalais · 2025-09-08T18:39:54Z

htdocs/index.php

    $factory->config(),
    [
-        __DIR__ . "/../project/",
+        __DIR__ . "/../project/modules",


needed to get things to load...

This was already done in #9916. Can you rebase so that the PR is up-to-date?

HenriRabalais · 2025-09-08T18:41:04Z

webpack.config.ts

  fallback: {
    fs: false,
    path: false,
+    stream: require.resolve("stream-browserify"),


npm compile was giving errors without this

HenriRabalais · 2025-09-08T18:41:15Z

package.json

        "jstat": "^1.9.5",
        "jszip": "^3.10.1",
        "papaparse": "^5.3.0",
+        "pbkdf2": "^3.1.3",


npm compile was giving errors without these

I don't love the idea of adding additional dependencies to LORIS, could you try to work around these? Might be helpful to look at the dataquery module. Dave was able to set-up streams without importing stream-browserify, and the other ones. I can't see why pbkdf2 and transliteration would be needed either.

yeah, I don't like the idea either and don't see why they would be needed, but npm was upset without them for some reason! I was hoping someone reviewing or maybe @driusan might have the answer.

I can play around with it some more, and maybe a rebase will help. I'll take a look at the dataquery module too.

HenriRabalais · 2025-09-09T11:34:11Z

jslib/core/http/Client.ts

+export class Client<T> {
+  protected baseUrl: string;
+  protected subEndpoint?: string;
+  public getCustomMessage: (


this is to allow each Client concrete class to define it's own errors across all the error types, not sure if it's the best implementation, but it seems to work — maybe it just needs a better name. return type be something like Record<string, string>

modules/acknowledgements/jsx/acknowledgementsIndex.js

HenriRabalais · 2025-09-11T21:45:36Z

@driusan @ridz1208 would love your thoughts on this! Hoping to extend this to more parts of loris after and add more entities. I'm also curious what you think of the directory structure I've started to build out, as it will likely get expanded. Should everything live in jslib? I'm thinking the top level components that currently live in jsx/ should also get moved into what ever the top level javascript directory is and live under a /components directory of sorts.

HenriRabalais · 2025-09-16T16:11:44Z

jslib/core/errors/BaseError.ts

+ * Base class for all custom API-related errors.
+ */
+export class BaseError extends Error {
+  public name: string;


need to delete this since name is already a property of Error

HenriRabalais · 2025-10-08T13:56:47Z

@kongtiaowang could you help me with these errors?

 ✘ Filters
   │
   │ Facebook\WebDriver\Exception\NoSuchElementException: Unable to locate element: input[name="fullName"]
   │
   │ /app/vendor/php-webdriver/webdriver/lib/Exception/WebDriverException.php:120
   │ /app/vendor/php-webdriver/webdriver/lib/Remote/HttpCommandExecutor.php:359
   │ /app/vendor/php-webdriver/webdriver/lib/Remote/RemoteWebDriver.php:601
   │ /app/vendor/php-webdriver/webdriver/lib/Remote/RemoteWebDriver.php:217
   │ /app/vendor/php-webdriver/webdriver/lib/WebDriverExpectedCondition.php:177
   │ /app/vendor/php-webdriver/webdriver/lib/WebDriverWait.php:54
   │ /app/test/integrationtests/LorisIntegrationTest.class.inc:544
   │ /app/test/integrationtests/LorisIntegrationTest.class.inc:707
   │ /app/modules/acknowledgements/test/AcknowledgementsIntegrationTest.php:170
   │
 ✔ Cant add new record
 ✘ Config setting policy
   │
   │ Facebook\WebDriver\Exception\NoSuchElementException: Unable to locate element: #citationPolicy
   │
   │ /app/vendor/php-webdriver/webdriver/lib/Exception/WebDriverException.php:120
   │ /app/vendor/php-webdriver/webdriver/lib/Remote/HttpCommandExecutor.php:359
   │ /app/vendor/php-webdriver/webdriver/lib/Remote/RemoteWebDriver.php:601
   │ /app/vendor/php-webdriver/webdriver/lib/Remote/RemoteWebDriver.php:217
   │ /app/vendor/php-webdriver/webdriver/lib/WebDriverExpectedCondition.php:177
   │ /app/vendor/php-webdriver/webdriver/lib/WebDriverWait.php:54
   │ /app/test/integrationtests/LorisIntegrationTest.class.inc:544
   │ /app/modules/acknowledgements/test/AcknowledgementsIntegrationTest.php:234
   │

kongtiaowang · 2025-10-14T11:15:57Z

@HenriRabalais I will handle it.

kongtiaowang · 2025-10-18T11:24:57Z

I made some changes in 3b59957

HenriRabalais · 2025-10-20T15:33:25Z

Thanks @kongtiaowang !

@driusan do you have time to take a look at this? Otherwise, can I assign it to someone else?

ridz1208 · 2025-10-21T16:33:46Z

@skarya22 @marandmart I assigned the both of you here because its a JSX heavy PR but also brongs some nice additions to what we already have. This is not exactly a critical priority but definitely a nice have so if you ca take a bit of time here and there to review it it would be perfect. We always talk baout improving our react side and this is doing just that.

jslib/entities/acknowledgement/clients/AcknowledgementClient.ts

jslib/core/http/Client.ts

jslib/core/http/Query.ts

jslib/core/http/Client.ts

HenriRabalais · 2025-10-29T19:41:36Z

@marandmart

Thank you so much for the comprehensive review! All amazing points and feedback. I've addressed and corrected every point you made.

Could you look it over one more time?

Thanks!

HenriRabalais · 2025-10-30T12:25:30Z

@kongtiaowang I have some failing tests — I'm worried I might have overwritten the changes you had pushed to this branch, even though your commits are still there.

modules/acknowledgements/jsx/acknowledgementsIndex.js

skarya22 · 2025-10-30T14:23:44Z

htdocs/index.php

    $factory->config(),
    [
-        __DIR__ . "/../project/",
+        __DIR__ . "/../project/modules",


This was already done in #9916. Can you rebase so that the PR is up-to-date?

jslib/core/http/Query.ts

skarya22 · 2025-10-30T14:35:04Z

package.json

        "jstat": "^1.9.5",
        "jszip": "^3.10.1",
        "papaparse": "^5.3.0",
+        "pbkdf2": "^3.1.3",


I don't love the idea of adding additional dependencies to LORIS, could you try to work around these? Might be helpful to look at the dataquery module. Dave was able to set-up streams without importing stream-browserify, and the other ones. I can't see why pbkdf2 and transliteration would be needed either.

skarya22 · 2025-10-30T14:37:25Z

There were some commits after passed manual tests was added, so I have removed the label

HenriRabalais · 2025-10-30T17:09:51Z

@skarya22 and @marandmart thank you for the reviews!

I've addressed all your comments, let me know if you see anything else that needs to be looked at!

github-actions bot added Language: PHP PR or issue that update PHP code Language: Javascript PR or issue that update Javascript code Module: acknowledgements PR or issue related to acknowledgements module labels Sep 8, 2025

HenriRabalais commented Sep 8, 2025

View reviewed changes

driusan assigned driusan and kongtiaowang Sep 8, 2025

HenriRabalais changed the title ~~[jslib] Refactored Acknowledgements Client with Enhanced API Utilities~~ [jslib] Refactored Acknowledgements with Enhanced HTTP Utilities Sep 9, 2025

HenriRabalais commented Sep 9, 2025

View reviewed changes

modules/acknowledgements/jsx/acknowledgementsIndex.js Show resolved Hide resolved

HenriRabalais commented Sep 16, 2025

View reviewed changes

kongtiaowang added the Passed manual tests PR has been successfully tested by at least one peer label Oct 18, 2025

ridz1208 assigned marandmart and skarya22 Oct 21, 2025

marandmart reviewed Oct 22, 2025

View reviewed changes

skarya22 requested changes Oct 30, 2025

View reviewed changes

skarya22 added State: Needs work PR awaiting additional work by the author to proceed and removed Passed manual tests PR has been successfully tested by at least one peer labels Oct 30, 2025

ridz1208 added 2 commits October 30, 2025 12:38

added base level files before testing

6ec9f13

added package lock

0915473

ridz1208 and others added 9 commits October 30, 2025 12:38

fixing fan

70f26fa

fix

e3a7a1f

fix 2

57cec43

fix 3

98e382b

fix-add data:acknowledgements

927d0f4

cs fix

266fa49

addressed Mario's review'

dc13572

fixing static tests

92ab272

addressing review

2171b89

HenriRabalais force-pushed the 2025-09-08_addhttpclient branch from 6372e1d to 2171b89 Compare October 30, 2025 16:39

ridz1208 added 2 commits October 30, 2025 13:07

addressing review

a1443e9

reverting to aces/main package.lock.json

f99f7e2

[jslib] Refactored Acknowledgements with Enhanced HTTP Utilities #9999

Are you sure you want to change the base?

[jslib] Refactored Acknowledgements with Enhanced HTTP Utilities #9999

Uh oh!

Conversation

HenriRabalais commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Changes

Updated Acknowledgements Module

Misc

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HenriRabalais Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HenriRabalais Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

HenriRabalais commented Sep 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HenriRabalais commented Oct 8, 2025

Uh oh!

kongtiaowang commented Oct 14, 2025

Uh oh!

kongtiaowang commented Oct 18, 2025

Uh oh!

HenriRabalais commented Oct 20, 2025

Uh oh!

ridz1208 commented Oct 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HenriRabalais commented Oct 29, 2025

Uh oh!

HenriRabalais commented Oct 30, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skarya22 commented Oct 30, 2025

Uh oh!

HenriRabalais commented Oct 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

HenriRabalais commented Sep 8, 2025 •

edited

Loading

HenriRabalais Oct 30, 2025 •

edited

Loading

HenriRabalais Sep 9, 2025 •

edited

Loading