Update target to es2024, use tsconfigs for typechecks, and run type checks at the top level (breaking changes) #2653

bdemann · 2025-02-05T19:27:43Z

Contributor

Reviewer

Breaking Changes

Uint8Array must use explicit <ArrayBuffer> type argument instead of the default <ArrayBufferLike> type argument

lastmjs · 2025-02-08T00:40:07Z

http_client/fetch_ic/call.ts

@@ -126,7 +126,7 @@ async function prepareRequestBody(
        init.body instanceof Float32Array ||
        init.body instanceof Float64Array
    ) {
-        return new Uint8Array(init.body);
+        return new Uint8Array(init.body as ArrayBuffer);


Let's talk about this, if you just get rid of BigUint64Array and BigInt64Array in the union the error gets fixed. We should consider just doing that, and maybe this is some bug we should open an issue for somewhere.

Maybe we should still file that issues somewhere?

lastmjs · 2025-02-08T00:41:36Z

.github/workflows/test.yml

+
+            - run: npm run typecheck
+            - run: npm run lint
+
    check-test-success:
        name: Check Azle tests succeeded
        needs: run-tests


But we want top-level-checks to be hooked up here don't we? We need to make sure there's only pass or fail if run-tests and top-level-checks pass or fail...right?

Correct, done

lastmjs · 2025-02-08T00:46:07Z

src/lib/experimental/fetch/http.ts

@@ -202,7 +202,7 @@ async function prepareRequestBody(

    if (typeof init.body === 'string') {
        const textEncoder = new TextEncoder();
-        return [textEncoder.encode(init.body)];
+        return [textEncoder.encode(init.body) as Uint8Array<ArrayBuffer>];


Let's discuss these casts

lastmjs · 2025-02-08T00:50:50Z

src/lib/experimental/fetch/icp.ts

@@ -61,7 +61,7 @@ export async function fetchIcp(
        }
    );

-    const decodedResult = IDL.decode(funcIdl.retTypes, result);
+    const decodedResult = IDL.decode(funcIdl.retTypes, result.buffer);


I really want to understand this. Let's discuss why this worked before, because it doesn't make sense to me fully why it would not continue to work.

lastmjs · 2025-02-08T00:52:46Z

src/lib/stable/ic_apis/is_controller.ts

@@ -21,8 +21,10 @@ export function isController(principal: Principal): boolean {
    }

    if (globalThis._azleIcExperimental !== undefined) {
+        const principalBytes =
+            principal.toUint8Array() as Uint8Array<ArrayBuffer>;


Whoa let's discuss this, I think there's a better way than these casts, I hope

Okay let's discuss it

lastmjs · 2025-02-08T00:54:05Z

tsconfig.json

@@ -2,6 +2,7 @@
    "compilerOptions": {
        "strict": true,
        "target": "ES2024",
+        "module": "ES2022",


Module and moduleResolution are being taken care of in another PR?

Why ES022 now?

Because ES2022 is what we agreed on for module... I thought.

Yes module and module resolution are in a separate issue. Though es2022 is the one I am planning on using for that pr.

lastmjs · 2025-02-08T00:54:40Z

tsconfig.typecheck.json

@@ -0,0 +1,8 @@
+{


Please help me to understand this

As mentioned in the package.json comment this is so that we can exclude all of the examples from the type checks. As long as we have to make a separate config for that I figured it would be good to add the other type checking settings like skipLibCheck and noEmit. We extend from the base tsconfig to make sure we use the same settings

lastmjs · 2025-02-08T00:54:54Z

package.json

@@ -3,7 +3,7 @@
    "version": "0.25.0",
    "description": "TypeScript and JavaScript CDK for the Internet Computer",
    "scripts": {
-        "typecheck": "tsc --noEmit",
+        "typecheck": "tsc --project tsconfig.typecheck.json",


Please help me to understand this

I don't want to type check the examples at this point. I was figuring that we didn't want to exclude the examples in the main tsconfig.json because it already had an exclude property that was only excluding the new examples (which actually needs to be updated? or gotten rid of, because it's in a new location. (just let me know which one that is and I will do it, otherwise I will add it to the issue about making the ideal tsconfig (another option is that we actually do just exclude the examples in the main ts config? I'm not sure how that would play off extending the main one though...))). Unfortunately you cannot, to my knowledge, pass an ignore list as a parameter, only in the tsconfig.json. You can make another tsconfig and point it tsc to it as a separate project. This allows us to have one tsconfig for building and one for typechecking.

lastmjs · 2025-02-08T00:55:45Z

test/index.ts

@@ -2,9 +2,14 @@ import * as dns from 'node:dns';
 dns.setDefaultResultOrder('ipv4first');

 import { describe, expect, test } from '@jest/globals';
+import { execSync } from 'child_process';


Why are we using execSync?

I have my reasons, but let's not worry about that, I'll just switch it to execSyncPretty

lastmjs · 2025-02-08T00:57:25Z

test/index.ts

@@ -36,12 +41,11 @@ export function runTests(

    if (shouldRunTypeChecks === true) {
        describe(`type checks`, () => {
-            it('checks types', () => {
+            it('checks types', async () => {
+                const typeCheckCommand = `npm exec --offline tsc -- --noEmit --skipLibCheck`;


Shouldn't we try to explicitly pass in the tsconfig.json of the project? Just like we do at the top level?

I don't think so, I felt like passing in at the top level was a work around we had to do because of the extra files we wanted to ignore. I think this is a much better method under normal circumstances

bdemann force-pushed the update_es_version branch from c79ff64 to 7a9509a Compare February 5, 2025 19:28

bdemann linked an issue Feb 7, 2025 that may be closed by this pull request

Implement top level azle checks #2655

Open

10 tasks

bdemann added 2 commits February 7, 2025 16:18

restore module and update to ES2022

69587da

update typechecking

42c4dc5

bdemann force-pushed the update_es_version branch from cbd7e61 to ccd4b2b Compare February 7, 2025 23:58

bdemann changed the title ~~restore module and update to ES2022~~ Update target to es2024, use tsconfigs for typechecks, and run type checks at the top level (breaking changes) Feb 8, 2025

bdemann requested a review from lastmjs February 8, 2025 00:10

bdemann added 4 commits February 7, 2025 17:13

add top level test

f2e7801

extend from the base tsconfig

e202f69

make explicit ArrayBuffers

6d82ff2

ignore errors in experimental fetch ic

d6c84db

bdemann force-pushed the update_es_version branch from e9ca70c to d6c84db Compare February 8, 2025 00:13

lastmjs enabled auto-merge February 8, 2025 00:31

lastmjs requested changes Feb 8, 2025

View reviewed changes

bdemann added 4 commits February 10, 2025 14:02

switch back to default ArrayBufferLike

cce5114

examples fixes

1ee59ed

Merge branch 'main' into update_es_version

c6c1358

pr fixes

2dea89e

bdemann mentioned this pull request Feb 10, 2025

Update_es_version_delete_me_after_update_es_version_is_merged #2669

Closed

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update target to es2024, use tsconfigs for typechecks, and run type checks at the top level (breaking changes) #2653

Update target to es2024, use tsconfigs for typechecks, and run type checks at the top level (breaking changes) #2653

bdemann commented Feb 5, 2025 •

edited

Loading

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

lastmjs Feb 8, 2025

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

lastmjs Feb 8, 2025

lastmjs Feb 8, 2025

bdemann Feb 8, 2025 •

edited

Loading

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

lastmjs Feb 8, 2025

bdemann Feb 10, 2025

lastmjs Feb 8, 2025

bdemann Feb 8, 2025

Update target to es2024, use tsconfigs for typechecks, and run type checks at the top level (breaking changes) #2653

Are you sure you want to change the base?

Update target to es2024, use tsconfigs for typechecks, and run type checks at the top level (breaking changes) #2653

Conversation

bdemann commented Feb 5, 2025 • edited Loading

Contributor

Reviewer

Breaking Changes

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

bdemann Feb 8, 2025 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdemann commented Feb 5, 2025 •

edited

Loading

bdemann Feb 8, 2025 •

edited

Loading