Workspaces refactor #86

Merged

norm merged 189 commits from refactor/workspaces into main 2022-08-28 14:46:45 +00:00

Conversation 10 Commits 189 Files changed 156 +25966 -17224

norm commented 2022-08-26 01:50:06 +00:00

Owner

Copy link

This PR aims to refactor the FoundKey repo to use Yarn Workspaces.
Notably, foundkey-js (fork of misskey-js) has been added as a workspace.

I'm not sure how much work it'll be to adopt workspaces, but it does seem like Misskey already does use sub-packages so this should hopefully not be too hard.

Help in refactoring would be very much appreciated.

Useful information on workspaces:

• https://classic.yarnpkg.com/lang/en/docs/workspaces/ (Yarn 1.x)
• https://yarnpkg.com/features/workspaces (Yarn 2.x+)

Once done, should resolve #24, #12, and #13

This PR aims to refactor the FoundKey repo to use Yarn Workspaces. Notably, `foundkey-js` (fork of `misskey-js`) has been added as a workspace. I'm not sure how much work it'll be to adopt workspaces, but it does seem like Misskey already does use sub-packages so this should hopefully not be too hard. Help in refactoring would be very much appreciated. Useful information on workspaces: - https://classic.yarnpkg.com/lang/en/docs/workspaces/ (Yarn 1.x) - https://yarnpkg.com/features/workspaces (Yarn 2.x+) Once done, should resolve https://akkoma.dev/FoundKeyGang/FoundKey/issues/24, https://akkoma.dev/FoundKeyGang/FoundKey/issues/12, and https://akkoma.dev/FoundKeyGang/FoundKey/issues/13

norm added 166 commits 2022-08-26 01:50:06 +00:00

Initial commit 8d7e6ee769

✌️ b53a6bfe0c

wip cb0e275db9

rename 81289762bc

Update README.md 71d89fb33e

i want you 32b0679472

Update README.md 92c170d540

wip eacb5fea9f

wip 6dc01cd109

refactor deab5bce91

Add ignore config 502ccea980

Merge pull request #2 from misskey-dev/work/project-1 ... e43a8bf88a

Add ignore config

