Parse "lang" member of Web Application Manifest #33004

christianliebel · 2024-09-01T14:27:25Z

`9b97de8`

Parse "lang" member of Web Application Manifest
https://bugs.webkit.org/show_bug.cgi?id=278984

Reviewed by NOBODY (OOPS!).

Implements the "lang" member to the web application manifest parser per spec:
https://www.w3.org/TR/appmanifest/#lang-member
Along with the required encoders/decoders and API tests.

* Source/JavaScriptCore/CMakeLists.txt:
* Source/JavaScriptCore/JavaScriptCore.xcodeproj/project.pbxproj:
* Source/JavaScriptCore/runtime/IntlObject.h:
* Source/WebCore/Modules/applicationmanifest/ApplicationManifest.h:
* Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.cpp:
(WebCore::ApplicationManifestParser::parseManifest):
(WebCore::ApplicationManifestParser::parseLang):
* Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.h:
* Source/WebKit/Shared/WebCoreArgumentCoders.serialization.in:
* Source/WebKit/UIProcess/API/Cocoa/_WKApplicationManifest.h:
* Source/WebKit/UIProcess/API/Cocoa/_WKApplicationManifest.mm:
(-[_WKApplicationManifest initWithCoder:]):
(-[_WKApplicationManifest encodeWithCoder:]):
(-[_WKApplicationManifest lang]):
* Tools/TestWebKitAPI/Tests/WebCore/ApplicationManifestParser.cpp:
(ApplicationManifestParserTest::testLang):
(TEST_F(ApplicationManifestParserTest, Lang)):

9b97de8

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	❌ 🛠 ios	❌ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
✅ 🧪 bindings	❌ 🛠 ios-sim	❌ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2	⏳ 🧪 win-tests
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	❌ 🧪 api-mac	✅ 🧪 api-wpe
	❌ 🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	❌ 🧪 api-ios	❌ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	❌ 🛠 vision	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	❌ 🛠 vision-sim	❌ 🧪 mac-wk2-stress	❌ 🧪 api-gtk
	⏳ 🧪 vision-wk2	❌ 🧪 mac-intel-wk2	~~🛠 playstation~~
	❌ 🛠 tv	❌ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	❌ 🛠 tv-sim		✅ 🧪 jsc-armv7-tests
	❌ 🛠 watch
	❌ 🛠 watch-sim

webkit-early-warning-system · 2024-09-01T14:27:31Z

EWS run on previous version of this PR (hash 025d6d5)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	✅ 🧪 wincairo-tests
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	❌ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	❌ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	✅ 🛠 jsc-armv7
	✅ 🛠 tv		✅ 🧪 jsc-armv7-tests
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

Tools/TestWebKitAPI/Tests/WebCore/ApplicationManifestParser.cpp

Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.cpp

webkit-early-warning-system · 2024-09-05T11:50:48Z

EWS run on previous version of this PR (hash fb614e0)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	✅ 🛠 wincairo
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	~~🧪 wpe-wk2~~	~~🧪 wincairo-tests~~
✅ 🧪 webkitperl	~~🧪 ios-wk2~~	~~🧪 api-mac~~	~~🧪 api-wpe~~
	~~🧪 ios-wk2-wpt~~	~~🧪 mac-wk1~~	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	~~🧪 api-ios~~	~~🧪 mac-wk2~~	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	✅ 🛠 vision	~~🧪 mac-AS-debug-wk2~~	~~🧪 gtk-wk2~~
	✅ 🛠 vision-sim	~~🧪 mac-wk2-stress~~	~~🧪 api-gtk~~
	~~🧪 vision-wk2~~	~~🧪 mac-intel-wk2~~	✅ 🛠 jsc-armv7
	✅ 🛠 tv		~~🧪 jsc-armv7-tests~~
	✅ 🛠 tv-sim
	✅ 🛠 watch
	✅ 🛠 watch-sim

webkit-early-warning-system · 2024-09-05T11:53:35Z

EWS run on previous version of this PR (hash 320394e)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	✅ 🛠 ios	✅ 🛠 mac	✅ 🛠 wpe	⏳ 🛠 win
✅ 🧪 bindings	✅ 🛠 ios-sim	✅ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	⏳ 🧪 win-tests
✅ 🧪 webkitperl	✅ 🧪 ios-wk2	✅ 🧪 api-mac	✅ 🧪 api-wpe
	✅ 🧪 ios-wk2-wpt	✅ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	✅ 🧪 api-ios	✅ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	✅ 🛠 vision	✅ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	✅ 🛠 vision-sim	✅ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
	✅ 🧪 vision-wk2	✅ 🧪 mac-intel-wk2	⏳ 🛠 playstation
	✅ 🛠 tv	⏳ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	✅ 🛠 tv-sim		✅ 🧪 jsc-armv7-tests
	✅ 🛠 watch
	✅ 🛠 watch-sim

annevk · 2024-09-05T11:57:47Z

Thanks! Looks good, but ideally someone from JSC reviews those bits.

darinadler · 2024-09-05T15:31:15Z

Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.cpp

+        return { };
+    }
+
+    return JSC::canonicalizeUnicodeLocaleID(lang.utf8());


Converting to UTF-8 on the way in is a peculiar step in canonicalizing this ID, and even an unnecessarily inefficient one since a structurally valid language tag is guaranteed not to have non-ASCII characters and likely is almost always already stored as an 8-bit string, while the utf8 function always returns newly allocated memory than then has to be deallocated. Building this inefficient idiom into the interface between JavaScriptCore and WebCore isn’t great, even for something trivial like this. The conversion step is required only because the existing function from IntlObject.h happens to take a CString. I think we should have a function that takes a String or StringView that does the same operation that we export from IntlObject.h, even if for now it has creates a CString internally for reasons of expediency; it would be easy to write a version that doesn’t unnecessarily allocate and deallocate memory for an extra copy of the string in the common case, though.

darinadler · 2024-09-05T15:36:12Z

Tools/TestWebKitAPI/Tests/WebCore/ApplicationManifestParser.cpp

@@ -203,6 +203,11 @@ class ApplicationManifestParserTest : public testing::Test {
        EXPECT_EQ(expectedValue, value);
    }

+    void testLang(const String& rawJSON, const String& expectedValue)
+    {
+        EXPECT_EQ(expectedValue, parseTopLevelProperty("lang"_s, rawJSON).lang);


I don’t understand why we are adding the parsing, but it has no effect on the web platform. It’s very strange that the only tests are in C++. Is there some web-platform-visible effect of the parsing that can be tested more end to end?

This change extends the Web Application Manifest, which is evaluated when a user adds a website to the home screen. Safari uses these values to determine the icon, suggested name, etc., for the web clip. After parsing, all values are passed to the platform-specific side, so there are indeed no web-platform-visible effects.

Are you contributing a pull request that parses more and hoping to influence the Safari developers to make use of the new values?

Yeah, it's more for standards compliance. Christian is a co-editor with me on the Manifest spec. On the W3C side, we require implementation before we add things to the spec. At the same time, I'm coordinating with Safari folks and letting them know of the changes - but it's up to them if they actually adopt them (i.e., that's a product decision for Safari, with the usual disclaimer that "Apple doesn't comment on future features and products"). Should Safari choose to use these values, they are there.

darinadler · 2024-09-05T15:36:55Z

Source/WebKit/UIProcess/API/Cocoa/_WKApplicationManifest.h

@@ -74,6 +74,7 @@ WK_CLASS_AVAILABLE(macos(10.13.4), ios(11.3))

 @property (nonatomic, readonly, nullable, copy) NSString *rawJSON;
 @property (nonatomic, readonly) _WKApplicationManifestDirection dir;
+@property (nonatomic, readonly, nullable, copy) NSString *lang;


I need to understand the big picture. Why are we adding all these getters to this Objective-C class. What is this SPI for? Is this a building block for some feature we are working on?

