Compare commits
No commits in common. "main" and "@emigrate/reporter-pino@0.6.0" have entirely different histories.
main
...
@emigrate/
85 changed files with 5223 additions and 8734 deletions
7
.github/workflows/ci.yaml
vendored
7
.github/workflows/ci.yaml
vendored
|
|
@ -13,7 +13,6 @@ jobs:
|
|||
env:
|
||||
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
|
||||
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
|
||||
DO_NOT_TRACK: 1
|
||||
|
||||
steps:
|
||||
- name: Check out code
|
||||
|
|
@ -21,12 +20,14 @@ jobs:
|
|||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
- uses: pnpm/action-setup@v4.0.0
|
||||
- uses: pnpm/action-setup@v2.4.0
|
||||
with:
|
||||
version: 8.3.1
|
||||
|
||||
- name: Setup Node.js environment
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22.15.0
|
||||
node-version: 20.9.0
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
|
|
|
|||
8
.github/workflows/deploy.yaml
vendored
8
.github/workflows/deploy.yaml
vendored
|
|
@ -10,7 +10,6 @@ on:
|
|||
|
||||
# Allow this job to clone the repo and create a page deployment
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
|
@ -30,10 +29,11 @@ jobs:
|
|||
echo $ASTRO_SITE
|
||||
echo $ASTRO_BASE
|
||||
- name: Install, build, and upload your site output
|
||||
uses: withastro/action@v2
|
||||
uses: withastro/action@v1
|
||||
with:
|
||||
path: ./docs # The root location of your Astro project inside the repository. (optional)
|
||||
package-manager: pnpm@9.4.0 # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
|
||||
node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
|
||||
package-manager: pnpm@8.10.2 # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
|
||||
|
||||
deploy:
|
||||
needs: build
|
||||
|
|
@ -44,4 +44,4 @@ jobs:
|
|||
steps:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
uses: actions/deploy-pages@v1
|
||||
|
|
|
|||
62
.github/workflows/integration.yaml
vendored
62
.github/workflows/integration.yaml
vendored
|
|
@ -1,62 +0,0 @@
|
|||
name: Integration Tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ['main', 'changeset-release/main']
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
mysql_integration:
|
||||
name: Emigrate MySQL integration tests
|
||||
timeout-minutes: 15
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
|
||||
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
|
||||
DO_NOT_TRACK: 1
|
||||
|
||||
services:
|
||||
mysql:
|
||||
image: mysql:8.0
|
||||
env:
|
||||
MYSQL_ROOT_PASSWORD: root
|
||||
MYSQL_DATABASE: emigrate
|
||||
MYSQL_USER: emigrate
|
||||
MYSQL_PASSWORD: emigrate
|
||||
ports:
|
||||
- 3306:3306
|
||||
options: --health-cmd="mysqladmin ping -h localhost" --health-interval=10s --health-timeout=5s --health-retries=5
|
||||
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
- uses: pnpm/action-setup@v4.0.0
|
||||
|
||||
- name: Setup Node.js environment
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22.15.0
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install
|
||||
|
||||
- name: Wait for MySQL to be ready
|
||||
run: |
|
||||
for i in {1..30}; do
|
||||
nc -z localhost 3306 && echo "MySQL is up!" && break
|
||||
echo "Waiting for MySQL..."
|
||||
sleep 2
|
||||
done
|
||||
|
||||
- name: Build package
|
||||
run: pnpm build --filter @emigrate/mysql
|
||||
|
||||
- name: Integration Tests
|
||||
env:
|
||||
MYSQL_HOST: '127.0.0.1'
|
||||
MYSQL_PORT: 3306
|
||||
run: pnpm --filter @emigrate/mysql integration
|
||||
34
.github/workflows/release.yaml
vendored
34
.github/workflows/release.yaml
vendored
|
|
@ -16,7 +16,6 @@ jobs:
|
|||
packages: write
|
||||
pull-requests: write
|
||||
actions: read
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v4
|
||||
|
|
@ -25,48 +24,25 @@ jobs:
|
|||
persist-credentials: false
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: pnpm/action-setup@v4.0.0
|
||||
- uses: pnpm/action-setup@v2.4.0
|
||||
with:
|
||||
version: 8.3.1
|
||||
|
||||
- name: Setup Node.js environment
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22.15.0
|
||||
node-version: 20.9.0
|
||||
cache: 'pnpm'
|
||||
|
||||
- name: Install Dependencies
|
||||
run: pnpm install
|
||||
|
||||
- name: Create Release Pull Request
|
||||
id: changesets
|
||||
uses: aboviq/changesets-action@v1.5.2
|
||||
uses: changesets/action@v1.4.5
|
||||
with:
|
||||
publish: pnpm run release
|
||||
commit: 'chore(release): version packages'
|
||||
title: 'chore(release): version packages'
|
||||
createGithubReleases: aggregate
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.PAT_GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
- name: Release to @next tag on npm
|
||||
if: github.ref_name == 'main' && steps.changesets.outputs.published != 'true'
|
||||
run: |
|
||||
git checkout main
|
||||
|
||||
CHANGESET_FILE=$(git diff-tree --no-commit-id --name-only HEAD -r ".changeset/*-*-*.md")
|
||||
if [ -z "$CHANGESET_FILE" ]; then
|
||||
echo "No changesets found, skipping release to @next tag"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
AFFECTED_PACKAGES=$(sed -n '/---/,/---/p' "$CHANGESET_FILE" | sed '/---/d')
|
||||
if [ -z "$AFFECTED_PACKAGES" ]; then
|
||||
echo "No packages affected by changesets, skipping release to @next tag"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
pnpm changeset version --snapshot next
|
||||
pnpm changeset publish --tag next
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.PAT_GITHUB_TOKEN }}
|
||||
|
|
|
|||
|
|
@ -1,27 +1,5 @@
|
|||
# @emigrate/docs
|
||||
|
||||
## 1.0.0
|
||||
|
||||
### Major Changes
|
||||
|
||||
- 1d33d65: Rename the URL path "/commands/" to "/cli/" to make it more clear that those pages are the documentation for the CLI. This change is a BREAKING CHANGE because it changes the URL path of the pages.
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 0c597fd: Add a separate page for the Emigrate CLI itself, with all the commands as sub pages
|
||||
|
||||
## 0.4.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- b62c692: Add documentation for the built-in "json" reporter
|
||||
- b62c692: The "default" reporter is now named "pretty"
|
||||
- e7ec75d: Add note in FAQ on using Emigrate for existing databases
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- c838ffb: Add note on how to write Emigrate's config using TypeScript in a production environment without having `typescript` installed.
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
|
@ -40,4 +18,4 @@
|
|||
### Minor Changes
|
||||
|
||||
- cbc35bd: Add first version of the [Baseline guide](https://emigrate.dev/guides/baseline)
|
||||
- cbc35bd: Document the new --limit, --from and --to options for the ["up" command](https://emigrate.dev/cli/up/)
|
||||
- cbc35bd: Document the new --limit, --from and --to options for the ["up" command](https://emigrate.dev/commands/up/)
|
||||
|
|
|
|||
|
|
@ -77,33 +77,24 @@ export default defineConfig({
|
|||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Command Line Interface',
|
||||
items: [
|
||||
{
|
||||
label: 'Introduction',
|
||||
link: '/cli/',
|
||||
},
|
||||
{
|
||||
label: 'Commands',
|
||||
items: [
|
||||
{
|
||||
label: 'emigrate up',
|
||||
link: '/cli/up/',
|
||||
link: '/commands/up/',
|
||||
},
|
||||
{
|
||||
label: 'emigrate list',
|
||||
link: '/cli/list/',
|
||||
link: '/commands/list/',
|
||||
},
|
||||
{
|
||||
label: 'emigrate new',
|
||||
link: '/cli/new/',
|
||||
link: '/commands/new/',
|
||||
},
|
||||
{
|
||||
label: 'emigrate remove',
|
||||
link: '/cli/remove/',
|
||||
},
|
||||
],
|
||||
link: '/commands/remove/',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
|
@ -115,7 +106,7 @@ export default defineConfig({
|
|||
link: '/guides/typescript/',
|
||||
},
|
||||
{
|
||||
label: 'Baseline existing database',
|
||||
label: 'Baseline',
|
||||
link: '/guides/baseline/',
|
||||
},
|
||||
],
|
||||
|
|
@ -180,12 +171,8 @@ export default defineConfig({
|
|||
link: '/plugins/reporters/',
|
||||
},
|
||||
{
|
||||
label: 'Pretty Reporter (default)',
|
||||
link: '/plugins/reporters/pretty/',
|
||||
},
|
||||
{
|
||||
label: 'JSON Reporter',
|
||||
link: '/plugins/reporters/json/',
|
||||
label: 'Default Reporter',
|
||||
link: '/plugins/reporters/default/',
|
||||
},
|
||||
{
|
||||
label: 'Pino Reporter',
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
"name": "@emigrate/docs",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"version": "1.0.0",
|
||||
"version": "0.3.0",
|
||||
"scripts": {
|
||||
"dev": "astro dev",
|
||||
"start": "astro dev",
|
||||
|
|
@ -11,7 +11,6 @@
|
|||
"astro": "astro"
|
||||
},
|
||||
"dependencies": {
|
||||
"@astrojs/check": "^0.7.0",
|
||||
"@astrojs/starlight": "^0.15.0",
|
||||
"@astrojs/starlight-tailwind": "2.0.1",
|
||||
"@astrojs/tailwind": "^5.0.3",
|
||||
|
|
@ -21,6 +20,5 @@
|
|||
},
|
||||
"volta": {
|
||||
"extends": "../package.json"
|
||||
},
|
||||
"packageManager": "pnpm@9.4.0"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,73 +0,0 @@
|
|||
---
|
||||
title: "CLI Introduction"
|
||||
description: "Some basic information about the Emigrate CLI."
|
||||
---
|
||||
|
||||
import { Tabs, TabItem, LinkCard } from '@astrojs/starlight/components';
|
||||
import Link from '@components/Link.astro';
|
||||
|
||||
Emigrate comes with a CLI that you can use to manage your migrations. The CLI is a powerful tool that allows you to create, run, and manage migrations.
|
||||
|
||||
### Installing the Emigrate CLI
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
```bash
|
||||
npm install @emigrate/cli
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="pnpm">
|
||||
```bash
|
||||
pnpm add @emigrate/cli
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="yarn">
|
||||
```bash
|
||||
yarn add @emigrate/cli
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="bun">
|
||||
```bash
|
||||
bun add @emigrate/cli
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="deno">
|
||||
```json title="package.json" {3,6}
|
||||
{
|
||||
"scripts": {
|
||||
"emigrate": "emigrate"
|
||||
},
|
||||
"dependencies": {
|
||||
"@emigrate/cli": "*"
|
||||
}
|
||||
}
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Existing commands
|
||||
|
||||
|
||||
<LinkCard
|
||||
href="up/"
|
||||
title="emigrate up"
|
||||
description="The command for executing migrations, or showing pending migrations in dry run mode."
|
||||
/>
|
||||
|
||||
<LinkCard
|
||||
href="list/"
|
||||
title="emigrate list"
|
||||
description="The command for listing all migrations and their status."
|
||||
/>
|
||||
|
||||
<LinkCard
|
||||
href="new/"
|
||||
title="emigrate new"
|
||||
description="The command for creating new migration files."
|
||||
/>
|
||||
|
||||
<LinkCard
|
||||
href="remove/"
|
||||
title="emigrate remove"
|
||||
description="The command for removing migrations from the migration history."
|
||||
/>
|
||||
|
|
@ -86,9 +86,6 @@ In case you have both a `emigrate-storage-somedb` and a `somedb` package install
|
|||
|
||||
### `-r`, `--reporter <name>`
|
||||
|
||||
**type:** `"pretty" | "json" | string`
|
||||
**default:** `"pretty"`
|
||||
|
||||
The <Link href="/plugins/reporters/">reporter</Link> to use for listing the migrations.
|
||||
|
||||
The name can be either a path to a module or a package name. For package names Emigrate will automatically prefix the given name with these prefixes in order:
|
||||
|
|
@ -101,9 +101,6 @@ In case you have both a `emigrate-plugin-someplugin` and a `someplugin` package
|
|||
|
||||
### `-r`, `--reporter <name>`
|
||||
|
||||
**type:** `"pretty" | "json" | string`
|
||||
**default:** `"pretty"`
|
||||
|
||||
The <Link href="/plugins/reporters/">reporter</Link> to use for listing the migrations.
|
||||
|
||||
The name can be either a path to a module or a package name. For package names Emigrate will automatically prefix the given name with these prefixes in order:
|
||||
|
|
@ -55,7 +55,7 @@ The `remove` command is used to remove a migration from the history. This is use
|
|||
|
||||
The name of the migration file to remove, including the extension, e.g. `20200101000000_some_migration.js`, or a relative file path to a migration file to remove, e.g: `migrations/20200101000000_some_migration.js`.
|
||||
|
||||
Using relative file paths is useful in terminals that support autocomplete, and also when you copy and use the relative migration file path from the output of the <Link href="/cli/list/">`list`</Link> command.
|
||||
Using relative file paths is useful in terminals that support autocomplete, and also when you copy and use the relative migration file path from the output of the <Link href="/commands/list/">`list`</Link> command.
|
||||
|
||||
## Options
|
||||
|
||||
|
|
@ -95,9 +95,6 @@ In case you have both a `emigrate-storage-somedb` and a `somedb` package install
|
|||
|
||||
### `-r`, `--reporter <name>`
|
||||
|
||||
**type:** `"pretty" | "json" | string`
|
||||
**default:** `"pretty"`
|
||||
|
||||
The <Link href="/plugins/reporters/">reporter</Link> to use for listing the migrations.
|
||||
|
||||
The name can be either a path to a module or a package name. For package names Emigrate will automatically prefix the given name with these prefixes in order:
|
||||
|
|
@ -147,9 +147,6 @@ In case you have both a `emigrate-plugin-someplugin` and a `someplugin` package
|
|||
|
||||
### `-r`, `--reporter <name>`
|
||||
|
||||
**type:** `"pretty" | "json" | string`
|
||||
**default:** `"pretty"`
|
||||
|
||||
The <Link href="/plugins/reporters/">reporter</Link> to use for reporting the migration progress.
|
||||
|
||||
The name can be either a path to a module or a package name. For package names Emigrate will automatically prefix the given name with these prefixes in order:
|
||||
|
|
@ -113,8 +113,8 @@ CREATE TABLE public.posts (
|
|||
|
||||
### Log the baseline migration
|
||||
|
||||
For new environments this baseline migration will automatically be run when you run <Link href="/cli/up/">`emigrate up`</Link>.
|
||||
For any existing environments you will need to run `emigrate up` with the <Link href="/cli/up/#--no-execution">`--no-execution`</Link> flag to prevent the migration from being executed and only log the migration:
|
||||
For new environments this baseline migration will automatically be run when you run <Link href="/commands/up/">`emigrate up`</Link>.
|
||||
For any existing environments you will need to run `emigrate up` with the <Link href="/commands/up/#--no-execution">`--no-execution`</Link> flag to prevent the migration from being executed and only log the migration:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
|
|
@ -155,7 +155,7 @@ For any existing environments you will need to run `emigrate up` with the <Link
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
In case you have already added more migration files to your migration directory you can limit the "up" command to just log the baseline migration by specifying the <Link href="/cli/up/#-t---to-name">`--to`</Link> option:
|
||||
In case you have already added more migration files to your migration directory you can limit the "up" command to just log the baseline migration by specifying the <Link href="/commands/up/#-t---to-name">`--to`</Link> option:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
|
|
@ -198,7 +198,7 @@ In case you have already added more migration files to your migration directory
|
|||
|
||||
### Verify the baseline migration status
|
||||
|
||||
You can verify the status of the baseline migration by running the <Link href="/cli/list/">`emigrate list`</Link> command:
|
||||
You can verify the status of the baseline migration by running the <Link href="/commands/list/">`emigrate list`</Link> command:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
|
|
@ -251,5 +251,5 @@ Emigrate list v0.14.1 /your/project/path
|
|||
|
||||
### Happy migrating!
|
||||
|
||||
You can now start adding new migrations to your migration directory and run <Link href="/cli/up/">`emigrate up`</Link> to apply them to your database.
|
||||
You can now start adding new migrations to your migration directory and run <Link href="/commands/up/">`emigrate up`</Link> to apply them to your database.
|
||||
Which should be part of your CD pipeline to ensure that your database schema is always up to date in each environment.
|
||||
|
|
|
|||
|
|
@ -7,14 +7,14 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
|
|||
import Link from '@components/Link.astro';
|
||||
|
||||
:::tip[Using Bun or Deno?]
|
||||
If you are using [Bun](https://bun.sh) or [Deno](https://deno.land) you are already good to go as they both support TypeScript out of the box!
|
||||
If you are using [Bun](https://bun.sh) or [Deno](https://deno.land) you are already good to go as they both support TypeScript out of the box.
|
||||
:::
|
||||
|
||||
If you're using NodeJS you have at least the two following options to support running TypeScript migration files in NodeJS.
|
||||
You have at least the two following options to support running TypeScript migration files in NodeJS.
|
||||
|
||||
## Using `tsx`
|
||||
|
||||
If you want to be able to write and run migration files written in TypeScript an easy way is to install the [`tsx`](https://github.com/privatenumber/tsx) package.
|
||||
If you want to be able to write and run migration files written in TypeScript the easiest way is to install the [`tsx`](https://github.com/privatenumber/tsx) package.
|
||||
|
||||
### Installing `tsx`
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ After installing `tsx` you can load it in two ways.
|
|||
|
||||
#### Via CLI
|
||||
|
||||
Using the <Link href="/cli/up/#-i---import-module">`--import`</Link> flag you can load `tsx` before running your migration files.
|
||||
Using the <Link href="/commands/up/#-i---import-module">`--import`</Link> flag you can load `tsx` before running your migration files.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
|
|
@ -67,13 +67,9 @@ Using the <Link href="/cli/up/#-i---import-module">`--import`</Link> flag you ca
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::note
|
||||
This method is necessary if you want to write your configuration file in TypeScript without having `typescript` installed in your production environment, as `tsx` must be loaded before the configuration file is loaded.
|
||||
:::
|
||||
|
||||
#### Via configuration file
|
||||
|
||||
You can also directly import `tsx` in your configuration file (will only work if you're not using TypeScript for your configuration file).
|
||||
You can also directly import `tsx` in your configuration file.
|
||||
|
||||
```js title="emigrate.config.js" {1}
|
||||
import 'tsx';
|
||||
|
|
|
|||
|
|
@ -3,13 +3,11 @@ title: "FAQ"
|
|||
description: "Frequently asked questions about Emigrate."
|
||||
---
|
||||
|
||||
import Link from '@components/Link.astro';
|
||||
|
||||
## Why no `down` migrations?
|
||||
|
||||
> Always forward never backwards.
|
||||
|
||||
Many other migration tools support `down` (or undo) migrations, but in all the years we have been
|
||||
Many other migration tools support `down` migrations, but in all the years we have been
|
||||
doing migrations we have never needed to rollback a migration in production,
|
||||
in that case we would just write a new migration to fix the problem.
|
||||
|
||||
|
|
@ -19,7 +17,3 @@ and in such case you just revert the migration manually and fix the `up` migrati
|
|||
The benefit of this is that you don't have to worry about writing `down` migrations, and you can focus on writing the `up` migrations.
|
||||
This way you will only ever have to write `down` migrations when they are really necessary instead of for every migration
|
||||
(which makes it the exception rather than the rule, which is closer to the truth).
|
||||
|
||||
## Can I use Emigrate with my existing database?
|
||||
|
||||
Yes, you can use Emigrate with an existing database. See the <Link href="/guides/baseline/">Baseline guide</Link> for more information.
|
||||
|
|
|
|||
|
|
@ -22,5 +22,5 @@ The generator is responsible for generating migration files in a specific format
|
|||
</CardGrid>
|
||||
|
||||
:::note
|
||||
Instead of having to install a generator plugin, you can also use the much simpler <Link href="/cli/new/#-t---template-path">`--template`</Link> option to specify a custom template file for new migrations.
|
||||
Instead of having to install a generator plugin, you can also use the much simpler <Link href="/commands/new/#-t---template-path">`--template`</Link> option to specify a custom template file for new migrations.
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -79,4 +79,4 @@ A <Link href="/plugins/generators/">generator plugin</Link> for generating new m
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
For more information see <Link href="/cli/new/">the `new` command</Link>'s documentation.
|
||||
For more information see <Link href="/commands/new/">the `new` command</Link>'s documentation.
|
||||
|
|
|
|||
|
|
@ -79,4 +79,4 @@ The MySQL generator creates new migration files with the `.sql` extension. In th
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
For more information see <Link href="/cli/new/">the `new` command</Link>'s documentation.
|
||||
For more information see <Link href="/commands/new/">the `new` command</Link>'s documentation.
|
||||
|
|
|
|||
|
|
@ -79,4 +79,4 @@ The PostgreSQL generator creates new migration files with the `.sql` extension.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
For more information see <Link href="/cli/new/">the `new` command</Link>'s documentation.
|
||||
For more information see <Link href="/commands/new/">the `new` command</Link>'s documentation.
|
||||
|
|
|
|||
23
docs/src/content/docs/plugins/reporters/default.mdx
Normal file
23
docs/src/content/docs/plugins/reporters/default.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Default Reporter
|
||||
---
|
||||
|
||||
Emigrate's default reporter. The default reporter recognizes if the current terminal is an interactive shell (or if it's a CI environment), if that's the case _no_ animations will be shown.
|
||||
|
||||
## Usage
|
||||
|
||||
By default, Emigrate uses the default reporter.
|
||||
|
||||
## Example output
|
||||
|
||||
```bash
|
||||
|
||||
Emigrate up v0.10.0 /Users/joakim/dev/@aboviq/test-emigrate (dry run)
|
||||
|
||||
1 pending migrations to run
|
||||
|
||||
› migration-folder/20231218135441244_create_some_table.sql (pending)
|
||||
|
||||
1 pending (1 total)
|
||||
|
||||
```
|
||||
|
|
@ -20,7 +20,6 @@ Or set it up in your configuration file, see <Link href="/reference/configuratio
|
|||
## Available Reporters
|
||||
|
||||
<CardGrid>
|
||||
<LinkCard title="Pretty Reporter" description="The default reporter" href="pretty/" />
|
||||
<LinkCard title="JSON Reporter" description="A built-in reporter for outputing a JSON object" href="json/" />
|
||||
<LinkCard title="Pino Reporter" description="A reporter package for outputting new line delimited JSON" href="pino/" />
|
||||
<LinkCard title="Default Reporter" href="default/" />
|
||||
<LinkCard title="Pino Reporter" href="pino/" />
|
||||
</CardGrid>
|
||||
|
|
|
|||
|
|
@ -1,102 +0,0 @@
|
|||
---
|
||||
title: JSON Reporter
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components';
|
||||
import Link from '@components/Link.astro';
|
||||
|
||||
An Emigrate reporter that outputs a JSON object.
|
||||
|
||||
The reporter is included by default and does not need to be installed separately.
|
||||
|
||||
## Usage
|
||||
|
||||
### Via CLI
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
```bash
|
||||
npx emigrate <command> --reporter json
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="pnpm">
|
||||
```bash
|
||||
pnpm emigrate <command> --reporter json
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="yarn">
|
||||
```bash
|
||||
yarn emigrate <command> --reporter json
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="bun">
|
||||
```bash
|
||||
bunx --bun emigrate <command> --reporter json
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="deno">
|
||||
```json title="package.json" {3}
|
||||
{
|
||||
"scripts": {
|
||||
"emigrate": "emigrate"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
deno task emigrate <command> --reporter json
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
See for instance the <Link href="/cli/up/#-r---reporter-name">Reporter Option</Link> for the `up` command for more information.
|
||||
|
||||
### Via configuration file
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="JavaScript">
|
||||
```js title="emigrate.config.js"
|
||||
/** @type {import('@emigrate/cli').EmigrateConfig} */
|
||||
export default {
|
||||
reporter: 'json',
|
||||
};
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="TypeScript">
|
||||
```ts title="emigrate.config.ts"
|
||||
import { type EmigrateConfig } from '@emigrate/cli';
|
||||
|
||||
const config: EmigrateConfig = {
|
||||
reporter: 'json',
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
See <Link href="/reference/configuration/#reporter">Reporter Configuration</Link> for more information.
|
||||
|
||||
## Example output
|
||||
|
||||
```json
|
||||
{
|
||||
"command": "up",
|
||||
"version": "0.17.2",
|
||||
"numberTotalMigrations": 1,
|
||||
"numberDoneMigrations": 0,
|
||||
"numberSkippedMigrations": 0,
|
||||
"numberFailedMigrations": 0,
|
||||
"numberPendingMigrations": 1,
|
||||
"success": true,
|
||||
"startTime": 1707206599968,
|
||||
"endTime": 1707206600005,
|
||||
"migrations": [
|
||||
{
|
||||
"name": "/your/project/migrations/20240206075446123_some_other_table.sql",
|
||||
"status": "pending",
|
||||
"duration": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
|
@ -87,31 +87,15 @@ The `@emigrate/reporter-` prefix is optional when using this reporter.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
See for instance the <Link href="/cli/up/#-r---reporter-name">Reporter Option</Link> for the `up` command for more information.
|
||||
See for instance the <Link href="/commands/up/#-r---reporter-name">Reporter Option</Link> for the `up` command for more information.
|
||||
|
||||
### Via configuration file
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="JavaScript">
|
||||
```js title="emigrate.config.js"
|
||||
/** @type {import('@emigrate/cli').EmigrateConfig} */
|
||||
export default {
|
||||
```js title="emigrate.config.js" {2}
|
||||
export default {
|
||||
reporter: 'pino',
|
||||
};
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="TypeScript">
|
||||
```ts title="emigrate.config.ts"
|
||||
import { type EmigrateConfig } from '@emigrate/cli';
|
||||
|
||||
const config: EmigrateConfig = {
|
||||
reporter: 'pino',
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
};
|
||||
```
|
||||
|
||||
See <Link href="/reference/configuration/#reporter">Reporter Configuration</Link> for more information.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,90 +0,0 @@
|
|||
---
|
||||
title: Pretty Reporter (default)
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components';
|
||||
import Link from '@components/Link.astro';
|
||||
|
||||
Emigrate's default reporter. It recognizes if the current terminal is an interactive shell (or if it's a CI environment), if that's the case _no_ animations will be shown.
|
||||
|
||||
The reporter is included by default and does not need to be installed separately.
|
||||
|
||||
## Usage
|
||||
|
||||
By default, Emigrate uses the "pretty" reporter, but it can also be explicitly set by using the <Link href="/cli/up/#-r---reporter-name">`--reporter`</Link> flag.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="npm">
|
||||
```bash
|
||||
npx emigrate <command> --reporter pretty
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="pnpm">
|
||||
```bash
|
||||
pnpm emigrate <command> --reporter pretty
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="yarn">
|
||||
```bash
|
||||
yarn emigrate <command> --reporter pretty
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="bun">
|
||||
```bash
|
||||
bunx --bun emigrate <command> --reporter pretty
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="deno">
|
||||
```json title="package.json" {3}
|
||||
{
|
||||
"scripts": {
|
||||
"emigrate": "emigrate"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
deno task emigrate <command> --reporter pretty
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
Or by setting it in the configuration file.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="JavaScript">
|
||||
```js title="emigrate.config.js"
|
||||
/** @type {import('@emigrate/cli').EmigrateConfig} */
|
||||
export default {
|
||||
reporter: 'pretty',
|
||||
};
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem label="TypeScript">
|
||||
```ts title="emigrate.config.ts"
|
||||
import { type EmigrateConfig } from '@emigrate/cli';
|
||||
|
||||
const config: EmigrateConfig = {
|
||||
reporter: 'pretty',
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
See <Link href="/reference/configuration/#reporter">Reporter Configuration</Link> for more information.
|
||||
|
||||
## Example output
|
||||
|
||||
```bash
|
||||
|
||||
Emigrate up v0.17.2 /your/working/directory (dry run)
|
||||
|
||||
1 pending migrations to run
|
||||
|
||||
› migration-folder/20231218135441244_create_some_table.sql (pending)
|
||||
|
||||
1 pending (1 total)
|
||||
|
||||
```
|
||||
|
|
@ -45,9 +45,9 @@ Set the directory where your migrations are located, relative to the project roo
|
|||
|
||||
### `reporter`
|
||||
|
||||
**type:** `"pretty" | "json" | string | EmigrateReporter | Promise<EmigrateReporter> | (() => Promise<EmigrateReporter>)`
|
||||
**type:** `string | EmigrateReporter | Promise<EmigrateReporter> | (() => Promise<EmigrateReporter>)`
|
||||
|
||||
**default:** `"pretty"` - the default reporter
|
||||
**default:** `"default"` - the default reporter
|
||||
|
||||
Set the reporter to use for the different commands. Specifying a <Link href="/plugins/reporters/">reporter</Link> is most useful in a CI or production environment where you either ship logs or want to have a machine-readable format.
|
||||
|
||||
|
|
@ -64,9 +64,6 @@ export default {
|
|||
up: {
|
||||
reporter: 'json',
|
||||
},
|
||||
new: {
|
||||
reporter: 'pretty', // Not really necessary, as it's the default
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
|
|
|
|||
21
package.json
21
package.json
|
|
@ -37,10 +37,9 @@
|
|||
"bugs": "https://github.com/aboviq/emigrate/issues",
|
||||
"license": "MIT",
|
||||
"volta": {
|
||||
"node": "22.15.0",
|
||||
"pnpm": "9.4.0"
|
||||
"node": "20.9.0",
|
||||
"pnpm": "8.10.2"
|
||||
},
|
||||
"packageManager": "pnpm@9.4.0",
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
},
|
||||
|
|
@ -62,10 +61,7 @@
|
|||
},
|
||||
"overrides": [
|
||||
{
|
||||
"files": [
|
||||
"packages/**/*.test.ts",
|
||||
"packages/**/*.integration.ts"
|
||||
],
|
||||
"files": "packages/**/*.test.ts",
|
||||
"rules": {
|
||||
"@typescript-eslint/no-floating-promises": 0,
|
||||
"max-params": 0
|
||||
|
|
@ -75,18 +71,17 @@
|
|||
},
|
||||
"dependencies": {
|
||||
"@changesets/cli": "2.27.1",
|
||||
"@commitlint/cli": "18.6.1",
|
||||
"@commitlint/config-conventional": "18.6.1",
|
||||
"@commitlint/cli": "18.4.3",
|
||||
"@commitlint/config-conventional": "18.4.3",
|
||||
"@types/node": "20.10.4",
|
||||
"glob": "10.3.10",
|
||||
"husky": "8.0.3",
|
||||
"lint-staged": "15.2.0",
|
||||
"npm-run-all": "4.1.5",
|
||||
"prettier": "3.1.1",
|
||||
"testcontainers": "10.24.2",
|
||||
"tsx": "4.15.7",
|
||||
"turbo": "2.0.5",
|
||||
"typescript": "5.5.2",
|
||||
"tsx": "4.7.0",
|
||||
"turbo": "1.10.16",
|
||||
"typescript": "5.3.3",
|
||||
"xo": "0.56.0"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,63 +1,5 @@
|
|||
# @emigrate/cli
|
||||
|
||||
## 0.18.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d779286: Upgrade TypeScript to v5.5 and enable [isolatedDeclarations](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations)
|
||||
- Updated dependencies [d779286]
|
||||
- @emigrate/plugin-tools@0.9.8
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.18.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/plugin-tools@0.9.7
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.18.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 4152209: Handle the case where the config is returned as an object with a nested `default` property
|
||||
|
||||
## 0.18.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 57a0991: Cleanup AbortSignal listeners when they are not needed to avoid MaxListenersExceededWarning when migrating many migrations at once
|
||||
|
||||
## 0.18.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- c838ffb: Make it possible to write the Emigrate configuration file in TypeScript and load it using `tsx` in a NodeJS environment by importing packages provided using the `--import` CLI option before loading the configuration file. This makes it possible to run Emigrate in production with a configuration file written in TypeScript without having the `typescript` package installed.
|
||||
- 18382ce: Add a built-in "json" reporter for outputting a single JSON object
|
||||
- 18382ce: Rename the "default" reporter to "pretty" and make it possible to specify it using the `--reporter` CLI option or in the configuration file
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- c838ffb: Don't use the `typescript` package for loading an Emigrate configuration file written in TypeScript in a Bun or Deno environment
|
||||
|
||||
## 0.17.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 61cbcbd: Force exiting after 10 seconds should not change the exit code, i.e. if all migrations have run successfully the exit code should be 0
|
||||
|
||||
## 0.17.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 543b7f6: Use setTimeout/setInterval from "node:timers" so that .unref() correctly works with Bun
|
||||
- db656c2: Enable NPM provenance
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/plugin-tools@0.9.6
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.17.0
|
||||
|
||||
### Minor Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/cli",
|
||||
"version": "0.18.4",
|
||||
"version": "0.17.0",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "",
|
||||
"type": "module",
|
||||
|
|
@ -19,8 +18,7 @@
|
|||
"emigrate": "dist/cli.js"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
|
|
@ -37,9 +35,7 @@
|
|||
"immigration"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@emigrate/tsconfig": "workspace:*",
|
||||
"@types/bun": "1.0.5",
|
||||
"bun-types": "1.0.26"
|
||||
"@emigrate/tsconfig": "workspace:*"
|
||||
},
|
||||
"author": "Aboviq AB <dev@aboviq.com> (https://www.aboviq.com)",
|
||||
"homepage": "https://github.com/aboviq/emigrate/tree/main/packages/cli#readme",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/usr/bin/env node
|
||||
import process from 'node:process';
|
||||
import { parseArgs } from 'node:util';
|
||||
import { setTimeout } from 'node:timers';
|
||||
import importFromEsm from 'import-from-esm';
|
||||
import { CommandAbortError, ShowUsageError } from './errors.js';
|
||||
import { getConfig } from './get-config.js';
|
||||
|
|
@ -24,6 +23,7 @@ const importAll = async (cwd: string, modules: string[]) => {
|
|||
};
|
||||
|
||||
const up: Action = async (args, abortSignal) => {
|
||||
const config = await getConfig('up');
|
||||
const { values } = parseArgs({
|
||||
args,
|
||||
options: {
|
||||
|
|
@ -103,7 +103,7 @@ Options:
|
|||
|
||||
-p, --plugin <name> The plugin(s) to use (can be specified multiple times)
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the migration progress (default: pretty)
|
||||
-r, --reporter <name> The reporter to use for reporting the migration progress
|
||||
|
||||
-l, --limit <count> Limit the number of migrations to run
|
||||
|
||||
|
|
@ -142,14 +142,6 @@ Examples:
|
|||
}
|
||||
|
||||
const cwd = process.cwd();
|
||||
|
||||
if (values.import) {
|
||||
await importAll(cwd, values.import);
|
||||
}
|
||||
|
||||
const forceImportTypeScriptAsIs = values.import?.some((module) => module === 'tsx' || module.startsWith('tsx/'));
|
||||
|
||||
const config = await getConfig('up', forceImportTypeScriptAsIs);
|
||||
const {
|
||||
directory = config.directory,
|
||||
storage = config.storage,
|
||||
|
|
@ -158,6 +150,7 @@ Examples:
|
|||
from,
|
||||
to,
|
||||
limit: limitString,
|
||||
import: imports = [],
|
||||
'abort-respite': abortRespiteString,
|
||||
'no-execution': noExecution,
|
||||
} = values;
|
||||
|
|
@ -183,6 +176,8 @@ Examples:
|
|||
return;
|
||||
}
|
||||
|
||||
await importAll(cwd, imports);
|
||||
|
||||
try {
|
||||
const { default: upCommand } = await import('./commands/up.js');
|
||||
process.exitCode = await upCommand({
|
||||
|
|
@ -213,6 +208,7 @@ Examples:
|
|||
};
|
||||
|
||||
const newMigration: Action = async (args) => {
|
||||
const config = await getConfig('new');
|
||||
const { values, positionals } = parseArgs({
|
||||
args,
|
||||
options: {
|
||||
|
|
@ -242,12 +238,6 @@ const newMigration: Action = async (args) => {
|
|||
multiple: true,
|
||||
default: [],
|
||||
},
|
||||
import: {
|
||||
type: 'string',
|
||||
short: 'i',
|
||||
multiple: true,
|
||||
default: [],
|
||||
},
|
||||
color: {
|
||||
type: 'boolean',
|
||||
},
|
||||
|
|
@ -269,24 +259,14 @@ Arguments:
|
|||
Options:
|
||||
|
||||
-h, --help Show this help message and exit
|
||||
|
||||
-d, --directory <path> The directory where the migration files are located (required)
|
||||
|
||||
-i, --import <module> Additional modules/packages to import before creating the migration (can be specified multiple times)
|
||||
For example if you want to use Dotenv to load environment variables or when using TypeScript
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the migration file creation progress (default: pretty)
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the migration file creation progress
|
||||
-p, --plugin <name> The plugin(s) to use (can be specified multiple times)
|
||||
|
||||
-t, --template <path> A template file to use as contents for the new migration file
|
||||
(if the extension option is not provided the template file's extension will be used)
|
||||
|
||||
-x, --extension <ext> The extension to use for the new migration file
|
||||
(if no template or plugin is provided an empty migration file will be created with the given extension)
|
||||
|
||||
--color Force color output (this option is passed to the reporter)
|
||||
|
||||
--no-color Disable color output (this option is passed to the reporter)
|
||||
|
||||
One of the --template, --extension or the --plugin options must be specified
|
||||
|
|
@ -306,14 +286,6 @@ Examples:
|
|||
}
|
||||
|
||||
const cwd = process.cwd();
|
||||
|
||||
if (values.import) {
|
||||
await importAll(cwd, values.import);
|
||||
}
|
||||
|
||||
const forceImportTypeScriptAsIs = values.import?.some((module) => module === 'tsx' || module.startsWith('tsx/'));
|
||||
|
||||
const config = await getConfig('new', forceImportTypeScriptAsIs);
|
||||
const {
|
||||
directory = config.directory,
|
||||
template = config.template,
|
||||
|
|
@ -339,6 +311,7 @@ Examples:
|
|||
};
|
||||
|
||||
const list: Action = async (args) => {
|
||||
const config = await getConfig('list');
|
||||
const { values } = parseArgs({
|
||||
args,
|
||||
options: {
|
||||
|
|
@ -381,18 +354,12 @@ List all migrations and their status. This command does not run any migrations.
|
|||
Options:
|
||||
|
||||
-h, --help Show this help message and exit
|
||||
|
||||
-d, --directory <path> The directory where the migration files are located (required)
|
||||
|
||||
-i, --import <module> Additional modules/packages to import before listing the migrations (can be specified multiple times)
|
||||
For example if you want to use Dotenv to load environment variables
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the migrations (default: pretty)
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the migrations
|
||||
-s, --storage <name> The storage to use to get the migration history (required)
|
||||
|
||||
--color Force color output (this option is passed to the reporter)
|
||||
|
||||
--no-color Disable color output (this option is passed to the reporter)
|
||||
|
||||
Examples:
|
||||
|
|
@ -408,15 +375,14 @@ Examples:
|
|||
}
|
||||
|
||||
const cwd = process.cwd();
|
||||
const {
|
||||
directory = config.directory,
|
||||
storage = config.storage,
|
||||
reporter = config.reporter,
|
||||
import: imports = [],
|
||||
} = values;
|
||||
|
||||
if (values.import) {
|
||||
await importAll(cwd, values.import);
|
||||
}
|
||||
|
||||
const forceImportTypeScriptAsIs = values.import?.some((module) => module === 'tsx' || module.startsWith('tsx/'));
|
||||
|
||||
const config = await getConfig('list', forceImportTypeScriptAsIs);
|
||||
const { directory = config.directory, storage = config.storage, reporter = config.reporter } = values;
|
||||
await importAll(cwd, imports);
|
||||
|
||||
try {
|
||||
const { default: listCommand } = await import('./commands/list.js');
|
||||
|
|
@ -434,6 +400,7 @@ Examples:
|
|||
};
|
||||
|
||||
const remove: Action = async (args) => {
|
||||
const config = await getConfig('remove');
|
||||
const { values, positionals } = parseArgs({
|
||||
args,
|
||||
options: {
|
||||
|
|
@ -485,20 +452,13 @@ Arguments:
|
|||
Options:
|
||||
|
||||
-h, --help Show this help message and exit
|
||||
|
||||
-d, --directory <path> The directory where the migration files are located (required)
|
||||
|
||||
-i, --import <module> Additional modules/packages to import before removing the migration (can be specified multiple times)
|
||||
For example if you want to use Dotenv to load environment variables
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the removal process (default: pretty)
|
||||
|
||||
-r, --reporter <name> The reporter to use for reporting the removal process
|
||||
-s, --storage <name> The storage to use to get the migration history (required)
|
||||
|
||||
-f, --force Force removal of the migration history entry even if the migration is not in a failed state
|
||||
|
||||
--color Force color output (this option is passed to the reporter)
|
||||
|
||||
--no-color Disable color output (this option is passed to the reporter)
|
||||
|
||||
Examples:
|
||||
|
|
@ -516,15 +476,15 @@ Examples:
|
|||
}
|
||||
|
||||
const cwd = process.cwd();
|
||||
const {
|
||||
directory = config.directory,
|
||||
storage = config.storage,
|
||||
reporter = config.reporter,
|
||||
force,
|
||||
import: imports = [],
|
||||
} = values;
|
||||
|
||||
if (values.import) {
|
||||
await importAll(cwd, values.import);
|
||||
}
|
||||
|
||||
const forceImportTypeScriptAsIs = values.import?.some((module) => module === 'tsx' || module.startsWith('tsx/'));
|
||||
|
||||
const config = await getConfig('remove', forceImportTypeScriptAsIs);
|
||||
const { directory = config.directory, storage = config.storage, reporter = config.reporter, force } = values;
|
||||
await importAll(cwd, imports);
|
||||
|
||||
try {
|
||||
const { default: removeCommand } = await import('./commands/remove.js');
|
||||
|
|
@ -641,5 +601,5 @@ await main(process.argv.slice(2), controller.signal);
|
|||
|
||||
setTimeout(() => {
|
||||
console.error('Process did not exit within 10 seconds, forcing exit');
|
||||
process.exit(process.exitCode);
|
||||
process.exit(1);
|
||||
}, 10_000).unref();
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
import { type MigrationHistoryEntry, type MigrationMetadata, type MigrationMetadataFinished } from '@emigrate/types';
|
||||
import { toMigrationMetadata } from './to-migration-metadata.js';
|
||||
import { getMigrations as getMigrationsOriginal, type GetMigrationsFunction } from './get-migrations.js';
|
||||
import { getMigrations as getMigrationsOriginal } from './get-migrations.js';
|
||||
|
||||
export async function* collectMigrations(
|
||||
cwd: string,
|
||||
directory: string,
|
||||
history: AsyncIterable<MigrationHistoryEntry>,
|
||||
getMigrations: GetMigrationsFunction = getMigrationsOriginal,
|
||||
getMigrations = getMigrationsOriginal,
|
||||
): AsyncIterable<MigrationMetadata | MigrationMetadataFinished> {
|
||||
const allMigrations = await getMigrations(cwd, directory);
|
||||
const seen = new Set<string>();
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ import { exec } from '../exec.js';
|
|||
import { migrationRunner } from '../migration-runner.js';
|
||||
import { collectMigrations } from '../collect-migrations.js';
|
||||
import { version } from '../get-package-info.js';
|
||||
import { getStandardReporter } from '../reporters/get.js';
|
||||
|
||||
const lazyDefaultReporter = async () => import('../reporters/default.js');
|
||||
|
||||
type ExtraFlags = {
|
||||
cwd: string;
|
||||
|
|
@ -17,7 +18,7 @@ export default async function listCommand({
|
|||
storage: storageConfig,
|
||||
color,
|
||||
cwd,
|
||||
}: Config & ExtraFlags): Promise<number> {
|
||||
}: Config & ExtraFlags) {
|
||||
if (!directory) {
|
||||
throw MissingOptionError.fromOption('directory');
|
||||
}
|
||||
|
|
@ -28,7 +29,7 @@ export default async function listCommand({
|
|||
throw BadOptionError.fromOption('storage', 'No storage found, please specify a storage using the storage option');
|
||||
}
|
||||
|
||||
const reporter = getStandardReporter(reporterConfig) ?? (await getOrLoadReporter([reporterConfig]));
|
||||
const reporter = await getOrLoadReporter([reporterConfig ?? lazyDefaultReporter]);
|
||||
|
||||
if (!reporter) {
|
||||
throw BadOptionError.fromOption(
|
||||
|
|
|
|||
|
|
@ -15,7 +15,8 @@ import { type Config } from '../types.js';
|
|||
import { withLeadingPeriod } from '../with-leading-period.js';
|
||||
import { version } from '../get-package-info.js';
|
||||
import { getDuration } from '../get-duration.js';
|
||||
import { getStandardReporter } from '../reporters/get.js';
|
||||
|
||||
const lazyDefaultReporter = async () => import('../reporters/default.js');
|
||||
|
||||
type ExtraFlags = {
|
||||
cwd: string;
|
||||
|
|
@ -24,7 +25,7 @@ type ExtraFlags = {
|
|||
export default async function newCommand(
|
||||
{ directory, template, reporter: reporterConfig, plugins = [], cwd, extension, color }: Config & ExtraFlags,
|
||||
name: string,
|
||||
): Promise<void> {
|
||||
) {
|
||||
if (!directory) {
|
||||
throw MissingOptionError.fromOption('directory');
|
||||
}
|
||||
|
|
@ -37,7 +38,7 @@ export default async function newCommand(
|
|||
throw MissingOptionError.fromOption(['extension', 'template', 'plugin']);
|
||||
}
|
||||
|
||||
const reporter = getStandardReporter(reporterConfig) ?? (await getOrLoadReporter([reporterConfig]));
|
||||
const reporter = await getOrLoadReporter([reporterConfig ?? lazyDefaultReporter]);
|
||||
|
||||
if (!reporter) {
|
||||
throw BadOptionError.fromOption(
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ import {
|
|||
StorageInitError,
|
||||
} from '../errors.js';
|
||||
import {
|
||||
assertErrorEqualEnough,
|
||||
getErrorCause,
|
||||
getMockedReporter,
|
||||
getMockedStorage,
|
||||
|
|
@ -200,11 +199,6 @@ function assertPreconditionsFailed(reporter: Mocked<Required<EmigrateReporter>>,
|
|||
assert.strictEqual(reporter.onMigrationSkip.mock.calls.length, 0, 'Total pending and skipped');
|
||||
assert.strictEqual(reporter.onFinished.mock.calls.length, 1, 'Finished called once');
|
||||
const [entries, error] = reporter.onFinished.mock.calls[0]?.arguments ?? [];
|
||||
// hackety hack:
|
||||
if (finishedError) {
|
||||
finishedError.stack = error?.stack;
|
||||
}
|
||||
|
||||
assert.deepStrictEqual(error, finishedError, 'Finished error');
|
||||
const cause = getErrorCause(error);
|
||||
const expectedCause = finishedError?.cause;
|
||||
|
|
@ -294,7 +288,14 @@ function assertPreconditionsFulfilled(
|
|||
assert.strictEqual(reporter.onMigrationSkip.mock.calls.length, 0, 'Total pending and skipped');
|
||||
assert.strictEqual(reporter.onFinished.mock.calls.length, 1, 'Finished called once');
|
||||
const [entries, error] = reporter.onFinished.mock.calls[0]?.arguments ?? [];
|
||||
assertErrorEqualEnough(error, finishedError, 'Finished error');
|
||||
assert.deepStrictEqual(error, finishedError, 'Finished error');
|
||||
const cause = getErrorCause(error);
|
||||
const expectedCause = finishedError?.cause;
|
||||
assert.deepStrictEqual(
|
||||
cause,
|
||||
expectedCause ? deserializeError(expectedCause) : expectedCause,
|
||||
'Finished error cause',
|
||||
);
|
||||
assert.strictEqual(entries?.length, expected.length, 'Finished entries length');
|
||||
assert.deepStrictEqual(
|
||||
entries.map((entry) => `${entry.name} (${entry.status})`),
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@ import { collectMigrations } from '../collect-migrations.js';
|
|||
import { migrationRunner } from '../migration-runner.js';
|
||||
import { arrayMapAsync } from '../array-map-async.js';
|
||||
import { type GetMigrationsFunction } from '../get-migrations.js';
|
||||
import { getStandardReporter } from '../reporters/get.js';
|
||||
|
||||
type ExtraFlags = {
|
||||
cwd: string;
|
||||
|
|
@ -28,6 +27,8 @@ type ExtraFlags = {
|
|||
|
||||
type RemovableMigrationMetadata = MigrationMetadata & { originalStatus?: 'done' | 'failed' };
|
||||
|
||||
const lazyDefaultReporter = async () => import('../reporters/default.js');
|
||||
|
||||
export default async function removeCommand(
|
||||
{
|
||||
directory,
|
||||
|
|
@ -39,7 +40,7 @@ export default async function removeCommand(
|
|||
getMigrations,
|
||||
}: Config & ExtraFlags,
|
||||
name: string,
|
||||
): Promise<number> {
|
||||
) {
|
||||
if (!directory) {
|
||||
throw MissingOptionError.fromOption('directory');
|
||||
}
|
||||
|
|
@ -54,7 +55,7 @@ export default async function removeCommand(
|
|||
throw BadOptionError.fromOption('storage', 'No storage found, please specify a storage using the storage option');
|
||||
}
|
||||
|
||||
const reporter = getStandardReporter(reporterConfig) ?? (await getOrLoadReporter([reporterConfig]));
|
||||
const reporter = await getOrLoadReporter([reporterConfig ?? lazyDefaultReporter]);
|
||||
|
||||
if (!reporter) {
|
||||
throw BadOptionError.fromOption(
|
||||
|
|
|
|||
|
|
@ -1,6 +1,13 @@
|
|||
import { describe, it, mock } from 'node:test';
|
||||
import assert from 'node:assert';
|
||||
import { type EmigrateReporter, type Storage, type Plugin, type MigrationMetadataFinished } from '@emigrate/types';
|
||||
import {
|
||||
type EmigrateReporter,
|
||||
type Storage,
|
||||
type Plugin,
|
||||
type SerializedError,
|
||||
type MigrationMetadataFinished,
|
||||
} from '@emigrate/types';
|
||||
import { deserializeError } from 'serialize-error';
|
||||
import { version } from '../get-package-info.js';
|
||||
import {
|
||||
BadOptionError,
|
||||
|
|
@ -9,6 +16,7 @@ import {
|
|||
MigrationHistoryError,
|
||||
MigrationRunError,
|
||||
StorageInitError,
|
||||
toSerializedError,
|
||||
} from '../errors.js';
|
||||
import {
|
||||
type Mocked,
|
||||
|
|
@ -16,7 +24,7 @@ import {
|
|||
toMigrations,
|
||||
getMockedReporter,
|
||||
getMockedStorage,
|
||||
assertErrorEqualEnough,
|
||||
getErrorCause,
|
||||
} from '../test-utils.js';
|
||||
import upCommand from './up.js';
|
||||
|
||||
|
|
@ -922,13 +930,15 @@ function assertPreconditionsFulfilled(
|
|||
for (const [index, entry] of failedEntries.entries()) {
|
||||
if (entry.status === 'failed') {
|
||||
const error = reporter.onMigrationError.mock.calls[index]?.arguments[1];
|
||||
assertErrorEqualEnough(error, entry.error, 'Error');
|
||||
assert.deepStrictEqual(error, entry.error, 'Error');
|
||||
const cause = entry.error?.cause;
|
||||
assert.deepStrictEqual(error?.cause, cause ? deserializeError(cause) : cause, 'Error cause');
|
||||
|
||||
if (entry.started) {
|
||||
const [finishedMigration, error] = storage.onError.mock.calls[index]?.arguments ?? [];
|
||||
assert.strictEqual(finishedMigration?.name, entry.name);
|
||||
assert.strictEqual(finishedMigration?.status, entry.status);
|
||||
assertErrorEqualEnough(error, entry.error, `Entry error (${entry.name})`);
|
||||
assertErrorEqualEnough(error, entry.error);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -936,7 +946,15 @@ function assertPreconditionsFulfilled(
|
|||
assert.strictEqual(reporter.onMigrationSkip.mock.calls.length, pending + skipped, 'Total pending and skipped');
|
||||
assert.strictEqual(reporter.onFinished.mock.calls.length, 1, 'Finished called once');
|
||||
const [entries, error] = reporter.onFinished.mock.calls[0]?.arguments ?? [];
|
||||
assertErrorEqualEnough(error, finishedError, 'Finished error');
|
||||
assertErrorEqualEnough(error, finishedError);
|
||||
|
||||
const cause = getErrorCause(error);
|
||||
const expectedCause = finishedError?.cause;
|
||||
assert.deepStrictEqual(
|
||||
cause,
|
||||
expectedCause ? deserializeError(expectedCause) : expectedCause,
|
||||
'Finished error cause',
|
||||
);
|
||||
assert.strictEqual(entries?.length, expected.length, 'Finished entries length');
|
||||
assert.deepStrictEqual(
|
||||
entries.map((entry) => `${entry.name} (${entry.status})`),
|
||||
|
|
@ -977,6 +995,33 @@ function assertPreconditionsFailed(
|
|||
assert.strictEqual(reporter.onMigrationSkip.mock.calls.length, 0, 'Total pending and skipped');
|
||||
assert.strictEqual(reporter.onFinished.mock.calls.length, 1, 'Finished called once');
|
||||
const [entries, error] = reporter.onFinished.mock.calls[0]?.arguments ?? [];
|
||||
assertErrorEqualEnough(error, finishedError, 'Finished error');
|
||||
assert.deepStrictEqual(error, finishedError, 'Finished error');
|
||||
const cause = getErrorCause(error);
|
||||
const expectedCause = finishedError?.cause;
|
||||
assert.deepStrictEqual(
|
||||
cause,
|
||||
expectedCause ? deserializeError(expectedCause) : expectedCause,
|
||||
'Finished error cause',
|
||||
);
|
||||
assert.strictEqual(entries?.length, 0, 'Finished entries length');
|
||||
}
|
||||
|
||||
function assertErrorEqualEnough(actual?: Error | SerializedError, expected?: Error) {
|
||||
if (expected === undefined) {
|
||||
assert.strictEqual(actual, undefined);
|
||||
return;
|
||||
}
|
||||
|
||||
const {
|
||||
cause: actualCause,
|
||||
stack: actualStack,
|
||||
...actualError
|
||||
} = actual instanceof Error ? toSerializedError(actual) : actual ?? {};
|
||||
const { cause: expectedCause, stack: expectedStack, ...expectedError } = toSerializedError(expected);
|
||||
// @ts-expect-error Ignore
|
||||
const { stack: actualCauseStack, ...actualCauseRest } = actualCause ?? {};
|
||||
// @ts-expect-error Ignore
|
||||
const { stack: expectedCauseStack, ...expectedCauseRest } = expectedCause ?? {};
|
||||
assert.deepStrictEqual(actualError, expectedError);
|
||||
assert.deepStrictEqual(actualCauseRest, expectedCauseRest);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@ import { exec } from '../exec.js';
|
|||
import { migrationRunner } from '../migration-runner.js';
|
||||
import { collectMigrations } from '../collect-migrations.js';
|
||||
import { version } from '../get-package-info.js';
|
||||
import { getStandardReporter } from '../reporters/get.js';
|
||||
|
||||
type ExtraFlags = {
|
||||
cwd: string;
|
||||
|
|
@ -30,6 +29,7 @@ type ExtraFlags = {
|
|||
abortRespite?: number;
|
||||
};
|
||||
|
||||
const lazyDefaultReporter = async () => import('../reporters/default.js');
|
||||
const lazyPluginLoaderJs = async () => import('../plugin-loader-js.js');
|
||||
|
||||
export default async function upCommand({
|
||||
|
|
@ -58,7 +58,7 @@ export default async function upCommand({
|
|||
throw BadOptionError.fromOption('storage', 'No storage found, please specify a storage using the storage option');
|
||||
}
|
||||
|
||||
const reporter = getStandardReporter(reporterConfig) ?? (await getOrLoadReporter([reporterConfig]));
|
||||
const reporter = await getOrLoadReporter([reporterConfig ?? lazyDefaultReporter]);
|
||||
|
||||
if (!reporter) {
|
||||
throw BadOptionError.fromOption(
|
||||
|
|
|
|||
6
packages/cli/src/deno.d.ts
vendored
6
packages/cli/src/deno.d.ts
vendored
|
|
@ -1,6 +0,0 @@
|
|||
declare global {
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||
const Deno: any;
|
||||
}
|
||||
|
||||
export {};
|
||||
|
|
@ -8,7 +8,7 @@ import { serializeError, errorConstructors, deserializeError } from 'serialize-e
|
|||
|
||||
const formatter = new Intl.ListFormat('en', { style: 'long', type: 'disjunction' });
|
||||
|
||||
export const toError = (error: unknown): Error => (error instanceof Error ? error : new Error(String(error)));
|
||||
export const toError = (error: unknown) => (error instanceof Error ? error : new Error(String(error)));
|
||||
|
||||
export const toSerializedError = (error: unknown) => {
|
||||
const errorInstance = toError(error);
|
||||
|
|
@ -30,7 +30,7 @@ export class EmigrateError extends Error {
|
|||
export class ShowUsageError extends EmigrateError {}
|
||||
|
||||
export class MissingOptionError extends ShowUsageError {
|
||||
static fromOption(option: string | string[]): MissingOptionError {
|
||||
static fromOption(option: string | string[]) {
|
||||
return new MissingOptionError(
|
||||
`Missing required option: ${Array.isArray(option) ? formatter.format(option) : option}`,
|
||||
undefined,
|
||||
|
|
@ -48,7 +48,7 @@ export class MissingOptionError extends ShowUsageError {
|
|||
}
|
||||
|
||||
export class MissingArgumentsError extends ShowUsageError {
|
||||
static fromArgument(argument: string): MissingArgumentsError {
|
||||
static fromArgument(argument: string) {
|
||||
return new MissingArgumentsError(`Missing required argument: ${argument}`, undefined, argument);
|
||||
}
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ export class MissingArgumentsError extends ShowUsageError {
|
|||
}
|
||||
|
||||
export class OptionNeededError extends ShowUsageError {
|
||||
static fromOption(option: string, message: string): OptionNeededError {
|
||||
static fromOption(option: string, message: string) {
|
||||
return new OptionNeededError(message, undefined, option);
|
||||
}
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ export class OptionNeededError extends ShowUsageError {
|
|||
}
|
||||
|
||||
export class BadOptionError extends ShowUsageError {
|
||||
static fromOption(option: string, message: string): BadOptionError {
|
||||
static fromOption(option: string, message: string) {
|
||||
return new BadOptionError(message, undefined, option);
|
||||
}
|
||||
|
||||
|
|
@ -96,7 +96,7 @@ export class UnexpectedError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class MigrationHistoryError extends EmigrateError {
|
||||
static fromHistoryEntry(entry: FailedMigrationHistoryEntry): MigrationHistoryError {
|
||||
static fromHistoryEntry(entry: FailedMigrationHistoryEntry) {
|
||||
return new MigrationHistoryError(`Migration ${entry.name} is in a failed state, it should be fixed and removed`, {
|
||||
cause: deserializeError(entry.error),
|
||||
});
|
||||
|
|
@ -108,7 +108,7 @@ export class MigrationHistoryError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class MigrationLoadError extends EmigrateError {
|
||||
static fromMetadata(metadata: MigrationMetadata, cause?: Error): MigrationLoadError {
|
||||
static fromMetadata(metadata: MigrationMetadata, cause?: Error) {
|
||||
return new MigrationLoadError(`Failed to load migration file: ${metadata.relativeFilePath}`, { cause });
|
||||
}
|
||||
|
||||
|
|
@ -118,7 +118,7 @@ export class MigrationLoadError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class MigrationRunError extends EmigrateError {
|
||||
static fromMetadata(metadata: FailedMigrationMetadata): MigrationRunError {
|
||||
static fromMetadata(metadata: FailedMigrationMetadata) {
|
||||
return new MigrationRunError(`Failed to run migration: ${metadata.relativeFilePath}`, { cause: metadata.error });
|
||||
}
|
||||
|
||||
|
|
@ -128,7 +128,7 @@ export class MigrationRunError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class MigrationNotRunError extends EmigrateError {
|
||||
static fromMetadata(metadata: MigrationMetadata, cause?: Error): MigrationNotRunError {
|
||||
static fromMetadata(metadata: MigrationMetadata, cause?: Error) {
|
||||
return new MigrationNotRunError(`Migration "${metadata.name}" is not in the migration history`, { cause });
|
||||
}
|
||||
|
||||
|
|
@ -138,7 +138,7 @@ export class MigrationNotRunError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class MigrationRemovalError extends EmigrateError {
|
||||
static fromMetadata(metadata: MigrationMetadata, cause?: Error): MigrationRemovalError {
|
||||
static fromMetadata(metadata: MigrationMetadata, cause?: Error) {
|
||||
return new MigrationRemovalError(`Failed to remove migration: ${metadata.relativeFilePath}`, { cause });
|
||||
}
|
||||
|
||||
|
|
@ -148,7 +148,7 @@ export class MigrationRemovalError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class StorageInitError extends EmigrateError {
|
||||
static fromError(error: Error): StorageInitError {
|
||||
static fromError(error: Error) {
|
||||
return new StorageInitError('Could not initialize storage', { cause: error });
|
||||
}
|
||||
|
||||
|
|
@ -158,11 +158,11 @@ export class StorageInitError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class CommandAbortError extends EmigrateError {
|
||||
static fromSignal(signal: NodeJS.Signals): CommandAbortError {
|
||||
static fromSignal(signal: NodeJS.Signals) {
|
||||
return new CommandAbortError(`Command aborted due to signal: ${signal}`);
|
||||
}
|
||||
|
||||
static fromReason(reason: string, cause?: unknown): CommandAbortError {
|
||||
static fromReason(reason: string, cause?: unknown) {
|
||||
return new CommandAbortError(`Command aborted: ${reason}`, { cause });
|
||||
}
|
||||
|
||||
|
|
@ -172,7 +172,7 @@ export class CommandAbortError extends EmigrateError {
|
|||
}
|
||||
|
||||
export class ExecutionDesertedError extends EmigrateError {
|
||||
static fromReason(reason: string, cause?: Error): ExecutionDesertedError {
|
||||
static fromReason(reason: string, cause?: Error) {
|
||||
return new ExecutionDesertedError(`Execution deserted: ${reason}`, { cause });
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
import { setTimeout } from 'node:timers';
|
||||
import prettyMs from 'pretty-ms';
|
||||
import { ExecutionDesertedError, toError } from './errors.js';
|
||||
import { DEFAULT_RESPITE_SECONDS } from './defaults.js';
|
||||
|
|
@ -28,8 +27,6 @@ export const exec = async <Return extends Promise<any>>(
|
|||
const aborter = options.abortSignal ? getAborter(options.abortSignal, options.abortRespite) : undefined;
|
||||
const result = await Promise.race(aborter ? [aborter, fn()] : [fn()]);
|
||||
|
||||
aborter?.cancel();
|
||||
|
||||
return [result, undefined];
|
||||
} catch (error) {
|
||||
return [undefined, toError(error)];
|
||||
|
|
@ -42,44 +39,27 @@ export const exec = async <Return extends Promise<any>>(
|
|||
* @param signal The abort signal to listen to
|
||||
* @param respite The time in milliseconds to wait before rejecting
|
||||
*/
|
||||
const getAborter = (
|
||||
signal: AbortSignal,
|
||||
respite = DEFAULT_RESPITE_SECONDS * 1000,
|
||||
): PromiseLike<never> & { cancel: () => void } => {
|
||||
const cleanups: Array<() => void> = [];
|
||||
|
||||
const aborter = new Promise<never>((_, reject) => {
|
||||
const abortListener = () => {
|
||||
const timer = setTimeout(
|
||||
const getAborter = async (signal: AbortSignal, respite = DEFAULT_RESPITE_SECONDS * 1000): Promise<never> => {
|
||||
return new Promise((_, reject) => {
|
||||
if (signal.aborted) {
|
||||
setTimeout(
|
||||
reject,
|
||||
respite,
|
||||
ExecutionDesertedError.fromReason(`Deserted after ${prettyMs(respite)}`, toError(signal.reason)),
|
||||
);
|
||||
timer.unref();
|
||||
cleanups.push(() => {
|
||||
clearTimeout(timer);
|
||||
});
|
||||
};
|
||||
|
||||
if (signal.aborted) {
|
||||
abortListener();
|
||||
).unref();
|
||||
return;
|
||||
}
|
||||
|
||||
signal.addEventListener('abort', abortListener, { once: true });
|
||||
|
||||
cleanups.push(() => {
|
||||
signal.removeEventListener('abort', abortListener);
|
||||
signal.addEventListener(
|
||||
'abort',
|
||||
() => {
|
||||
setTimeout(
|
||||
reject,
|
||||
respite,
|
||||
ExecutionDesertedError.fromReason(`Deserted after ${prettyMs(respite)}`, toError(signal.reason)),
|
||||
).unref();
|
||||
},
|
||||
{ once: true },
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
const cancel = () => {
|
||||
for (const cleanup of cleanups) {
|
||||
cleanup();
|
||||
}
|
||||
|
||||
cleanups.length = 0;
|
||||
};
|
||||
|
||||
return Object.assign(aborter, { cancel });
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,28 +1,11 @@
|
|||
import process from 'node:process';
|
||||
import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
|
||||
import { cosmiconfig } from 'cosmiconfig';
|
||||
import { type Config, type EmigrateConfig } from './types.js';
|
||||
|
||||
const commands = ['up', 'list', 'new', 'remove'] as const;
|
||||
type Command = (typeof commands)[number];
|
||||
const canImportTypeScriptAsIs = Boolean(process.isBun) || typeof Deno !== 'undefined';
|
||||
|
||||
const getEmigrateConfig = (config: any): EmigrateConfig => {
|
||||
if ('default' in config && typeof config.default === 'object' && config.default !== null) {
|
||||
return config.default as EmigrateConfig;
|
||||
}
|
||||
|
||||
if (typeof config === 'object' && config !== null) {
|
||||
return config as EmigrateConfig;
|
||||
}
|
||||
|
||||
return {};
|
||||
};
|
||||
|
||||
export const getConfig = async (command: Command, forceImportTypeScriptAsIs = false): Promise<Config> => {
|
||||
const explorer = cosmiconfig('emigrate', {
|
||||
// eslint-disable-next-line @typescript-eslint/naming-convention
|
||||
loaders: forceImportTypeScriptAsIs || canImportTypeScriptAsIs ? { '.ts': defaultLoaders['.js'] } : undefined,
|
||||
});
|
||||
export const getConfig = async (command: Command): Promise<Config> => {
|
||||
const explorer = cosmiconfig('emigrate');
|
||||
|
||||
const result = await explorer.search();
|
||||
|
||||
|
|
@ -30,7 +13,7 @@ export const getConfig = async (command: Command, forceImportTypeScriptAsIs = fa
|
|||
return {};
|
||||
}
|
||||
|
||||
const config = getEmigrateConfig(result.config);
|
||||
const config = result.config as EmigrateConfig;
|
||||
|
||||
const commandConfig = config[command];
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import process from 'node:process';
|
||||
|
||||
export const getDuration = (start: [number, number]): number => {
|
||||
export const getDuration = (start: [number, number]) => {
|
||||
const [seconds, nanoseconds] = process.hrtime(start);
|
||||
return seconds * 1000 + nanoseconds / 1_000_000;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -39,6 +39,6 @@ export const getMigrations = async (cwd: string, directory: string): Promise<Mig
|
|||
extension: withLeadingPeriod(path.extname(name)),
|
||||
directory,
|
||||
cwd,
|
||||
};
|
||||
} satisfies MigrationMetadata;
|
||||
});
|
||||
};
|
||||
|
|
|
|||
|
|
@ -28,7 +28,4 @@ const getPackageInfo = async () => {
|
|||
throw new UnexpectedError(`Could not read package info from: ${packageInfoPath}`);
|
||||
};
|
||||
|
||||
const packageInfo = await getPackageInfo();
|
||||
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const version: string = packageInfo.version;
|
||||
export const { version } = await getPackageInfo();
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
export * from './types.js';
|
||||
|
||||
export const emigrate = (): void => {
|
||||
export const emigrate = () => {
|
||||
// console.log('Done!');
|
||||
};
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
import { setInterval } from 'node:timers';
|
||||
import { black, blueBright, bold, cyan, dim, faint, gray, green, red, redBright, yellow, yellowBright } from 'ansis';
|
||||
import logUpdate from 'log-update';
|
||||
import elegantSpinner from 'elegant-spinner';
|
||||
|
|
@ -471,6 +470,6 @@ class DefaultReporter implements Required<EmigrateReporter> {
|
|||
}
|
||||
}
|
||||
|
||||
const reporterDefault: EmigrateReporter = interactive ? new DefaultFancyReporter() : new DefaultReporter();
|
||||
const reporterDefault = interactive ? new DefaultFancyReporter() : new DefaultReporter();
|
||||
|
||||
export default reporterDefault;
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
import type { EmigrateReporter } from '@emigrate/types';
|
||||
import { type Config } from '../types.js';
|
||||
import * as reporters from './index.js';
|
||||
|
||||
export const getStandardReporter = (reporter?: Config['reporter']): EmigrateReporter | undefined => {
|
||||
if (!reporter) {
|
||||
return reporters.pretty;
|
||||
}
|
||||
|
||||
if (typeof reporter === 'string' && reporter in reporters) {
|
||||
return reporters[reporter as keyof typeof reporters];
|
||||
}
|
||||
|
||||
return undefined;
|
||||
};
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
export { default as pretty } from './default.js';
|
||||
export { default as json } from './json.js';
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
import { type ReporterInitParameters, type EmigrateReporter, type MigrationMetadataFinished } from '@emigrate/types';
|
||||
import { toSerializedError } from '../errors.js';
|
||||
|
||||
class JsonReporter implements EmigrateReporter {
|
||||
#parameters!: ReporterInitParameters;
|
||||
#startTime!: number;
|
||||
|
||||
onInit(parameters: ReporterInitParameters): void {
|
||||
this.#startTime = Date.now();
|
||||
this.#parameters = parameters;
|
||||
}
|
||||
|
||||
onFinished(migrations: MigrationMetadataFinished[], error?: Error | undefined): void {
|
||||
const { command, version } = this.#parameters;
|
||||
|
||||
let numberDoneMigrations = 0;
|
||||
let numberSkippedMigrations = 0;
|
||||
let numberFailedMigrations = 0;
|
||||
let numberPendingMigrations = 0;
|
||||
|
||||
for (const migration of migrations) {
|
||||
// eslint-disable-next-line unicorn/prefer-switch
|
||||
if (migration.status === 'done') {
|
||||
numberDoneMigrations++;
|
||||
} else if (migration.status === 'skipped') {
|
||||
numberSkippedMigrations++;
|
||||
} else if (migration.status === 'failed') {
|
||||
numberFailedMigrations++;
|
||||
} else {
|
||||
numberPendingMigrations++;
|
||||
}
|
||||
}
|
||||
|
||||
const result = {
|
||||
command,
|
||||
version,
|
||||
numberTotalMigrations: migrations.length,
|
||||
numberDoneMigrations,
|
||||
numberSkippedMigrations,
|
||||
numberFailedMigrations,
|
||||
numberPendingMigrations,
|
||||
success: !error,
|
||||
startTime: this.#startTime,
|
||||
endTime: Date.now(),
|
||||
error: error ? toSerializedError(error) : undefined,
|
||||
migrations: migrations.map((migration) => ({
|
||||
name: migration.filePath,
|
||||
status: migration.status,
|
||||
duration: 'duration' in migration ? migration.duration : 0,
|
||||
error: 'error' in migration ? toSerializedError(migration.error) : undefined,
|
||||
})),
|
||||
};
|
||||
|
||||
console.log(JSON.stringify(result, undefined, 2));
|
||||
}
|
||||
}
|
||||
|
||||
const jsonReporter: EmigrateReporter = new JsonReporter();
|
||||
|
||||
export default jsonReporter;
|
||||
|
|
@ -1,6 +1,5 @@
|
|||
import { mock, type Mock } from 'node:test';
|
||||
import path from 'node:path';
|
||||
import assert from 'node:assert';
|
||||
import {
|
||||
type SerializedError,
|
||||
type EmigrateReporter,
|
||||
|
|
@ -10,14 +9,13 @@ import {
|
|||
type NonFailedMigrationHistoryEntry,
|
||||
type Storage,
|
||||
} from '@emigrate/types';
|
||||
import { toSerializedError } from './errors.js';
|
||||
|
||||
export type Mocked<T> = {
|
||||
// @ts-expect-error - This is a mock
|
||||
[K in keyof T]: Mock<T[K]>;
|
||||
};
|
||||
|
||||
export async function noop(): Promise<void> {
|
||||
export async function noop() {
|
||||
// noop
|
||||
}
|
||||
|
||||
|
|
@ -33,8 +31,8 @@ export function getErrorCause(error: Error | undefined): Error | SerializedError
|
|||
return undefined;
|
||||
}
|
||||
|
||||
export function getMockedStorage(historyEntries: Array<string | MigrationHistoryEntry>): Mocked<Storage> {
|
||||
return {
|
||||
export function getMockedStorage(historyEntries: Array<string | MigrationHistoryEntry>) {
|
||||
const storage: Mocked<Storage> = {
|
||||
lock: mock.fn(async (migrations) => migrations),
|
||||
unlock: mock.fn(async () => {
|
||||
// void
|
||||
|
|
@ -47,6 +45,8 @@ export function getMockedStorage(historyEntries: Array<string | MigrationHistory
|
|||
onError: mock.fn(),
|
||||
end: mock.fn(),
|
||||
};
|
||||
|
||||
return storage;
|
||||
}
|
||||
|
||||
export function getMockedReporter(): Mocked<Required<EmigrateReporter>> {
|
||||
|
|
@ -112,23 +112,3 @@ export function toEntries(
|
|||
): MigrationHistoryEntry[] {
|
||||
return names.map((name) => (typeof name === 'string' ? toEntry(name, status) : name));
|
||||
}
|
||||
|
||||
export function assertErrorEqualEnough(actual?: Error | SerializedError, expected?: Error, message?: string): void {
|
||||
if (expected === undefined) {
|
||||
assert.strictEqual(actual, undefined);
|
||||
return;
|
||||
}
|
||||
|
||||
const {
|
||||
cause: actualCause,
|
||||
stack: actualStack,
|
||||
...actualError
|
||||
} = actual instanceof Error ? toSerializedError(actual) : actual ?? {};
|
||||
const { cause: expectedCause, stack: expectedStack, ...expectedError } = toSerializedError(expected);
|
||||
// @ts-expect-error Ignore
|
||||
const { stack: actualCauseStack, ...actualCauseRest } = actualCause ?? {};
|
||||
// @ts-expect-error Ignore
|
||||
const { stack: expectedCauseStack, ...expectedCauseRest } = expectedCause ?? {};
|
||||
assert.deepStrictEqual(actualError, expectedError, message);
|
||||
assert.deepStrictEqual(actualCauseRest, expectedCauseRest, message ? `${message} (cause)` : undefined);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,4 @@
|
|||
import { type EmigrateStorage, type Awaitable, type Plugin, type EmigrateReporter } from '@emigrate/types';
|
||||
import type * as reporters from './reporters/index.js';
|
||||
|
||||
export type StandardReporter = keyof typeof reporters;
|
||||
|
||||
export type EmigratePlugin = Plugin;
|
||||
|
||||
|
|
@ -9,7 +6,7 @@ type StringOrModule<T> = string | T | (() => Awaitable<T>) | (() => Awaitable<{
|
|||
|
||||
export type Config = {
|
||||
storage?: StringOrModule<EmigrateStorage>;
|
||||
reporter?: StandardReporter | StringOrModule<EmigrateReporter>;
|
||||
reporter?: StringOrModule<EmigrateReporter>;
|
||||
plugins?: Array<StringOrModule<EmigratePlugin>>;
|
||||
directory?: string;
|
||||
template?: string;
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
export const withLeadingPeriod = (string: string): string => (string.startsWith('.') ? string : `.${string}`);
|
||||
export const withLeadingPeriod = (string: string) => (string.startsWith('.') ? string : `.${string}`);
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,62 +1,5 @@
|
|||
# @emigrate/mysql
|
||||
|
||||
## 0.3.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 26240f4: Make sure we can initialize multiple running instances of Emigrate using @emigrate/mysql concurrently without issues with creating the history table (for instance in a Kubernetes environment and/or with a Percona cluster).
|
||||
- d779286: Upgrade TypeScript to v5.5 and enable [isolatedDeclarations](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations)
|
||||
- 26240f4: Either lock all or none of the migrations to run to make sure they run in order when multiple instances of Emigrate runs concurrently (for instance in a Kubernetes environment)
|
||||
- Updated dependencies [d779286]
|
||||
- @emigrate/plugin-tools@0.9.8
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.3.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 57498db: Unreference all connections when run using Bun, to not keep the process open unnecessarily long
|
||||
|
||||
## 0.3.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/plugin-tools@0.9.7
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 4442604: Automatically create the database if it doesn't exist, and the user have the permissions to do so
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- aef2d7c: Avoid "CREATE TABLE IF NOT EXISTS" as it's too locking in a clustered database when running it concurrently
|
||||
|
||||
## 0.2.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 17feb2d: Only unreference connections in a Bun environment as it crashes Node for some reason, without even throwing an error that is
|
||||
|
||||
## 0.2.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 198aa54: Unreference all connections automatically so that they don't hinder the process from exiting. This is especially needed in Bun environments as it seems to handle sockets differently regarding this matter than NodeJS.
|
||||
|
||||
## 0.2.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/plugin-tools@0.9.6
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.2.5
|
||||
|
||||
### Patch Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/mysql",
|
||||
"version": "0.3.3",
|
||||
"version": "0.2.5",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "A MySQL plugin for Emigrate. Uses a MySQL database for storing migration history. Can load and generate .sql migration files.",
|
||||
"main": "dist/index.js",
|
||||
|
|
@ -16,17 +15,12 @@
|
|||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo",
|
||||
"!dist/**/*.test.js",
|
||||
"!dist/tests/*"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
"build:watch": "tsc --pretty --watch",
|
||||
"lint": "xo --cwd=../.. $(pwd)",
|
||||
"integration": "glob -c \"node --import tsx --test-reporter spec --test\" \"./src/**/*.integration.ts\"",
|
||||
"integration:watch": "glob -c \"node --watch --import tsx --test-reporter spec --test\" \"./src/**/*.integration.ts\""
|
||||
"lint": "xo --cwd=../.. $(pwd)"
|
||||
},
|
||||
"keywords": [
|
||||
"emigrate",
|
||||
|
|
@ -48,9 +42,7 @@
|
|||
"mysql2": "3.6.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@emigrate/tsconfig": "workspace:*",
|
||||
"@types/bun": "1.1.2",
|
||||
"bun-types": "1.1.8"
|
||||
"@emigrate/tsconfig": "workspace:*"
|
||||
},
|
||||
"volta": {
|
||||
"extends": "../../package.json"
|
||||
|
|
|
|||
|
|
@ -1,103 +0,0 @@
|
|||
import assert from 'node:assert';
|
||||
import path from 'node:path';
|
||||
import { before, after, describe, it } from 'node:test';
|
||||
import type { MigrationMetadata } from '@emigrate/types';
|
||||
import { startDatabase, stopDatabase } from './tests/database.js';
|
||||
import { createMysqlStorage } from './index.js';
|
||||
|
||||
let db: { port: number; host: string };
|
||||
|
||||
const toEnd = new Set<{ end: () => Promise<void> }>();
|
||||
|
||||
describe('emigrate-mysql', async () => {
|
||||
before(
|
||||
async () => {
|
||||
db = await startDatabase();
|
||||
},
|
||||
{ timeout: 60_000 },
|
||||
);
|
||||
|
||||
after(
|
||||
async () => {
|
||||
for (const storage of toEnd) {
|
||||
// eslint-disable-next-line no-await-in-loop
|
||||
await storage.end();
|
||||
}
|
||||
|
||||
toEnd.clear();
|
||||
await stopDatabase();
|
||||
},
|
||||
{ timeout: 10_000 },
|
||||
);
|
||||
|
||||
describe('migration locks', async () => {
|
||||
it('either locks none or all of the given migrations', async () => {
|
||||
const { initializeStorage } = createMysqlStorage({
|
||||
table: 'migrations',
|
||||
connection: {
|
||||
host: db.host,
|
||||
user: 'emigrate',
|
||||
password: 'emigrate',
|
||||
database: 'emigrate',
|
||||
port: db.port,
|
||||
},
|
||||
});
|
||||
|
||||
const [storage1, storage2] = await Promise.all([initializeStorage(), initializeStorage()]);
|
||||
|
||||
toEnd.add(storage1);
|
||||
toEnd.add(storage2);
|
||||
|
||||
const migrations = toMigrations('/emigrate', 'migrations', [
|
||||
'2023-10-01-01-test.js',
|
||||
'2023-10-01-02-test.js',
|
||||
'2023-10-01-03-test.js',
|
||||
'2023-10-01-04-test.js',
|
||||
'2023-10-01-05-test.js',
|
||||
'2023-10-01-06-test.js',
|
||||
'2023-10-01-07-test.js',
|
||||
'2023-10-01-08-test.js',
|
||||
'2023-10-01-09-test.js',
|
||||
'2023-10-01-10-test.js',
|
||||
'2023-10-01-11-test.js',
|
||||
'2023-10-01-12-test.js',
|
||||
'2023-10-01-13-test.js',
|
||||
'2023-10-01-14-test.js',
|
||||
'2023-10-01-15-test.js',
|
||||
'2023-10-01-16-test.js',
|
||||
'2023-10-01-17-test.js',
|
||||
'2023-10-01-18-test.js',
|
||||
'2023-10-01-19-test.js',
|
||||
'2023-10-01-20-test.js',
|
||||
]);
|
||||
|
||||
const [locked1, locked2] = await Promise.all([storage1.lock(migrations), storage2.lock(migrations)]);
|
||||
|
||||
assert.strictEqual(
|
||||
locked1.length === 0 || locked2.length === 0,
|
||||
true,
|
||||
'One of the processes should have no locks',
|
||||
);
|
||||
assert.strictEqual(
|
||||
locked1.length === 20 || locked2.length === 20,
|
||||
true,
|
||||
'One of the processes should have all locks',
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
function toMigration(cwd: string, directory: string, name: string): MigrationMetadata {
|
||||
return {
|
||||
name,
|
||||
filePath: `${cwd}/${directory}/${name}`,
|
||||
relativeFilePath: `${directory}/${name}`,
|
||||
extension: path.extname(name),
|
||||
directory,
|
||||
cwd,
|
||||
};
|
||||
}
|
||||
|
||||
function toMigrations(cwd: string, directory: string, names: string[]): MigrationMetadata[] {
|
||||
return names.map((name) => toMigration(cwd, directory, name));
|
||||
}
|
||||
|
|
@ -1,6 +1,5 @@
|
|||
import process from 'node:process';
|
||||
import fs from 'node:fs/promises';
|
||||
import { setTimeout } from 'node:timers/promises';
|
||||
import {
|
||||
createConnection,
|
||||
createPool,
|
||||
|
|
@ -10,13 +9,10 @@ import {
|
|||
type Pool,
|
||||
type ResultSetHeader,
|
||||
type RowDataPacket,
|
||||
type Connection,
|
||||
} from 'mysql2/promise';
|
||||
import { getTimestampPrefix, sanitizeMigrationName } from '@emigrate/plugin-tools';
|
||||
import {
|
||||
type Awaitable,
|
||||
type MigrationMetadata,
|
||||
type MigrationFunction,
|
||||
type EmigrateStorage,
|
||||
type LoaderPlugin,
|
||||
type Storage,
|
||||
|
|
@ -44,39 +40,27 @@ export type MysqlLoaderOptions = {
|
|||
connection: ConnectionOptions | string;
|
||||
};
|
||||
|
||||
const getConnection = async (options: ConnectionOptions | string) => {
|
||||
let connection: Connection;
|
||||
|
||||
if (typeof options === 'string') {
|
||||
const uri = new URL(options);
|
||||
const getConnection = async (connection: ConnectionOptions | string) => {
|
||||
if (typeof connection === 'string') {
|
||||
const uri = new URL(connection);
|
||||
|
||||
// client side connectTimeout is unstable in mysql2 library
|
||||
// it throws an error you can't catch and crashes node
|
||||
// best to leave this at 0 (disabled)
|
||||
uri.searchParams.set('connectTimeout', '0');
|
||||
uri.searchParams.set('multipleStatements', 'true');
|
||||
uri.searchParams.set('flags', '-FOUND_ROWS');
|
||||
|
||||
connection = await createConnection(uri.toString());
|
||||
} else {
|
||||
connection = await createConnection({
|
||||
...options,
|
||||
return createConnection(uri.toString());
|
||||
}
|
||||
|
||||
return createConnection({
|
||||
...connection,
|
||||
// client side connectTimeout is unstable in mysql2 library
|
||||
// it throws an error you can't catch and crashes node
|
||||
// best to leave this at 0 (disabled)
|
||||
connectTimeout: 0,
|
||||
multipleStatements: true,
|
||||
flags: ['-FOUND_ROWS'],
|
||||
});
|
||||
}
|
||||
|
||||
if (process.isBun) {
|
||||
// @ts-expect-error the connection is not in the types but it's there
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
|
||||
connection.connection.stream.unref();
|
||||
}
|
||||
|
||||
return connection;
|
||||
};
|
||||
|
||||
const getPool = (connection: PoolOptions | string) => {
|
||||
|
|
@ -87,7 +71,6 @@ const getPool = (connection: PoolOptions | string) => {
|
|||
// it throws an error you can't catch and crashes node
|
||||
// best to leave this at 0 (disabled)
|
||||
uri.searchParams.set('connectTimeout', '0');
|
||||
uri.searchParams.set('flags', '-FOUND_ROWS');
|
||||
|
||||
return createPool(uri.toString());
|
||||
}
|
||||
|
|
@ -98,7 +81,6 @@ const getPool = (connection: PoolOptions | string) => {
|
|||
// it throws an error you can't catch and crashes node
|
||||
// best to leave this at 0 (disabled)
|
||||
connectTimeout: 0,
|
||||
flags: ['-FOUND_ROWS'],
|
||||
});
|
||||
};
|
||||
|
||||
|
|
@ -109,8 +91,8 @@ type HistoryEntry = {
|
|||
error?: SerializedError;
|
||||
};
|
||||
|
||||
const lockMigration = async (connection: Connection, table: string, migration: MigrationMetadata) => {
|
||||
const [result] = await connection.execute<ResultSetHeader>({
|
||||
const lockMigration = async (pool: Pool, table: string, migration: MigrationMetadata) => {
|
||||
const [result] = await pool.execute<ResultSetHeader>({
|
||||
sql: `
|
||||
INSERT INTO ${escapeId(table)} (name, status, date)
|
||||
VALUES (?, ?, NOW())
|
||||
|
|
@ -173,186 +155,42 @@ const deleteMigration = async (pool: Pool, table: string, migration: MigrationMe
|
|||
return result.affectedRows === 1;
|
||||
};
|
||||
|
||||
const getDatabaseName = (config: ConnectionOptions | string) => {
|
||||
if (typeof config === 'string') {
|
||||
const uri = new URL(config);
|
||||
|
||||
return uri.pathname.replace(/^\//u, '');
|
||||
}
|
||||
|
||||
return config.database ?? '';
|
||||
};
|
||||
|
||||
const setDatabaseName = <T extends ConnectionOptions | string>(config: T, databaseName: string): T => {
|
||||
if (typeof config === 'string') {
|
||||
const uri = new URL(config);
|
||||
|
||||
uri.pathname = `/${databaseName}`;
|
||||
|
||||
return uri.toString() as T;
|
||||
}
|
||||
|
||||
if (typeof config === 'object') {
|
||||
return {
|
||||
...config,
|
||||
database: databaseName,
|
||||
};
|
||||
}
|
||||
|
||||
throw new Error('Invalid connection config');
|
||||
};
|
||||
|
||||
const initializeDatabase = async (config: ConnectionOptions | string) => {
|
||||
let connection: Connection | undefined;
|
||||
|
||||
try {
|
||||
connection = await getConnection(config);
|
||||
await connection.query('SELECT 1');
|
||||
await connection.end();
|
||||
} catch (error) {
|
||||
await connection?.end();
|
||||
|
||||
// The ER_BAD_DB_ERROR error code is thrown when the database does not exist but the user might have the permissions to create it
|
||||
// Otherwise the error code is ER_DBACCESS_DENIED_ERROR
|
||||
if (error && typeof error === 'object' && 'code' in error && error.code === 'ER_BAD_DB_ERROR') {
|
||||
const databaseName = getDatabaseName(config);
|
||||
|
||||
const informationSchemaConfig = setDatabaseName(config, 'information_schema');
|
||||
|
||||
const informationSchemaConnection = await getConnection(informationSchemaConfig);
|
||||
try {
|
||||
await informationSchemaConnection.query(`CREATE DATABASE ${escapeId(databaseName)}`);
|
||||
// Any database creation error here will be propagated
|
||||
} finally {
|
||||
await informationSchemaConnection.end();
|
||||
}
|
||||
} else {
|
||||
// In this case we don't know how to handle the error, so we rethrow it
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const lockWaitTimeout = 10; // seconds
|
||||
|
||||
const isHistoryTableExisting = async (connection: Connection, table: string) => {
|
||||
const [result] = await connection.execute<RowDataPacket[]>({
|
||||
sql: `
|
||||
SELECT
|
||||
1 as table_exists
|
||||
FROM
|
||||
information_schema.tables
|
||||
WHERE
|
||||
table_schema = DATABASE()
|
||||
AND table_name = ?
|
||||
`,
|
||||
values: [table],
|
||||
});
|
||||
|
||||
return result[0]?.['table_exists'] === 1;
|
||||
};
|
||||
|
||||
const initializeTable = async (config: ConnectionOptions | string, table: string) => {
|
||||
const connection = await getConnection(config);
|
||||
|
||||
if (await isHistoryTableExisting(connection, table)) {
|
||||
await connection.end();
|
||||
return;
|
||||
}
|
||||
|
||||
const lockName = `emigrate_init_table_lock_${table}`;
|
||||
|
||||
const [lockResult] = await connection.query<RowDataPacket[]>(`SELECT GET_LOCK(?, ?) AS got_lock`, [
|
||||
lockName,
|
||||
lockWaitTimeout,
|
||||
]);
|
||||
const didGetLock = lockResult[0]?.['got_lock'] === 1;
|
||||
|
||||
if (didGetLock) {
|
||||
try {
|
||||
const initializeTable = async (pool: Pool, table: string) => {
|
||||
// This table definition is compatible with the one used by the immigration-mysql package
|
||||
await connection.execute(`
|
||||
await pool.execute(`
|
||||
CREATE TABLE IF NOT EXISTS ${escapeId(table)} (
|
||||
name varchar(255) not null primary key,
|
||||
status varchar(32),
|
||||
date datetime not null
|
||||
) Engine=InnoDB;
|
||||
`);
|
||||
} finally {
|
||||
await connection.query(`SELECT RELEASE_LOCK(?)`, [lockName]);
|
||||
await connection.end();
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Didn't get the lock, wait to see if the table was created by another process
|
||||
const maxWait = lockWaitTimeout * 1000; // milliseconds
|
||||
const checkInterval = 250; // milliseconds
|
||||
const start = Date.now();
|
||||
|
||||
try {
|
||||
while (Date.now() - start < maxWait) {
|
||||
// eslint-disable-next-line no-await-in-loop
|
||||
if (await isHistoryTableExisting(connection, table)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line no-await-in-loop
|
||||
await setTimeout(checkInterval);
|
||||
}
|
||||
|
||||
throw new Error(`Timeout waiting for table ${table} to be created by other process`);
|
||||
} finally {
|
||||
await connection.end();
|
||||
}
|
||||
};
|
||||
|
||||
export const createMysqlStorage = ({ table = defaultTable, connection }: MysqlStorageOptions): EmigrateStorage => {
|
||||
return {
|
||||
async initializeStorage() {
|
||||
await initializeDatabase(connection);
|
||||
await initializeTable(connection, table);
|
||||
|
||||
const pool = getPool(connection);
|
||||
|
||||
if (process.isBun) {
|
||||
pool.on('connection', (connection) => {
|
||||
// @ts-expect-error stream is not in the types but it's there
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call
|
||||
connection.stream.unref();
|
||||
});
|
||||
await pool.query('SELECT 1');
|
||||
|
||||
try {
|
||||
await initializeTable(pool, table);
|
||||
} catch (error) {
|
||||
await pool.end();
|
||||
throw error;
|
||||
}
|
||||
|
||||
const storage: Storage = {
|
||||
async lock(migrations) {
|
||||
const connection = await pool.getConnection();
|
||||
|
||||
try {
|
||||
await connection.beginTransaction();
|
||||
const lockedMigrations: MigrationMetadata[] = [];
|
||||
|
||||
for await (const migration of migrations) {
|
||||
if (await lockMigration(connection, table, migration)) {
|
||||
if (await lockMigration(pool, table, migration)) {
|
||||
lockedMigrations.push(migration);
|
||||
}
|
||||
}
|
||||
|
||||
if (lockedMigrations.length === migrations.length) {
|
||||
await connection.commit();
|
||||
|
||||
return lockedMigrations;
|
||||
}
|
||||
|
||||
await connection.rollback();
|
||||
|
||||
return [];
|
||||
} catch (error) {
|
||||
await connection.rollback();
|
||||
throw error;
|
||||
} finally {
|
||||
connection.release();
|
||||
}
|
||||
},
|
||||
async unlock(migrations) {
|
||||
for await (const migration of migrations) {
|
||||
|
|
@ -411,6 +249,17 @@ export const createMysqlStorage = ({ table = defaultTable, connection }: MysqlSt
|
|||
};
|
||||
};
|
||||
|
||||
export const { initializeStorage } = createMysqlStorage({
|
||||
table: process.env['MYSQL_TABLE'],
|
||||
connection: process.env['MYSQL_URL'] ?? {
|
||||
host: process.env['MYSQL_HOST'],
|
||||
port: process.env['MYSQL_PORT'] ? Number.parseInt(process.env['MYSQL_PORT'], 10) : undefined,
|
||||
user: process.env['MYSQL_USER'],
|
||||
password: process.env['MYSQL_PASSWORD'],
|
||||
database: process.env['MYSQL_DATABASE'],
|
||||
},
|
||||
});
|
||||
|
||||
export const createMysqlLoader = ({ connection }: MysqlLoaderOptions): LoaderPlugin => {
|
||||
return {
|
||||
loadableExtensions: ['.sql'],
|
||||
|
|
@ -429,6 +278,16 @@ export const createMysqlLoader = ({ connection }: MysqlLoaderOptions): LoaderPlu
|
|||
};
|
||||
};
|
||||
|
||||
export const { loadableExtensions, loadMigration } = createMysqlLoader({
|
||||
connection: process.env['MYSQL_URL'] ?? {
|
||||
host: process.env['MYSQL_HOST'],
|
||||
port: process.env['MYSQL_PORT'] ? Number.parseInt(process.env['MYSQL_PORT'], 10) : undefined,
|
||||
user: process.env['MYSQL_USER'],
|
||||
password: process.env['MYSQL_PASSWORD'],
|
||||
database: process.env['MYSQL_DATABASE'],
|
||||
},
|
||||
});
|
||||
|
||||
export const generateMigration: GenerateMigrationFunction = async (name) => {
|
||||
return {
|
||||
filename: `${getTimestampPrefix()}_${sanitizeMigrationName(name)}.sql`,
|
||||
|
|
@ -437,34 +296,6 @@ export const generateMigration: GenerateMigrationFunction = async (name) => {
|
|||
};
|
||||
};
|
||||
|
||||
const storage = createMysqlStorage({
|
||||
table: process.env['MYSQL_TABLE'],
|
||||
connection: process.env['MYSQL_URL'] ?? {
|
||||
host: process.env['MYSQL_HOST'],
|
||||
port: process.env['MYSQL_PORT'] ? Number.parseInt(process.env['MYSQL_PORT'], 10) : undefined,
|
||||
user: process.env['MYSQL_USER'],
|
||||
password: process.env['MYSQL_PASSWORD'],
|
||||
database: process.env['MYSQL_DATABASE'],
|
||||
},
|
||||
});
|
||||
|
||||
const loader = createMysqlLoader({
|
||||
connection: process.env['MYSQL_URL'] ?? {
|
||||
host: process.env['MYSQL_HOST'],
|
||||
port: process.env['MYSQL_PORT'] ? Number.parseInt(process.env['MYSQL_PORT'], 10) : undefined,
|
||||
user: process.env['MYSQL_USER'],
|
||||
password: process.env['MYSQL_PASSWORD'],
|
||||
database: process.env['MYSQL_DATABASE'],
|
||||
},
|
||||
});
|
||||
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const initializeStorage: () => Promise<Storage> = storage.initializeStorage;
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const loadableExtensions: string[] = loader.loadableExtensions;
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const loadMigration: (migration: MigrationMetadata) => Awaitable<MigrationFunction> = loader.loadMigration;
|
||||
|
||||
const defaultExport: EmigrateStorage & LoaderPlugin & GeneratorPlugin = {
|
||||
initializeStorage,
|
||||
loadableExtensions,
|
||||
|
|
|
|||
|
|
@ -1,49 +0,0 @@
|
|||
/* eslint @typescript-eslint/naming-convention:0, import/no-extraneous-dependencies: 0 */
|
||||
import process from 'node:process';
|
||||
import { GenericContainer, type StartedTestContainer } from 'testcontainers';
|
||||
|
||||
let container: StartedTestContainer | undefined;
|
||||
|
||||
export const startDatabase = async (): Promise<{ port: number; host: string }> => {
|
||||
if (process.env['CI']) {
|
||||
const config = {
|
||||
port: process.env['MYSQL_PORT'] ? Number.parseInt(process.env['MYSQL_PORT'], 10) : 3306,
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
host: process.env['MYSQL_HOST'] || 'localhost',
|
||||
};
|
||||
|
||||
console.log(`Connecting to MySQL from environment variables: ${JSON.stringify(config)}`);
|
||||
|
||||
return config;
|
||||
}
|
||||
|
||||
if (!container) {
|
||||
console.log('Starting MySQL container...');
|
||||
const containerSetup = new GenericContainer('mysql:8.2')
|
||||
.withEnvironment({
|
||||
MYSQL_ROOT_PASSWORD: 'admin',
|
||||
MYSQL_USER: 'emigrate',
|
||||
MYSQL_PASSWORD: 'emigrate',
|
||||
MYSQL_DATABASE: 'emigrate',
|
||||
})
|
||||
.withTmpFs({ '/var/lib/mysql': 'rw' })
|
||||
.withCommand(['--sql-mode=NO_ENGINE_SUBSTITUTION', '--default-authentication-plugin=mysql_native_password'])
|
||||
.withExposedPorts(3306)
|
||||
.withReuse();
|
||||
|
||||
container = await containerSetup.start();
|
||||
|
||||
console.log('MySQL container started');
|
||||
}
|
||||
|
||||
return { port: container.getMappedPort(3306), host: container.getHost() };
|
||||
};
|
||||
|
||||
export const stopDatabase = async (): Promise<void> => {
|
||||
if (container) {
|
||||
console.log('Stopping MySQL container...');
|
||||
await container.stop();
|
||||
console.log('MySQL container stopped');
|
||||
container = undefined;
|
||||
}
|
||||
};
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,29 +1,5 @@
|
|||
# @emigrate/plugin-generate-js
|
||||
|
||||
## 0.3.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [d779286]
|
||||
- @emigrate/plugin-tools@0.9.8
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.3.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/plugin-tools@0.9.7
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.3.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/plugin-tools@0.9.6
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.3.5
|
||||
|
||||
### Patch Changes
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@emigrate/plugin-generate-js",
|
||||
"version": "0.3.8",
|
||||
"version": "0.3.5",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,28 +1,5 @@
|
|||
# @emigrate/plugin-tools
|
||||
|
||||
## 0.9.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d779286: Upgrade TypeScript to v5.5 and enable [isolatedDeclarations](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations)
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.9.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.9.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.9.5
|
||||
|
||||
### Patch Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/plugin-tools",
|
||||
"version": "0.9.8",
|
||||
"version": "0.9.5",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "",
|
||||
"main": "dist/index.js",
|
||||
|
|
@ -16,8 +15,7 @@
|
|||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
|
|
|
|||
|
|
@ -204,7 +204,7 @@ const load = async <T>(
|
|||
*
|
||||
* @returns A timestamp string in the format YYYYMMDDHHmmssmmm
|
||||
*/
|
||||
export const getTimestampPrefix = (): string => new Date().toISOString().replaceAll(/[-:ZT.]/g, '');
|
||||
export const getTimestampPrefix = () => new Date().toISOString().replaceAll(/[-:ZT.]/g, '');
|
||||
|
||||
/**
|
||||
* A utility function to sanitize a migration name so that it can be used as a filename
|
||||
|
|
@ -212,7 +212,7 @@ export const getTimestampPrefix = (): string => new Date().toISOString().replace
|
|||
* @param name A migration name to sanitize
|
||||
* @returns A sanitized migration name that can be used as a filename
|
||||
*/
|
||||
export const sanitizeMigrationName = (name: string): string =>
|
||||
export const sanitizeMigrationName = (name: string) =>
|
||||
name
|
||||
.replaceAll(/[\W/\\:|*?'"<>_]+/g, '_')
|
||||
.trim()
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,38 +1,5 @@
|
|||
# @emigrate/postgres
|
||||
|
||||
## 0.3.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d779286: Upgrade TypeScript to v5.5 and enable [isolatedDeclarations](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations)
|
||||
- Updated dependencies [d779286]
|
||||
- @emigrate/plugin-tools@0.9.8
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.3.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/plugin-tools@0.9.7
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.3.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 4442604: Automatically create the database if it doesn't exist, and the user have the permissions to do so
|
||||
|
||||
## 0.2.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/plugin-tools@0.9.6
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.2.5
|
||||
|
||||
### Patch Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/postgres",
|
||||
"version": "0.3.2",
|
||||
"version": "0.2.5",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "A PostgreSQL plugin for Emigrate. Uses a PostgreSQL database for storing migration history. Can load and generate .sql migration files.",
|
||||
"main": "dist/index.js",
|
||||
|
|
@ -16,8 +15,7 @@
|
|||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
|
|
|
|||
|
|
@ -11,8 +11,6 @@ import {
|
|||
type GeneratorPlugin,
|
||||
type SerializedError,
|
||||
type MigrationHistoryEntry,
|
||||
type Awaitable,
|
||||
type MigrationFunction,
|
||||
} from '@emigrate/types';
|
||||
|
||||
const defaultTable = 'migrations';
|
||||
|
|
@ -94,64 +92,6 @@ const deleteMigration = async (sql: Sql, table: string, migration: MigrationMeta
|
|||
return result.count === 1;
|
||||
};
|
||||
|
||||
const getDatabaseName = (config: ConnectionOptions | string) => {
|
||||
if (typeof config === 'string') {
|
||||
const uri = new URL(config);
|
||||
|
||||
return uri.pathname.replace(/^\//u, '');
|
||||
}
|
||||
|
||||
return config.database ?? '';
|
||||
};
|
||||
|
||||
const setDatabaseName = <T extends ConnectionOptions | string>(config: T, databaseName: string): T => {
|
||||
if (typeof config === 'string') {
|
||||
const uri = new URL(config);
|
||||
|
||||
uri.pathname = `/${databaseName}`;
|
||||
|
||||
return uri.toString() as T;
|
||||
}
|
||||
|
||||
if (typeof config === 'object') {
|
||||
return {
|
||||
...config,
|
||||
database: databaseName,
|
||||
};
|
||||
}
|
||||
|
||||
throw new Error('Invalid connection config');
|
||||
};
|
||||
|
||||
const initializeDatabase = async (config: ConnectionOptions | string) => {
|
||||
let sql: Sql | undefined;
|
||||
|
||||
try {
|
||||
sql = await getPool(config);
|
||||
await sql.end();
|
||||
} catch (error) {
|
||||
await sql?.end();
|
||||
|
||||
// The error code 3D000 means that the database does not exist, but the user might have the permissions to create it
|
||||
if (error && typeof error === 'object' && 'code' in error && error.code === '3D000') {
|
||||
const databaseName = getDatabaseName(config);
|
||||
|
||||
const postgresConfig = setDatabaseName(config, 'postgres');
|
||||
|
||||
const postgresSql = await getPool(postgresConfig);
|
||||
try {
|
||||
await postgresSql`CREATE DATABASE ${postgresSql(databaseName)}`;
|
||||
// Any database creation error here will be propagated
|
||||
} finally {
|
||||
await postgresSql.end();
|
||||
}
|
||||
} else {
|
||||
// In this case we don't know how to handle the error, so we rethrow it
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const initializeTable = async (sql: Sql, table: string) => {
|
||||
const [row] = await sql<Array<{ exists: 1 }>>`
|
||||
SELECT 1 as exists
|
||||
|
|
@ -182,8 +122,6 @@ export const createPostgresStorage = ({
|
|||
}: PostgresStorageOptions): EmigrateStorage => {
|
||||
return {
|
||||
async initializeStorage() {
|
||||
await initializeDatabase(connection);
|
||||
|
||||
const sql = await getPool(connection);
|
||||
|
||||
try {
|
||||
|
|
@ -257,6 +195,17 @@ export const createPostgresStorage = ({
|
|||
};
|
||||
};
|
||||
|
||||
export const { initializeStorage } = createPostgresStorage({
|
||||
table: process.env['POSTGRES_TABLE'],
|
||||
connection: process.env['POSTGRES_URL'] ?? {
|
||||
host: process.env['POSTGRES_HOST'],
|
||||
port: process.env['POSTGRES_PORT'] ? Number.parseInt(process.env['POSTGRES_PORT'], 10) : undefined,
|
||||
user: process.env['POSTGRES_USER'],
|
||||
password: process.env['POSTGRES_PASSWORD'],
|
||||
database: process.env['POSTGRES_DB'],
|
||||
},
|
||||
});
|
||||
|
||||
export const createPostgresLoader = ({ connection }: PostgresLoaderOptions): LoaderPlugin => {
|
||||
return {
|
||||
loadableExtensions: ['.sql'],
|
||||
|
|
@ -275,6 +224,16 @@ export const createPostgresLoader = ({ connection }: PostgresLoaderOptions): Loa
|
|||
};
|
||||
};
|
||||
|
||||
export const { loadableExtensions, loadMigration } = createPostgresLoader({
|
||||
connection: process.env['POSTGRES_URL'] ?? {
|
||||
host: process.env['POSTGRES_HOST'],
|
||||
port: process.env['POSTGRES_PORT'] ? Number.parseInt(process.env['POSTGRES_PORT'], 10) : undefined,
|
||||
user: process.env['POSTGRES_USER'],
|
||||
password: process.env['POSTGRES_PASSWORD'],
|
||||
database: process.env['POSTGRES_DB'],
|
||||
},
|
||||
});
|
||||
|
||||
export const generateMigration: GenerateMigrationFunction = async (name) => {
|
||||
return {
|
||||
filename: `${getTimestampPrefix()}_${sanitizeMigrationName(name)}.sql`,
|
||||
|
|
@ -283,34 +242,6 @@ export const generateMigration: GenerateMigrationFunction = async (name) => {
|
|||
};
|
||||
};
|
||||
|
||||
const storage = createPostgresStorage({
|
||||
table: process.env['POSTGRES_TABLE'],
|
||||
connection: process.env['POSTGRES_URL'] ?? {
|
||||
host: process.env['POSTGRES_HOST'],
|
||||
port: process.env['POSTGRES_PORT'] ? Number.parseInt(process.env['POSTGRES_PORT'], 10) : undefined,
|
||||
user: process.env['POSTGRES_USER'],
|
||||
password: process.env['POSTGRES_PASSWORD'],
|
||||
database: process.env['POSTGRES_DB'],
|
||||
},
|
||||
});
|
||||
|
||||
const loader = createPostgresLoader({
|
||||
connection: process.env['POSTGRES_URL'] ?? {
|
||||
host: process.env['POSTGRES_HOST'],
|
||||
port: process.env['POSTGRES_PORT'] ? Number.parseInt(process.env['POSTGRES_PORT'], 10) : undefined,
|
||||
user: process.env['POSTGRES_USER'],
|
||||
password: process.env['POSTGRES_PASSWORD'],
|
||||
database: process.env['POSTGRES_DB'],
|
||||
},
|
||||
});
|
||||
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const initializeStorage: () => Promise<Storage> = storage.initializeStorage;
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const loadableExtensions: string[] = loader.loadableExtensions;
|
||||
// eslint-disable-next-line prefer-destructuring
|
||||
export const loadMigration: (migration: MigrationMetadata) => Awaitable<MigrationFunction> = loader.loadMigration;
|
||||
|
||||
const defaultExport: EmigrateStorage & LoaderPlugin & GeneratorPlugin = {
|
||||
initializeStorage,
|
||||
loadableExtensions,
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,40 +1,5 @@
|
|||
# @emigrate/reporter-pino
|
||||
|
||||
## 0.6.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d779286: Upgrade TypeScript to v5.5 and enable [isolatedDeclarations](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations)
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.6.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.6.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 081ab34: Make sure Pino outputs logs in Bun environments
|
||||
|
||||
## 0.6.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 1065322: Show correct status for migrations for the "list" and "new" commands
|
||||
|
||||
## 0.6.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.6.0
|
||||
|
||||
### Minor Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/reporter-pino",
|
||||
"version": "0.6.5",
|
||||
"version": "0.6.0",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "A Pino reporter for Emigrate for logging the migration process.",
|
||||
"main": "dist/index.js",
|
||||
|
|
@ -16,8 +15,7 @@
|
|||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
|
|
@ -41,9 +39,7 @@
|
|||
"pino": "8.16.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@emigrate/tsconfig": "workspace:*",
|
||||
"@types/bun": "1.0.5",
|
||||
"bun-types": "1.0.26"
|
||||
"@emigrate/tsconfig": "workspace:*"
|
||||
},
|
||||
"volta": {
|
||||
"extends": "../../package.json"
|
||||
|
|
|
|||
|
|
@ -52,7 +52,6 @@ class PinoReporter implements Required<EmigrateReporter> {
|
|||
scope: command,
|
||||
version,
|
||||
},
|
||||
transport: process.isBun ? { target: 'pino/file', options: { destination: 1 } } : undefined,
|
||||
});
|
||||
|
||||
this.#logger.info({ parameters }, `Emigrate "${command}" initialized${parameters.dry ? ' (dry-run)' : ''}`);
|
||||
|
|
@ -117,26 +116,12 @@ class PinoReporter implements Required<EmigrateReporter> {
|
|||
}
|
||||
|
||||
onMigrationStart(migration: MigrationMetadata): Awaitable<void> {
|
||||
let status = 'running';
|
||||
|
||||
if (this.#command === 'remove') {
|
||||
status = 'removing';
|
||||
} else if (this.#command === 'new') {
|
||||
status = 'creating';
|
||||
}
|
||||
|
||||
const status = this.#command === 'up' ? 'running' : 'removing';
|
||||
this.#logger.info({ migration: migration.relativeFilePath }, `${migration.name} (${status})`);
|
||||
}
|
||||
|
||||
onMigrationSuccess(migration: MigrationMetadataFinished): Awaitable<void> {
|
||||
let status = 'done';
|
||||
|
||||
if (this.#command === 'remove') {
|
||||
status = 'removed';
|
||||
} else if (this.#command === 'new') {
|
||||
status = 'created';
|
||||
}
|
||||
|
||||
const status = this.#command === 'up' ? 'done' : 'removed';
|
||||
this.#logger.info({ migration: migration.relativeFilePath }, `${migration.name} (${status})`);
|
||||
}
|
||||
|
||||
|
|
@ -204,8 +189,6 @@ export const createPinoReporter = (options: PinoReporterOptions = {}): EmigrateR
|
|||
return new PinoReporter(options);
|
||||
};
|
||||
|
||||
const defaultExport: EmigrateReporter = createPinoReporter({
|
||||
export default createPinoReporter({
|
||||
level: process.env['LOG_LEVEL'],
|
||||
});
|
||||
|
||||
export default defaultExport;
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,5 @@
|
|||
# @emigrate/storage-fs
|
||||
|
||||
## 0.4.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
- Updated dependencies [ca154fa]
|
||||
- @emigrate/types@0.12.2
|
||||
|
||||
## 0.4.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
- Updated dependencies [db656c2]
|
||||
- @emigrate/types@0.12.1
|
||||
|
||||
## 0.4.5
|
||||
|
||||
### Patch Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/storage-fs",
|
||||
"version": "0.4.7",
|
||||
"version": "0.4.5",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "A storage plugin for Emigrate for storing the migration history in a file",
|
||||
"main": "dist/index.js",
|
||||
|
|
@ -16,8 +15,7 @@
|
|||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,17 +1,5 @@
|
|||
# @emigrate/tsconfig
|
||||
|
||||
## 1.0.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- d779286: Upgrade TypeScript to v5.5 and enable [isolatedDeclarations](https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations)
|
||||
|
||||
## 1.0.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
|
||||
## 1.0.1
|
||||
|
||||
### Patch Changes
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@
|
|||
"forceConsistentCasingInFileNames": true,
|
||||
"inlineSources": false,
|
||||
"isolatedModules": true,
|
||||
"isolatedDeclarations": true,
|
||||
"incremental": true,
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
|
|
@ -32,7 +31,5 @@
|
|||
"strict": true,
|
||||
"target": "ES2022",
|
||||
"lib": ["ESNext", "DOM", "DOM.Iterable"]
|
||||
},
|
||||
"include": ["${configDir}/src"],
|
||||
"exclude": ["${configDir}/dist"]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
"display": "Build",
|
||||
"extends": "./base.json",
|
||||
"compilerOptions": {
|
||||
"noEmit": false,
|
||||
"outDir": "${configDir}/dist"
|
||||
"noEmit": false
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/tsconfig",
|
||||
"version": "1.0.3",
|
||||
"version": "1.0.1",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"files": [
|
||||
"base.json",
|
||||
|
|
|
|||
|
|
@ -1,17 +1,5 @@
|
|||
# @emigrate/types
|
||||
|
||||
## 0.12.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- ca154fa: Minimize package size by excluding \*.tsbuildinfo files
|
||||
|
||||
## 0.12.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- db656c2: Enable NPM provenance
|
||||
|
||||
## 0.12.0
|
||||
|
||||
### Minor Changes
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
{
|
||||
"name": "@emigrate/types",
|
||||
"version": "0.12.2",
|
||||
"version": "0.12.0",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
"access": "public"
|
||||
},
|
||||
"description": "Common Emigrate TypeScript types to ease plugin development.",
|
||||
"main": "dist/index.js",
|
||||
|
|
@ -16,8 +15,7 @@
|
|||
}
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"!dist/*.tsbuildinfo"
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --pretty",
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
{
|
||||
"extends": "@emigrate/tsconfig/build.json"
|
||||
"extends": "@emigrate/tsconfig/build.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist"
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
|
|
|
|||
11943
pnpm-lock.yaml
generated
11943
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load diff
|
|
@ -1,7 +1,6 @@
|
|||
{
|
||||
"$schema": "https://turborepo.org/schema.json",
|
||||
"ui": "stream",
|
||||
"tasks": {
|
||||
"pipeline": {
|
||||
"build": {
|
||||
"dependsOn": ["^build"],
|
||||
"inputs": ["src/**/*", "!src/**/*.test.ts", "tsconfig.json", "tsconfig.build.json"],
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue