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

Added LD+JSON asset and test case #1936

Merged
merged 19 commits into from
Sep 23, 2018
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ class Parser {
this.registerExtension('vue', './assets/VueAsset');
this.registerExtension('json', './assets/JSONAsset');
this.registerExtension('json5', './assets/JSONAsset');
this.registerExtension('jsonld', './assets/JSONLDAsset');
this.registerExtension('yaml', './assets/YAMLAsset');
this.registerExtension('yml', './assets/YAMLAsset');
this.registerExtension('toml', './assets/TOMLAsset');
Expand Down
12 changes: 8 additions & 4 deletions src/assets/HTMLAsset.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ const META = {
'msapplication-square310x310logo',
'msapplication-square70x70logo',
'msapplication-wide310x150logo',
'msapplication-TileImage'
'msapplication-TileImage',
'msapplication-config'
],
itemprop: [
'image',
Expand All @@ -64,7 +65,8 @@ const META = {
const SCRIPT_TYPES = {
'application/javascript': 'js',
'text/javascript': 'js',
'application/json': false
'application/json': false,
'application/ld+json': 'jsonld'
};

// Options to be passed to `addURLDependency` for certain tags + attributes
Expand Down Expand Up @@ -247,13 +249,15 @@ class HTMLAsset extends Asset {
} else if (type === 'tag') {
if (
(rendition.type === 'js' && node.tag === 'script') ||
(rendition.type === 'css' && node.tag === 'style')
(rendition.type === 'css' && node.tag === 'style') ||
(rendition.type === 'jsonld' && node.tag === 'script')
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why not just check isAstDirty ?

) {
node.content = rendition.value;
}

// Delete "type" attribute, since CSS and JS are the defaults.
if (node.attrs) {
// Unless it's application/ld+json
if (node.attrs && node.attrs.type !== 'application/ld+json') {
Copy link
Contributor Author

@bre7 bre7 Aug 26, 2018

Choose a reason for hiding this comment

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

Quick fix. Proper solution: #1924

delete node.attrs.type;
}
}
Expand Down
72 changes: 72 additions & 0 deletions src/assets/JSONLDAsset.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
const urlJoin = require('../utils/urlJoin');
const isURL = require('../utils/is-url');
const Asset = require('../Asset');
const logger = require('../Logger');

// A list of all attributes in a schema that may produce a dependency
// Based on https://schema.org/ImageObject
// Section "Instances of ImageObject may appear as values for the following properties"
const SCHEMA_ATTRS = [
'logo',
'photo',
'image',
'thumbnail',
'screenshot',
'primaryImageOfPage'
Copy link
Member

Choose a reason for hiding this comment

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

You could look through https://schema.org/URL for more URL instances. Maybe Video/MediaObject and a few others of those would be good to support too.

];
Copy link
Member

Choose a reason for hiding this comment

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

Good start. I guess we should go through the specs and find all the possible attributes that are URLs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if they list every single property, but https://schema.org/ImageObject has a dependents list: "Instances of ImageObject may appear as values for the following properties"


class JSONLDAsset extends Asset {
constructor(name, options) {
super(name, options);
this.type = 'jsonld';
}

parse(content) {
return JSON.parse(content.trim());
}

collectDependencies() {
if (!this.options.publicURL.startsWith('http')) {
logger.warn(
"Please specify a publicURL using --public-url, otherwise schema asset links won't work"
);
return;
}

for (let schemaKey in this.ast) {
if (SCHEMA_ATTRS.includes(schemaKey)) {
this.collectFromKey(this.ast, schemaKey);
this.isAstDirty = true;
}
}
}

// Auxiliary method for collectDependencies() to use for recursion
collectFromKey(schema, schemaKey) {
if (!schema.hasOwnProperty(schemaKey)) {
return;
}
// values can be strings or objects
// if it's not a string, it should have a url
if (typeof schema[schemaKey] === 'string') {
let assetPath = this.addURLDependency(schema[schemaKey]);
if (!isURL(assetPath)) {
// paths aren't allowed, values must be urls
assetPath = urlJoin(this.options.publicURL, assetPath);
}
schema[schemaKey] = assetPath;
} else {
this.collectFromKey(schema[schemaKey], 'url');
}
}

generate() {
if (this.options.production) {
return JSON.stringify(this.ast);
} else {
return JSON.stringify(this.ast, null, 2);
}
}
}

module.exports = JSONLDAsset;
Binary file added test/integration/schema-jsonld/images/image.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added test/integration/schema-jsonld/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions test/integration/schema-jsonld/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<html>
<head>
<title>hi</title>
<link rel="stylesheet" href="other.css">
</head>
<body>

<p>text 123</p>

<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "LocalBusiness",
"description": "This is your business description.",
"name": "Parcel's parcel",
"telephone": "555-111-2345",
"openingHours": "Mo,Tu,We,Th,Fr 09:00-17:00",
"logo": {
"@type": "ImageObject",
"url": "images/logo.png",
"width": 180,
"height": 120
},
"image": "images/image.jpeg"
}
</script>

</body>
</html>
3 changes: 3 additions & 0 deletions test/integration/schema-jsonld/other.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.other {
color: green;
}
26 changes: 26 additions & 0 deletions test/schema-jsonld.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
const {bundle, assertBundleTree} = require('./utils');

describe('schema ld+json', function() {
it('Should parse a LD+JSON schema and collect dependencies', async function() {
let b = await bundle(__dirname + '/integration/schema-jsonld/index.html', {
production: true,
publicURL: 'https://place.holder/'
});

await assertBundleTree(b, {
name: 'index.html',
assets: ['index.html'],
childBundles: [
{
type: 'jpeg'
},
{
type: 'png'
},
{
type: 'css'
}
]
});
});
});