internetarchive / iaux-search-service

GNU Affero General Public License v3.0
4 stars 2 forks source link

WEBDEV-5544 Add `uid` and `client_url` PPS params #21

Closed latonv closed 2 years ago

latonv commented 2 years ago

The PPS now handles a uid parameter that is returned unmodified in the response, which can be used to determine whether responses should be ignored as obsolete (i.e., from a previous search). Our current strategy for this is to compare the current query with the one in each response’s client_parameters, but this is unreliable since in some cases the backend may alter those in a normalization step. The uid, in contrast, is guaranteed to be returned-as-received.

The PPS also has tentative support for a client_url param which should contain the full URL that the search is originating from, to aid in debugging issues that arise on the PPS end.

This PR adds support for both of these params to the search service.

github-actions[bot] commented 2 years ago

PR Preview Action v1.2.0 :---: Preview removed because the pull request was closed. 2022-10-25 16:55 UTC

codecov[bot] commented 2 years ago

Codecov Report

Merging #21 (33825ea) into main (1b34208) will increase coverage by 0.07%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #21      +/-   ##
==========================================
+ Coverage   81.97%   82.05%   +0.07%     
==========================================
  Files          24       24              
  Lines        1981     1989       +8     
  Branches      105      106       +1     
==========================================
+ Hits         1624     1632       +8     
  Misses        345      345              
  Partials       12       12              
Impacted Files Coverage Δ
src/search-param-url-generator.ts 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.