Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Discuss the future of this repo and the template repo #294

@motin

Description

@motin

For ongoing discussion.

With the upcoming in-tree support for add-on study lifecycle handling and the normandyAddonStudy Web Extension API, there will be no need for the lifecycle handling code that builds up the bulk of this repository.

However, when that code is gone, there are plenty of unprivileged utility functions that are likely to be useful for add-on study extension authors, including construction of survey urls, handling expiration / slumber, sending and verifying study telemetry down specific pipelines/schemas, handling errors, improve logging, run automated tests, help QA etc.

Also, authors probably may benefit of a well-documented best practice example/template/boilerplate/generator for properly setting up branch-specific builds, functional/unit tests, CI etc using the proper tooling - something that can be used without having built previous add-on studies.

Where and how should we house and develop that kind of utility code and example/template/boilerplate/generator?

We could keep this repo as it is (just drastically clean up it's contents), even rename it to reflect the new paradigm (addon-study-utils? normandy-addon-study-utils?), but we could also decouple and split this repo into use-case-specific helper libraries as necessary, ie one for study telemetry, one for logging, one for QA helpers etc.

As for a example/template/boilerplate/generator, I am hoping that we can convert the current template (but supposedly rename it to normandy-addon-study-example/template/boilerplate/generator) to reflect the new paradigm.

Ping @mythmon @rehandalal

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions