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

Replace placeholder with blurDataURL in global StaticImageData type #27916

Merged
merged 2 commits into from
Aug 10, 2021

Conversation

stefanprobst
Copy link
Contributor

I think the global StaticImageData type does not currently match what actually gets imported, and what the Image component expects (see here). This PR changes placeholder to blurDataURL.

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Feature

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

  • Make sure the linting passes

@ijjk

This comment has been minimized.

Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

You're right!

We should probably import the public interface to image.tsx instead of redefining it.

interface StaticImageData {
src: string
height: number
width: number
blurDataURL?: string
}

@ijjk
Copy link
Member

ijjk commented Aug 10, 2021

Stats from current PR

Default Build (Decrease detected ✓)
General
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
buildDuration 12s 11.7s -244ms
buildDurationCached 2.7s 2.7s -2ms
nodeModulesSize 49.1 MB 49.1 MB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
/ failed reqs 0 0
/ total time (seconds) 2.187 2.213 ⚠️ +0.03
/ avg req/sec 1143.28 1129.92 ⚠️ -13.36
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.24 1.232 -0.01
/error-in-render avg req/sec 2016.11 2028.9 +12.79
Client Bundles (main, webpack, commons)
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
745.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 23.1 kB 23.1 kB
webpack-HASH.js gzip 1.5 kB 1.5 kB
Overall change 67 kB 67 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
polyfills-HASH.js gzip 31.1 kB 31.1 kB
Overall change 31.1 kB 31.1 kB
Client Pages
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
_app-HASH.js gzip 980 B 980 B
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 329 B 329 B
dynamic-HASH.js gzip 2.52 kB 2.52 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 904 B 904 B
image-HASH.js gzip 4.12 kB 4.12 kB
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 1.66 kB 1.66 kB
routerDirect..HASH.js gzip 319 B 319 B
script-HASH.js gzip 387 B 387 B
withRouter-HASH.js gzip 320 B 320 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 12.8 kB 12.8 kB
Client Build Manifests
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
_buildManifest.js gzip 490 B 490 B
Overall change 490 B 490 B
Rendered Page Sizes
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
index.html gzip 532 B 532 B
link.html gzip 543 B 543 B
withRouter.html gzip 523 B 523 B
Overall change 1.6 kB 1.6 kB

Webpack 4 Mode (Decrease detected ✓)
General
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
buildDuration 10s 10s -26ms
buildDurationCached 3.8s 3.8s ⚠️ +18ms
nodeModulesSize 49.1 MB 49.1 MB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
/ failed reqs 0 0
/ total time (seconds) 2.104 2.156 ⚠️ +0.05
/ avg req/sec 1188.29 1159.31 ⚠️ -28.98
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.191 1.232 ⚠️ +0.04
/error-in-render avg req/sec 2099.34 2028.5 ⚠️ -70.84
Client Bundles (main, webpack, commons)
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
17.HASH.js gzip 185 B 185 B
677f882d2ed8..HASH.js gzip 14 kB 14 kB
framework.HASH.js gzip 41.9 kB 41.9 kB
main-HASH.js gzip 10.6 kB 10.6 kB
webpack-HASH.js gzip 1.19 kB 1.19 kB
Overall change 67.8 kB 67.8 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
polyfills-HASH.js gzip 31.3 kB 31.3 kB
Overall change 31.3 kB 31.3 kB
Client Pages
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
_app-HASH.js gzip 965 B 965 B
_error-HASH.js gzip 3.71 kB 3.71 kB
amp-HASH.js gzip 552 B 552 B
css-HASH.js gzip 333 B 333 B
dynamic-HASH.js gzip 2.71 kB 2.71 kB
head-HASH.js gzip 2.97 kB 2.97 kB
hooks-HASH.js gzip 911 B 911 B
index-HASH.js gzip 231 B 231 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 298 B 298 B
script-HASH.js gzip 2.94 kB 2.94 kB
withRouter-HASH.js gzip 294 B 294 B
e025d2764813..52f.css gzip 125 B 125 B
Overall change 17.7 kB 17.7 kB
Client Build Manifests
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
_buildManifest.js gzip 498 B 498 B
Overall change 498 B 498 B
Rendered Page Sizes
vercel/next.js canary stefanprobst/next.js fix/staticimagedata-type Change
index.html gzip 577 B 577 B
link.html gzip 590 B 590 B
withRouter.html gzip 570 B 570 B
Overall change 1.74 kB 1.74 kB
Commit: 51cb104

@kodiakhq kodiakhq bot merged commit eb871d3 into vercel:canary Aug 10, 2021
@stefanprobst stefanprobst deleted the fix/staticimagedata-type branch August 10, 2021 17:12
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Aug 19, 2021
…type (vercel#27916)

I think the global `StaticImageData` type does not currently match what actually gets imported, and what the `Image` component expects (see [here](https://github.com/vercel/next.js/blob/canary/packages/next/client/image.tsx#L60-L65)). This PR changes `placeholder` to `blurDataURL`.

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants