Decoupling looper #85646

New Issue

Anna Sirota · 2021-02-15T11:23:43+01:00

Anna Sirota commented

2021-02-15 11:23:43 +01:00

Goal

Having a looper package that is used in DevFund and can also be reused in Blender Studio with mostly cosmetic changes. This means the following payments components should be decoupled from DevFund:

Data structures, models, signals and so on;
Braintree integration, JS and views;
Checkout views and templates;

If possible, these would be nice to make reusable too:

Customer information view and templates;
Billing address views and templates.

Two existing loopers

Standalone looper: https:*developer.blender.org/source/looper/

Devfund's looper: https:*developer.blender.org/source/blender-dev-fund/browse/master/looper/

The goal of the below steps is to use the already working DevFund's looper as a starting point, while attempting to salvage some useful changes from the standalone looper.

This means:

making only cosmetic changes to the DevFund's implementation,
adding all DevFund's features into the standalone version,
temporarily reverting any features and migrations that the standalone version has and DevFund's doesn't.

Decoupling devfund's looper

Minimising superficial differences: currently two versions of looper have very different sources, partially due to syntax checkers enforced differently, which makes patching/reading diffs almost impossible (D10434, D10435):
1. pug templates and gulp boilerplate removed from devfund;
  - D10407
2. black, mypy applied to devfund's looper;
  - D10431 (on hold)
3. Missing tests and views copied, so that they exist in both versions.
  - D10398
4. Functionality that doesn't belong to looper moved out of DevFund's looper
  - D10437
Static assets devfund's looper depends on should be contained in its looper directory

D10440

GeoLite2 should be contained in devfund's looper directory
Devfund's looper packaged as a standalone looper package

  Devfund's implementation contains views that do not exist in the standalone one and are not specific to DevFund (e.g. customer settings, address editing, existing payment methods).

**As a start, devfund's version of `looper.migrations` should be used, so that no migrations have to be applied when devfund switches to using a packaged looper.**

Devfund should use this package

  (as a submodule, via pypi or git dependency, whichever is quicker to setup, this can changed later)

Applying missing migrations

After packaged version has proven not to break anything in devfund, changes that had been rolled back in the standalone looper can be reapplied.

~~User to Customer migration applied to devfund~~

Upd: the migration was not applied, because its benefits for Blender Cloud didn't seem to be greater than the effort required to make it work with Development Fund and risks of applying it to the whole database of existing Fund members.

At this point it should be possible to integrate looper into Blender Studio in the same manner.

Clean up

- GitLab's looper should be removed/archived, to avoid causing confusion in the future
- Stale patches and abandoned looper branches should be closed/deleted

## Goal Having a `looper` package that is used in DevFund and can also be reused in Blender Studio with mostly cosmetic changes. This means the following payments components should be decoupled from DevFund: * Data structures, models, signals and so on; * Braintree integration, JS and views; * Checkout views and templates; If possible, these would be nice to make reusable too: * Customer information view and templates; * Billing address views and templates. ### Two existing loopers Standalone looper: [https:*developer.blender.org/source/looper/](https:*developer.blender.org/source/looper/) Devfund's looper: [https:*developer.blender.org/source/blender-dev-fund/browse/master/looper/](https:*developer.blender.org/source/blender-dev-fund/browse/master/looper/) The goal of the below steps is to use the already working DevFund's looper as a starting point, while attempting to salvage some useful changes from the standalone looper. This means: - making only cosmetic changes to the DevFund's implementation, - adding all DevFund's features into the standalone version, - temporarily reverting any features and migrations that the standalone version has and DevFund's doesn't. ## Decoupling devfund's looper 1. Minimising superficial differences: currently two versions of looper have very different sources, partially due to syntax checkers enforced differently, which makes patching/reading diffs almost impossible ([D10434](https://archive.blender.org/developer/D10434), [D10435](https://archive.blender.org/developer/D10435)): 1. `pug` templates and `gulp` boilerplate removed from devfund; * [D10407](https://archive.blender.org/developer/D10407) 2. `black`, `mypy` applied to devfund's looper; * [D10431](https://archive.blender.org/developer/D10431) (on hold) 3. Missing tests and **views** copied, so that they exist in both versions. * [D10398](https://archive.blender.org/developer/D10398) 4. Functionality that doesn't belong to looper moved out of DevFund's looper * [D10437](https://archive.blender.org/developer/D10437) 2. Static assets devfund's looper depends on should be contained in its looper directory * [D10440](https://archive.blender.org/developer/D10440) 3. GeoLite2 should be contained in devfund's looper directory 4. **Devfund's looper packaged as a standalone `looper` package** ``` Devfund's implementation contains views that do not exist in the standalone one and are not specific to DevFund (e.g. customer settings, address editing, existing payment methods). ``` **As a start, devfund's version of `looper.migrations` should be used, so that no migrations have to be applied when devfund switches to using a packaged looper.** 5. Devfund should use this package ``` (as a submodule, via pypi or git dependency, whichever is quicker to setup, this can changed later) ``` ## Applying missing migrations After packaged version has proven not to break anything in devfund, changes that had been rolled back in the standalone looper can be reapplied. 1. ~~[User to Customer migration applied to devfund](https://developer.blender.org/rLfadc6daea8c30dfc4ba7f5ef6b5331f5d7414aa9)~~ Upd: the migration was not applied, because its benefits for Blender Cloud didn't seem to be greater than the effort required to make it work with Development Fund and risks of applying it to the whole database of existing Fund members. At this point it should be possible to integrate looper into Blender Studio in the same manner. ## Clean up - - [x] [GitLab's looper](https://gitlab.com/blender/looper) should be removed/archived, to avoid causing confusion in the future - - [x] Stale patches and abandoned looper branches should be closed/deleted

Anna Sirota self-assigned this 2021-02-15 11:23:43 +01:00

Anna Sirota commented

2021-02-15 11:23:43 +01:00

Added subscriber: @railla