Log Records Seeding Script #74

connor-bechthold · 2023-05-25T05:21:48Z

Implementation description

Created a bash script that can be ran to seed the log records table with an arbitrary amount of semi-random records

Add an env file in the seeding directory with these values:

#Log Records Table
LOG_RECORD_ROWS=50
EMPLOYEE_ID=1
ATTN_TO_ID=1

Steps to test

Run bash seed.sh (if you're on Windows. include a -w flag)
Check your table to ensure entries are there

What should reviewers focus on?

Whipped this up with little thought so there's probably room for improvement, but it at least serves as a solid starting point that can be built upon

Checklist

My PR name is descriptive and in imperative tense
My commit messages are descriptive and in imperative tense. My commits are atomic and trivial commits are squashed or fixup'd into non-trivial commits
I have run the appropriate linter(s)
I have requested a review from the PL, as well as other devs who have background knowledge on this PR or who will be building on top of this PR
If I have made API changes, I have updated the REST API Docs
IF I have made changes to the db/models, I have updated the Data Models Page
I have updated other Docs as needed

Safewaan · 2023-05-29T03:45:42Z

db-init/seed.sql

+INSERT INTO log_records (
+  employee_id, 
+  resident_first_name, 
+  resident_last_name, 


this needs to be updated to resident_id but we need to wait for #50 to be merged first

it can never be escaped

we can ignore this and merge what you have for now

Safewaan · 2023-05-29T03:45:52Z

db-init/seed.sql

+  flagged, 
+  attn_to, 
+  note, 
+  tags, 


same here as well, need to wait for your tags PR to be merged

Safewaan · 2023-05-29T03:46:44Z

db-init/seed.sql

+  tags, 
+  building ) 
+
+SELECT


would we able to do something similar to set up residents and a few dummy accounts in the db? It would definitely help set up a testing env fairly quickly and we can include an admin account here and in Firebase (so we don't have to keep creating accounts on fresh runs of the containers)

Safewaan · 2023-05-29T03:49:34Z

db-init/seed.sql

+  1, 
+  (ARRAY['Amazing note','This is a note','Bad note','Decent Note','Cool note'])[floor(random() * 5 + 1)], 
+  ARRAY['tag1', 'tag2'], 
+  (ARRAY['Building A','Building B','Building C'])[floor(random() * 3 + 1)]


buildings are:
144, 362, 402

connor-bechthold · 2023-05-31T04:51:16Z

I think it would be beneficial to at least share these files in Slack so they can be used as a template for other tables

Just so we're not waiting on a merge

Safewaan · 2023-05-31T18:57:38Z

db-init/seed.sql

+INSERT INTO log_records (
+  employee_id, 
+  resident_first_name, 
+  resident_last_name, 


we can ignore this and merge what you have for now

Safewaan · 2023-05-31T18:58:05Z

db-init/seed.sql

+  ARRAY['tag1', 'tag2'], 
+  (ARRAY['Building A','Building B','Building C'])[floor(random() * 3 + 1)]
+
+FROM generate_series(1, 50); -- Change this to get a different amount of rows


can we move this to a env file in db-init? I'd like to avoid bi-accidently pushing changes to this file

The number of rows?

…eeding directory

Safewaan · 2023-06-01T14:17:03Z

seeding/seed.sh

+
+#Get absolute path to seeding dir
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cat $SCRIPT_DIR/seed.sql | docker exec -i SHOW-database /bin/bash -c 'psql -U postgres -d show_db'


below was an error I ran into running the script on Windows:

OCI runtime exec failed: exec failed: unable to start container process: exec: "C:/Program Files/Git/usr/bin/bash": stat C:/Program Files/Git/usr/bin/bash: no such file or directory: unknown

The fix is to double the slashes so that its //bin//bash, its something to do with Windows interpreting it as a local path instead of a dir on the Docker container (Windows diff)

Idk if this would effect Linux environments, but if it does we can just have to versions of this file, one for Windows and and one for Linux

Tested this locally on Mac (UNIX); had no issues running the script with bash OR zsh, so I think we could proceed with the two files soln. I'm thinking we just add a subdir /windows and /unix to the seeding directory OR prepend the OS to the file names themselves

Safewaan · 2023-06-01T20:14:41Z

seeding/seed.sh

+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cat $SCRIPT_DIR/seed.sql | docker exec -i SHOW-database /bin/bash -c 'psql -U postgres -d show_db'
+
+echo "Database seeding complete"


can you display a error message if the above process fails?

you'll know if it fails from the sql logs

also the toast msg won't ever appear

Safewaan

another W Connor moment 😎 small nit for the .env but I'm good to merge this in

Next session you should go over this PR, how to use it, and how to add to it (for example, creating fake residents), it would be extremely helpful for the team :D

Safewaan · 2023-06-04T23:36:31Z

seeding/seed.sh

+#Otherwise, run bash seed.sh
+
+#Import root env file variables
+source ../.env


would it be possible to have an .env file in the seeding dir instead?

kevin-pierce

LGTM 🔥

Connor Bechthold added 3 commits May 25, 2023 00:59

create sql file and bash script

7f74e63

fix dir issue

066675a

move files

2a7ffc2

Safewaan self-requested a review May 29, 2023 03:46

Safewaan linked an issue May 29, 2023 that may be closed by this pull request

Investigate how to pre-populate DB with fake data #71

Closed

1 task

Safewaan reviewed May 29, 2023

View reviewed changes

Safewaan reviewed May 31, 2023

View reviewed changes

Connor Bechthold added 2 commits May 31, 2023 21:36

allow container to read script from local machine and move files to s…

7fe36b2

…eeding directory

update building names

d6669b3

kevin-pierce mentioned this pull request Jun 1, 2023

Update homepage with log records from DB + pagination #77

Merged

7 tasks

Safewaan requested changes Jun 1, 2023

View reviewed changes

Safewaan requested a review from kevin-pierce June 1, 2023 16:41

Safewaan reviewed Jun 1, 2023

View reviewed changes

Safewaan added the enhancement improves dev flow label Jun 4, 2023

Connor Bechthold added 2 commits June 4, 2023 00:09

windows and env var support

95311d8

add comments

0db102d

Safewaan approved these changes Jun 4, 2023

View reviewed changes

kevin-pierce approved these changes Jun 5, 2023

View reviewed changes

use env file in seeding dir

94f0eab

connor-bechthold merged commit 5d4da9a into main Jun 5, 2023

connor-bechthold deleted the connor/log-records-seeding-script branch June 5, 2023 16:34

Safewaan mentioned this pull request Jun 5, 2023

User and Residents Seeding Script #96

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Log Records Seeding Script #74

Log Records Seeding Script #74

connor-bechthold commented May 25, 2023 •

edited

Loading

Safewaan May 29, 2023

connor-bechthold May 31, 2023

Safewaan May 31, 2023

Safewaan May 29, 2023

Safewaan May 29, 2023

connor-bechthold May 31, 2023

Safewaan May 29, 2023

connor-bechthold commented May 31, 2023

Safewaan May 31, 2023

Safewaan May 31, 2023

connor-bechthold Jun 1, 2023

Safewaan Jun 1, 2023

Safewaan Jun 1, 2023

Safewaan Jun 1, 2023

kevin-pierce Jun 1, 2023

Safewaan Jun 1, 2023

connor-bechthold Jun 4, 2023

Safewaan left a comment

Safewaan Jun 4, 2023

kevin-pierce left a comment

Log Records Seeding Script #74

Log Records Seeding Script #74

Conversation

connor-bechthold commented May 25, 2023 • edited Loading

Implementation description

Steps to test

What should reviewers focus on?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

connor-bechthold commented May 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Safewaan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevin-pierce left a comment

Choose a reason for hiding this comment

connor-bechthold commented May 25, 2023 •

edited

Loading