@adobe/helix-html-pipeline 3.11.8 → 3.11.10

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [3.11.10](https://github.com/adobe/helix-html-pipeline/compare/v3.11.9...v3.11.10) (2023-06-01)
+
+
+### Bug Fixes
+
+* coverage ([#326](https://github.com/adobe/helix-html-pipeline/issues/326)) ([31a34b9](https://github.com/adobe/helix-html-pipeline/commit/31a34b96a5ed01c002e9951507712904f8ff5615))
+* output image title attribute ([3893776](https://github.com/adobe/helix-html-pipeline/commit/3893776a5b6ce786e69e9475dc148955a634d719)), closes [#308](https://github.com/adobe/helix-html-pipeline/issues/308)
+
+## [3.11.9](https://github.com/adobe/helix-html-pipeline/compare/v3.11.8...v3.11.9) (2023-05-25)
+
+
+### Bug Fixes
+
+* properly set surrogate keys for 404 with .plain.html ([#321](https://github.com/adobe/helix-html-pipeline/issues/321)) ([c7a956a](https://github.com/adobe/helix-html-pipeline/commit/c7a956a1684e758b5c0cf343c68a8dba1f8bc226)), closes [#320](https://github.com/adobe/helix-html-pipeline/issues/320)
+
 ## [3.11.8](https://github.com/adobe/helix-html-pipeline/compare/v3.11.7...v3.11.8) (2023-05-22)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "3.11.8",
+  "version": "3.11.10",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -90,7 +90,7 @@
     "esmock": "2.2.3",
     "husky": "8.0.3",
     "js-yaml": "4.1.0",
-    "jsdom": "22.0.0",
+    "jsdom": "22.1.0",
     "junit-report-builder": "3.0.1",
     "lint-staged": "13.2.2",
     "mocha": "10.2.0",

package/src/steps/create-pictures.js

@@ -18,7 +18,7 @@ const BREAK_POINTS = [
   { width: '750' },
 ];
 
-export function createOptimizedPicture(src, alt = '') {
+export function createOptimizedPicture(src, alt = '', title = undefined) {
   const url = new URL(src, 'https://localhost/');
   const { pathname, hash = '' } = url;
   const props = new URLSearchParams(hash.substring(1));
@@ -55,6 +55,7 @@ export function createOptimizedPicture(src, alt = '') {
     return h('img', {
       loading: 'lazy',
       alt,
+      'data-title': title === alt ? undefined : title,
       type: v.type,
       src: srcset,
       width,
@@ -78,8 +79,8 @@ export default async function createPictures({ content }) {
   const { hast } = content;
 
   visitParents(hast, isMediaImage, (img, parents) => {
-    const { src, alt } = img.properties;
-    const picture = createOptimizedPicture(src, alt);
+    const { src, alt, title } = img.properties;
+    const picture = createOptimizedPicture(src, alt, title);
 
     // check if parent has style and unwrap if needed
     const parent = parents[parents.length - 1];

package/src/steps/fetch-404.js

@@ -9,8 +9,8 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { computeSurrogateKey } from '@adobe/helix-shared-utils';
 import { extractLastModified } from '../utils/last-modified.js';
+import { getPathKey } from './set-x-surrogate-key-header.js';
 
 /**
  * Loads the 404.html from code-bus and stores it in `res.body`
@@ -21,9 +21,7 @@ import { extractLastModified } from '../utils/last-modified.js';
  * @returns {Promise<void>}
  */
 export default async function fetch404(state, req, res) {
-  const {
-    contentBusId, info, owner, repo, ref,
-  } = state;
+  const { owner, repo, ref } = state;
   const ret = await state.s3Loader.getObject('helix-code-bus', `${owner}/${repo}/${ref}/404.html`);
   if (ret.status === 200) {
     // override last-modified if source-last-modified is set
@@ -36,7 +34,9 @@ export default async function fetch404(state, req, res) {
     res.body = ret.body;
     res.headers.set('last-modified', ret.headers.get('last-modified'));
     res.headers.set('content-type', 'text/html; charset=utf-8');
-    const pathKey = await computeSurrogateKey(`${contentBusId}${info.path}`);
-    res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404`);
   }
+
+  // set 404 keys in any case
+  const pathKey = await getPathKey(state);
+  res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404`);
 }

package/src/steps/set-x-surrogate-key-header.js

@@ -11,6 +11,24 @@
  */
 import { computeSurrogateKey } from '@adobe/helix-shared-utils';
 
+/**
+ * Returns the surrogate key based on the contentBusId and the resource path
+ * @param state
+ * @returns {Promise<string>}
+ */
+export async function getPathKey(state) {
+  const { contentBusId, info } = state;
+  let { path } = info;
+  // surrogate key for path
+  // strip [index].plain.html
+  if (path.endsWith('index.plain.html')) {
+    path = path.substring(0, path.length - 'index.plain.html'.length);
+  } else if (path.endsWith('.plain.html')) {
+    path = path.substring(0, path.length - '.plain.html'.length);
+  }
+  return computeSurrogateKey(`${contentBusId}${path}`);
+}
+
 /**
  * @type PipelineStep
  * @param {PipelineState} state
@@ -20,26 +38,16 @@ import { computeSurrogateKey } from '@adobe/helix-shared-utils';
  */
 export default async function setXSurrogateKeyHeader(state, req, res) {
   const {
-    content, contentBusId, owner, repo, ref, info,
+    content, contentBusId, owner, repo, ref,
   } = state;
 
-  let { path } = info;
-
   const keys = [];
   if (content.sourceLocation) {
     keys.push(await computeSurrogateKey(content.sourceLocation));
   }
 
-  // surrogate key for path
-  // strip [index].plain.html
-  if (path.endsWith('index.plain.html')) {
-    path = path.substring(0, path.length - 'index.plain.html'.length);
-  } else if (path.endsWith('.plain.html')) {
-    path = path.substring(0, path.length - '.plain.html'.length);
-  }
-  const hash = await computeSurrogateKey(`${contentBusId}${path}`);
+  const hash = await getPathKey(state);
   keys.push(hash);
-
   keys.push(`${contentBusId}_metadata`);
   keys.push(`${ref}--${repo}--${owner}_head`);