sbonami/milliejs

milliejs's Issues

Fix test leaks

And check for leaks in production application

Use jest automock for unit tests to ensure granular test coverage

Plus:

• clean-up the early mocks
• create a better incremental store factory

Configure repo issue templates

Add integration test coverage for source subscriptions

Investigate sponsorship

• Github sponsorship
• OpenCollective

Review and assign codeowners or PR reviewers

Improve EventEmitter typing in Subscriber

Types for events and listeners

Populate Contributing guide to assist potential contributors in getting started

Investigate CRUD action improvements

• DAG
• Pluggable (a la serverless hooks)

Comply with OWASP

• Comply with OWASP
• Add OWASP scans to CI/CD
• Mention OWASP compliance in Security Policy

Add documentation to repo

Add a contributing guide

https://github.com/github/.github/blob/main/CONTRIBUTING.md

Also mention in README

Setup repo's required checks and other branch rules

Expand Query capabilities

Queries are limited to simple equality checks for attributes, however, a more expansive feature set is necessary for even the most elementary use cases.

Setup some project branding

• logo
• keywords
• description
• readme badges

Document CRUD flows

sequenceDiagram
    Client->>Millie: create Entity (from request)
    par In parallel
        critical Attempt to update Replica with requested payload
            Millie->>Replica: create Entity (from request)
        option Succeeded
            Replica-->>Client: new Entity (from request)
        option Failed
            rect rgb(255, 0, 0)
                Note over Replica,Client: TBD
                Replica-->>Client: Replica Error
            end
        end
    and
        critical Attempt to update Source with requested payload
            Millie->>Source: create Entity (from request)
        option Succeeded
            Source->>Millie: 
            par In parallel
                Millie-->>Client: new Entity (from source)
            and
                critical Attempt to update Replica with Source's payload
                    Millie->>Replica: new Entity (from source)
                option Succeeded
                    Millie-->>Client: new Entity (from source)
                option Failed
                    rect rgb(255, 0, 0)
                        Note over Millie,Client: TBD
                        Millie-->>Client: Replica Error
                    end
                end
            end
        option Failed
            rect rgb(255, 0, 0)
                Note over Source,Client: TBD
                Source-->>Client: Source Error
            end
        end
    end

Setup lint-staged for auto-prettier execution

https://www.coffeeclass.io/articles/commit-better-code-with-husky-prettier-eslint-lint-staged
https://typicode.github.io/husky/#/?id=yarn-2
https://github.com/okonet/lint-staged

Add inline code documentation

Populate Store Contributing guide to assist integrators

CRUD action fault-tolerance

Investigate invariant error extraction

Allow replica entities to expire

Benchmark

Add a client-side example using Redux

Setup release automation

Maybe https://github.com/sindresorhus/np

Populate README usage instructions to demonstrate basic utility

Create a Redis store

Configure repo PR templates

Create security policy

Support subscription narrowing

Not all source data is useful for every consumer, so it would be beneficial to allow the client to limit which source subscription data syncs into the replica store.

Simplify delegation code

The MillieJS class does a ton of delegation to the IncrementalStore, and the IncrementalStore likewise to the various CRUD actions. Instead, some meta-programming would be a boon to maintenance.

Add Typescript type test coverage

https://github.com/SamVerschueren/tsd
Also maybe https://api-extractor.com

Create a code of conduct

https://opensource.guide/code-of-conduct/

[Feature]: yarn constraints check in ci

🚀 Feature Proposal

Using the yarn constraints, plug-in check the repo is compliant during the continuous integration checks

Motivation

To keep the repo in compliance with standards and best practices

Example

No response

Pitch

Uh, because 😝

[Feature]: Improve type predicates

🚀 Feature Proposal

The type predicates are at present only checking for undefined properties, but they could be more specific. Additional checks within the predicate would include: type validation, enum validation, and nesting (Resource within Query).

Additionally, the MillieJS library should perform an invariant check of user inputs, and IncrementalStore should perform invariant checks of store inputs.

Motivation

To ensure the application is operating accurately and to provide specific feedback in moments where provided data is incorrect.

Example

No response

Pitch

The only way to achieve this is to add it to the core

Build homepage with documentation

[Chore]: Add integration tests for Windows and Mac

🚀 Feature Proposal

Re-add the Windows and Mac runners to the integration test runs once Github supports services: actions/runner#904

Motivation

Proving multi-platform support is a great sales-pitch

Example

No response

Pitch

N/A

Create a Google PubSub store

Hone PATCH request type

Replace the "any" type for the PATCH payload with something more form-fit. Perhaps the JSON Patch https://datatracker.ietf.org/doc/html/rfc6902?

Support CRUD action concurrency

Introduce concurrency between the CRUD action to the replica store and the upstream source

[Bug]: CI dep cache check only for MacOS

Version

latest

Steps to reproduce

1. Clone the repo on an OS other than Mac
2. Perform a yarn cache check (yarn install --immutable --immutable-cache --check-cache)

Expected behavior

Successful check and/or better handling of optional dependencies that differ per OS

Actual behavior

An error is thrown for one or more of the optional dependencies that were just cached for MacOS

Additional context

See yarnpkg/berry#5692

Environment

All except MacOS

[Feature]: split out actions into different consistency models

🚀 Feature Proposal

To support other consistency models, like: strong consistency, weak consistency, read committed, read uncommitted, snapshot isolation, and linearizeability. This would support client needs that are specific to a particular resource or integration.

Motivation

This will make MillieJS more attractive for integrators that have varying requirements.

Example

No response

Pitch

The adapter to the different consistency models would have to live in core, but there’s no reason why the consistency models themselves could not be plug-and-play packages provided by the community.

Populate example projects to demonstrate basic utility

Review and automate repo labels

Support horizontally-scalable Millie instances

From the perspective of a replica store, Millie would benefit from being able to scale horizontally. This would enable Millie to fan out upstream events for replication or processing. Another use-case where this would be helpful is in a distributed rules-engine.

Look into Apache Zookeeper, consul, Netflix Eureka, etc

Add license to files during build

Setup semantic-release for commit linting

https://github.com/marketplace/actions/semantic-pull-request