fix(next): `Metadata.openGraph` values not resolving basic values when `type` is set #63620

devjiwonchoi · 2024-03-22T19:18:22Z

What?

The string value of Metadata.openGraph.emails throws error:

export const metadata = {
  openGraph: {
    type: 'article',
    emails: 'author@vercel.com',
  },
};

Error:

r.map is not a function

The type is:

type OpenGraphMetadata = {
  // ...
  emails?: string | Array<string>
}

Why?

Basic values such as emails and phoneNumbers were not included when ogType was set while resolving the values.

How?

Include basic values when resolving the metadata.

Fixes #63415

ijjk · 2024-03-22T19:18:44Z

Allow CI Workflow Run

approve CI run for commit: 320544e

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

ijjk · 2024-03-22T19:18:44Z

Allow CI Workflow Run

approve CI run for commit: 0cd5e48

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

This reverts commit 320544e.

ijjk · 2024-04-15T16:43:28Z

Tests Passed

ijjk · 2024-04-15T16:44:46Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
buildDuration	14.9s	15s	N/A
buildDurationCached	8.2s	6.9s	N/A
nodeModulesSize	199 MB	199 MB	⚠️ +638 B
nextStartRea..uration (ms)	409ms	418ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
2453-HASH.js gzip	31.4 kB	31.4 kB	N/A
3304.HASH.js gzip	181 B	181 B	✓
3f784ff6-HASH.js gzip	53.7 kB	53.7 kB	✓
8299-HASH.js gzip	5.1 kB	5.1 kB	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	242 B	241 B	N/A
main-HASH.js gzip	29.6 kB	29.6 kB	N/A
webpack-HASH.js gzip	1.68 kB	1.68 kB	N/A
Overall change	99 kB	99 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
_app-HASH.js gzip	196 B	197 B	N/A
_error-HASH.js gzip	184 B	184 B	✓
amp-HASH.js gzip	505 B	505 B	✓
css-HASH.js gzip	324 B	325 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	258 B	258 B	✓
head-HASH.js gzip	352 B	352 B	✓
hooks-HASH.js gzip	370 B	371 B	N/A
image-HASH.js gzip	4.27 kB	4.27 kB	✓
index-HASH.js gzip	259 B	259 B	✓
link-HASH.js gzip	2.67 kB	2.67 kB	N/A
routerDirect..HASH.js gzip	314 B	312 B	N/A
script-HASH.js gzip	386 B	386 B	✓
withRouter-HASH.js gzip	309 B	309 B	✓
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	6.63 kB	6.63 kB	✓

Client Build Manifests

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
_buildManifest.js gzip	483 B	485 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
index.html gzip	529 B	528 B	N/A
link.html gzip	542 B	541 B	N/A
withRouter.html gzip	525 B	522 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
edge-ssr.js gzip	95.6 kB	95.6 kB	N/A
page.js gzip	3.05 kB	3.05 kB	✓
Overall change	3.05 kB	3.05 kB	✓

Middleware size

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
middleware-b..fest.js gzip	623 B	623 B	✓
middleware-r..fest.js gzip	155 B	156 B	N/A
middleware.js gzip	25.5 kB	25.5 kB	N/A
edge-runtime..pack.js gzip	839 B	839 B	✓
Overall change	1.46 kB	1.46 kB	✓

Next Runtimes

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
app-page-exp...dev.js gzip	171 kB	171 kB	N/A
app-page-exp..prod.js gzip	97.5 kB	97.5 kB	N/A
app-page-tur..prod.js gzip	99.2 kB	99.2 kB	N/A
app-page-tur..prod.js gzip	93.5 kB	93.5 kB	N/A
app-page.run...dev.js gzip	145 kB	145 kB	N/A
app-page.run..prod.js gzip	92 kB	92 kB	N/A
app-route-ex...dev.js gzip	21.5 kB	21.5 kB	✓
app-route-ex..prod.js gzip	15.2 kB	15.2 kB	✓
app-route-tu..prod.js gzip	15.2 kB	15.2 kB	✓
app-route-tu..prod.js gzip	14.9 kB	14.9 kB	✓
app-route.ru...dev.js gzip	21.1 kB	21.1 kB	✓
app-route.ru..prod.js gzip	14.9 kB	14.9 kB	✓
pages-api-tu..prod.js gzip	9.55 kB	9.55 kB	✓
pages-api.ru...dev.js gzip	9.82 kB	9.82 kB	✓
pages-api.ru..prod.js gzip	9.55 kB	9.55 kB	✓
pages-turbo...prod.js gzip	22.5 kB	22.5 kB	✓
pages.runtim...dev.js gzip	23.1 kB	23.1 kB	✓
pages.runtim..prod.js gzip	22.5 kB	22.5 kB	✓
server.runti..prod.js gzip	51.4 kB	51.4 kB	✓
Overall change	251 kB	251 kB	✓

build cache Overall increase ⚠️

	vercel/next.js canary	devjiwonchoi/next.js og-emails	Change
0.pack gzip	1.59 MB	1.59 MB	⚠️ +356 B
index.pack gzip	108 kB	107 kB	N/A
Overall change	1.59 MB	1.59 MB	⚠️ +356 B

Diff details

Diff for middleware.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

failed to diff

Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js

Diff too large to display

Diff for app-page.runtime.prod.js

Diff too large to display

Commit: c63306b

huozhi

Thanks!

…n `type` is set (#63620) ### What? The string value of `Metadata.openGraph.emails` throws error: ```tsx export const metadata = { openGraph: { type: 'article', emails: 'author@vercel.com', }, }; ``` Error: ```sh r.map is not a function ``` The type is: ```tsx type OpenGraphMetadata = { // ... emails?: string | Array<string> } ``` ### Why? Basic values such as `emails` and `phoneNumbers` were not included when `ogType` was set while resolving the values. ### How? Include basic values when resolving the metadata. Fixes #63415

refactor: initially take emails, phonenums, faxnums as string[]

320544e

ijjk added the type: next label Mar 22, 2024

Merge branch 'canary' into og-emails

564e421

devjiwonchoi marked this pull request as ready for review March 22, 2024 19:28

devjiwonchoi requested review from timneutkens, ijjk, shuding, huozhi, feedthejim, ztanner and wyattjoh as code owners March 22, 2024 19:28

devjiwonchoi changed the title ~~refactor(next): OpenGraph params like emails to be received as string array by default~~ fix(next): some Metadata.openGraph values were not resolving string params Mar 22, 2024

devjiwonchoi marked this pull request as draft March 23, 2024 13:12

devjiwonchoi added 3 commits March 23, 2024 22:21

Revert "refactor: initially take emails, phonenums, faxnums as string[]"

5398d4a

This reverts commit 320544e.

fix: OgTypeFields.basic was not added to the keys to be resolved

a9779e0

test: add basic openGraph metadata as string value

f2afbd0

ijjk added the area: tests label Mar 23, 2024

Merge branch 'canary' into og-emails

0cd5e48

devjiwonchoi changed the title ~~fix(next): some Metadata.openGraph values were not resolving string params~~ fix(next): Metadata.openGraph values not resolving basic values when type is given Mar 23, 2024

devjiwonchoi changed the title ~~fix(next): Metadata.openGraph values not resolving basic values when type is given~~ fix(next): Metadata.openGraph values not resolving basic values when type is given Mar 23, 2024

devjiwonchoi changed the title ~~fix(next): Metadata.openGraph values not resolving basic values when type is given~~ fix(next): Metadata.openGraph values not resolving basic values when type is set Mar 23, 2024

devjiwonchoi marked this pull request as ready for review March 23, 2024 14:27

shuding added the CI approved Approve running CI for fork label Apr 15, 2024

Merge branch 'canary' into og-emails

2c3f5b0

huozhi approved these changes Apr 15, 2024

View reviewed changes

Merge branch 'canary' into og-emails

c63306b

huozhi merged commit 2bd27e7 into vercel:canary Apr 15, 2024
72 of 73 checks passed

devjiwonchoi deleted the og-emails branch April 15, 2024 19:19

github-actions bot added the locked label Apr 30, 2024

github-actions bot locked as resolved and limited conversation to collaborators Apr 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(next): `Metadata.openGraph` values not resolving basic values when `type` is set #63620

fix(next): `Metadata.openGraph` values not resolving basic values when `type` is set #63620

devjiwonchoi commented Mar 22, 2024 •

edited

Loading

ijjk commented Mar 22, 2024

ijjk commented Mar 22, 2024 •

edited

Loading

ijjk commented Apr 15, 2024 •

edited

Loading

ijjk commented Apr 15, 2024 •

edited

Loading

huozhi left a comment

fix(next): Metadata.openGraph values not resolving basic values when type is set #63620

fix(next): Metadata.openGraph values not resolving basic values when type is set #63620

Conversation

devjiwonchoi commented Mar 22, 2024 • edited Loading

What?

Why?

How?

ijjk commented Mar 22, 2024

ijjk commented Mar 22, 2024 • edited Loading

ijjk commented Apr 15, 2024 • edited Loading

Tests Passed

ijjk commented Apr 15, 2024 • edited Loading

Stats from current PR

huozhi left a comment

Choose a reason for hiding this comment

fix(next): `Metadata.openGraph` values not resolving basic values when `type` is set #63620

fix(next): `Metadata.openGraph` values not resolving basic values when `type` is set #63620

devjiwonchoi commented Mar 22, 2024 •

edited

Loading

ijjk commented Mar 22, 2024 •

edited

Loading

ijjk commented Apr 15, 2024 •

edited

Loading

ijjk commented Apr 15, 2024 •

edited

Loading