From 4fb034aeec9fe7a4ed1763ee81bf23c11f33348e Mon Sep 17 00:00:00 2001
From: Sonu Kapoor <sonukapoor@gmail.com>
Date: Mon, 30 Mar 2020 07:10:15 -0400
Subject: [PATCH] build(docs-infra): fix `autoLinkCode` to ignore docs without
 a path (#36316)

Previously, the auto linker generated links without an `href` when the
API was private. This commit fixes this by making sure that the `path`
of the document is not empty.

Closes #36260

PR Close #36316
---
 .../post-processors/auto-link-code.js         | 34 +++++++++++++++----
 .../post-processors/auto-link-code.spec.js    |  9 +++++
 2 files changed, 37 insertions(+), 6 deletions(-)

diff --git a/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.js b/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.js
index 7ed9f89b24..383fa2704d 100644
--- a/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.js
+++ b/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.js
@@ -28,7 +28,7 @@ module.exports = function autoLinkCode(getDocFromAlias) {
   return autoLinkCodeImpl;
 
   function autoLinkCodeImpl() {
-    return (ast) => {
+    return (ast, file) => {
       visit(ast, 'element', (node, ancestors) => {
         // Only interested in code elements that:
         // * do not have `no-auto-link` class
@@ -46,7 +46,7 @@ module.exports = function autoLinkCode(getDocFromAlias) {
 
               // Can we convert the whole text node into a doc link?
               const docs = getDocFromAlias(node.value);
-              if (foundValidDoc(docs)) {
+              if (foundValidDoc(docs, node.value, file)) {
                 parent.children.splice(index, 1, createLinkNode(docs[0], node.value));
               } else {
                 // Parse the text for words that we can convert to links
@@ -58,7 +58,7 @@ module.exports = function autoLinkCode(getDocFromAlias) {
                           // remove docs that fail the custom filter tests
                           const filteredDocs = autoLinkCodeImpl.customFilters.reduce(
                               (docs, filter) => filter(docs, words, index), getDocFromAlias(word));
-                          return foundValidDoc(filteredDocs) ?
+                          return foundValidDoc(filteredDocs, word, file) ?
                               // Create a link wrapping the text node.
                               createLinkNode(filteredDocs[0], word) :
                               // this is just text so push a new text node
@@ -75,9 +75,31 @@ module.exports = function autoLinkCode(getDocFromAlias) {
     };
   }
 
-  function foundValidDoc(docs) {
-    return docs.length === 1 && !docs[0].internal &&
-        autoLinkCodeImpl.docTypes.indexOf(docs[0].docType) !== -1;
+  /**
+   * Validates the docs to be used to generate the links. The validation ensures
+   * that the docs are not `internal` and that the `docType` is supported. The `path`
+   * can be empty when the `API` is not public.
+   *
+   * @param {Array<Object>} docs An array of objects containing the doc details
+   *
+   * @param {string} keyword The keyword the doc applies to
+   */
+  function foundValidDoc(docs, keyword, file) {
+    if (docs.length !== 1) {
+      return false;
+    }
+
+    var doc = docs[0];
+    if (doc.path === '') {
+      var message = `
+      autoLinkCode: Doc path is empty for "${doc.id}" - link will not be generated for "${keyword}".
+      Please make sure if the doc should be public. If not, it should probably not be referenced in the docs.`;
+
+      file.message(message);
+      return false;
+    }
+
+    return !doc.internal && autoLinkCodeImpl.docTypes.includes(doc.docType);
   }
 
   function createLinkNode(doc, text) {
diff --git a/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.spec.js b/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.spec.js
index 59281a5a73..676cfa2c71 100644
--- a/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.spec.js
+++ b/aio/tools/transforms/angular-base-package/post-processors/auto-link-code.spec.js
@@ -126,6 +126,15 @@ describe('autoLinkCode post-processor', () => {
     expect(doc.renderedContent).toEqual('<code>MyClass</code>');
   });
 
+  it('should ignore code items that match an API doc but have no path set',
+     () => {
+       aliasMap.addDoc(
+           {docType: 'class', id: 'MyClass', aliases: ['MyClass'], path: ''});
+       const doc = {docType: 'test-doc', renderedContent: '<code>MyClass</code>'};
+       processor.$process([doc]);
+       expect(doc.renderedContent).toEqual('<code>MyClass</code>');
+     });
+
   it('should insert anchors for individual text nodes within a code block', () => {
     aliasMap.addDoc({docType: 'class', id: 'MyClass', aliases: ['MyClass'], path: 'a/b/myclass'});
     const doc = {