Revision as of 00:24, 24 August 2013

Web Assets

Summary

Traditionally, Fedora has been pushing bits from its various servers to people's browsers in an ad-hoc fashion, and issues surrounding JavaScript have been swept under the rug. This change proposal provides a simple framework for shipping static web content and a way forward to treat JavaScript more closely to other code in the distribution.

Owner

Name: T.C. Hollingsworth
Email: tchollingsworth@gmail.com

Current status

Targeted release: Fedora 20
Last updated: 2013-07-10
Tracker bug: F20WebAssets #998583

Detailed Description

A standard directory (/usr/share/web-assets) for static bits that are intended to be delivered to web browsers, such as CSS Frameworks, UI libraries, etc. will be introduced. HTTP daemons in the distribution should make this directory available publicly as /_sysassets.

Additionally, a standard directory (/usr/share/javascript) for JavaScript code, which may be used in browsers or server-side by applications such as nodejs or rubygem-execjs will also be introduced.

Finally, new packaging guidelines will provide instructions for making proper use of these new directories.

Benefit to Fedora

Packagers will benefit from clear guidelines for shipping JavaScript code and other modular content that can be used by multiple web applications.

By eliminating bundling of JavaScript code within web applications and replacing it with proper packaging, the security footprint of the distribution will be improved.

Scope

Fedora 20

The `web-assets` RPM

Status: awaiting review

A web-assets package will be introduced. A preliminary SRPM is available here.

The web-assets-filesystem subpackage will be provided, which contains the following directories:

/usr/share/web-assets
/usr/share/javascript

Additionally the following symlinks will be provided:

/usr/share/web-assets/javascript points to /usr/share/javascript
/usr/share/web-assets/fonts points to /usr/share/fonts (so any Fedora font package can be used as a web font)

A web-assets-devel subpackage will be provided that provides macros like %{_assetdir} and other conveniences described in the proposed guidelines.

`redhat-rpm-config`

Status: waiting on me to test and write a patch

We can trivially automatically version the virtual Provides required by the static inclusion section of the new guidelines, but the macro would need to live in redhat-rpm-config to work right in koji without conditional inclusion, which results in terrible syntax like %{?js_includes: %js_includes foopackage} due to RPM's restrictions regarding macros that accept arguments.

Fonts

Status: will be announced shortly

Now that we're going to make many of the free fonts in the distribution available over the Internet, we'd like to take the opportunity to make sure the licensing metadata is populated in each of them so we can be sure we're complying with their licenses.

There are 80 fonts in 28 packages that are currently missing the necessary data. Additionally, the remainder will need to be audited to make sure they actually specify correct license data. (This will be mostly scripted away so it won't be too onerous.)

Finally, User:Patches/PackagingDrafts/FontsPolicy new guidelines will be put into effect to ensure this is done correctly in the future.

Flash

Status: bugs filed

It seems a number of packages contain precompiled Flash files. [[This has never been acceptable for Fedora. These packages will be identified and bugs will be as part of the cleanup tasks.

Foreign languages

Status: not started

Many foreign languages support JavaScript, like Ruby via rubygem-execjs or Java via rhino. Several of them already depend on existing JavaScript library packages (virtually all node.js-related ones) and will need to be modified to conform to the new locations specified by the guidelines.

Node.js

Status: not started

Several node packages ship JavaScript for the browser and will need to be modified to conform to the new guidelines.

FPC

Status: guidelines approved

The Fedora Packaging Committee will need to consider and approve drafts pertaining to Web Assets and JavaScript.

FPC/FESCo

Status: effectively already done?

FPC/FESCo may or may not want to consider a firm date for sunsetting the bundled JavaScript exception and requiring all new packages to meet the new guidelines.

Fedora 21

The web-assets RPM

A web-assets-httpd package will make the web assets directory available at the final decided location.

`httpd`

httpd may want to add Requires: web-assets-httpd (or ship the configuration itself, though it was suggested that it would be better seperate) to make the assets directory available unconditionally by default. This will simplify packaging. (We really would prefer that JavaScript libraries not depend on httpd, as they could be used by Node.js or Ruby.)

other HTTP daemons

It would be nice to support additional HTTP daemons as well. I'll investigate whether we can support them with drop-in configuration files or symlinks from other web-assets subpackages in addition to httpd.

Handwavy Future

JavaScript packagers

Some longstanding reviews (like jquery) can now be completed with clear guidelines, paving the way for web applications to start being migrating to using proper dependencies instead of bundling.

All web applications currently in the distribution should be examined for bundled JavaScript, which should be packaged separately.

Web application packagers

Web applications can migrate to new JavaScript/Web Asset packages as they become available.

There are a lot of potentially affected packages. There's no hope of fixing them all in one release cycle, and even the dependency chain for jQuery, a big ticket package, could take several months to get reviewed and imported. Therefore, this Change proposal just seeks FESCo/FPC approval for a start to unravelling this madness. This will be a long transition, and will probably make the systemd transition look like a day in the park.

Just to give you an idea of the magnitude: there are 1836 packages that ship .js files, discounting Node.js packages. (Though those certainly all don't necessarily include bundled JS.) There's a lot of low-hanging fruit: for instance, there are 963 packages that ship a file called jquery.js, a whole bunch of which is just included as output from documentation generators like Sphinx or rdoc. (Though keep in mind that isn't necessarily the only JS these packages bundle.) More low hanging fruit can be gleamed from this list of frequencies of filenames ending in .js.

Upgrade/compatibility impact

None at this time.

Web Applications migrating their dependencies to the new framework will need to take care to provide a sane upgrade path, but that should be relatively simple.

How To Test

Make sure the directories exist.
Install httpd and web-assets-httpd, then verify that you can navigate to http://localhost/_sysassets/ and http://localhost/_sysassets/javascript/.

User Experience

Web Developers who want to use these libraries and frameworks in their applications will have a single place to look going forward.

Dependencies

FPC approval of the new guidelines will be obtained prior to implementing any of the engineering components described in this document.

web-assets review (currently unfiled; preliminary version here)
Requires added to httpd
Macro added to redhat-rpm-config
nodejs packages affected:
- uglify-js
- uglify-js1
- coffee-script
- nodejs-less
Ruby packages affected:
- rubygem-coffee-script
- rubygem-coffee-script-source
- rubygem-uglifier

FAQ

Why is /usr/share/javascript outside of /usr/share/assets?

Using /usr/share/javascript allows for consistency with other distributions (like Debian) and reflects the fact that JavaScript code can be run on Fedora itself as well as being pushed to the browser.

Why not just ship Apache configuration files for this kind of stuff like we've been doing/has been suggested before?

That leaves other http daemons and servers that don't involve traditional HTTP daemons (like many Node.js applications) hung out to dry. By just using a single, standard directory, and making that accessible from all HTTP daemons, support for many HTTP daemons is provided, and the need for packagers to keep up with changing Apache configuration formats just to ship a few simple JS files is eliminated.

Contingency Plan

None needed, either the directories get added or they don't.

Documentation

The new Packaging Guidelines referenced above.

Release Notes

Fedora 20 introduces standard directories for web assets (such as web user interface libraries) in /usr/share/web-assets, and JavaScript code in /usr/share/javascript. In future releases, web applications will be migrated to using shared components, eliminating the need for security updates to the same code in multiple packages.

@@ Line 40: / Line 40: @@
 == Scope ==
-=== The <code>web-assets</code> RPM ===
+=== Fedora 20 ===
+==== The <code>web-assets</code> RPM ====
+'''Status:'''  [https://bugzilla.redhat.com/show_bug.cgi?id=997678 awaiting review]
 A <code>web-assets</code> package will be introduced.  [https://github.com/tchollingsworth/fedora-web-assets A preliminary SRPM is available here.]
@@ Line 56: / Line 60: @@
 A <code>web-assets-devel</code> subpackage will be provided that provides macros like <code>%{_assetdir}</code> and other conveniences described in the proposed guidelines.
-A <code>web-assets-httpd</code> package will make the web assets directory available at <code>http://server/_sysassets/</code>.
+==== <code>redhat-rpm-config</code> ====
-=== <code>redhat-rpm-config</code> ===
+'''Status:''' waiting on me to test and write a patch
 We can [https://github.com/tchollingsworth/fedora-web-assets/blob/master/macros.web-assets#L4-L13 trivially] automatically version the virtual Provides required by the [[User:Patches/PackagingDrafts/Web_Assets##Static_Inclusion_of_Libraries|static inclusion section]] of the new guidelines, but the macro would need to live in <code>redhat-rpm-config</code> to work right in koji without conditional inclusion, which results in terrible syntax like <code>%{?js_includes: %js_includes foopackage}</code> due to RPM's restrictions regarding macros that accept arguments.
-=== <code>httpd</code> ===
+==== Fonts ====
+'''Status:''' will be announced shortly
+Now that we're going to make many of the free fonts in the distribution available over the Internet, we'd like to take the opportunity to make sure the licensing metadata is populated in each of them so we can be sure we're complying with their licenses.
-<code>httpd</code> may want to add <code>Requires: web-assets-httpd</code> (or ship the configuration itself, though [https://lists.fedoraproject.org/pipermail/packaging/2013-July/009313.html it was suggested that it would be better seperate]) to make the assets directory available unconditionally by default.  This will simplify packaging.  (We really would prefer that JavaScript libraries not depend on httpd, as they could be used by Node.js or Ruby.)
+There are [http://patches.fedorapeople.org/js-repoqueries/fonts-neither 80 fonts in 28 packages] that are currently missing the necessary data.  Additionally, the remainder will need to be audited to make sure they actually specify correct license data.  (This will be mostly scripted away so it won't be too onerous.)
+Finally, [[User:Patches/PackagingDrafts/FontsPolicy new guidelines]] will be put into effect to ensure this is done correctly in the future.
+==== Flash ====
-=== Flash ===
+'''Status:''' [https://bugzilla.redhat.com/show_bug.cgi?id=1000236 bugs filed]
 It seems [[Web Assets/Flash/Packages|a number of packages]] contain precompiled Flash files.  [[[[Packaging:Guidelines#No_inclusion_of_pre-built_binaries_or_libraries|This has never been acceptable for Fedora.]]  These packages will be identified and bugs will be as part of the cleanup tasks.
-=== other HTTP daemons ===
+==== Foreign languages ====
-It would be nice to support additional HTTP daemons as well.  I'll investigate whether we can support them with drop-in configuration files or symlinks from other <code>web-assets</code> subpackages in addition to httpd.
+'''Status:''' not started
+Many foreign languages support JavaScript, like Ruby via <code>rubygem-execjs</code> or Java via <code>rhino</code>.  Several of them already depend on existing JavaScript library packages (virtually all node.js-related ones) and will need to be modified to conform to the new locations specified by the guidelines.
+==== Node.js ====
+'''Status:''' not started
+Several node packages ship JavaScript for the browser and will need to be modified to conform to the new guidelines.
+==== FPC ====
+'''Status:''' [[Packaging:Web Assets|guidelines approved]]
+The Fedora Packaging Committee will need to consider and approve drafts pertaining to [[User:Patches/PackagingDrafts/Web Assets|Web Assets]] and [[User:Patches/PackagingDrafts/JavaScript|JavaScript]].
-=== Fonts ===
+==== FPC/FESCo ====
-Now that we're going to make many of the free fonts in the distribution available over the Internet, we'd like to take the opportunity to make sure the licensing metadata is populated in each of them so we can be sure we're complying with their licenses.
+'''Status:''' [https://lists.fedoraproject.org/pipermail/devel/2013-August/187836.html effectively already done?]
-There are [http://patches.fedorapeople.org/js-repoqueries/fonts-neither 80 fonts in 28 packages] that are currently missing the necessary data.  Additionally, the remainder will need to be audited to make sure they actually specify correct license data.  (This will be mostly scripted away so it won't be too onerous.)
+FPC/FESCo may or may not want to consider a firm date for sunsetting the bundled JavaScript exception and requiring all new packages to meet the new guidelines.
-Finally, [[User:Patches/PackagingDrafts/FontsPolicy new guidelines]] will be put into effect to ensure this is done correctly in the future.
+=== Fedora 21 ===
-=== JavaScript packagers ===
+==== The web-assets RPM ====
-Some longstanding reviews (like jquery) can now be completed with clear guidelines, paving the way for web applications to start being migrating to using proper dependencies instead of bundling.
+A <code>web-assets-httpd</code> package will make the web assets directory available at the final decided location.
-All web applications currently in the distribution should be examined for bundled JavaScript, which should be packaged separately.
-=== Web application packagers ===
+==== <code>httpd</code> ====
-Web applications can migrate to new JavaScript/Web Asset packages as they become available.
+<code>httpd</code> may want to add <code>Requires: web-assets-httpd</code> (or ship the configuration itself, though [https://lists.fedoraproject.org/pipermail/packaging/2013-July/009313.html it was suggested that it would be better seperate]) to make the assets directory available unconditionally by default.  This will simplify packaging.  (We really would prefer that JavaScript libraries not depend on httpd, as they could be used by Node.js or Ruby.)
-There are a lot of potentially affected packages.  There's no hope of fixing them all in one release cycle, and even the dependency chain for jQuery, a big ticket package, could take several months to get reviewed and imported.  Therefore, this Change proposal just seeks FESCo/FPC approval for a start to unravelling this madness.  This will be a long transition, and will probably make the systemd transition look like a day in the park.
+==== other HTTP daemons ====
-Just to give you an idea of the magnitude:  there are [http://patches.fedorapeople.org/js-repoqueries/js.txt 1836 packages] that ship <code>.js</code> files, discounting Node.js packages.  (Though those certainly all don't necessarily include bundled JS.) There's a lot of low-hanging fruit:  for instance, there are [http://patches.fedorapeople.org/js-repoqueries/jquery.js.txt 963 packages] that ship a file called <code>jquery.js</code>, a whole bunch of which is just included as output from documentation generators like Sphinx or rdoc.  (Though keep in mind that isn't necessarily the only JS these packages bundle.)  More low hanging fruit can be gleamed from [http://patches.fedorapeople.org/js-repoqueries/js-frequency.txt this list of frequencies of filenames ending in <code>.js</code>].
+It would be nice to support additional HTTP daemons as well.  I'll investigate whether we can support them with drop-in configuration files or symlinks from other <code>web-assets</code> subpackages in addition to httpd.
-=== Foreign languages ===
+=== Handwavy Future ===
-Many foreign languages support JavaScript, like Ruby via <code>rubygem-execjs</code> or Java via <code>rhino</code>.  Several of them already depend on existing JavaScript library packages (virtually all node.js-related ones) and will need to be modified to conform to the new locations specified by the guidelines.
+==== JavaScript packagers ====
-=== Node.js ===
+Some longstanding reviews (like jquery) can now be completed with clear guidelines, paving the way for web applications to start being migrating to using proper dependencies instead of bundling.
-Several node packages ship JavaScript for the browser and will need to be modified to conform to the new guidelines.
+All web applications currently in the distribution should be examined for bundled JavaScript, which should be packaged separately.
-=== FPC ===
+==== Web application packagers ====
-The Fedora Packaging Committee will need to consider and approve drafts pertaining to [[User:Patches/PackagingDrafts/Web Assets|Web Assets]] and [[User:Patches/PackagingDrafts/JavaScript|JavaScript]].
+Web applications can migrate to new JavaScript/Web Asset packages as they become available.
-=== FPC/FESCo ===
+There are a lot of potentially affected packages.  There's no hope of fixing them all in one release cycle, and even the dependency chain for jQuery, a big ticket package, could take several months to get reviewed and imported.  Therefore, this Change proposal just seeks FESCo/FPC approval for a start to unravelling this madness.  This will be a long transition, and will probably make the systemd transition look like a day in the park.
-FPC/FESCo may or may not want to consider a firm date for sunsetting the bundled JavaScript exception and requiring all new packages to meet the new guidelines.
+Just to give you an idea of the magnitude:  there are [http://patches.fedorapeople.org/js-repoqueries/js.txt 1836 packages] that ship <code>.js</code> files, discounting Node.js packages.  (Though those certainly all don't necessarily include bundled JS.) There's a lot of low-hanging fruit:  for instance, there are [http://patches.fedorapeople.org/js-repoqueries/jquery.js.txt 963 packages] that ship a file called <code>jquery.js</code>, a whole bunch of which is just included as output from documentation generators like Sphinx or rdoc.  (Though keep in mind that isn't necessarily the only JS these packages bundle.)  More low hanging fruit can be gleamed from [http://patches.fedorapeople.org/js-repoqueries/js-frequency.txt this list of frequencies of filenames ending in <code>.js</code>].
 == Upgrade/compatibility impact ==

Search

Changes/Web Assets: Difference between revisions