chore!: update typescript to version `5.0.4` #5145

david-luna · 2024-11-12T17:35:55Z

Closes: #4870

Checklist:

Update typescript to 5.0.4
Document our new minimum typescript version
- Document a policy for updating typescript in minor versions in the future
Add a test project to ensure that minimum typescript version can compile using the updated otel dependencies

codecov · 2024-11-12T17:39:39Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.61%. Comparing base (8dc74e6) to head (e01cd50).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5145      +/-   ##
==========================================
- Coverage   94.63%   94.61%   -0.02%     
==========================================
  Files         323      323              
  Lines        8083     8083              
  Branches     1643     1643              
==========================================
- Hits         7649     7648       -1     
- Misses        434      435       +1

Files with missing lines	Coverage Δ
...s/sampler-jaeger-remote/src/JaegerRemoteSampler.ts	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

david-luna · 2024-11-15T08:56:39Z

I starting to think that maybe we need a next branch in the contrib repository so we can sync this type of changes 🤔

david-luna · 2024-11-15T16:56:49Z

Add a test project to ensure that minimum typescript version can compile using the updated otel dependencies

@pichlermarc @dyladan
I see a project name esm-http-ts within examples folder. Could that be our testing project? or it's preferable to have something more complex within integration-tests maybe?

david-luna · 2024-11-18T15:51:41Z

.github/workflows/unit-test.yml

@@ -129,39 +129,3 @@ jobs:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        with:
          verbose: true
-  api-eol-node-test:


note for reviewer: TypeScript 5.0+ removes support for Node.js <=12.0

.mocharc.yml

david-luna · 2024-11-18T15:54:32Z

CONTRIBUTING.md

+TypeScript version used to compile the pacakges is `v5.6.3`. If you plan to make your own instrumentation script
+in a `.ts` file it is recommended to use same version or higher.
+
+<!-- TODO: review the update policy -->


note for reviewer: any other items we can add to this list?

dyladan · 2024-11-25T21:59:13Z

api/package.json

@@ -98,7 +97,7 @@
    "nyc": "15.1.0",
    "sinon": "15.1.2",
    "ts-loader": "9.5.1",
-    "typescript": "4.4.4",
+    "typescript": "5.6.3",


@open-telemetry/javascript-maintainers what do you think about making this change in the API package? I think we should probably just go for it:

We can't stay on 4.4.4 forever

We don't want to go to API 2.0 any time in the foreseeable future

I think for both of these to be true, we have to eventually make this change in a minor API version, painful though it may be to some small number of users.

In order to not make this change, we'd have to keep a different version of typescript here than everywhere else. IDK how painful this would be in practice in our monorepo (maybe not that bad?)

Hmm, I think at least typedoc is coupled with the typescript version - so it may hold us back with quite a few dependencies as well. I'm for updating. Maybe we could do the following:

we compile using [email protected]

we add a integration test package (not linked to the monorepo) that installs the local @opentelemetry/api compiled with 5.6.3, and that checks if current features compile with TypeScript 4.4.4 and only runs in the test workflow. Maybe it even works fine since we're not using any new TypeScript features. 🤔

If it does work fine the question might become: do we want to allow new API features that use new TypeScript features that would not work with 4.4.4 in minor versions?

Here's me hoping that bumping the API major will be allowed at some point in the future.

Edit: the reason we don't do is because of this spec, and 2.0 milestone scope creep, right? Dropping language version support has its own spec actually and says that we should follow the conventions given by the ecosystem (which would be bumping major). This spec does not explicitly prohibit it.

trentm · 2024-11-26T01:00:07Z

  '5.6.3': '2024-10-08T22:01:09.783Z',

TypeScript 5.6.3 is a fairly recent release. Is there a reason for or against 5.6.3 specifically? Was 5.6.3 the latest release at the time you started working on this PR?

trentm · 2024-11-26T01:01:31Z

CHANGELOG_NEXT.md

