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

8d7e6ee769

Initial commit

b53a6bfe0c ✌️

cb0e275db9 wip

81289762bc rename

71d89fb33e Update README.md

32b0679472 i want you

92c170d540 Update README.md

eacb5fea9f wip

6dc01cd109 wip

deab5bce91 refactor

502ccea980 Add ignore config

e43a8bf88a

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

Add ignore config

148730dac3

Add endpoints (#7) ...

* Add endpoints

* endpoint

* endpoint: stats

* endpoint
* reset-password
* server-info

* endpoint
* announcements
* drive
* page-push

* page endpoint

* page id

a4d5faa789

Rename render acct (#5)

460e23c2e7

fix fetch mock (#9)

c7bfdea17b

misc (#10)

f5fcc130bf export entity types

1cfa30b982 rename

c7d5da4ec5 define APIError

1bd75619dd provide api error detection function

00bbd9c7bb Update package-lock.json

aace7a1900 add streaming test

2f8f6431d1 ✌️

767df5967a tab

6c938905f9 やった

57c6e7f823 Update README.md

c27340eddc Update README.md

49a655f78e Update README.md

bd52ff905f nannka

d7d02cd2bc

Update README.md

99276028ae

Typed stream (#13) ...

* Update streaming.ts

* Update streaming.ts

* wip

a385bd0227 add test

e1317ce098 test

e8c856924c ✌️

ec50d657bb

add endpoints (#14)

88c1874943

add comment

c6088a1cb3 add test

83b86c745d

update endpoints (#15) ...

* 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

9d89314afa

update userlist endpoints (#16)

3557741f13

Append null to TODO type

bdb592539e update api api

08f673802f fix test

e7eac5baa7 update test

8d3f9d7e34 ✌️

ca655c0628 Update endpoints.ts

6ae5f76250 resolve #17

adae7cf2ec fix TODO type

39270c782a fix TODO type

893fa691a7

add FetchLike (#19)

d311f74349

Add WebSocket option for Stream (#21)

70aaf34094 0.0.1

a61507e971 Update README.md

691f0d07b9 Update README.md

8c08be47cb update type definitions

509dc30ae6 Update endpoints.ts

b818da3b1c Update endpoints.ts

d9fbddc26c 0.0.2

b1934d95f2 Improve type definition

b2549d98f9 Update streaming.ts

a1f2dd7846 Improve type

5e6e1084cf Update test

1cdf9e19a0 fix type

5431f4fb86 0.0.3

1e7219b043 Update type definitions

c75ff55bbc fix typescript config

aa9182bd50 0.0.4

b9056a9fd9 Create ci.yml

b5a01217b1 rename github action

1d17516aa8

Add CI status badge

091ef2e240 fix connection close logic

ce12fc2b67 refactor

f894d978df Improve type definitions

64cf49c378 Update type definition

b729000687 Add test

bc3b3bb1c0 Update type definition

2a84e5034e Update type definitions

17c9f6eace Update type definitions

873f24618c Update deps

037f68858d fix type

c6285944a1 codecov integration

154e0fe94a add tests

e40f0800a0 refactor

36bfaeba12 0.0.5

b95775041c Improve type

b6df8cc1f5 Add tests

8bc7daa3f3 refactor

adb168dfdc add test

0bab055441 refactor

05a902f3a5 improve type definitions

78861f8a31 add test

0acaa2f3b0 Improve type definiyion

fe1c8b882a Resolve #1

99dc38c6e0 0.0.6

76d0a9cc5d refactor

4e93f2f360 Update deps

127a1320a8

Update README.md

dfc8a09f44 fix typo

b11c00ccdc

Update README.md

56958d2397

Update README.md

015d169423

Update README.md

42b611de9b

Update README.md

170e84360c

Update README.md

65f0b195a2

Create pull_request_template.md

7a41dc2a7a

Create CHANGELOG.md

0616534af7 Update pull_request_template.md

677ed40b40 introduce eslint

51ca78d496 Update .eslintrc.js

2ffff0fa61 ci: use `npm ci` to improve CI performance

32ff71a67d introduce api-extractor

99fa6e3cd0 Update api.yml

7ee3b4536c

Create CONTRIBUTING.md

8ea124b999

Create CODE_OF_CONDUCT.md

e6e339cc3e

Update CONTRIBUTING.md

0c61d052d2 update contribution guide

85eb00b0a6

Update CONTRIBUTING.en.md

39668a21d7

Update CONTRIBUTING.en.md

3e6ad67d59

Update CONTRIBUTING.en.md

ab391870ed

Update CONTRIBUTING.en.md

b1b90185c4

Update CONTRIBUTING.md

a526f75a3e

Update CONTRIBUTING.en.md

7a148e9ffa update contribution guides

1243e6a655 Create config.yml

fa98dabeec

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

* fix messaging

* add changelog

f278390012

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

* Update entities.ts

* Update entities.ts

* extract

* fix app define
extract

* appの定義を修正

* 改行コード修正

* add changelog

* fix

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

b7fd9e8c55

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

* fix fetch

* add comment

* 表現を変更

d549879cd4 update type definition

4021c3c61a 0.0.7

227e603194 Update misskey-js.api.md

8ba56df54e

Update README.md

71f35d90c5 ✨

34afa60aff

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

* add: type definition for messagingMessage event

* update: changelog

510a1408a2 update Note type

80ef07222d Update misskey-js.api.md

7f3943f794 0.0.8

714753d001 add list of api permission, Update Note type

f08a840d7d 0.0.9

43d9149c8a add consts

043ffe3a2e 0.0.10

de81437248 Fix #31

2bf63b158c Update .eslintrc.js

4ff49b0a3f

Update .eslintrc.js

d2b634c349 fix lint

755189f6f3

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

* Add missing main stream types

* changelog, fix

* update api

* fix

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

231ac8e323

UserDetailed, MeDetailed (#34) ...

* UserDetailed, MeDetailed

* npm run api

* remote: lastFetchedAt

* Update misskey-js.api.md

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

233ffe46d5 update deps

2c079a9608 fix test

a4b14d54f2 update copyright

6c990f3ce7 0.0.11

a05f47d5cc improve test

f3640add23 fix streaming query bug

cbce1242b9 0.0.12

287f595239 Resolve #38

8ab9b92f60 0.0.13

84dffdf510

fix (#42)

b41c1fe3af 0.0.14

bc9525c665

Update .eslintrc.js

78ee600752

Update .eslintrc.js

5531a1fdf2 NoteUpdatedEvent に unreacted を追加 ...

Fix #43

c17c42fa05

Update consts.ts

28f244479c

Add comment property to DriveFile ...

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

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

Reviewed-on: norm/foundkey.js#46

b21ac2da9b

Update package.json

d5a92e822e Update CHANGELOG.md for 0.0.15

637c6f1411 Update 'CHANGELOG.md'

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

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

3b921ece5d

add workspaces to package.json

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

c1242cfde2

Fix build errors

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

e8699ff978

Update yarn lockfile

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

b230dc98a9

fix import path for TreeAdapter

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

33146ffa5e

Fix paths for twemoji and font-awesome

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

7420aab1b6

chore: update foundkey-js package.json

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

a424426857

client: Use foundkey-js instead of misskey-js

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

ebaa1960bf

foundkey-js: remove github files

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

237c29a4b8

backend: move to foundkey-js

622731d1bd

sw: switch to foundkey-js

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

99bed3f872

remove install-packages.js ...

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

13b2cba980

foundkey-js: mark as module

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

6bccbc0d6d

switch to yarn for scripts and move start to backend

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

d8fd6d55ed

ci: add lint for foundkey-js

6bb3f39c36

migrate to Yarn 3.2.3

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

b3548cf9a0

fix typo in ci

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

759d031a5f

ci: combine install and lint/build tasks

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

247a01dfe6

remove subproject yarn.locks

bc0f0bf08f

add foundkey-js to each workspace package.json

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

dd9dc497fb

fix some deps

d36d9692b8

foundkey-js: use prepack instead of prepare

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

91e4c159b8

explicitly build foundkey-js before everything else

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

122482e0a2

use topological for build

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 issue 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 issue 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 Label

feature

fix

upkeep

Milestone

Clear milestone

No items

No Milestone

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.