From 7fc176f744b351489c0dc12a9cd568d3fed06e29 Mon Sep 17 00:00:00 2001 From: Namekuji Date: Tue, 2 May 2023 19:53:57 -0400 Subject: [PATCH 1/2] add migration patches and fix commands --- docs/migrate.md | 41 ++++++++++--- docs/mkv13_restore.patch | 127 +++++++++++++++++++++++++++++++++++++++ docs/renote_muting.patch | 23 +++++++ 3 files changed, 181 insertions(+), 10 deletions(-) create mode 100644 docs/mkv13_restore.patch create mode 100644 docs/renote_muting.patch diff --git a/docs/migrate.md b/docs/migrate.md index 07a5fea07..152a37a7c 100644 --- a/docs/migrate.md +++ b/docs/migrate.md @@ -1,27 +1,44 @@ # 🚚 Migrating from Misskey to Calckey +The following process may not work depending on your environment and version of Misskey. + +**Make sure you** +- **stopped all master and worker processes of Misskey.** +- **have backups of the database before performing any commands.** + ## Misskey v13 and above +Tested with Misskey v13.11.3. + +If your Misskey v13 is older, we recommend updating your Misskey to v13.11.3. + ```sh wget -O mkv13.patch https://codeberg.org/calckey/calckey/raw/branch/develop/docs/mkv13.patch -git apply mkv13.patch +wget -O mkv13_restore.patch https://codeberg.org/calckey/calckey/raw/branch/develop/docs/mkv13_restore.patch +git apply mkv13.patch mkv13_restore.patch cd packages/backend -LINE_NUM="$(npx typeorm migration:show -d ormconfig.js | grep -n activeEmailValidation1657346559800 | cut -d ':' -f 1)" -NUM_MIGRATIONS="$(npx typeorm migration:show -d ormconfig.js | tail -n+"$LINE_NUM" | grep '\[X\]' | nl)" +LINE_NUM="$(pnpm typeorm migration:show -d ormconfig.js | grep -n activeEmailValidation1657346559800 | cut -d ':' -f 1)" +NUM_MIGRATIONS="$(pnpm typeorm migration:show -d ormconfig.js | tail -n+"$LINE_NUM" | grep '\[X\]' | wc -l)" -for i in $(seq 1 $NUM_MIGRAIONS); do - npx typeorm migration:revert -d ormconfig.js -done +for i in $(seq 1 $NUM_MIGRATIONS); do pnpm typeorm migration:revert -d ormconfig.js; done + +cd ../../ git remote set-url origin https://codeberg.org/calckey/calckey.git -git fetch -git checkout main # or beta or develop +git fetch origin +git stash push +rm -rf fluent-emojis misskey-assets +git switch main # or beta or develop git pull --ff +wget -O renote_muting.patch https://codeberg.org/calckey/calckey/raw/branch/develop/docs/renote_muting.patch +git apply renote_muting.patch -NODE_ENV=production pnpm run migrate -# build using prefered method +pnpm install +NODE_ENV=production pnpm run build +pnpm run migrate +git stash push ``` Depending on the version you're migrating from, you may have to open Postgres with `psql -d your_database` and run the following commands: @@ -44,6 +61,10 @@ ALTER TABLE "instance" ADD COLUMN "lastCommunicatedAt" date; then quit with `\q`, and restart Calckey. +Note: Ignore errors of `column "xxx" of relation "xxx" already exists`. + +If no other errors happened, your Calckey is ready to launch! + ## Misskey v12.119 and before ```sh diff --git a/docs/mkv13_restore.patch b/docs/mkv13_restore.patch new file mode 100644 index 000000000..9ef9934ed --- /dev/null +++ b/docs/mkv13_restore.patch @@ -0,0 +1,127 @@ +diff --git a/packages/backend/migration/1680491187535-cleanup.js b/packages/backend/migration/1680491187535-cleanup.js +index 1e609ca06..0e6accf3e 100644 +--- a/packages/backend/migration/1680491187535-cleanup.js ++++ b/packages/backend/migration/1680491187535-cleanup.js +@@ -1,10 +1,40 @@ + export class cleanup1680491187535 { +- name = 'cleanup1680491187535' ++ name = "cleanup1680491187535"; + +- async up(queryRunner) { +- await queryRunner.query(`DROP TABLE "antenna_note" `); +- } ++ async up(queryRunner) { ++ await queryRunner.query(`DROP TABLE "antenna_note" `); ++ } + +- async down(queryRunner) { +- } ++ async down(queryRunner) { ++ await queryRunner.query( ++ `CREATE TABLE antenna_note ( id character varying(32) NOT NULL, "noteId" character varying(32) NOT NULL, "antennaId" character varying(32) NOT NULL, read boolean DEFAULT false NOT NULL)`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN antenna_note."noteId" IS 'The note ID.'`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN antenna_note."antennaId" IS 'The antenna ID.'`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY antenna_note ADD CONSTRAINT "PK_fb28d94d0989a3872df19fd6ef8" PRIMARY KEY (id)`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_0d775946662d2575dfd2068a5f" ON antenna_note USING btree ("antennaId")`, ++ ); ++ await queryRunner.query( ++ `CREATE UNIQUE INDEX "IDX_335a0bf3f904406f9ef3dd51c2" ON antenna_note USING btree ("noteId", "antennaId")`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_9937ea48d7ae97ffb4f3f063a4" ON antenna_note USING btree (read)`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_bd0397be22147e17210940e125" ON antenna_note USING btree ("noteId")`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY antenna_note ADD CONSTRAINT "FK_0d775946662d2575dfd2068a5f5" FOREIGN KEY ("antennaId") REFERENCES antenna(id) ON DELETE CASCADE`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY antenna_note ADD CONSTRAINT "FK_bd0397be22147e17210940e125b" FOREIGN KEY ("noteId") REFERENCES note(id) ON DELETE CASCADE`, ++ ); ++ } + } +diff --git a/packages/backend/migration/1680582195041-cleanup.js b/packages/backend/migration/1680582195041-cleanup.js +index c587e456a..a91d6ff3c 100644 +--- a/packages/backend/migration/1680582195041-cleanup.js ++++ b/packages/backend/migration/1680582195041-cleanup.js +@@ -1,11 +1,64 @@ + export class cleanup1680582195041 { +- name = 'cleanup1680582195041' ++ name = "cleanup1680582195041"; + +- async up(queryRunner) { +- await queryRunner.query(`DROP TABLE "notification" `); +- } ++ async up(queryRunner) { ++ await queryRunner.query(`DROP TABLE "notification"`); ++ } + +- async down(queryRunner) { +- +- } ++ async down(queryRunner) { ++ await queryRunner.query( ++ `CREATE TABLE notification ( id character varying(32) NOT NULL, "createdAt" timestamp with time zone NOT NULL, "notifieeId" character varying(32) NOT NULL, "notifierId" character varying(32), "isRead" boolean DEFAULT false NOT NULL, "noteId" character varying(32), reaction character varying(128), choice integer, "followRequestId" character varying(32), type notification_type_enum NOT NULL, "customBody" character varying(2048), "customHeader" character varying(256), "customIcon" character varying(1024), "appAccessTokenId" character varying(32), achievement character varying(128))`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN notification."createdAt" IS 'The created date of the Notification.'`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN notification."notifieeId" IS 'The ID of recipient user of the Notification.'`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN notification."notifierId" IS 'The ID of sender user of the Notification.'`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN notification."isRead" IS 'Whether the Notification is read.'`, ++ ); ++ await queryRunner.query( ++ `COMMENT ON COLUMN notification.type IS 'The type of the Notification.'`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY notification ADD CONSTRAINT "PK_705b6c7cdf9b2c2ff7ac7872cb7" PRIMARY KEY (id)`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_080ab397c379af09b9d2169e5b" ON notification USING btree ("isRead")`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_33f33cc8ef29d805a97ff4628b" ON notification USING btree (type)`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_3b4e96eec8d36a8bbb9d02aa71" ON notification USING btree ("notifierId")`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_3c601b70a1066d2c8b517094cb" ON notification USING btree ("notifieeId")`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_b11a5e627c41d4dc3170f1d370" ON notification USING btree ("createdAt")`, ++ ); ++ await queryRunner.query( ++ `CREATE INDEX "IDX_e22bf6bda77b6adc1fd9e75c8c" ON notification USING btree ("appAccessTokenId")`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY notification ADD CONSTRAINT "FK_3b4e96eec8d36a8bbb9d02aa710" FOREIGN KEY ("notifierId") REFERENCES "user"(id) ON DELETE CASCADE`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY notification ADD CONSTRAINT "FK_3c601b70a1066d2c8b517094cb9" FOREIGN KEY ("notifieeId") REFERENCES "user"(id) ON DELETE CASCADE`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY notification ADD CONSTRAINT "FK_769cb6b73a1efe22ddf733ac453" FOREIGN KEY ("noteId") REFERENCES note(id) ON DELETE CASCADE`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY notification ADD CONSTRAINT "FK_bd7fab507621e635b32cd31892c" FOREIGN KEY ("followRequestId") REFERENCES follow_request(id) ON DELETE CASCADE`, ++ ); ++ await queryRunner.query( ++ `ALTER TABLE ONLY notification ADD CONSTRAINT "FK_e22bf6bda77b6adc1fd9e75c8c9" FOREIGN KEY ("appAccessTokenId") REFERENCES access_token(id) ON DELETE CASCADE`, ++ ); ++ } + } diff --git a/docs/renote_muting.patch b/docs/renote_muting.patch new file mode 100644 index 000000000..c5bd2818c --- /dev/null +++ b/docs/renote_muting.patch @@ -0,0 +1,23 @@ +diff --git a/packages/backend/migration/1665091090561-add-renote-muting.js b/packages/backend/migration/1665091090561-add-renote-muting.js +index 2c76aaff5..f8541c818 100644 +--- a/packages/backend/migration/1665091090561-add-renote-muting.js ++++ b/packages/backend/migration/1665091090561-add-renote-muting.js +@@ -4,18 +4,6 @@ export class addRenoteMuting1665091090561 { + } + + async up(queryRunner) { +- await queryRunner.query( +- `CREATE TABLE "renote_muting" ("id" character varying(32) NOT NULL, "createdAt" TIMESTAMP WITH TIME ZONE NOT NULL, "muteeId" character varying(32) NOT NULL, "muterId" character varying(32) NOT NULL, CONSTRAINT "PK_renoteMuting_id" PRIMARY KEY ("id"))`, +- ); +- await queryRunner.query( +- `CREATE INDEX "IDX_renote_muting_createdAt" ON "muting" ("createdAt") `, +- ); +- await queryRunner.query( +- `CREATE INDEX "IDX_renote_muting_muteeId" ON "muting" ("muteeId") `, +- ); +- await queryRunner.query( +- `CREATE INDEX "IDX_renote_muting_muterId" ON "muting" ("muterId") `, +- ); + } + + async down(queryRunner) {} From 01db45f2ecaa8a02017368fd89e60e804b9394ac Mon Sep 17 00:00:00 2001 From: Namekuji Date: Tue, 2 May 2023 20:45:20 -0400 Subject: [PATCH 2/2] fix typo --- docs/migrate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/migrate.md b/docs/migrate.md index 152a37a7c..7e9653e70 100644 --- a/docs/migrate.md +++ b/docs/migrate.md @@ -1,6 +1,6 @@ # 🚚 Migrating from Misskey to Calckey -The following process may not work depending on your environment and version of Misskey. +The following procedure may not work depending on your environment and version of Misskey. **Make sure you** - **stopped all master and worker processes of Misskey.**