Add endpoints (#7) ... 148730dac3

* Add endpoints

* endpoint

* endpoint: stats

* endpoint
* reset-password
* server-info

* endpoint
* announcements
* drive
* page-push

* page endpoint

* page id

Rename render acct (#5) a4d5faa789

fix fetch mock (#9) 460e23c2e7

misc (#10) c7bfdea17b

export entity types f5fcc130bf

rename 1cfa30b982

define APIError c7d5da4ec5

provide api error detection function 1bd75619dd

Update package-lock.json 00bbd9c7bb

add streaming test aace7a1900

✌️ 2f8f6431d1

tab 767df5967a

やった 6c938905f9

Update README.md 57c6e7f823

Update README.md c27340eddc

Update README.md 49a655f78e

nannka bd52ff905f

Update README.md d7d02cd2bc

Typed stream (#13) ... 99276028ae

* Update streaming.ts

* Update streaming.ts

* wip

add test a385bd0227

test e1317ce098

✌️ e8c856924c

add endpoints (#14) ec50d657bb

add comment 88c1874943

add test c6088a1cb3

update endpoints (#15) ... 83b86c745d

* update endpoints

* add endpoints
* endpoint
* endpoints

* update announcements endpoint

* replace to DateString

* update antennas endpoints

* update app endpoints

* update auth endpoints

* update entity: Antenna

* admin/delete-all-files-of-a-user

* fix

* admin/delete-logs

* update endpoints
* admin/ad/delete
* admin/announcements/delete

* update endpoints
* admin/federation/delete-all-files
* clips/delete

* update endpoints
* drive/files/delete
* drive/folders/delete
* gallery/posts/delete
* i/delete-account
* mute/delete

* update endpoints
* notes/favorites/delete
* notes/reactions/delete
* notes/watching/delete
* users/groups/delete
* users/lists/delete

* specifical id

* update antennas/notes endpoint

update userlist endpoints (#16) 9d89314afa

Append null to TODO type 3557741f13

update api api bdb592539e

fix test 08f673802f

update test e7eac5baa7

✌️ 8d3f9d7e34

Update endpoints.ts ca655c0628

resolve #17 6ae5f76250

fix TODO type adae7cf2ec

fix TODO type 39270c782a

add FetchLike (#19) 893fa691a7

Add WebSocket option for Stream (#21) d311f74349

0.0.1 70aaf34094

Update README.md a61507e971

Update README.md 691f0d07b9

update type definitions 8c08be47cb

Update endpoints.ts 509dc30ae6

Update endpoints.ts b818da3b1c

0.0.2 d9fbddc26c

Improve type definition b1934d95f2

Update streaming.ts b2549d98f9

Improve type a1f2dd7846

Update test 5e6e1084cf

fix type 1cdf9e19a0

0.0.3 5431f4fb86

Update type definitions 1e7219b043

fix typescript config c75ff55bbc

0.0.4 aa9182bd50

Create ci.yml b9056a9fd9

rename github action b5a01217b1

Add CI status badge 1d17516aa8

fix connection close logic 091ef2e240

refactor ce12fc2b67

Improve type definitions f894d978df

Update type definition 64cf49c378

Add test b729000687

Update type definition bc3b3bb1c0

Update type definitions 2a84e5034e

Update type definitions 17c9f6eace

Update deps 873f24618c

fix type 037f68858d

codecov integration c6285944a1

add tests 154e0fe94a

refactor e40f0800a0

0.0.5 36bfaeba12

Improve type b95775041c

Add tests b6df8cc1f5

refactor 8bc7daa3f3

add test adb168dfdc

refactor 0bab055441

improve type definitions 05a902f3a5

add test 78861f8a31

Improve type definiyion 0acaa2f3b0

Resolve #1 fe1c8b882a

0.0.6 99dc38c6e0

refactor 76d0a9cc5d

Update deps 4e93f2f360

Update README.md 127a1320a8

fix typo dfc8a09f44

Update README.md b11c00ccdc

Update README.md 56958d2397

Update README.md 015d169423

Update README.md 42b611de9b

Update README.md 170e84360c

Create pull_request_template.md 65f0b195a2

Create CHANGELOG.md 7a41dc2a7a

Update pull_request_template.md 0616534af7

introduce eslint 677ed40b40

Update .eslintrc.js 51ca78d496

ci: use npm ci to improve CI performance 2ffff0fa61

introduce api-extractor 32ff71a67d

Update api.yml 99fa6e3cd0

Create CONTRIBUTING.md 7ee3b4536c

Create CODE_OF_CONDUCT.md 8ea124b999

Update CONTRIBUTING.md e6e339cc3e

update contribution guide 0c61d052d2

Update CONTRIBUTING.en.md 85eb00b0a6

Update CONTRIBUTING.en.md 39668a21d7

Update CONTRIBUTING.en.md 3e6ad67d59

Update CONTRIBUTING.en.md ab391870ed

Update CONTRIBUTING.md b1b90185c4

Update CONTRIBUTING.en.md a526f75a3e

update contribution guides 7a148e9ffa

Create config.yml 1243e6a655

fix: MessagingMessageの型を修正 (#28) ... fa98dabeec

* fix messaging

* add changelog

fix: Notificationsの型を修正 (#27) ... f278390012

* Update entities.ts

* Update entities.ts

* extract

* fix app define
extract

* appの定義を修正

* 改行コード修正

* add changelog

* fix

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>

fix: apiでネイティブfetchを格納する際に無名関数でラップするように (#29) ... b7fd9e8c55

* fix fetch

* add comment

* 表現を変更

update type definition d549879cd4

0.0.7 4021c3c61a

Update misskey-js.api.md 227e603194

Update README.md 8ba56df54e

✨ 71f35d90c5

feat: add type definition for messagingMessage event to main stream channel (#30) ... 34afa60aff

* add: type definition for messagingMessage event

* update: changelog

update Note type 510a1408a2

Update misskey-js.api.md 80ef07222d

0.0.8 7f3943f794

add list of api permission, Update Note type 714753d001

0.0.9 f08a840d7d

add consts 43d9149c8a

0.0.10 043ffe3a2e

Fix #31 de81437248

Update .eslintrc.js 2bf63b158c

Update .eslintrc.js 4ff49b0a3f

fix lint d2b634c349

Add missing main stream types (#36) ... 755189f6f3

* Add missing main stream types

* changelog, fix

* update api

* fix

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>

UserDetailed, MeDetailed (#34) ... 231ac8e323

* UserDetailed, MeDetailed

* npm run api

* remote: lastFetchedAt

* Update misskey-js.api.md

Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>

update deps 233ffe46d5

fix test 2c079a9608

update copyright a4b14d54f2

0.0.11 6c990f3ce7

improve test a05f47d5cc

fix streaming query bug f3640add23

0.0.12 cbce1242b9

Resolve #38 287f595239

0.0.13 8ab9b92f60

fix (#42) 84dffdf510

0.0.14 b41c1fe3af

Update .eslintrc.js bc9525c665

Update .eslintrc.js 78ee600752

NoteUpdatedEvent に unreacted を追加 ... 5531a1fdf2

Fix #43

Update consts.ts c17c42fa05

Add comment property to DriveFile ... 28f244479c

Some components of Misskey like the image viewer use this property, but it hasn't been defined in the type definition itself.

Merge pull request 'fix: Add comment property to DriveFile' (#46) from archaeme/patch-1 into develop ... ea2f56f86e

Reviewed-on: norm/foundkey.js#46

Update package.json b21ac2da9b

Update CHANGELOG.md for 0.0.15 d5a92e822e

Update 'CHANGELOG.md' 637c6f1411

Add 'packages/foundkey-js/' from commit '637c6f1411c9c03f204f21da12e1f8e390d05cb8' ... b558716fa1

git-subtree-dir: packages/foundkey-js
git-subtree-mainline: aa144e803c
git-subtree-split: 637c6f1411

add workspaces to package.json 3b921ece5d

norm commented 2022-08-26 01:52:04 +00:00

Author

Owner

Copy link

The large amount of commits is because these are originally from the misskey.js repo plus a few more that I added in my fork.

I used git-subtree to import the repo and its commit history as a subdirectory of this repo.

The large amount of commits is because these are originally from the [misskey.js repo](https://github.com/misskey-dev/misskey.js) plus a few more that I added in [my fork](https://akkoma.dev/norm/foundkey.js). I used `git-subtree` to import the repo and its commit history as a subdirectory of this repo.

norm added 1 commit 2022-08-26 03:36:34 +00:00

Fix build errors c1242cfde2

norm added 1 commit 2022-08-26 04:11:06 +00:00

Update yarn lockfile e8699ff978

norm added 1 commit 2022-08-26 04:15:26 +00:00

fix import path for TreeAdapter b230dc98a9

norm commented 2022-08-26 04:18:16 +00:00

Author

Owner

Copy link

Ok, so server finally starts and all, but like the icons are missing for some reason...

Seems like more import paths needs fixing...

Ok, so server finally starts and all, but like the icons are missing for some reason... Seems like more import paths needs fixing...

norm commented 2022-08-26 04:22:02 +00:00

Author

Owner

Copy link

Also wondering if we should jump to Yarn 2.x+ or stick to 1.x

Also wondering if we should jump to Yarn 2.x+ or stick to 1.x

norm added 1 commit 2022-08-26 04:31:25 +00:00

Fix paths for twemoji and font-awesome 33146ffa5e

norm added 1 commit 2022-08-26 04:53:29 +00:00

chore: update foundkey-js package.json 7420aab1b6

norm added 1 commit 2022-08-26 05:26:10 +00:00

client: Use foundkey-js instead of misskey-js a424426857

norm added 1 commit 2022-08-26 05:30:30 +00:00

foundkey-js: remove github files ebaa1960bf

norm added 2 commits 2022-08-26 05:35:53 +00:00

backend: move to foundkey-js 237c29a4b8

sw: switch to foundkey-js 622731d1bd

Johann150 commented 2022-08-26 05:44:11 +00:00

Owner

Copy link

Also wondering if we should jump to Yarn 2.x+ or stick to 1.x

I think I brought that up on IRC a bit ago because there is a PR by thatonecalculator to bring misskey to yarn 2 if I remember correctly. But we have probably changed quite a lot from misskey already that we couldn't just merge that one in.

> Also wondering if we should jump to Yarn 2.x+ or stick to 1.x I think I brought that up on IRC a bit ago because there is a PR by thatonecalculator to bring misskey to yarn 2 if I remember correctly. But we have probably changed quite a lot from misskey already that we couldn't just merge that one in.

👍 1

norm commented 2022-08-26 05:48:48 +00:00

Author

Owner

Copy link

Yeah, there's a bunch of stuff that hardcodes to various paths that I had to change to make things work in this refactor. Moving to yarn 2 would probably require more of those sorts of changes.

Yeah, there's a bunch of stuff that hardcodes to various paths that I had to change to make things work in this refactor. Moving to yarn 2 would probably require more of those sorts of changes.

norm added 1 commit 2022-08-26 06:31:46 +00:00

remove install-packages.js ... 99bed3f872

Since we're now using workspaces, the dependencies of all modules in the
repo are automatically fetched.

norm force-pushed refactor/workspaces from 7ee8034909 to 90adbfb2c2 2022-08-26 06:37:19 +00:00 Compare

norm added 1 commit 2022-08-26 06:44:10 +00:00

foundkey-js: mark as module 13b2cba980

norm commented 2022-08-26 06:47:27 +00:00

Author

Owner

Copy link

Judging by calckey's package.json it seems like they're already using workspaces, and also the use of workspaces seems to have eliminated much of the need for the various scripts, so I'll see which we can remove.

Judging by [calckey's package.json](https://codeberg.org/thatonecalculator/calckey/src/branch/develop/package.json) it seems like they're already using workspaces, and also the use of workspaces seems to have eliminated much of the need for the various scripts, so I'll see which we can remove.

👍 1

norm added 1 commit 2022-08-26 16:49:07 +00:00

switch to yarn for scripts and move start to backend 6bccbc0d6d

norm added 2 commits 2022-08-26 19:24:43 +00:00

ci: add lint for foundkey-js d8fd6d55ed

migrate to Yarn 3.2.3 6bb3f39c36

norm added 1 commit 2022-08-26 19:33:43 +00:00

fix typo in ci b3548cf9a0

norm added 1 commit 2022-08-26 19:50:29 +00:00

ci: combine install and lint/build tasks 759d031a5f

norm added 2 commits 2022-08-26 20:38:58 +00:00

remove subproject yarn.locks 247a01dfe6

add foundkey-js to each workspace package.json bc0f0bf08f

norm added 2 commits 2022-08-26 22:05:21 +00:00

fix some deps dd9dc497fb

foundkey-js: use prepack instead of prepare d36d9692b8

norm added 1 commit 2022-08-26 22:15:32 +00:00

explicitly build foundkey-js before everything else 91e4c159b8

norm added 1 commit 2022-08-26 22:19:44 +00:00

use topological for build 122482e0a2

norm commented 2022-08-26 22:30:26 +00:00

Author

Owner

Copy link

Finally gotten the build step to work properly. The yarn workspaces foreach command also supports --parallel and it does work locally on my own machine, but I'm not sure if it would be too much to handle on a small VPS...

That could be made into a separate build-parallel script if needed be.

Finally gotten the build step to work properly. The `yarn workspaces foreach` command also supports `--parallel` and it does work locally on my own machine, but I'm not sure if it would be too much to handle on a small VPS... That could be made into a separate `build-parallel` script if needed be.

norm changed title from WIP: Workspaces refactor to Workspaces refactor 2022-08-26 22:34:52 +00:00

norm commented 2022-08-26 22:52:53 +00:00

Author

Owner

Copy link

I think everything works now. This should be ready for review.

I think everything works now. This should be ready for review.

toast commented 2022-08-26 23:06:06 +00:00

Owner

Copy link

You may want to rebase this - I somehow doubt all 100 ancient syuilo commits are relevant.

You may want to rebase this - I somehow doubt all 100 ancient syuilo commits are relevant.

Johann150 commented 2022-08-26 23:08:47 +00:00

Owner

Copy link

@toast I belive those are from misskey.js:

The large amount of commits is because these are originally from the misskey.js repo plus a few more that I added in my fork.

I used git-subtree to import the repo and its commit history as a subdirectory of this repo.
-- #86 (comment)

@toast I belive those are from misskey.js: > The large amount of commits is because these are originally from the misskey.js repo plus a few more that I added in my fork. > > I used git-subtree to import the repo and its commit history as a subdirectory of this repo. -- https://akkoma.dev/FoundKeyGang/FoundKey/pulls/86#issuecomment-2519

Johann150 approved these changes 2022-08-26 23:25:38 +00:00

Johann150 left a comment

Owner

Copy link

This is a lot of stuff, thanks for doing this! 🙏

Didn't see anything that would be obviously wrong, but since its so much I'm also trusting that you tested it and it works. :)

This is a lot of stuff, thanks for doing this! 🙏 Didn't see anything that would be obviously wrong, but since its so much I'm also trusting that you tested it and it works. :)

👍 2

Johann150 added this to the (deleted) project 2022-08-27 00:03:47 +00:00

Johann150 added a new dependency 2022-08-27 00:05:03 +00:00

#24 Add misskey-js into main repo

norm merged commit 10caf861e8 into main 2022-08-28 14:46:45 +00:00

norm deleted branch refactor/workspaces 2022-08-28 14:46:45 +00:00

norm referenced this pull request from a commit 2022-08-28 14:46:46 +00:00

Merge pull request 'Workspaces refactor' (#86) from refactor/workspaces into main

norm referenced this pull request from a commit 2022-09-07 18:04:26 +00:00

Revert "ci: combine install and lint/build tasks"

Johann150 added the

upkeep

label 2022-12-23 10:26:10 +00:00

Sign in to join this conversation.

Reviewers

No reviewers

Johann150

Labels

Clear labels   

feature

task that proposes new feature(s)

  

fix

task to fix behavioral problems in the FoundKey codebase

  

upkeep

task that should make FoundKey smaller and more maintainable

No labels

feature

fix

upkeep

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

3 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks

#24 Add misskey-js into main repo}

FoundKeyGang/FoundKey

Reference: FoundKeyGang/FoundKey#86

No description provided.