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.

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

Openshift updates ; Dependency & Maintenance update #31

Merged
merged 36 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
081371f
Openshift no instantclient (#28)
ammsalme Oct 23, 2024
6b96972
Test resumption token with from, (#30)
ammsalme Oct 24, 2024
ac49b5c
Use z13 instead of z106 (#32)
ammsalme Oct 24, 2024
1d61611
Fix queries
ammsalme Oct 24, 2024
ac196c8
Fix queries2
ammsalme Oct 24, 2024
6872fdf
Add logLabels to logs and debug to identify requests
ammsalme Oct 24, 2024
2aca175
Validate for controlCharacters in record before trying to clean them
ammsalme Oct 24, 2024
fc3d110
Do not JSON.stringify circular params.connection.
ammsalme Oct 24, 2024
4658e40
Fix queries
ammsalme Oct 24, 2024
dc35970
Do not JSON.stringify circular resultSet
ammsalme Oct 24, 2024
b812f9a
Add logging/debug to generateResponse
ammsalme Oct 25, 2024
ab371d0
Update logging/debug
ammsalme Oct 25, 2024
e492e23
Update building queries
ammsalme Oct 25, 2024
48de838
First tests for query.js
ammsalme Oct 25, 2024
4c1268d
Add tests, fix version/tags
ammsalme Oct 29, 2024
bbe29f5
2.0.0-alpha.4
ammsalme Oct 29, 2024
431bb26
Fix tests
ammsalme Oct 29, 2024
ca79bc3
2.0.0-alpha.5
ammsalme Oct 29, 2024
462aecd
Update deps
ammsalme Nov 5, 2024
7d88238
2.0.0-alpha.6
ammsalme Nov 5, 2024
db65007
Use @natlibfi/oracledb-aleph
ammsalme Nov 5, 2024
6bc2b10
2.0.0-alpha.7
ammsalme Nov 5, 2024
e8d8c02
Use normal oracleDb (test build)
ammsalme Nov 5, 2024
53c417e
use normal oracledb (test2)
ammsalme Nov 5, 2024
df11e8c
use @natlibfi/oracledb-aleph
ammsalme Nov 5, 2024
6288699
Update dockerfile
ammsalme Nov 5, 2024
11c36fa
Add python to dockerfile
ammsalme Nov 5, 2024
33316b1
Add log
ammsalme Nov 5, 2024
ed01e1b
Add logging
ammsalme Nov 5, 2024
0bb931b
Handle ORA-01103
ammsalme Nov 5, 2024
1c3a7ab
Add examples: env and sets.json
ammsalme Nov 12, 2024
9a3898d
Remove old files
ammsalme Nov 12, 2024
ff1a358
Update license to MIT
ammsalme Nov 12, 2024
bf69a76
Fix empty lines
ammsalme Nov 12, 2024
8feaa54
Update deps
ammsalme Nov 12, 2024
957c557
Update dependabot
ammsalme Nov 12, 2024
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
13 changes: 9 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ updates:
interval: "daily"
time: "06:30"
timezone: "Europe/Helsinki"
target-branch: "dependencies"
target-branch: "next"
ammsalme marked this conversation as resolved.
Show resolved Hide resolved

# Minor updates to npm production dependencies daily
- package-ecosystem: "npm"
Expand All @@ -20,9 +20,14 @@ updates:
time: "06:45"
timezone: "Europe/Helsinki"
versioning-strategy: lockfile-only
allow:
- dependency-type: "production"
target-branch: "dependencies"
target-branch: "next"
pull-request-branch-name:
separator: "-"
groups:
production-dependencies:
dependency-type: "production"
development-dependencies:
dependency-type: "development"

# Major updates to npm dependencies weekly @tuesday
# Not possible yet https://github.com/dependabot/dependabot-core/issues/1778
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ WORKDIR /home/node

COPY --chown=node:node . build

RUN apk add -U --no-cache --virtual .build-deps git build-base sudo \
RUN apk add -U --no-cache --virtual .build-deps git build-base sudo python3 \
&& sudo -u node sh -c 'cd build && npm install && npm run build' \
&& sudo -u node cp -r build/package.json build/dist/* . \
&& sudo -u node npm install --prod \
Expand Down
25 changes: 0 additions & 25 deletions Dockerfile.old

This file was deleted.

222 changes: 21 additions & 201 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,201 +1,21 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
MIT License

Copyright (c) 2019-current University of Helsinki (National Library of Finland)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

# About the implementation
- Authoritative source of records is z00. If any of these records don't have an entry in z106, that's an error
- This was a problem previously when near 100k of records were missing entries in z106. Reason: unknown. Fixed by creating the corresponding entries in z106
- This was a problem previously when near 100k of records were missing entries in z106. Reason: unknown. Fixed by creating the corresponding entries in z106
- Should this happen again the problem would manifest itself as OAI-PMH returning less records than it should the flow control would break
- Note: > v.2.0.0 uses Z13 for change data
- Flow control is based on on [keyset pagination](https://taylorbrazelton.com/posts/2019/03/offset-vs-seek-pagination/).
- When Aleph's headings indexing is in progress, the service doesn't return correct results (For set queries, which use these indexes) because the even though the record data has been updated, the index has not
- The indexing should be made much more faster. The workaround would be to have a polling service that check the state of the indexing table (z07) and makes the oai-pmh service respond with 503 (Service unavailable) when there is too many rows in the table
Expand All @@ -17,4 +18,4 @@

Copyright (c) 2019-2020, 2023-2024 **University Of Helsinki (The National Library Of Finland)**

This project's source code is licensed under the terms of **Apache License 2.0** .
This project's source code is licensed under the terms of **MIT** .
18 changes: 0 additions & 18 deletions entrypoint.sh

This file was deleted.

17 changes: 17 additions & 0 deletions example.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
OAI_IDENTIFIER_PREFIX='oai:example.com/bib'
INSTANCE_URL=https://bib-oai-pmh.example.com/
TZ=Europe/Helsinki
RESUMPTION_TOKEN_TIMEOUT='7200000'
IS_PRIVILEGED='false'
SETS_FILE=./volume/sets/sets.json
[email protected]
ALEPH_LIBRARY=foo01
ENABLE_PROXY='1'
MELINDA_PREFIX=FI-EXAMPLE
CONTEXT_NAME=bib
MAX_RESULTS='2500'
LOG_LEVEL='debug'
DEBUG='@natlibfi/*,-*:dev,-*:data'
ORACLE_CONNECT_STRING='oracle.server.example.com:2484/ORACLE_SID'
ORACLE_PASSWORD='ORACLE_PASSW'
ORACLE_USERNAME='ORACLE_USER'
Loading
Loading