Skip to content

WIP: 🕸️ Bug / Support AWS OpenSearch Auth#1081

Draft
demariadaniel wants to merge 6 commits into
mainfrom
bug/support-aws-auth
Draft

WIP: 🕸️ Bug / Support AWS OpenSearch Auth#1081
demariadaniel wants to merge 6 commits into
mainfrom
bug/support-aws-auth

Conversation

@demariadaniel

Copy link
Copy Markdown
Contributor

Summary

Adds AWS SDK Client Auth support for OpenSearch client

Issues

nci-hcmi-catalog/portal#1145

Description of Changes

Adds AWS SDK for

Readiness Checklist

  • Self Review
    • I have performed a self review of code
    • I have run the application locally and manually tested the feature
    • I have checked all updates to correct typos and misspellings
  • Formatting
    • Code follows the project style guide
    • Autmated code formatters (ie. Prettier) have been run
  • Local Testing
    • Successfully built all packages locally
    • Successfully ran all test suites, all unit and integration tests pass
  • Updated Tests
    • Unit and integration tests have been added that describe the bug that was fixed or the features that were added
  • Documentation
    • All new environment variables added to .env.schema file and documented in the README
    • All changes to server HTTP endpoints have open-api documentation
    • All new functions exported from their module have TSDoc comment documentation

@demariadaniel demariadaniel self-assigned this Jul 2, 2026
@demariadaniel demariadaniel added bug Something isn't working authorization Issue is related to user auth or permissions. labels Jul 2, 2026
Comment thread apps/search-server/pnpm-lock.yaml Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

until we migrate this codebase to use pnpm, please refrain from using the library or committing this file

thanks

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry this was created by mistake, removed

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please exclude the modules/graphql-router/src/admin files out of this and all PRs

thanks

@demariadaniel demariadaniel Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of distracting Type errors in this folder, maybe we can remove it or gitignore? I'm often using Type errors to validate that my new changes haven't broken anything, but frequently end up impacting code in /admin

Suggested gitignore change:
https://github.com/overture-stack/arranger/pull/1081/changes#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947

I will revert the changes in this file, but that's the context / source of repeat issues

Comment on lines -79 to +78
enableDebug,
enableDebug: !!enableDebug,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how is this change necessary?

@demariadaniel demariadaniel Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a Type error, enableDebug at line 58 is boolean | undefined, and getIndexMapping expects only a boolean.
We had to leverage enableDebug to troubleshoot in HCMI Dev.

...clientConfig,
clientType,
...AwsSigv4Signer({
region: 'us-east-1',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hard coding this would limit the library's usefulness to a specific subset of users who would otherwise choose a different mirror/server location

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this should be dynamic, I'm not sure yet what other features also may need to be included.

This is still in draft until I can validate what other changes will need to be made to work with the context of HCMI. The AWS-ArrangerSearchClient config still needs improvement, this is only set up for testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

authorization Issue is related to user auth or permissions. bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants