Added ts node approach #6112

SamTV12345 · 2024-01-20T17:11:53Z

No description provided.

AugustinMauroy · 2024-01-20T22:31:35Z

src/package.json

-    "test-container": "mocha --timeout 5000 tests/container/specs/api"
+    "test": "mocha --require ts-node/register --timeout 120000 --recursive tests/backend/specs ../node_modules/ep_*/static/tests/backend/specs",
+    "test-container": "mocha --require ts-node/register --timeout 5000 tests/container/specs/api",
+    "dev": "ts-node node/server.ts",


you can run ts file whit tsx like that node --import tsx ./file.ts

Ref:

TSX

article about loader on nodejs

Is tsx better than ts-node?

with ts-node you call a script that runs the typescriopt script, whereas with tsx in loader node it's node that runs the script directly. Normally tsx is supposed to perform better, but I'm not 100% sure.

EDIT: i have found this link

AugustinMauroy · 2024-01-21T11:53:56Z

src/tsconfig.json

@@ -0,0 +1,109 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */


I thinks we can remove all commented key to have something more clean. What do you thinks ?

Good suggestion. I did that.

AugustinMauroy · 2024-01-24T08:10:49Z

src/package.json

@@ -108,7 +108,8 @@
    "test": "mocha --import=tsx --timeout 120000 --recursive tests/backend/specs ../node_modules/ep_*/static/tests/backend/specs",
    "test-container": "mocha --import=tsx --timeout 5000 tests/container/specs/api",
    "dev": "node --import tsx node/server.ts",
-    "prod": "node --import tsx node/server.ts"
+    "prod": "node --import tsx node/server.ts",
+    "ts-check": "tsc --noEmit --watch"


Suggested change

"ts-check": "tsc --noEmit --watch"

"ts-check": "tsc --noEmit",

"ts-check:watch": "tsc --noEmit --watch"

it's allow us to use ts-check on CI and ts-check:watch for dev. What do you think ?

AugustinMauroy · 2024-01-24T08:12:40Z

src/node/models/PromiseWithStd.ts

+import {Readable} from "node:stream";
+import {ChildProcess} from "node:child_process";


If you import something as type use this syntax:

Suggested change

import {Readable} from "node:stream";

import {ChildProcess} from "node:child_process";

import type {Readable} from "node:stream";

import type {ChildProcess} from "node:child_process";

this avoids confusion for junior devs.

https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html

Thanks for the suggestion. I fixed that.

AugustinMauroy · 2024-01-24T08:53:41Z

is it a good idea to call the directory model? I'd go for types or maybe you've also got people using @types but I'm not a big fan because it creates confusion with DefinitelyTyped

SamTV12345 · 2024-01-24T08:57:53Z

is it a good idea to call the directory model? I'd go for types or maybe you've also got people using @types but I'm not a big fan because it creates confusion with DefinitelyTyped

Maybe not. I renamed it to types.

AugustinMauroy · 2024-01-24T09:09:18Z

.github/workflows/windows.yml

@@ -116,7 +116,8 @@ jobs:
      -
        name: Install Cypress
        run: cd etherpad && cd src && npm install cypress --legacy-peer-deps
-      - name: Install npm@6
+      - 
+        name: Install npm@6
        run: npm install npm@6 -g


why install npm because it's already ship with node

The problem is that Etherpad is one of the first projects that started to use node and npm. The only problem is that to run Etherpad you require this old npm version. More recent versions of npm will upgrade the package-lock.json file which breaks the Etherpad installation. There is a branch available that tries to do the npm update but there is unfortunately currently no one looking at it.

I see. In short, the infrastructure is "old". We can start with typescript.
I'm willing to open up an issue for the roadmap of how to modernise the infrastructure if you (the ether contributors) are interested.

Yes that would be great. Thanks. I guess the best starting point is currently Typescript. After that current npm version and then move to ES instead of CJS.

AugustinMauroy · 2024-01-24T19:31:56Z

src/node/hooks/express.ts

@@ -1,7 +1,9 @@
 'use strict';

+import {Socket} from "node:net";
+import {MapArrayType} from "../types/MapType";
+
 const _ = require('underscore');


normally this pr allow us to migrate the back-end to esm ?

You should test that :

Suggested change

const _ = require('underscore');

import _ from 'underscore';

Does not work unfortunately. That throws an error in NodeJS. It only works for types because they are ignored by jsx.

Could you give exact error. Because it's should work.
Unless the type in the package.json is set to commonjs.

When I go to express.ts and change the import of SecretRotater to import {SecretRotater} from '../security/SecretRotater' it says TypeError import_SecretRotater.SecretRotater is not a constructor

Oh. So everytime I use import I also have to make sure that the script to be imported uses the ES syntax. Otherwise I get weird errors.

Ok, I thinks it's because the source file/package isn't use ES syntax .

AugustinMauroy · 2024-01-24T19:32:39Z

src/node/hooks/express.ts

@@ -1,7 +1,9 @@
 'use strict';

+import {Socket} from "node:net";
+import {MapArrayType} from "../types/MapType";


don't forget to add type keyword 😄

Suggested change

import {MapArrayType} from "../types/MapType";

import type {MapArrayType} from "../types/MapType";

AugustinMauroy · 2024-01-24T19:36:30Z

src/node/hooks/express.ts

@@ -160,10 +165,10 @@ exports.restartServer = async () => {
  }

  // Measure response time
-  app.use((req, res, next) => {
+  app.use((req:any, res:any, next:Function) => {


What if req doesn't have any specifique type ? And what if we type req: Request

REF

AugustinMauroy · 2024-02-01T18:22:01Z

src/node/stats.ts

@@ -0,0 +1,10 @@
+'use strict';


use strict is still needed with typescript ?

AugustinMauroy · 2024-02-05T20:14:53Z

why all CI didn't pass

SamTV12345 · 2024-02-05T21:00:07Z

why all CI didn't pass

Because there is a major outage for the ubuntu repository for libreoffice. Thus the pipelines fail.

AugustinMauroy · 2024-02-06T09:02:50Z

ok

SamTV12345 changed the title ~~Fixed determining file extension.~~ Added ts node approach Jan 20, 2024

SamTV12345 mentioned this pull request Jan 20, 2024

Add typescript support and update package.json #5750

Closed

AugustinMauroy reviewed Jan 20, 2024

View reviewed changes

AugustinMauroy reviewed Jan 21, 2024

View reviewed changes

AugustinMauroy reviewed Jan 24, 2024

View reviewed changes

AugustinMauroy reviewed Feb 1, 2024

View reviewed changes

src/node/stats.ts Outdated

@@ -0,0 +1,10 @@

'use strict';

Copy link

AugustinMauroy Feb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use strict is still needed with typescript ?

SamTV12345 added 19 commits February 5, 2024 20:40

Fixed determining file extension.

826dc93

Added ts-node

1a8e5b1

Fixed backend tests.

1893cef

Fixed frontend test runs.

ac5c65b

Fixed tests.

fadc56e

Use script approach for starting etherpad.

cfaee1a

Change directory to src.

c4fa093

Fixed env.

e154a61

Change directory

71cd42d

Fixed build arg.

3d7ca0f

Fixed docker build.

cb97af3

Fixed.

cf62973

Fixed cypress file path.

ef650be

Fixed.

996fcab

Use latest node container.

df9ba59

Fixed windows workflow.

9842a03

Use tsx and optimized docker image.

c10867c

Added workflow for type checks.

2d69099

Fixed.

dedb7c7

SamTV12345 and others added 16 commits February 5, 2024 20:41

Added tsconfig.

93dffc0

Converted more files to typescript.

c24ae14

Removed commented keys.

1009b02

Typed caching middleware.

cd98696

Added script for checking the types.

d5c011e

Moved SecretRotator to typescript.

a57b13d

Fixed npm installation and moved to types folder.

d2cbe1b

Use better scripts for watching typescript changes.

e521b4b

Update windows.yml

1252b0d

Fixed order of npm installation.

2df3011

Converted i18n.

545c7c6

Added more types.

03e7305

Added more types.

6fdf9ed

Fixed import.

b617ac4

Fixed tests.

1f43bf5

Fixed tests.

dfef1e7

SamTV12345 force-pushed the feature/typescript-ts-node branch from 4d8d17d to dfef1e7 Compare February 5, 2024 19:42

SamTV12345 added 4 commits February 5, 2024 20:45

Fixed type checking test.

04b88cf

Fixed stats

85881c7

Added express types.

f604eb8

fixed.

8519119

SamTV12345 merged commit ead3c0e into develop Feb 5, 2024
31 of 41 checks passed

SamTV12345 deleted the feature/typescript-ts-node branch February 5, 2024 20:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added ts node approach #6112

Added ts node approach #6112

SamTV12345 commented Jan 20, 2024

AugustinMauroy Jan 20, 2024 •

edited

Loading

SamTV12345 Jan 20, 2024

AugustinMauroy Jan 20, 2024 •

edited

Loading

AugustinMauroy Jan 21, 2024

SamTV12345 Jan 21, 2024

AugustinMauroy Jan 21, 2024

AugustinMauroy Jan 24, 2024

AugustinMauroy Jan 24, 2024

SamTV12345 Jan 24, 2024

AugustinMauroy commented Jan 24, 2024

SamTV12345 commented Jan 24, 2024

AugustinMauroy Jan 24, 2024

SamTV12345 Jan 24, 2024

AugustinMauroy Jan 24, 2024

SamTV12345 Jan 24, 2024

AugustinMauroy Jan 24, 2024

SamTV12345 Jan 24, 2024

AugustinMauroy Jan 24, 2024

SamTV12345 Jan 24, 2024

SamTV12345 Jan 24, 2024

AugustinMauroy Jan 25, 2024

AugustinMauroy Jan 24, 2024

AugustinMauroy Jan 24, 2024

AugustinMauroy Feb 1, 2024

AugustinMauroy commented Feb 5, 2024

SamTV12345 commented Feb 5, 2024

AugustinMauroy commented Feb 6, 2024

	"ts-check": "tsc --noEmit --watch"
	"ts-check": "tsc --noEmit",
	"ts-check:watch": "tsc --noEmit --watch"

		import {Readable} from "node:stream";
		import {ChildProcess} from "node:child_process";

	import {MapArrayType} from "../types/MapType";
	import type {MapArrayType} from "../types/MapType";

Added ts node approach #6112

Added ts node approach #6112

Conversation

SamTV12345 commented Jan 20, 2024

AugustinMauroy Jan 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AugustinMauroy Jan 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AugustinMauroy commented Jan 24, 2024

SamTV12345 commented Jan 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AugustinMauroy commented Feb 5, 2024

SamTV12345 commented Feb 5, 2024

AugustinMauroy commented Feb 6, 2024

AugustinMauroy Jan 20, 2024 •

edited

Loading

AugustinMauroy Jan 20, 2024 •

edited

Loading