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

feat: per-user secured Algolia API keys [BB-8083] #1962

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

0x29a
Copy link
Contributor

@0x29a 0x29a commented Dec 6, 2023

Description

Adds a new endpoint that generates a secured Algolia API key capable of retrieving only data that is associated with enterprises linked to a requesting user. This is useful when you want to isolate enterprise learners, so they can't modify underlying Algolia requests to fetch the whole index content.

Testing steps

See openedx/frontend-app-learner-portal-enterprise#887

@openedx-webhooks
Copy link

openedx-webhooks commented Dec 6, 2023

Thanks for the pull request, @0x29a!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 6, 2023
@0x29a 0x29a force-pushed the 0x29a/bb8083/per-user-algolia-key branch from 529ace0 to 4281496 Compare December 6, 2023 12:41
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Dec 6, 2023
@0x29a 0x29a force-pushed the 0x29a/bb8083/per-user-algolia-key branch from 4281496 to 04df3a2 Compare December 7, 2023 09:17
@0x29a 0x29a changed the title feat: per-user secured Algolia API keys [WIP] feat: per-user secured Algolia API keys [BB-8083] Dec 7, 2023
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

👍

@e0d
Copy link

e0d commented Dec 14, 2023

I've run the tests and added @0x29a to the triage group so that test will run automatically going forward.

@e0d e0d closed this Dec 14, 2023
@e0d e0d reopened this Dec 14, 2023
@e0d
Copy link

e0d commented Dec 14, 2023

Clicked the wrong button :)

@e0d
Copy link

e0d commented Dec 14, 2023

@0x29a Looks like there are some failed tests, can you please have a look?

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Dec 14, 2023
@0x29a 0x29a force-pushed the 0x29a/bb8083/per-user-algolia-key branch 2 times, most recently from c5fdfdb to 23b1317 Compare December 15, 2023 08:56
@0x29a 0x29a force-pushed the 0x29a/bb8083/per-user-algolia-key branch from 23b1317 to 6247ed4 Compare December 15, 2023 09:02
@0x29a
Copy link
Contributor Author

0x29a commented Dec 15, 2023

Thank you for adding me to the triage group, @e0d. 🙂

Looks like there are some failed tests, can you please have a look?

Yep, the newer version, to which I cherry-picked this change, doesn't import gettext anymore. I fixed this.

@mphilbrick211 mphilbrick211 requested a review from a team February 21, 2024 14:54
@mphilbrick211 mphilbrick211 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Feb 21, 2024
@mphilbrick211
Copy link

Hi @openedx/2u-titans! If you're still reviewing pull requests, would you be able to please review / merge this for us? Thanks!

@mphilbrick211 mphilbrick211 reopened this Feb 21, 2024
@mphilbrick211 mphilbrick211 added needs reviewer assigned PR needs to be (re-)assigned a new reviewer and removed waiting for eng review PR is ready for review. Review and merge it, or suggest changes. labels Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

5 participants