Manual update some dependency

[yanguoyu]

Because of some dependencies auto-update failed, so we need to update them manually.
https://github.com/Magickbase/neuron/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc

• fix(deps): update dependency typeorm to v0.3.17 neuron#139 @JeffreyMa597 @WhiteMinds chore: upgrade typeorm to 0.2.45 nervosnetwork/neuron#2680
• chore(deps): update dependency jest-when to v3 - autoclosed neuron#162 @JeffreyMa597 fix: update dependency jest when to v3 nervosnetwork/neuron#2684
• fix(deps): update dependency sqlite3 to v5.1.6 - autoclosed neuron#167 @JeffreyMa597 @WhiteMinds fix:update dependency sqlite3 to v5.1.6 nervosnetwork/neuron#2676
• chore(deps): update dependency typescript to v5.3.2 neuron#191 @yanguoyu chore(deps): update typescript to 5.0.4 nervosnetwork/neuron#2660

[yanguoyu]

For updating typescript to V5, it's blocked by ttypescript. Because of this cevek/ttypescript#140 (comment), and the ttypescript seems not active. And someone gives a solution nonara/ts-patch#93 (comment) with ts-patch, but this repository owner may not have much time to update it nonara/ts-patch#93 (comment).

So I have four solutions to fix it:

1. use roll-up or babel to resolve the alias problem, they are stable but it seems a waste and heavy to use them.
2. Replace ttypescript with ts-patch, I think it can work with typescript V5 at least.
3. Wrapper require function to try to get the module from dist directory.
4. Output the tsc file to dist/node_modules, but it will change the output directory struct with input. It may introduce other problems.

I suggest using the second solution, although it's maybe updating not timely, we only use this to transform the path, I think it's enough. But after I use the transform plugin with ts-patch, the compiler progress crashed with out of memory. Then I find another package tsc-alias to alias the path after tsc. It works.

Another thing I am concerned about is whether the package tsc-alias will be safe in the future. Because it will change the outputs after tsc. Should we alias the required path by ourselves? If so, I think 3 or 4 is better, or we can remove tsconfig's baseUrl @Keith-CY

[Keith-CY]

For updating typescript to V5, it's blocked by ttypescript. Because of this cevek/ttypescript#140 (comment), and the ttypescript seems not active. And someone gives a solution nonara/ts-patch#93 (comment) with ts-patch, but this repository owner may not have much time to update it nonara/ts-patch#93 (comment).

So I have four solutions to fix it:

1. use roll-up or babel to resolve the alias problem, they are stable but it seems a waste and heavy to use them.
2. Replace ttypescript with ts-patch, I think it can work with typescript V5 at least.
3. Wrapper require function to try to get the module from dist directory.
4. Output the tsc file to dist/node_modules, but it will change the output directory struct with input. It may introduce other problems.

I suggest using the second solution, although it's maybe updating not timely, we only use this to transform the path, I think it's enough. But after I use the transform plugin with ts-patch, the compiler progress crashed with out of memory. Then I find another package tsc-alias to alias the path after tsc. It works.

Another thing I am concerned about is whether the package tsc-alias will be safe in the future. Because it will change the outputs after tsc. Should we alias the required path by ourselves? If so, I think 3 or 4 is better, or we can remove tsconfig's baseUrl @Keith-CY

Does paths in tsconfig.json meet the request?

Ref:

• paths: https://www.typescriptlang.org/tsconfig#paths

[yanguoyu]

Does paths in tsconfig.json meet the request?

Ref:

• paths: https://www.typescriptlang.org/tsconfig#paths

microsoft/TypeScript#10866
microsoft/TypeScript#10866 (comment)
It's a known issue, tsc will not change the module path, and they think path mapping reflects the behavior of an external resolution scheme.

[WhiteMinds]

I think we can remove the import aliases because I believe the cost it brings is less than the benefits.

Benefits of using import aliases:

1. Improves readability (although sometimes it's not necessarily the case, I often mistake utils for a library)
2. No need to update import codes when moving files

Costs of using import aliases:

1. Increases workflow complexity, any workflow that needs to handle the source code must configure the alias, such as tsc, vite, webpack, IDE (VSCode), etc., which also means that it reduces the available ecosystem.
2. Increases cognitive burden (sometimes the source of the imported file needs to be clicked to confirm)

I actually don't think the benefit of not updating the import code is necessary because moving will always result in a new commit, and recording IDE's automatic update import records in it will not affect anything. IDEs hardly make mistakes with this kind of relative path change.

Regarding the readability of imports, I think it is not very important. Often, we don't care about import codes, and we only need IDE's automatic import and eslint's automatic sorting of import orders.

Therefore, taking all factors into account, I think the cost we pay is greater than our benefits. We can continue to use it if there were no problems before, but since we are currently blocked by import aliases, we can consider removing them.

@yanguoyu @Keith-CY What do you think?

[Keith-CY]

I think we can remove the import aliases because I believe the cost it brings is less than the benefits.

Benefits of using import aliases:

1. Improves readability (although sometimes it's not necessarily the case, I often mistake utils for a library)
2. No need to update import codes when moving files

Costs of using import aliases:

1. Increases workflow complexity, any workflow that needs to handle the source code must configure the alias, such as tsc, vite, webpack, IDE (VSCode), etc., which also means that it reduces the available ecosystem.
2. Increases cognitive burden (sometimes the source of the imported file needs to be clicked to confirm)

I actually don't think the benefit of not updating the import code is necessary because moving will always result in a new commit, and recording IDE's automatic update import records in it will not affect anything. IDEs hardly make mistakes with this kind of relative path change.

Regarding the readability of imports, I think it is not very important. Often, we don't care about import codes, and we only need IDE's automatic import and eslint's automatic sorting of import orders.

Therefore, taking all factors into account, I think the cost we pay is greater than our benefits. We can continue to use it if there were no problems before, but since we are currently blocked by import aliases, we can consider removing them.

@yanguoyu @Keith-CY What do you think?

I also value the readability of code because most time I read code from GitHub which is not so smart to resolve imports. Especially alias, it may be resolved to an external package occasionally.

[WhiteMinds]

I also value the readability of code because most time I read code from GitHub which is not so smart to resolve imports. Especially alias, it may be resolved to an external package occasionally.

Yes, that's exactly what I wanted to say about the importance of following standards. By following standards, we can better utilize various ecosystems.
Online IDEs that support importing relative paths are definitely more common than those that support importing aliases.

[yanguoyu]

I also value the readability of code because most time I read code from GitHub which is not so smart to resolve imports. Especially alias, it may be resolved to an external package occasionally.

Yes, that's exactly what I wanted to say about the importance of following standards. By following standards, we can better utilize various ecosystems. Online IDEs that support importing relative paths are definitely more common than those that support importing aliases.

I also think it's better to remove the import aliases.

[yanguoyu]

nervosnetwork/neuron#2660

[WhiteMinds]

nervosnetwork/neuron#2660

Afterwards, it is probably necessary to provide PRs for modifications to those two large branches(newui / lightclient).

[yanguoyu]

nervosnetwork/neuron#2660

Afterwards, it is probably necessary to provide PRs for modifications to those two large branches(newui / lightclient).

We will rebase the develop branch regularly after some commits are added to develop branch.

[alexsupa597]

nervosnetwork/neuron#2676

[WhiteMinds]

From version 0.2 to 0.3, TypeORM introduced significant changes to concepts and APIs. The APIs we currently use, such as createConnection, getConnectionOptions, and getConnection, have been deprecated.

Migrating to this version may require a considerable amount of time to adapt to the new abstract concepts. Therefore, I suggest creating a separate issue specifically for upgrading TypeORM from version 0.2 to 0.3.

For now, I have only completed a PR to upgrade to the latest version of 0.2 from our current version: nervosnetwork/neuron#2680

[alexsupa597]

nervosnetwork/neuron#2684