Class: PackageProtections::Private::VisibilityProtection

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
PackageProtections::ProtectionInterface
Defined in:
lib/package_protections/private/visibility_protection.rb

Constant Summary collapse

IDENTIFIER = 
'prevent_other_packages_from_using_this_package_without_explicit_visibility'

Instance Method Summary collapse

Methods included from PackageProtections::ProtectionInterface

#get_offenses, #supports_violation_behavior?

Instance Method Details

#default_behavior ⇒ Object 



40
41
42
 
# File 'lib/package_protections/private/visibility_protection.rb', line 40

def default_behavior
  ViolationBehavior::FailNever
end

#get_offenses_for_existing_violations(protected_packages) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/package_protections/private/visibility_protection.rb', line 97

def get_offenses_for_existing_violations(protected_packages)
  all_offenses = T.let([], T::Array[Offense])

  all_listed_violations = protected_packages.flat_map do |protected_package|
    protected_package.violations.flat_map do |violation|
      PerFileViolation.from(violation, protected_package.original_package)
    end
  end

  #
  # First we get offenses related to violations between packages, looking at all dependency and privacy
  # violations between packages.
  #

  # We only care about looking at each edge once. Since an edge can show up twice if its both a privacy and dependency violation,
  # we only look at each combination of class from package (A) that's referenced in package (B)
  unique_per_file_violations = all_listed_violations.uniq do |per_file_violation|
    [per_file_violation.reference_source_package.name, per_file_violation.constant_source_package, per_file_violation.class_name]
  end

  all_offenses += unique_per_file_violations.flat_map do |per_file_violation|
    depended_on_package = Private.get_package_with_name(per_file_violation.constant_source_package)
    violation_behavior = depended_on_package.violation_behavior_for(identifier)
    visible_to = depended_on_package.visible_to
    next [] if visible_to.include?(per_file_violation.reference_source_package.name)

    case violation_behavior
    when ViolationBehavior::FailNever, ViolationBehavior::FailOnNew
      next []
    when ViolationBehavior::FailOnAny
      message = message_for_fail_on_any(per_file_violation)
    else
      T.absurd(violation_behavior)
    end

    Offense.new(
      file: per_file_violation.filepath,
      message: message,
      violation_type: identifier,
      package: depended_on_package.original_package
    )
  end

  #
  # Then we get offenses from stated dependencies
  #
  all_offenses += protected_packages.flat_map do |protected_package|
    protected_package.dependencies.flat_map do |package_dependency_name|
      depended_on_package = Private.get_package_with_name(package_dependency_name)
      visible_to = depended_on_package.visible_to
      next [] if visible_to.include?(protected_package.name)

      violation_behavior = depended_on_package.violation_behavior_for(identifier)

      case violation_behavior
      when ViolationBehavior::FailNever
        next []
      when ViolationBehavior::FailOnAny, ViolationBehavior::FailOnNew
        # continue
      else
        T.absurd(violation_behavior)
      end

      message = "`#{protected_package.name}` cannot state a dependency on `#{depended_on_package.name}`, as it violates package visibility in `#{depended_on_package.yml}`"
      Offense.new(
        file: protected_package.yml.to_s,
        message: message,
        violation_type: identifier,
        package: depended_on_package.original_package
      )
    end
  end

  all_offenses
end

#get_offenses_for_new_violations(new_violations) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/package_protections/private/visibility_protection.rb', line 65

def get_offenses_for_new_violations(new_violations)
  new_violations.flat_map do |per_file_violation|
    depended_on_package = Private.get_package_with_name(per_file_violation.constant_source_package)
    violation_behavior = depended_on_package.violation_behavior_for(identifier)
    visible_to = depended_on_package.visible_to
    next [] if visible_to.include?(per_file_violation.reference_source_package.name)

    case violation_behavior
    when ViolationBehavior::FailNever
      next []
    when ViolationBehavior::FailOnNew
      message = message_for_fail_on_new(per_file_violation)
    when ViolationBehavior::FailOnAny
      message = message_for_fail_on_any(per_file_violation)
    else
      T.absurd(violation_behavior)
    end

    Offense.new(
      file: per_file_violation.filepath,
      message: message,
      violation_type: identifier,
      package: depended_on_package.original_package
    )
  end
end

#humanized_protection_description ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/package_protections/private/visibility_protection.rb', line 50

def humanized_protection_description
  "    These files are using a constant from a package that restricts its usage through the `visible_to` flag in its `package.yml`\n    To resolve these violations, work with the team who owns the package you are trying to use and to figure out the\n    preferred public API for the behavior you want.\n\n    See https://go/packwerk_cheatsheet_visibility for more info.\n  MESSAGE\nend\n"

#humanized_protection_name ⇒ Object 



45
46
47
 
# File 'lib/package_protections/private/visibility_protection.rb', line 45

def humanized_protection_name
  'Visibility Violations'
end

#identifier ⇒ Object 



14
15
16
 
# File 'lib/package_protections/private/visibility_protection.rb', line 14

def identifier
  IDENTIFIER
end

#unmet_preconditions_for_behavior(behavior, package) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/package_protections/private/visibility_protection.rb', line 19

def unmet_preconditions_for_behavior(behavior, package)
  # This protection relies on seeing privacy violations in other packages.
  # We also require that the other package enforces dependencies, as otherwise, if the client is using public API, it won't show up
  # as a privacy OR dependency violation. For now, we don't have the system structure to support that requirement.
  if behavior.enabled? && !package.enforces_privacy?
    "Package #{package.name} must have `enforce_privacy: true` to use this protection"
  elsif !behavior.enabled? && !package.metadata['visible_to'].nil?
    "Invalid configuration for package `#{package.name}`. `#{identifier}` must be turned on to use `visible_to` configuration."
  else
    nil
  end
end