# Proven Modularization Plan

## 2023 December 14

Action Items
- Get Proven Core running
- ~~Finish WS API split~~
- Get it compiled
- Make a Dockerfile
- Migrations Flattening? Or copy-paste old?
- Docker env's
- Running integration tests (even if empty)
- Developer environment

## 2023 November 29

Aggregating notes from discussion with Enterprise team.

- All of our changes will be to Proven and will not include the actual customizations for SITA.
- Just the supporting code so that the SITA customizations can be plugged in
- Where will the customizations live?
- TBD but maybe in the repos they currently live in, just with all the Proven copy-pasted pieces removed.
- ~~I think we can leave this to the End team to decide~~ We need to be able to demonstrate parity after our changes...
- Maybe a single repo for all the customizations since the volume of code will be dramatically reduced
- I think the customizations will still need to be individually loadable; we can do this even while the modules all live in the same repo.
- We need to discover the "profile" of the customizations
- Once we determine the shape, we should be able to create a consistent interface that meets the needs of all the customizations.
- Should help the hooks/events be generally applicable and useful outside of this batch of customizations.
- Modules need to be able to access Proven
- Module needs to depend on Proven
- SITA DTC Issuer depends on module and Proven
- Need to create Proven bundle to import/require
- Use a private GitHub repo as an npm dependency?
- Needs keys or token to access repo
- Might be tough with Docker image builds
- Git submodules..?
- Submodule with submodules? Would need `--recursive` flag
- DTC issuer api and government api are in the same repo
- Create an event bus
- Event-driven would be less inevasive
- [Adding A Pub/Sub layer To Your Express Backend](https://dev.to/ragrag/adding-a-pub-sub-layer-to-your-express-backend-3p09)
- Missing parameters

### Testing
- Alternatives to custom build of SITA Air/Aruba HOP app?
- Use ACA-Py

### Non-Goals
- Create a Proven core (not a reasonable scope for this immediate project)

### Customization Types

- Custom APIs (routes/endpoints); keeping in mind middleware like checking the API key.

### Action Items
- Create a test environment in dtc-issuer-api that runs a standard ACA-Py instance against the dtc-issuer-api instance (Char + Adam)
- Something should be kicked off by accepting an invitation
- I believe there is first time setup required for the dtc-issuer-api
- This should be automate-able
- Ammon has done a lot of this before Proven-to-Proven; we can reach out to him to see if we can get 30 minutes with him
- Collect test data
- Get with a member of the Test team and have them show us the expected flow for the DTC Issuer stuff
- Stephen? Alex? (she's busy wrapping up BC Gov so maybe not right now)
- Char reached out to Stephen
- EventEmitter defintion
- Proven Interface definition
- Finish enumerating the types of customizations
- Update node versions
- For instance, [here](https://github.com/Indicio-tech/sita-docker-issuer/blob/e4b1a07a6f2c4b3579ff6c27bbaea76d1b89a54a/docker/Dockerfile.dtc-issuer-api#L1)

const Proven = require("proven");
const ProvenEvents = require("proven/events");
const Router = require("express/router");

const Config = { };
const eventEmitter = new EventEmitter();

const eventEmitter.on(
    ProvenEvents.ConnectionCompleted, myCoolEventHandler
);

const router = new Router();

router.post("/api/my-custom-api-endpoint", () => {});

const proven = new Proven({
    config,
    eventEmitter,
    router,
  }
);

proven.start();

const Proven = require("proven");
const ProvenEvents = require("proven/events");
const Router = require("express/router");

const Config = { };
const proven = new Proven({
    config,
  }
);

const eventEmitter = proven.container.get(EventEmitter);

const eventEmitter.on(
    ProvenEvents.ConnectionCompleted, myCoolEventHandler
);

const router = proven.container.get(Router);

router.post("/api/my-custom-api-endpoint", () => {});


proven.start();

Multiple modules:

const Proven = require("proven");
const ProvenEvents = require("proven/events");
const Router = require("express/router");
const DTCIssuer = require("dts-issuer-api");
const GovernmentController = require("govenrment-controller-api");

const Config = { };
const eventEmitter = new EventEmitter();

DTCIssuer.registerEvents(eventEmitter);
GovernmentController.registerEvents(eventEmitter);

const router = new Router();
router.use('/dtc', DTCIssuer.router);
router.use('/gov', Governmentcontroller.router);

const proven = new Proven({
    config,
    eventEmitter,
    router,
  }
);

proven.start();