@@ -25,5 +25,6 @@

 * chore: remove checks for unsupported node versions [#4341](https://github.com/open-telemetry/opentelemetry-js/pull/4341) @dyladan
 * refactor(sdk-trace-base): remove `BasicTracerProvider._registeredSpanProcessors` private property. [#5134](https://github.com/open-telemetry/opentelemetry-js/pull/5177) @david-luna
+* chore: update typescript to version `^5.6.3` [#5145](https://github.com/open-telemetry/opentelemetry-js/pull/5145) @david-luna


This almost certainly should move up to the "breaking change" section, no?

Also should that say 5.6.3 rather than ^5.6.3? The package.json files below (at least some of them) pin the version.

At 1st I checked https://github.com/microsoft/TypeScript/wiki/Breaking-Changes and was hesitating since I'm not completely sure how the produced types may break user apps. Also I've tried using ^ in dependencies, its a leftover.

Thanks for spotting it. I'll move it up :)

trentm · 2024-11-26T01:05:02Z

CONTRIBUTING.md

+
+<!-- TODO: review the update policy -->
+Also TypeScript is meant to be updated in compatible verisons of `5.x`. However there could be scenarios
+where we might don't want to update the minor version:


This is likely my TypeScript-ignorance: What is TypeScript's definition of "compatible versions", if not all of "5.x"?

Or could I be misunderstanding what you are saying? Are you saying "all updates of TS 5.x to a later 5.x version is meant to be compatible, but here is a list of reasons that might not be true for us: ..."?

Sometimes a TS release has this paragraph that makes me be cautious about updating versions.
See: https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#lib.d.ts-changes

trentm · 2024-11-26T01:19:25Z

tsconfig.base.esm.json

@@ -2,6 +2,6 @@
  "extends": "./tsconfig.base.es5.json",
  "compilerOptions": {
    "module": "ES6",
-    "moduleResolution": "node"
+    "moduleResolution": "node10"


We specifically need node10 and not node16?
https://www.typescriptlang.org/tsconfig/#moduleResolution
(I am pretty ignorant here, but it seems odd given that our base supported Node.js version for the "next" branch will be node 18.)

I thought once we have TS updated we could do this change within the scope of #4898 but I'm okay to change it

at the end it was necessary even for tsconfig.base.json file. So now they all have node16

david-luna · 2024-11-27T15:40:11Z

  '5.6.3': '2024-10-08T22:01:09.783Z',
TypeScript 5.6.3 is a fairly recent release. Is there a reason for or against 5.6.3 specifically? Was 5.6.3 the latest release at the time you started working on this PR?

It was the latest release. I tried how far I could update the version and it turns out we can aim the latest. I guess you're asking because we may reduce the number of users affected (app or instrumentation script compilation errors) by having lower version.

About type changes most of the are related on inference when coding and it should not affect our exports. I think the most interesting feats are:

moduleResolution in v4.7.2 (link). This version will unblock Publish ESM packages following ESM spec #4898
ES2020 and min Node.js set to v14.17 in v5.1 (link)

These are the publish dates of the lowest 4.7.x and 5.1.x

'4.7.2': '2022-05-24T18:38:10.371Z',
'5.1.3': '2023-06-01T17:29:55.756Z',

Probably updating to v4.7.2 will be enough for the features we want 🤔

david-luna · 2024-12-09T15:19:38Z

package.json

@@ -109,10 +109,10 @@
    "prettier": "3.3.3",
    "process": "0.11.10",
    "semver": "7.6.3",
-    "typedoc": "0.22.18",
-    "typedoc-plugin-missing-exports": "1.0.0",
-    "typedoc-plugin-resolve-crossmodule-references": "0.2.2",


note for reviewer: package author recommends to update typedoc and remove this dependency https://www.npmjs.com/package/typedoc-plugin-resolve-crossmodule-references

pichlermarc

thanks for working on this 🙂

We also used to add typesVersions fields in package.jsons for packages that have different entrypoins. They were only needed for typescript 4.4.4 compatibility, we may be able to remove those as well (can also be done in a a follow-up, but we should track that).

We may not be able to remove that for semantic-conventions since we'd be dropping support in a minor version, but we'll but we might be able to do it with the otlp-exporter-base package.

CHANGELOG_NEXT.md

.mocharc.yml

CONTRIBUTING.md

TypeScript has to be temporarily bumped because msw listed it as a optional peerDependency with an incompatibile version range, which is a strange thing to do IMO, but nevertheless this shouldn't be an issue in the long run, since open-telemetry#5145 will bump us to 5.0 anyway.

david-luna · 2024-12-18T20:14:09Z

I guess I should target this one to main now :)

ref: #5284

pichlermarc · 2024-12-18T20:43:00Z

I guess I should target this one to main now :)

ref: #5284

Yes, main is the development branch for 2.0 now, everything goes there now :)

It'll make larger changes easier since we don't have to merge back and forth anymore.

pichlermarc · 2024-12-20T09:30:31Z

CONTRIBUTING.md

+#### TypeScript version & update policy
+
+TypeScript version used to compile the pacakges is `v5.0.4`. If you plan to use any of the packages from this
+repository to make your own application or package instrumentation make sure to use same version or higher.
+
+<!-- Ref: https://github.com/open-telemetry/opentelemetry-js/pull/5145#issuecomment-2518263890 -->
+As update policy OpenTelemetry JS will follow DefinitelyType's [support policy for TypeScript](https://github.com/DefinitelyTyped/DefinitelyTyped#support-window)
+which sets a support window of 2 years.
+


It may be good to have this be more visible by also stating something similar in README.md - while it's important for contributors to know how we're using typescript, there's an effect on end-users that we should communicate. 🙂

would be e01cd50 enough?

I added one more comment 🙂
#5145 (comment)

TypeScript has to be temporarily bumped because msw listed it as a optional peerDependency with an incompatibile version range, which is a strange thing to do IMO, but nevertheless this shouldn't be an issue in the long run, since open-telemetry#5145 will bump us to 5.0 anyway.

pichlermarc

Looks good - one more nit on the documentation and then we should be ready to go 🙂

README.md

chancancode · 2025-01-08T00:55:14Z

experimental/packages/opentelemetry-instrumentation-fetch/test/fetch.test.ts

@@ -224,6 +224,7 @@ describe('fetch', () => {
            const decoder = new TextDecoder();
            requestBody = '';
            const read = async () => {
+              // @ts-expect-error -- iterator symbol was removed from types


This error can be resolved by adding DOM.AsyncIterable to "lib" in tsconfig.base.json

chancancode · 2025-01-08T01:03:30Z

tsconfig.base.json

@@ -9,6 +9,7 @@
    "incremental": true,
    "inlineSources": true,
    "module": "commonjs",


I'm getting an error in my editor complaining about this setting:

Changing it to node16 would resolve this and mostly preserve existing behavior, but ...

I suppose this is really a separate issue that should be followed-up separately, but if our minimum Node version is node 18, do we actually still intend for our modules to be compiled into CJS before publishing...? As we adopt features like dynamic imports and top-level await, that seems like an increasing dubious proposition.

But in any case that seems to be what is currently happening, and will continue to happen according to the docs, since we use the generic extensions and we don't have "type": "module" in package.json.

Probably worth revisiting some of these as part of the 2.0 milestone but as far as I can tell, changing this option to node16 now seems necessary and compatible.

chancancode · 2025-01-08T01:06:06Z

tsconfig.base.json

@@ -9,6 +9,7 @@
    "incremental": true,
    "inlineSources": true,
    "module": "commonjs",
+    "moduleResolution": "node16",
    "newLine": "LF",
    "noEmitOnError": true,
    "noFallthroughCasesInSwitch": true,


Can't comment past this line, but as I mentioned above I think we need to add DOM.AsyncIterable to "lib". The preferred casing seems to have changed, so it would look like:

"target": "ES2017", "useUnknownInCatchVariables": false, "lib": [ "ES2017", "DOM", "DOM.Iterable", "DOM.AsyncIterable" ]

Should we also update target/lib to at least ES2020? I suspect that's still older than what we actually intended but it matches what is currently stated in the README.

Co-authored-by: Marc Pichler <[email protected]>

david-luna added 3 commits November 12, 2024 18:23

chore: update typescript and ts-node dependencies

f0933b9

chore: transpile only for tests

8d8ea7c

chore: bump mocha types

08d14f7

david-luna added 4 commits November 12, 2024 20:19

chore: remove api-test-eol workflow

73422ec

chore: update typescript on missing packages

40d4587

chore: merge upstream/next

8f4220c

chore: update changelog

0695015

david-luna added 3 commits November 15, 2024 12:29

chore: pin typescript version

1db53a3

chore: update TS mode resolution to nodenext

7dfbae7

chore: rever module resolution

780830e

david-luna added 2 commits November 18, 2024 15:46

chore: update docs

268bf92

chore: update docs

6fe7953

david-luna marked this pull request as ready for review November 18, 2024 15:50

david-luna requested a review from a team as a code owner November 18, 2024 15:50

david-luna commented Nov 18, 2024

View reviewed changes

.mocharc.yml Outdated Show resolved Hide resolved

david-luna commented Nov 18, 2024

View reviewed changes

david-luna added 2 commits November 18, 2024 16:58

chore: revert change in tsconfig

87f231f

chore: update value for tsconfig compiler options

703f0ab

david-luna changed the title ~~chore: update typescript~~ chore!: update typescript to version 5.6.3 Nov 18, 2024

Merge branch 'next' into next-update-typescript

c46c11b

dyladan reviewed Nov 25, 2024

View reviewed changes

trentm reviewed Nov 26, 2024

View reviewed changes

david-luna added 2 commits November 27, 2024 16:41

chore: update changelog

7d71e92

Merge branch 'next' into next-update-typescript

8ce75a9

david-luna requested review from pichlermarc, dyladan and trentm December 5, 2024 15:52

david-luna added 3 commits December 5, 2024 16:58

chore: fix lint issues

8b6e408

chore: merge next

af2f2b0

chore: sync package-lock.json

9d74bb9

david-luna commented Dec 9, 2024

View reviewed changes

chore: fix compilation error

36c084c

pichlermarc reviewed Dec 10, 2024

View reviewed changes

CHANGELOG_NEXT.md Outdated Show resolved Hide resolved

.mocharc.yml Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

david-luna added 3 commits December 19, 2024 13:29

chore: merge main

7c5e895

chore: use nodenext as module compile option

920c2c3

chore: reset module resolution

bb7568d

david-luna changed the base branch from next to main December 19, 2024 14:14

david-luna added 4 commits December 19, 2024 15:14

Merge branch 'main' into next-update-typescript

d26fbd2

chore: reset module resolution is esm config

b7580fb

chore: set resolution to node16 & fix imports

991280b

chore: rollback mocha config

a4e30a7

pichlermarc reviewed Dec 20, 2024

View reviewed changes

chore: update readme

e01cd50

david-luna requested a review from pichlermarc December 20, 2024 12:02

pichlermarc approved these changes Jan 7, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

chancancode reviewed Jan 8, 2025

View reviewed changes

Update README.md

d890099

Co-authored-by: Marc Pichler <[email protected]>

chancancode mentioned this pull request Jan 8, 2025

feat(api): Integrate @opentelemetry/api-logs package into @opentelemetry/api as experimental #4862

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore!: update typescript to version `5.0.4` #5145

chore!: update typescript to version `5.0.4` #5145

david-luna commented Nov 12, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading

david-luna commented Nov 15, 2024

david-luna commented Nov 15, 2024

david-luna Nov 18, 2024 •

edited

Loading

david-luna Nov 18, 2024

dyladan Nov 25, 2024

pichlermarc Nov 26, 2024 •

edited

Loading

trentm commented Nov 26, 2024

trentm Nov 26, 2024

david-luna Nov 27, 2024

trentm Nov 26, 2024

david-luna Nov 27, 2024

trentm Nov 26, 2024

david-luna Nov 27, 2024

david-luna Dec 20, 2024

david-luna commented Nov 27, 2024

david-luna Dec 9, 2024

pichlermarc left a comment

david-luna commented Dec 18, 2024

pichlermarc commented Dec 18, 2024

pichlermarc Dec 20, 2024

david-luna Dec 20, 2024

pichlermarc Jan 7, 2025

pichlermarc left a comment

chancancode Jan 8, 2025

chancancode Jan 8, 2025

chancancode Jan 8, 2025

chancancode Jan 8, 2025

chore!: update typescript to version 5.0.4 #5145

Are you sure you want to change the base?

chore!: update typescript to version 5.0.4 #5145

Conversation

david-luna commented Nov 12, 2024 • edited Loading

codecov bot commented Nov 12, 2024 • edited Loading

Codecov Report

david-luna commented Nov 15, 2024

david-luna commented Nov 15, 2024

david-luna Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pichlermarc Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

trentm commented Nov 26, 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

david-luna commented Nov 27, 2024

Choose a reason for hiding this comment

pichlermarc left a comment

Choose a reason for hiding this comment

david-luna commented Dec 18, 2024

pichlermarc commented Dec 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pichlermarc left a 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

chore!: update typescript to version `5.0.4` #5145

chore!: update typescript to version `5.0.4` #5145

david-luna commented Nov 12, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading

david-luna Nov 18, 2024 •

edited

Loading

pichlermarc Nov 26, 2024 •

edited

Loading