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

Initialize postgres docker container with developer defined SQL #3654

Merged
merged 3 commits into from
Apr 3, 2023

Conversation

bjester
Copy link
Member

@bjester bjester commented Sep 16, 2022

Summary

Description of the change(s) you made

  • A major pain point is the need to run yarn run devsetup every time you switch to a new branch, because the compose project name includes the current git branch
    • This is a useful feature when switching between many branches where there are schema differences, since it maintains separate data volumes per branch
    • It's also annoying because you start fresh with every branch, and having some data in the database is useful for testing
  • This PR allows dumping/exporting SQL from an existing database for use during initialization of the docker postgres container
    • The .docker/postgres directory is mounted to the container and any .sh or .sql are executed in the container
    • The minio mount has also changed since it doesn't make much sense to keep separate volumes for it

Manual verification steps performed

  1. Run make dcservicesup
  2. Create the init.sql make .docker/postgres/init.sql from your populated database
  3. Stop everything
  4. Checkout a new branch
  5. Run make dcservicesup
  6. Your data has been restored to the database

References

Comments


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@bjester bjester force-pushed the docker-postgres-init branch from fc2bf4c to 9d1b82f Compare November 21, 2022 16:10
@vkWeb vkWeb self-assigned this Mar 18, 2023
Copy link
Member

@vkWeb vkWeb left a comment

Choose a reason for hiding this comment

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

@bjester sir, I manually tested the PR and its working as expected sir. 🚀

A really helpful feature sir for cross-branch development!

@vkWeb vkWeb merged commit fb8bebd into learningequality:unstable Apr 3, 2023
@vkWeb vkWeb removed their assignment Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants