Release 0.30.7

[odlbot]

Chris Chudzicki

• Add comma between build args (fix: deployment variable, add comma between build args #2083) (6862b2b3)
• Tie chatbots to URL parameters (Tie chatbots to URL parameters #2076) (7239c230)
• add MITOL_LOGOUT_SUFFIX to github actions (add MITOL_LOGOUT_SUFFIX to github actions #2079) (01fc6b66)
• Accessibility improvements (Accessibility improvements #2071) (0bed63b3)

Nathan Levesque

• Fix the user search URL (Fix the SCIM user search URL #2084) (d8a8758c)
• Fix user migrations for SCIM (Fix user migrations for SCIM #2078) (736b8105)
• Fix SCIM view tests (Fix SCIM view tests #2073) (798ef523)
• Added SCIM fields to User and populate (Added SCIM fields to User and populate #2062) (6c9a8d20)
• Fix SCIM search API sort and pagination (Fix SCIM search API sort and pagination #2066) (e394d1dd)

Shankar Ambady

• Add all Contentfile metadata to chunk responses (Add all Contentfile metadata to chunk responses #2075) (aa026304)
• Make embedding generation task use correct run (Make embedding generation task use correct run #2074) (1001aeef)

Matt Bertrand

• APISIX integration (APISIX integration #2061) (131c04e4)

Arslan Ashraf

• fix: Opensearch container on ARM64 based architecture (fix: opensearch container on ARM64 based architecture #2069) (af38efac)

renovate[bot]

• Update dependency @dnd-kit/sortable to v10 (Update dependency @dnd-kit/sortable to v10 #1974) (aeb59d30)
• Update akhileshns/heroku-deploy digest to e3eb99d (Update akhileshns/heroku-deploy digest to e3eb99d #2068) (be430a1c)
• Update dependency @sentry/nextjs to v9 (Update dependency @sentry/nextjs to v9 #2034) (b3d12422)
• Update dependency @mui/lab to v6.0.0-beta.28 (Update dependency @mui/lab to v6.0.0-beta.28 #2051) (d507c1fb)
• Update dependency tldextract to v5 (Update dependency tldextract to v5 #2031) (d47aa29c)

[gitguardian]

⚠️ GitGuardian has uncovered 5 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
13777606	Triggered	Generic Private Key	131c04e	config/keycloak/tls/tls.key.default	View secret
13777608	Triggered	Generic High Entropy Secret	131c04e	config/keycloak/realms/default-realm.json	View secret
13777609	Triggered	Generic Password	131c04e	config/keycloak/realms/default-realm.json	View secret
13777610	Triggered	Generic High Entropy Secret	131c04e	config/keycloak/realms/default-realm.json	View secret
10259317	Triggered	Generic Password	131c04e	docker-compose.services.yml	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[gemini-code-assist]

Hello @odlbot, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request releases version 0.30.7, incorporating a variety of fixes, updates, and new features. Key changes include updates to GitHub Actions workflows, dependency updates, SCIM-related fixes, APISIX integration, and accessibility improvements. The changes span multiple files, including workflow configurations, Dockerfiles, pre-commit settings, and documentation.

Highlights

• GitHub Actions Updates: Updates the akhileshns/heroku-deploy action digest and adds MITOL_API_LOGOUT_SUFFIX to production and release candidate workflows.
• Dependency Updates: Updates several dependencies, including @dnd-kit/sortable, @sentry/nextjs, @mui/lab, and tldextract.
• SCIM Fixes: Addresses issues related to user search URL, user migrations, SCIM view tests, SCIM fields in User, and SCIM search API sort and pagination.
• APISIX Integration: Introduces APISIX integration with Keycloak for authentication, including configuration files and documentation.
• Accessibility Improvements: Addresses accessibility concerns, specifically focus outlines on the Dashboard page.

Changelog

Click here to see the changelog

• .github/workflows/production.yml
  • Updates the heroku-deploy action to use the latest digest.
  • Adds MITOL_API_LOGOUT_SUFFIX to the environment variables.
  • Adds comma between build args
• .github/workflows/release-candidate.yml
  • Updates the heroku-deploy action to use the latest digest.
  • Adds MITOL_API_LOGOUT_SUFFIX to the environment variables.
  • Adds comma between build args
• .pre-commit-config.yaml
  • Excludes keycloak TLS and realm configuration files from pre-commit checks.
• .secrets.baseline
  • Excludes keycloak TLS files from secret scanning.
• Dockerfile
  • Changes mkdir to mkdir -p to ensure staticfiles directory exists.
• Dockerfile-litellm
  • Removes the Dockerfile-litellm file.
• README-keycloak.md
  • Adds documentation for Keycloak and APISIX integration, including default settings and instructions for making it work.
• RELEASE.rst
  • Adds release notes for version 0.30.7, summarizing the changes included in this release.
• config/apisix/apisix.yaml
  • Adds configuration for APISIX routes, including openid-connect plugin settings.
• config/apisix/config.yaml
  • Configures APISIX settings, such as disabling the admin interface and setting the node listen port.
• config/apisix/debug.yaml
  • Adds debug configuration for APISIX.
• config/keycloak/providers/README.md
  • Adds a README file for the keycloak providers directory.
• config/keycloak/realms/default-realm.json
  • Adds a default realm configuration for Keycloak, including users, roles, and client settings.
• config/keycloak/tls/README.md
  • Adds a README file for the keycloak TLS directory, providing instructions for configuring TLS certificates.
• config/keycloak/tls/tls.crt
  • Adds a default TLS certificate file.
• config/keycloak/tls/tls.crt.default
  • Adds a default TLS certificate file.
• config/keycloak/tls/tls.key
  • Adds a default TLS key file.
• config/keycloak/tls/tls.key.default
  • Adds a default TLS key file.
• config/litellm_config.yml
  • Removes the config/litellm_config.yml file.
• config/postgres/init-keycloak.sql
  • Adds SQL script to create the keycloak database and grant privileges.
• docker-compose.litellm.yml
  • Removes the docker-compose.litellm.yml file.
• docker-compose.opensearch.base.yml
  • Disables SVE (Scalable Vector Extension) for ARM64 architecture in OpenSearch container.
• docker-compose.services.yml
  • Adds a volume mount for postgres init db scripts
  • Removes restart policy for qdrant service
  • Adds keycloak and apigateway services with their configurations and dependencies.
  • Adds keycloak-store volume.
• docker-compose.yml
  • Adds env_file to docker-compose.yml
• env/backend.env
  • Changes MITOL_COOKIE_NAME from discussions to mitlearn.
• env/backend.local.example.env
  • Adds APISIX/Keycloak settings to the example environment file.
• env/frontend.env
  • Adds NEXT_PUBLIC_MITOL_API_LOGOUT_SUFFIX to the environment variables.
• env/shared.env
  • Adds MITOL_API_LOGOUT_SUFFIX and comments on how to configure with apisix and keycloak
  • Adds NGINX_PORT, APISIX_PORT, KEYCLOAK_PORT, and KEYCLOAK_SSL_PORT to the environment variables.
• env/shared.local.example.env
  • Adds MITOL_NEW_USER_LOGIN_URL to the example environment file.
• frontends/api/src/generated/v0/api.ts
  • Adds edx_block_id as a parameter to the VectorContentFilesSearchApi.
• frontends/main/Dockerfile.web
  • Adds NEXT_PUBLIC_MITOL_API_LOGOUT_SUFFIX to the environment variables.
• frontends/main/package.json
  • Updates @sentry/nextjs dependency to version 9.0.0.
• frontends/main/src/app-pages/ChatPage/ChatPage.tsx
  • Adds credentials: include to the fetch request.
• frontends/main/src/app-pages/ChatSyllabusPage/ChatSyllabusPage.tsx
  • Adds credentials: include to the fetch request.
• frontends/main/src/app-pages/DashboardPage/DashboardPage.tsx
  • Adds focus-visible styling to the TabsContainer.
• frontends/main/src/common/metadata.ts
  • Updates import to use RESOURCE_DRAWER_PARAMS instead of RESOURCE_DRAWER_QUERY_PARAM.
• frontends/main/src/common/urls.ts
  • Adds MITOL_API_LOGOUT_SUFFIX to the environment variables.
  • Updates LOGOUT to use MITOL_API_LOGOUT_SUFFIX.
  • Adds RECOMMENDER_QUERY_PARAM and RESOURCE_DRAWER_PARAMS constants.
• frontends/main/src/page-components/AiChat/AiChatWithEntryScreen.tsx
  • Adds data-testid to the AiChat entry screen.
• frontends/main/src/page-components/AiChat/AiRecommendationBotDrawer.tsx
  • Refactors AiRecommendationBotDrawer to use RoutedDrawer and DrawerContent components.
  • Adds credentials: include to the fetch request.
• frontends/main/src/page-components/AiChat/AskTimDrawerButton.test.tsx
  • Adds tests for AskTIMButton component.
• frontends/main/src/page-components/AiChat/AskTimDrawerButton.tsx
  • Refactors AskTIMButton to use ButtonLink and update URL parameters.
• frontends/main/src/page-components/LearningResourceDrawer/LearningResourceDrawer.test.tsx
  • Adds tests for LearningResourceDrawer component, including chat functionality.
• frontends/main/src/page-components/LearningResourceDrawer/LearningResourceDrawer.tsx
  • Updates LearningResourceDrawer to use RoutedDrawer and DrawerContent components.
  • Adds chatExpanded prop to DrawerContent component.
  • Removes the use of RESOURCE_DRAWER_QUERY_PARAM and uses RESOURCE_DRAWER_PARAMS instead
• frontends/main/src/page-components/LearningResourceDrawer/useResourceDrawerHref.ts
  • Updates useResourceDrawerHref to use RESOURCE_DRAWER_PARAMS instead of RESOURCE_DRAWER_QUERY_PARAM.
• frontends/main/src/page-components/LearningResourceExpanded/AiChatSyllabusSlideDown.test.tsx
  • Adds open prop to AiChatSyllabusSlideDown component in tests.
• frontends/main/src/page-components/LearningResourceExpanded/AiChatSyllabusSlideDown.tsx
  • Removes useState and toggleOpen from AiChatSyllabusSlideDown component.
  • Adds aria-pressed to the styled button
  • Adds credentials: include to the fetch request.
• frontends/main/src/page-components/LearningResourceExpanded/LearningResourceExpanded.test.tsx
  • Adds chatExpanded prop to setup function and tests.
• frontends/main/src/page-components/LearningResourceExpanded/LearningResourceExpanded.tsx
  • Removes useToggle hook.
  • Adds chatExpanded prop and useEffect hook to handle chat functionality.
  • Updates AiSyllabusBotSlideDown component to use open and onToggleOpen props.
• frontends/main/src/page-components/ResourceCard/ResourceCard.test.tsx
  • Updates tests to use RESOURCE_DRAWER_PARAMS instead of RESOURCE_DRAWER_QUERY_PARAM.
• frontends/ol-components/package.json
  • Updates @dnd-kit/sortable and @mui/lab dependencies.
• frontends/ol-components/src/components/Checkbox/Checkbox.tsx
  • Adds focus-visible styling to the checkbox input.
• frontends/ol-components/src/components/Checkbox/CheckboxChoiceField.tsx
  • Fixes type error with FormLabel and sets component to legend for accessibility
• frontends/ol-components/src/components/Link/Link.tsx
  • Refactors Link component to use LinkAdapter and improve shallow routing.
• frontends/ol-components/src/components/LinkAdapter/LinkAdapter.tsx
  • Creates a LinkAdapter component to handle shallow routing.
• frontends/ol-components/src/components/RoutedDrawer/RoutedDrawer.tsx
  • Adds documentation for RoutedDrawer component.
• frontends/ol-components/src/components/SelectField/SelectField.test.tsx
  • Adds tests for Select component.
• frontends/ol-components/src/components/SelectField/SelectField.tsx
  • Adds workaround for MUI SelectField accessibility issue.
• frontends/ol-components/src/components/SimpleSelect/SimpleSelect.tsx
  • Removes unnecessary MenuItem from SimpleSelectField component.
• frontends/ol-components/src/components/ThemeProvider/ThemeProvider.tsx
  • Updates ThemeProvider to use LinkAdapter.
• frontends/ol-utilities/package.json
  • Updates @dnd-kit/sortable dependency.
• learning_resources/models.py
  • Adds select_related and prefetch_related to the for_serialization method
• main/factories.py
  • Adds scim_external_id and scim_username to the UserFactory.
• main/middleware/apisix_user.py
  • Adds ApisixUserMiddleware to handle APISIX-specific headers.
• main/middleware/apisix_user_test.py
  • Adds tests for apisix middleware.
• main/settings.py
  • Updates VERSION to 0.30.7.
  • Adds ApisixUserMiddleware to MIDDLEWARE.
  • Adds Keycloak API settings and imports
• openapi/specs/v0.yaml
  • Adds edx_block_id as a parameter to the VectorContentFilesSearch API.
• poetry.lock
  • Updates dependencies in poetry.lock.
• profiles/admin.py
  • Removes scim_id, scim_username, and scim_external_id from the readonly_fields in ProfileAdmin.
• profiles/forms.py
  • Removes scim_id, scim_username, and scim_external_id from the fields in ProfileForm.
• pyproject.toml
  • Updates tldextract dependency.
• scim/adapters.py
  • Updates SCIMUser adapter to use User model fields instead of Profile model fields.
• scim/urls.py
  • Updates SCIM URLs to use regular expressions and include users-search endpoint.
• scim/views.py
  • Adds SearchView for /.search endpoint.
• scim/views_test.py
  • Updates tests to use User model fields instead of Profile model fields.
  • Adds tests for user search functionality.
• users/admin.py
  • Adds UserAdmin to manage User model in admin panel
• users/migrations/0004_add_scim_and_timestamp_fields.py
  • Adds SCIM-related fields and timestamp fields to the User model.
• users/migrations/0005_set_user_scim_id.py
  • Adds a data migration to populate the scim_id and other fields.
• users/models.py
  • Updates User model to inherit from AbstractSCIMUserMixin and TimestampedModel.
• vector_search/constants.py
  • Adds edx_block_id to QDRANT_CONTENT_FILE_PARAM_MAP.
• vector_search/serializers.py
  • Adds edx_block_id as a parameter to the ContentFileVectorSearchRequestSerializer.
• vector_search/tasks.py
  • Updates start_embed_resources and embed_learning_resources_by_id to use next_run or latest run for content files.
• vector_search/tasks_test.py
  • Adds tests for embedding content from next run and latest run.
• vector_search/utils.py
  • Updates _content_file_vector_hits to include all Contentfile metadata to chunk responses

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

Did you know?

The Public Suffix List, used by tldextract, is maintained by Mozilla and is crucial for accurately identifying domain names.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the release notes and the application version in the settings. The changes are straightforward and seem correct. However, I have a minor suggestion regarding the release notes format.

Summary of Findings

Merge Readiness

The changes are straightforward and appear correct. I don't see any critical issues preventing this pull request from being merged. However, consider the suggestion about the release notes format for better readability. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.