This is for create the UI that Safari uses when presenting the Add to Home Screen/Dock UI. The larger picture is to provide language hints, if needed, which would only have an impact potentially accessibility: the name of the application being read correctly in some language, for instance.

Constellation

r=me on JSC change

webkit-early-warning-system · 2025-06-26T11:06:47Z

EWS run on previous version of this PR (hash e61f53d)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	❌ 🛠 ios	❌ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
✅ 🧪 bindings	❌ 🛠 ios-sim	❌ 🛠 mac-AS-debug	✅ 🧪 wpe-wk2	⏳ 🧪 win-tests
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	❌ 🧪 api-mac	✅ 🧪 api-wpe
	❌ 🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	❌ 🧪 api-ios	❌ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	❌ 🛠 vision	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	❌ 🛠 vision-sim	❌ 🧪 mac-wk2-stress	✅ 🧪 api-gtk
	⏳ 🧪 vision-wk2	❌ 🧪 mac-intel-wk2	~~🛠 playstation~~
	❌ 🛠 tv	❌ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	❌ 🛠 tv-sim		✅ 🧪 jsc-armv7-tests
	❌ 🛠 watch
	❌ 🛠 watch-sim

https://bugs.webkit.org/show_bug.cgi?id=278984 Reviewed by NOBODY (OOPS!). Implements the "lang" member to the web application manifest parser per spec: https://www.w3.org/TR/appmanifest/#lang-member Along with the required encoders/decoders and API tests. * Source/JavaScriptCore/CMakeLists.txt: * Source/JavaScriptCore/JavaScriptCore.xcodeproj/project.pbxproj: * Source/JavaScriptCore/runtime/IntlObject.h: * Source/WebCore/Modules/applicationmanifest/ApplicationManifest.h: * Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.cpp: (WebCore::ApplicationManifestParser::parseManifest): (WebCore::ApplicationManifestParser::parseLang): * Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.h: * Source/WebKit/Shared/WebCoreArgumentCoders.serialization.in: * Source/WebKit/UIProcess/API/Cocoa/_WKApplicationManifest.h: * Source/WebKit/UIProcess/API/Cocoa/_WKApplicationManifest.mm: (-[_WKApplicationManifest initWithCoder:]): (-[_WKApplicationManifest encodeWithCoder:]): (-[_WKApplicationManifest lang]): * Tools/TestWebKitAPI/Tests/WebCore/ApplicationManifestParser.cpp: (ApplicationManifestParserTest::testLang): (TEST_F(ApplicationManifestParserTest, Lang)):

webkit-early-warning-system · 2025-07-01T07:05:35Z

EWS run on current version of this PR (hash 9b97de8)

Misc	iOS, visionOS, tvOS & watchOS	macOS	Linux	Windows
✅ 🧪 style	❌ 🛠 ios	❌ 🛠 mac	✅ 🛠 wpe	✅ 🛠 win
✅ 🧪 bindings	❌ 🛠 ios-sim	❌ 🛠 mac-AS-debug	❌ 🧪 wpe-wk2	⏳ 🧪 win-tests
✅ 🧪 webkitperl	❌ 🧪 ios-wk2	❌ 🧪 api-mac	✅ 🧪 api-wpe
	❌ 🧪 ios-wk2-wpt	❌ 🧪 mac-wk1	✅ 🛠 wpe-cairo
✅ 🛠 🧪 jsc	❌ 🧪 api-ios	❌ 🧪 mac-wk2	✅ 🛠 gtk
✅ 🛠 🧪 jsc-arm64	❌ 🛠 vision	❌ 🧪 mac-AS-debug-wk2	✅ 🧪 gtk-wk2
	❌ 🛠 vision-sim	❌ 🧪 mac-wk2-stress	❌ 🧪 api-gtk
	⏳ 🧪 vision-wk2	❌ 🧪 mac-intel-wk2	~~🛠 playstation~~
	❌ 🛠 tv	❌ 🛠 mac-safer-cpp	✅ 🛠 jsc-armv7
	❌ 🛠 tv-sim		✅ 🧪 jsc-armv7-tests
	❌ 🛠 watch
	❌ 🛠 watch-sim

