Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(sys): fix expected types for createNodeLogger and createNodeSys #5375

Merged
merged 11 commits into from
Mar 11, 2024

Conversation

christian-bromann
Copy link
Member

@christian-bromann christian-bromann commented Feb 16, 2024

What is the current behavior?

The methods createNodeLogger and createNodeSys currently have a wrong parameter definition.

What is the new behavior?

Update types to match with implementation:

and adds types for export methods:

Documentation

Does this introduce a breaking change?

  • Yes
  • No

Yes and no: yes we change public API interfaces but also no since these have been wrong in the first place.

Testing

n/a

Other information

n/a

Copy link
Contributor

github-actions bot commented Feb 16, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1144 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/dev-server/server-process.ts 32
src/compiler/prerender/prerender-main.ts 22
src/testing/puppeteer/puppeteer-element.ts 22
src/runtime/client-hydrate.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/compiler/transpile/transpile-module.ts 14
src/sys/node/node-sys.ts 14
src/compiler/prerender/prerender-queue.ts 13
src/compiler/sys/in-memory-fs.ts 13
src/runtime/connected-callback.ts 13
src/runtime/set-value.ts 13
src/compiler/output-targets/output-www.ts 12
src/compiler/transformers/test/parse-vdom.spec.ts 12
src/compiler/transformers/transform-utils.ts 12
src/mock-doc/test/attribute.spec.ts 12
Our most common errors
Typescript Error Code Count
TS2322 361
TS2345 349
TS18048 206
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 10
TS2769 8
TS2538 8
TS2416 6
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports
File Line Identifier
src/runtime/bootstrap-lazy.ts 21 setNonce
src/screenshot/screenshot-fs.ts 18 readScreenshotData
src/testing/testing-utils.ts 198 withSilentWarn
src/utils/index.ts 145 CUSTOM
src/utils/index.ts 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts 123 updateCacheFromRebuild
src/compiler/types/validate-primary-package-output-target.ts 61 satisfies
src/compiler/types/validate-primary-package-output-target.ts 61 Record
src/testing/puppeteer/puppeteer-declarations.ts 485 WaitForEventOptions
src/compiler/sys/fetch/write-fetch-success.ts 7 writeFetchSuccessSync

Copy link
Contributor

github-actions bot commented Feb 16, 2024

PR built and packed!

Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/8235460475/artifacts/1315440517

If your browser saves files to ~/Downloads you can install it like so:

unzip -d ~/Downloads ~/Downloads/stencil-core-4.12.6-dev.1710170978.10698a2.tgz.zip && npm install ~/Downloads/stencil-core-4.12.6-dev.1710170978.10698a2.tgz

* @returns a {@link Logger} object
*/
export declare function createNodeLogger(c: { process: any }): Logger;
export declare function createNodeLogger(): Logger;
Copy link
Member

Choose a reason for hiding this comment

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

It looks like we removed this in c114f0a - I don't see any comments to this effect, but I think we held off here due to breaking a public API (createNodeLogger is a available from @stencil/core/sys/node). @alicewriteswrongs do you remember by chance?

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah I think that might be why we left it like that, I don't remember exactly tbh

Copy link
Member

Choose a reason for hiding this comment

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

👍 In that case, can we add a TODO comment here instead of removing c? We can slate this change for Stencil v5

Copy link
Member Author

Choose a reason for hiding this comment

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

I created two versions and deprecated one which will result in the following:
Screenshot 2024-02-21 at 7 49 19 AM

src/sys/node/public.ts Show resolved Hide resolved
src/sys/node/public.ts Outdated Show resolved Hide resolved
scripts/test/validate-build.ts Outdated Show resolved Hide resolved
* @returns a {@link Logger} object
*/
export declare function createNodeLogger(c: { process: any }): Logger;
export declare function createNodeLogger(): Logger;
Copy link
Member

Choose a reason for hiding this comment

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

👍 In that case, can we add a TODO comment here instead of removing c? We can slate this change for Stencil v5

Copy link
Member

@rwaskiewicz rwaskiewicz left a comment

Choose a reason for hiding this comment

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

One non-blocking ask

src/sys/node/public.ts Outdated Show resolved Hide resolved
Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
@christian-bromann christian-bromann added this pull request to the merge queue Mar 11, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 11, 2024
@christian-bromann christian-bromann added this pull request to the merge queue Mar 11, 2024
Merged via the queue into main with commit 7a70281 Mar 11, 2024
121 checks passed
@christian-bromann christian-bromann deleted the cb/type-fixes branch March 11, 2024 16:40
@christian-bromann
Copy link
Member Author

This has been released with Stencil 🚞 v4.13.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants