com.nawforce.common.deps.DownWalker.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apexlink Show documentation
Offline validation and transformation toolkit for Salesforce packages
There is a newer version: 2.3.7
/*
 [The "BSD licence"]
 Copyright (c) 2020 Kevin Jones
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.nawforce.common.deps

import com.nawforce.common.api.{Name, Org, TypeIdentifier}
import com.nawforce.common.names.Names

import scala.collection.mutable.ArrayBuffer

/** Dependency information collected */
case class DependencyNode(id: TypeIdentifier,
                          nature: String,
                          transitiveCount: Int,
                          extending: Array[TypeIdentifier],
                          implementing: Array[TypeIdentifier],
                          using: Array[TypeIdentifier])

/** Downstream dependency walker. Collects information on the dependencies of a type. */
class DownWalker(org: Org) {

  private val packagesByNamespace =
    org.getPackages.map(pkg => (Name(pkg.getNamespaces(false).head), pkg)).toMap

  private val transitiveCollector = new TransitiveCollector(org)

  /* Collect information on dependencies of the passed type. The walk depth can be limited but the result will always
   * include the root node information as the first element of the returned Array.
   */
  def walk(id: TypeIdentifier, depth: Int): Array[DependencyNode] = {
    val collected = new ArrayBuffer[DependencyNode]()
    collected += createNode(id)
    walkNode(collected.head, collected, depth)
    collected.toArray
  }

  private def walkNode(node: DependencyNode,
                       collector: ArrayBuffer[DependencyNode],
                       depth: Int): Unit = {
    if (depth == 0) return
    (node.extending ++ node.implementing ++ node.using).foreach(id => {
      if (!collector.exists(n => n.id == id)) {
        val node = createNode(id)
        collector.append(node)
        walkNode(node, collector, depth - 1)
      }
    })
  }

  private def createNode(id: TypeIdentifier): DependencyNode = {
    val pkg = packagesByNamespace.get(id.namespace.getOrElse(Names.Empty))

    val inherits =
      pkg
        .map(pkg => {
          pkg.getDependencies(id, outerInheritanceOnly = true)
        })
        .getOrElse(Array[TypeIdentifier]())
        .toSet
    val extending = inherits.filter(id => nature(id) == "class")
    val implementing = inherits.filter(id => nature(id) == "interface")

    val all =
      pkg
        .map(pkg => {
          pkg.getDependencies(id, outerInheritanceOnly = false)
        })
        .getOrElse(Array[TypeIdentifier]())
    val uses = all.filterNot(inherits.contains)

    DependencyNode(id,
                   nature(id),
                   transitiveCollector.count(id),
                   extending.toArray,
                   implementing.toArray,
                   uses)
  }

  private def nature(id: TypeIdentifier): String = {
    val pkg = packagesByNamespace.get(id.namespace.getOrElse(Names.Empty))
    pkg.flatMap(pkg => Option(pkg.getSummaryOfType(id)).map(_.nature)).getOrElse("")
  }
}