feat: add prefix topics

[cjlawson02]

Fixes #30

BREAKING CHANGE to add support for prefix topics

Users can subscribe to any path (root or subpath) to receive value updates to their callback

[codecov]

Codecov Report

Attention: Patch coverage is 95.37037% with 5 lines in your changes missing coverage. Please review.

Project coverage is 87.50%. Comparing base (79c17ad) to head (27205e6).

Files with missing lines	Patch %	Lines
packages/ntcore-ts-client/src/lib/pubsub/pubsub.ts	85.29%	5 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main     #158    +/-   ##
========================================
  Coverage        ?   87.50%            
========================================
  Files           0       10    +10     
  Lines           0      704   +704     
  Branches        0      137   +137     
========================================
+ Hits            0      616   +616     
- Misses          0       88    +88     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jnallard]

@cjlawson02
Do you mind publishing a beta package of this change?
It would make it easier for me to test with a real connection the next time I'm at a team meeting

[cjlawson02]

Published https://www.npmjs.com/package/ntcore-ts-client/v/3.0.0-beta.1

[nab138]

This is great, however it does not seem to be compatible with the topicsOnly flag, I only want to receive the names/types of all topics, not all of the data from them, is there some way to do this? When I subscribe to a prefix key with topicsOnly: true, the callback never gets called.

[nab138]

Also, I noticed that if I am subscribing to a prefix topic of "/" that normal subscriptions stop working (never recieve updates for them). As soon as I comment out allTopics.subscribe(/*...*/) it works as normal.

[cjlawson02]

Thanks for letting me know, I'll try to get some time this weekend to spin up a simulator to test this

[nab138]

Sounds good, thanks for your work on this

[jnallard]

@cjlawson02 I can confirm that the change did work for me! Thank you! 🥳

This worked for me to listen for all the topics and add all the values into a Redux store:

    const client = NetworkTables.getInstanceByURI('localhost'); // Simulator

    const allTopics = client.createPrefixTopic('/');
    allTopics.subscribe((value, params) => {
        const topicName = params.name;
        const entryExists = !!store.getState().nt.data[topicName];
        if (!entryExists ) {
            store.dispatch(addNTEntry({topicName, type: params.type}))
        }
        store.dispatch(updateNTValue({topicName, value}));
    });

For the record - I tested @nab138's issue with the prefix and normal subscribe and I wasn't able to reproduce the problem:

    const client = NetworkTables.getInstanceByURI('localhost'); // Simulator

    const allTopics = client.createPrefixTopic('/');
    allTopics.subscribe((value, params) => {
        const topicName = params.name;
        if (topicName === '/Shuffleboard/Logging/timeMs') {
            console.log('prefix nt value', value);
        }
    });

    client.createTopic<number>('/Shuffleboard/Logging/timeMs', NetworkTablesTypeInfos.kInteger)
        .subscribe(value => console.log('NOT prefix nt value', value));

[nab138]

I've done some more experimenting and noticed that the problem is that when I subscribe to the "/" prefix and then attempt a subscription to a double[], I get a bunch of ZodErrors. When I remove it, it works as expected.

[cjlawson02]

@nab138 can you provide a minimal reproducible example please?