christianliebel requested review from cdumez, marcoscaceres and a team as code owners September 1, 2024 14:27

marcoscaceres reviewed Sep 5, 2024

View reviewed changes

Tools/TestWebKitAPI/Tests/WebCore/ApplicationManifestParser.cpp Show resolved Hide resolved

marcoscaceres requested review from Constellation and marcoscaceres September 5, 2024 10:11

annevk reviewed Sep 5, 2024

View reviewed changes

Source/WebCore/Modules/applicationmanifest/ApplicationManifestParser.cpp Outdated Show resolved Hide resolved

christianliebel changed the title ~~Parse "lang" member of Web Application Manifest~~ Parse "lang" member of Web Application Manifest https://bugs.webkit.org/show_bug.cgi?id=278984 Sep 5, 2024

christianliebel force-pushed the eng/Parse-lang-member-of-Web-Application-Manifest branch from 025d6d5 to fb614e0 Compare September 5, 2024 11:50

christianliebel changed the title ~~Parse "lang" member of Web Application Manifest https://bugs.webkit.org/show_bug.cgi?id=278984~~ Parse "lang" member of Web Application Manifest Sep 5, 2024

christianliebel force-pushed the eng/Parse-lang-member-of-Web-Application-Manifest branch from fb614e0 to 320394e Compare September 5, 2024 11:53

darinadler approved these changes Sep 5, 2024

View reviewed changes

Constellation approved these changes Sep 5, 2024

View reviewed changes

Ahmad-S792 assigned christianliebel Oct 17, 2024

christianliebel force-pushed the eng/Parse-lang-member-of-Web-Application-Manifest branch from 320394e to e61f53d Compare June 26, 2025 11:06

webkit-ews-buildbot added the merging-blocked Applied to prevent a change from being merged label Jun 26, 2025

christianliebel force-pushed the eng/Parse-lang-member-of-Web-Application-Manifest branch from e61f53d to 9b97de8 Compare July 1, 2025 07:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Parse "lang" member of Web Application Manifest #33004

Parse "lang" member of Web Application Manifest #33004

christianliebel commented Sep 1, 2024 •

edited by webkit-early-warning-system

Loading

Uh oh!

webkit-early-warning-system commented Sep 1, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 5, 2024 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Sep 5, 2024 •

edited

Loading

Uh oh!

annevk commented Sep 5, 2024

Uh oh!

darinadler Sep 5, 2024

Uh oh!

darinadler Sep 5, 2024

Uh oh!

christianliebel Sep 9, 2024

Uh oh!

darinadler Sep 9, 2024

Uh oh!

marcoscaceres Sep 10, 2024

Uh oh!

darinadler Sep 5, 2024

Uh oh!

marcoscaceres Jun 26, 2025

Uh oh!

Constellation left a comment

Uh oh!

webkit-early-warning-system commented Jun 26, 2025 •

edited

Loading

Uh oh!

webkit-early-warning-system commented Jul 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Parse "lang" member of Web Application Manifest #33004

Are you sure you want to change the base?

Parse "lang" member of Web Application Manifest #33004

Conversation

christianliebel commented Sep 1, 2024 • edited by webkit-early-warning-system Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

annevk commented Sep 5, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Constellation left a comment

Choose a reason for hiding this comment

Uh oh!

webkit-early-warning-system commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

webkit-early-warning-system commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

christianliebel commented Sep 1, 2024 •

edited by webkit-early-warning-system

Loading

webkit-early-warning-system commented Sep 1, 2024 •

edited

Loading

webkit-early-warning-system commented Sep 5, 2024 •

edited

Loading

webkit-early-warning-system commented Sep 5, 2024 •

edited

Loading

webkit-early-warning-system commented Jun 26, 2025 •

edited

Loading

webkit-early-warning-system commented Jul 1, 2025 •

edited

Loading