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

Civi\Angular\ChangeSet - Relax debug-mode consistency check #14510

Merged
merged 1 commit into from
Jun 13, 2019

Conversation

totten
Copy link
Member

@totten totten commented Jun 13, 2019

Overview

The Angular subsystem sometimes includes a consistency-check. The consistency check ensures that an HTML document is read/written in consistent format (i.e. encode(decode($html)) === $html). However, the check is not often run, and it sometimes produces errors on consistency issues which we don't care about.

The approach here is to relax the checks in civicrm-core and reproduce them in separate developer-oriented tooling.

Before

  • If an Angular HTML partial is not altered (hook_civicrm_alterAngular), then the partial is not checked for consistency.
  • If a site is in production/non-debug mode, then the partial is not checked for consistency.
  • If a site is in debug mode, then the partial is checked for consistency.
  • tldr: The consistency-check is executed very rarely.

After

  • The partial is not checked for consistency.
  • A task is recorded on the Afform roadmap to include better consistency checks in the afform_auditor extension.

Overview
--------

The Angular subsystem *sometimes* includes a consistency-check. The consistency check ensures that an HTML document is
read/written in consistency format (i.e. `encode(decode($html)) === $html`). However, the check is not often run, and
it sometimes produces errors on consistency issues which we don't care about.

This approach here is to relaxes the checks in `civicrm-core` and reproduce them in separate developer-oriented tooling.

Before
------

* If an Angular HTML partial is not altered (`hook_civicrm_alterAngular`), then the partial is *not* checked for consistency.
* If a site is in production/non-debug mode, then the partial is *not* checked for consistency.
* If a site is in debug mode, then the partial *is* checked for consistency.

After
-----

* The partial is not checked for consistency.
* A task is recorded on the [Afform roadmap](https://github.com/totten/afform/blob/master/docs/roadmap.md) to include
  better consistency checks in the `afform_auditor` extension.
@civibot
Copy link

civibot bot commented Jun 13, 2019

(Standard links)

@civibot civibot bot added the master label Jun 13, 2019
@colemanw
Copy link
Member

The Angular subsystem sometimes includes a consistency-check.

Sounds like the consistency check is inconsistent. Maybe it needs a consistency check.

@eileenmcnaughton eileenmcnaughton merged commit 5b1930a into civicrm:master Jun 13, 2019
@totten totten deleted the master-relax-get-to-it branch August 8, 2019 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants