feat: add support for dropping the database #67

alvincrespo · 2020-10-01T19:04:22Z

This PR ensures that a developer can drop their database from the script db:drop

Changes

Adds the script db:drop to a generated apps package.json
Includes Mocha for unit testing Bison
Creates an createApp script to create the app but NOT start it (to verify setup)
Defines a unit test to ensure that DATABASE_NAME is properly generated in prisma/.env
Extends our Release workflow to include unit tests
Creates a test:prisma script for independently testing prisma setup

Checklist

Requires dependency update?
Generating a new app works

alvincrespo · 2020-10-01T19:05:37Z

scripts/createAppAndStartServer.js

 const execa = require("execa");
 module.exports = {};

-async function createAppAndStartServer() {
+async function init() {


Just keeping the main method calls in sync across scripts.

alvincrespo · 2020-10-01T19:06:11Z

scripts/createAppAndStartServer.js

+
+  fs.writeFile("./tmp/tmpDir", tmpDir, () => {
+    console.log("tmpDir location stored.");
+  });


We're storing the tmp directory location so we can pick it up easily if needed.

alvincrespo · 2020-10-01T19:06:49Z

template/package.json.ejs

@@ -11,6 +11,7 @@
    "cypress:local": "CYPRESS_LOCAL=true CYPRESS_BASE_URL=http://localhost:3000 cypress",
    "db:migrate": "yarn -s prisma migrate up --experimental",
    "db:setup": "yarn db:migrate && yarn prisma generate",
+    "db:drop": "source prisma/.env && dropdb $(echo $DATABASE_NAME)",


dropdb is a command line helper for postgres. Comes with every install - more info here.

what do you think about putting this into scripts/dropDatabase? If we did that we could do:

import { Client } from 'pg'; const connectionString = process.env.DATABASE_URL; const db = new Client({ connectionString }); const { database } = db.connectionParameters; async function drop() { await db.connect(); console.log(`dropping the ${database} database`); await db.query(`DROP DATABASE IF EXISTS ${database}`); await db.end(); } drop();

the big advantage here I think is that we can just use the existing DATABASE_URL and not have to manage another variable. we should have pg included as a dependency already.

alvincrespo · 2020-10-01T19:28:42Z

@cball I wasn't sure if we wanted to use Mocha for unit tests - but went down that route to at least get something running. Let me know if you have a library pref and I can update.

cball

awesome @alvincrespo! It might be good to stick with jest since that's what we are leveraging once the app is generated. Looking at what you have for Mocha I don't think it will be much of an update.

Along the lines of what you mentioned, I'd be curious if our unit tests need to go through the whole app generation process, but we can circle back to that.

The biggest suggestion I have is around creating a script to drop the db. If we go that route, you'll want something like this:

{
  "db:drop": "DOTENV_CONFIG_PATH=./prisma/.env ts-node -r dotenv/config ./scripts/dropdb",
}

cball · 2020-10-02T13:35:23Z

.github/workflows/release.yml

@@ -31,6 +31,9 @@ jobs:
      - name: Install packages
        run: |
          yarn install --frozen-lockfile
+      - name: Run Prisma Unit Tests
+        run: |
+          yarn test:prisma


should we make this generic unit tests?

cball · 2020-10-02T13:36:18Z

package.json

@@ -44,6 +45,7 @@
    "@semantic-release/git": "^9.0.0",
    "cypress": "^5.1.0",
    "ejs-lint": "^1.1.0",
+    "mocha": "^8.1.3",


Like I mentioned in the comment I think we should keep this as jest for continuity sake. glad you got this in though!

cball · 2020-10-02T13:36:30Z

scripts/createApp.js

+  return path.join(tmpdir, name);
+}
+
+init();


cball · 2020-10-02T13:37:03Z

template/prisma/_.env.ejs

@@ -5,3 +5,4 @@
 # See the documentation for all the connection string options: https://pris.ly/d/connection-strings

 DATABASE_URL="postgresql://<%= db.dev.user %><%= db.dev.password %>@<%= db.dev.host %>:<%= db.dev.port %>/<%= db.dev.name %>?schema=public"
+DATABASE_NAME="<%= db.dev.name %>"


if we go the scripts route, may not need this

alvincrespo · 2020-10-02T13:54:59Z

@cball Awesome recommendations! This makes sense to me. I'll go ahead and implement.

alvincrespo · 2020-10-02T17:03:30Z

@cball Ready for another round of review.

# [1.7.0-canary.1](v1.6.4...v1.7.0-canary.1) (2020-10-02) ### Features * add support for dropping the database ([#67](#67)) ([b0d8424](b0d8424))

github-actions · 2020-10-02T18:16:19Z

🎉 This PR is included in version 1.7.0-canary.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

# [1.7.0](v1.6.4...v1.7.0) (2020-10-07) ### Features * add support for dropping the database ([#67](#67)) ([b0d8424](b0d8424)) * migrate to @nexus/schema from nexus framework ([#68](#68)) ([4c7d557](4c7d557))

github-actions · 2020-10-07T01:59:37Z

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

alvincrespo added 2 commits October 1, 2020 13:32

chore: add support for dropping database

30be3d5

adds unit test to verify DATABASE_NAME env

410de6a

alvincrespo added the enhancement New feature or request label Oct 1, 2020

alvincrespo requested a review from cball October 1, 2020 19:04

alvincrespo self-assigned this Oct 1, 2020

alvincrespo commented Oct 1, 2020

View reviewed changes

alvincrespo added 3 commits October 1, 2020 15:13

fix unit test action

37ae18d

fix action setup

7b779e4

create tmp directory if it does not exist

a4bd36b

cball requested changes Oct 2, 2020

View reviewed changes

alvincrespo added 4 commits October 2, 2020 10:42

mocha -> jest

1d4f7fa

replace tmp approach with dropDatabase script

c7ae363

move to TS and make some code style adjustments

685dcd8

fixes unit test

e311f7a

cball approved these changes Oct 2, 2020

View reviewed changes

alvincrespo merged commit b0d8424 into canary Oct 2, 2020

alvincrespo deleted the chore/add-support-for-dbdrop branch October 2, 2020 18:09

github-actions bot pushed a commit that referenced this pull request Oct 2, 2020

chore(release): 1.7.0-canary.1 [skip ci]

6261fe7

# [1.7.0-canary.1](v1.6.4...v1.7.0-canary.1) (2020-10-02) ### Features * add support for dropping the database ([#67](#67)) ([b0d8424](b0d8424))

github-actions bot added the released on @canary label Oct 2, 2020

github-actions bot added the released Issue has been included in a PR label Oct 7, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for dropping the database #67

feat: add support for dropping the database #67

alvincrespo commented Oct 1, 2020 •

edited

Loading

alvincrespo Oct 1, 2020

alvincrespo Oct 1, 2020

alvincrespo Oct 1, 2020 •

edited

Loading

cball Oct 2, 2020

cball Oct 2, 2020

alvincrespo commented Oct 1, 2020

cball left a comment

cball Oct 2, 2020

cball Oct 2, 2020

cball Oct 2, 2020

cball Oct 2, 2020

alvincrespo commented Oct 2, 2020

alvincrespo commented Oct 2, 2020

github-actions bot commented Oct 2, 2020

github-actions bot commented Oct 7, 2020

feat: add support for dropping the database #67

feat: add support for dropping the database #67

Conversation

alvincrespo commented Oct 1, 2020 • edited Loading

Changes

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alvincrespo Oct 1, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alvincrespo commented Oct 1, 2020

cball left a 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

alvincrespo commented Oct 2, 2020

alvincrespo commented Oct 2, 2020

github-actions bot commented Oct 2, 2020

github-actions bot commented Oct 7, 2020

alvincrespo commented Oct 1, 2020 •

edited

Loading

alvincrespo Oct 1, 2020 •

edited

Loading