Synnax 0.29.0 Release Candidate #832

Lham42 · 2024-09-16T21:45:54Z

Release Candidate Pull Request Template

Key Information

Platform Version:

Versioning

Public Packages

Version Consistency

I have verified that the following packages have the same minor version number:

Version Conflicts

I have verified that, when released, the following packages will not conflict with any
previously released packages:

CI Tests

I have verified that all CI tests pass.

CD Builds

I have verified that all CD builds pass.

User Documentation

Content Changes

I have verified that user facing documentation for each of the following services has
been updated to match any changes in the release candidate. If not, I will note why the
documentation has been left stale.

Examples

I have verified that code examples for each of the following services run correctly after releasing new versions of the corresponding packages:

client/py
client/ts
- version number in examples/node is up-to-date
pluto

Console

Auto Update

I have verified that the nightly builds of the console are able to auto-update
correctly.

Cluster Connection

I can successfully:

Labels

I can successfully open the label editing dialog from the command palette.
I can add a new label.
I can edit an existing label.

Ranges

I can successfully:

Channels

I can successfully:

Create a new channel from the search bar.
Create several channels with the 'Create More' flag set to true.
Rename a channel in the resources view.
Delete a channel in the resources view.
Delete multiple channels in the resources view.
Set the alias for a channel under a range.
Clear the alias for a channel under a range.
Copy a link to a channel in the resources view and open it from outside Synnax.

Line Plots

I can successfully:

Schematics

I can successfully:

Workspaces

I can successfully:

Resources

I can successfully:

Create a new group and move resources to it.
Move resources between groups.
Rename a group.
Delete a group.

Documentation

I can successfully:

Open the documentation from the command search bar.
Open the documentation from the question mark icon.

Devices

I can successfully:

Group devices in the resources view.
Rename a device in the resources view.
Delete a device in the resources view.

Tasks

I can successfully:

Group tasks in the resources view.
Rename a task in the resources view.
Delete a task in the resources view.

OPC UA

Configuration

I successfully:

Updated the license on TwinCat/Beckhoff before continuing QA

I can successfully:

Enable and disable OPC UA integration when starting the server.
Connect to an OPC UA server running unencrypted.
Connect to an OPC UA server running encrypted.
Create additional channels and move them to existing sampling groups.
Move and rename channels.
Save the device configuration.

Read Task

I can successfully:

Write Task

I can successfully:

Perform control and see changes reflected on the connected OPC UA server.
Stop, start and reconfigure task at will.
Enable and disable data saving at will.
Leave a write tasking played but idle for an hour and perform control without losing connection.
Perform a write on an encrypted server.

National Instruments

Configuration

I can successfully:

Read Task

I can successfully:

Plot live data from an analog read task.
Plot live data from a digital read task.
Stop, start and reconfigure task at will.
Disconnect a device while tasks are active and provide meaningful feedback in the
task dialogue.
Begin several tasks at different times and see them all plotting live data.
Enable and disable data saving at will.
verify there is no lag between sensor input and data written to sever.

Special Purpose Channels

Write Task

I can successfully:

Begin a digital write task and perform control actions with a schematic.
Stop, start and reconfigure task at will.
Disconnect a device while tasks are active and provide meaningful feedback in the
task dialogue.
Configure response time based on state rate specified:
- 1 Hz (should have visible delay in response)
- 20 Hz (should feel almost immediate)

General Usage

I can successfully:

Error Handling

I can successfully:

Pass in an invalid device configuration and receive meaningful feedback.
- Invalid ports
- Invalid task type for devices (e.g. analog read on a analog output device)
- Out of range values
- Multiple tasks using the same channel
Shut down the driver with an embedded driver without receiving an error from the
driver routine.

Other

I can successfully:

Toggle the color theme from the command search bar.
Run the driver for long periods of time with minimal memory leakage.

* fix(docs): Remove Linux from Console download button * refactor(docs): Add info on saving a range as a CSV * refactor(pluto): Simplify return statement * docs(client/py): Edit abort sequence README * refactor(docs): explicitly point to Python abort sequence example * feat(docs): Add info on snapshotting a schematic * feat(docs): Add a page on channels in the console * refactor(docs): Simplify code for OSDownloadButton * refactor(docs): change how channels are described * docs(client/py): update what DAQ is called in README for abort sequence * refactor(docs): Rework what channels are called

* docs: Update in-code links to documentation website * docs(client/ts): Update README, package.json, and contribution guidelines * docs(client/ts): Use bash as language for shell code blocks in README and CONTRIBUTING * docs: Remove contribution ask in README

…upgrade-open62541

SY-916 bump open62541 to 1.4.4

* checkpoint * [client/py] - improved threading mechanisms and added remains_true_for and while_true * [client/py] - improved docs * [client/py] - removed unnecessary deps * [freighter/py] - upgraded package versions * [freighter/py] - removed unnecessary util packages * [freighter/integration] - mod tidy * [driver] - bumped open62541 version * [client/py] - performance optimizations * [client/py] - several performance optimizations * [client/py] - improved transport semantics * [client/py] - minor PR adjustments and supplements to test cases

* updated streamer channel APIs and documentation * [drift] - reverted accidental changes * [cpp] - removed start field from streamer config instantiations * [client/ts] - updated generateed API * [cpp] - removed start field from OPC task * [synnax] - fixed bad test case compilation * [client/cpp] - adjusted frame streamer tests * [client/ts] - removed 'start' argument from streamer config * [client/ts] - updated API * [client/py] - fixed function renae

* fix(console): edit schematic stateZ to match State interface * refactor(console): add download button to schematic toolbar, refactored logic for download schematic to a separate hook * fix(console): better error handling for drag-and-drop files and working multiple files * fix(console): use dispatch effect to remove existing schematic when importing * refactor(console): Correct spelling of "pallette" to "palette" * feat(media): Add upload icon * feat(pluto): add upload and download icons * refactor(console): minor refactoring * refactor(console): store schematic name in schematic state * refactor(console): Add select schematic slice state selector * refactor(console): add icons for download/import schematic * Moved logic for handling schematic files into its own place * refactor(console): fix name on importing schematics * refactor(console): Change download schematic to export schematic + aded tooltip to button * refactor(console): remove dead code + fix imports * perf(console): change schematic state parser to try latest state first * refactor(console): Change the download / upload icons to import / export icons * feature(console): Add workspace export * feat(console): Add importing workspace * refactor(console): rename useTriggerHold.tsx to hooks.ts * refactor(console): Specify type of file in file handler * chore(client/ts): Update client API * feature(x/ts): Make a zodutil tool for transforming objects with Zod * refactor(console): Make JSON parsers use a combined zodutil * refactor(client/ts): Correct misnamed line plot variable * refactor(console): moved link.tsx files to link.ts * Partially implemented lineplot import * Removed saving the schematic name twice in store * Better error handling for drag-and-dropping files * Only send remove dispatch action if it does not exist * Fix an error where layout would not be placed * Rename file * Make workspace file handling logic cleaner * Finish merge * feat(console): Implement import line plot * refactor(console): Match lineplot and workspace file handling to schematic * "Refactor(console): Move hooks.ts to useTriggerHold.ts * refactor(console): Move parser into slice * refactor(console): rename exprt to handleExport * feat(console): Add link button to line plot toolbar * refactor(console): change size=0 in <Align> to empty * ops: add lint on save to VSCode workspace settings * console: remove workspace file handler * refactor(console): fix lineplot toolbar * refactor(console): minor name and logic improvements for clarity * refactor(console): handle resource import error messages better * refactor(console): Remove dead code

…ble-ni-chan SY 1129 allow ni channels to be enabled and disabled

- refactor(pluto): add border color to box and tank, new box border radius - refactor(pluto): Remove unnecessary code on tank/box form

- feat(pluto): Add scaling to most schematic elements - refactor(pluto): Make separate light aether component

* feat(media): Add name resources * docs: update file paths for icons

* refactor(console): Remove edit range from create range modal, clean range toolbar context menu & resource toolbar context menu for ranges * ci(github): update QA process for ranges

* [ops/ts] - bumped package versions * [ops/ts] - compatibility fixes for upgraded package versions * [ops/ts] - upgraded package versions * [console] - adjusted window visibility

* [docs/site] - improved documentation for new controller methods * [docs/site] - removed extra dividers

…8-documentation-site-breadcrumbs

…button-not-appearing SY-1179 fix update available button not appearing

…eadcrumbs SY-1218 documentation site breadcrumbs

* [console] - fixed incorrectly positioned items on layout laod * [console] - fixed schematic endpoints positioned incorrectly * [console] - removed commented out code and added documentation for an unintuitive section * [console] - removed commented out code and added documentation for an unintuitive section * [console] - adjusted tank handle offset slightly --------- Co-authored-by: Elham Islam <elham@synnaxlabs.com>

codecov-commenter · 2024-09-16T21:47:34Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 13.12127% with 437 lines in your changes missing coverage. Please review.

Project coverage is 46.31%. Comparing base (c3b8e28) to head (71340fb).
Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
pluto/src/vis/schematic/Forms.tsx	0.00%	87 Missing ⚠️
pluto/src/vis/schematic/Symbols.tsx	0.00%	76 Missing ⚠️
pluto/src/vis/schematic/primitives/Primitives.tsx	0.00%	66 Missing ⚠️
pluto/src/breadcrumb/Breadcrumb.tsx	0.00%	56 Missing ⚠️
pluto/src/vis/light/aether/light.ts	0.00%	50 Missing and 1 partial ⚠️
pluto/src/vis/schematic/registry.ts	0.00%	31 Missing ⚠️
pluto/src/vis/light/use.ts	0.00%	22 Missing and 1 partial ⚠️
drift/src/tauri/index.ts	0.00%	9 Missing ⚠️
pluto/src/triggers/Text.tsx	0.00%	8 Missing ⚠️
pluto/src/vis/diagram/Diagram.tsx	0.00%	5 Missing ⚠️
... and 14 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #832      +/-   ##
==========================================
- Coverage   46.37%   46.31%   -0.06%     
==========================================
  Files        1086     1088       +2     
  Lines       67807    67885      +78     
  Branches     3509     3512       +3     
==========================================
- Hits        31448    31444       -4     
- Misses      35309    35387      +78     
- Partials     1050     1054       +4

Flag	Coverage Δ
aspen	`50.40% <ø> (ø)`
cesium	`75.53% <ø> (ø)`
clientpy	`86.04% <100.00%> (+4.93%)`	⬆️
clientts	`61.35% <92.72%> (-0.02%)`	⬇️
drift	`26.30% <6.66%> (-0.08%)`	⬇️
freightergo	`25.70% <ø> (ø)`
freighterpy	`81.03% <100.00%> (+4.64%)`	⬆️
freighterts	`83.25% <ø> (ø)`
pluto	`35.34% <2.57%> (-0.18%)`	⬇️
synnax	`28.49% <25.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Lham42 and others added 30 commits September 3, 2024 07:34

[driver/vendor/open62541] bump open62541 version

e262237

Merge branch 'main' into rc

fc5eabd

Auto Update JSON File

0a83af3

Merge branch 'main' into rc

2c9d529

Auto Update JSON File

78e2d54

Merge branch 'main' into rc

fdbffb8

Merge branch 'main' into rc

7a5e4d3

Auto Update JSON File

c7845a3

Auto Update JSON File

ab04a92

Merge branch 'rc' of github.com:synnaxlabs/synnax into eislam/sy-916-…

63ed253

…upgrade-open62541

Merge pull request #805 from synnaxlabs/eislam/sy-916-upgrade-open62541

69b7349

SY-916 bump open62541 to 1.4.4

[driver] only return channel keys of enabled channels

c2fbbe4

update default enabled state

f1e462e

[driver] only construct frame with enabled channels

f364fdd

[driver] repeat for digital reads}

4334039

[driver/ni] dig writes

39dda16

[driver] update get cmd keys

5628f68

[driver] maintain enabled state of state channels

52c1cbb

[driver] typo

c056ee2

[driver] formatting

c3942b4

Auto Update JSON File

f6da9ba

Auto Update JSON File

1cba582

Auto Update JSON File

f6fe623

Merge branch 'main' into rc

6aa75d7

Merge branch 'main' into rc

a3dad5e

Lham42 and others added 28 commits September 12, 2024 11:52

[driver] fix digital writes

a0c4f0f

Merge pull request #818 from synnaxlabs/eislam/sy-1129-sy-disable-ena…

d9bb763

…ble-ni-chan SY 1129 allow ni channels to be enabled and disabled

Merge branch 'main' into rc

38cac58

Auto Update JSON File

9cffb8e

SY-1194 Adjust Box Border Radius + Tank & Box Background Color (#819)

7cc4012

- refactor(pluto): add border color to box and tank, new box border radius - refactor(pluto): Remove unnecessary code on tank/box form

SY-1098 Add Ability to Resize Most Schematic Symbols (#813)

9ba77f0

- feat(pluto): Add scaling to most schematic elements - refactor(pluto): Make separate light aether component

Auto Update JSON File

ab17586

Sy 1209 update logos (#820)

172c8b1

* feat(media): Add name resources * docs: update file paths for icons

Auto Update JSON File

d8a552a

Sy 1141 remove view details from range toolbar context menu (#826)

976abbb

* refactor(console): Remove edit range from create range modal, clean range toolbar context menu & resource toolbar context menu for ranges * ci(github): update QA process for ranges

Merge branch 'main' into rc

dc384c8

Auto Update JSON File

4cbd672

[console] - fixed version available notification

5748927

[ops/ts] - bumped package versions (#824)

bbd4641

* [ops/ts] - bumped package versions * [ops/ts] - compatibility fixes for upgraded package versions * [ops/ts] - upgraded package versions * [console] - adjusted window visibility

[ops] - bumped platform version to 0.29

20a2a83

[ops] - bumped platform version to 0.29

1ca6e7b

Sy 1216 document new controller wait conditions (#827)

f82b5ed

* [docs/site] - improved documentation for new controller methods * [docs/site] - removed extra dividers

[docs/site] - added breadcrumbs and next and prev buttons to docs site

46e031a

Merge branch 'rc' of https://github.com/synnaxlabs/synnax into sy-121…

1bd3722

…8-documentation-site-breadcrumbs

[ops/ts] - updated console CI

cfa7bca

[console] - updated tauri json update

a23902a

[console] - updated tauri json update

ec53de0

Merge pull request #828 from synnaxlabs/sy-1179-fix-update-available-…

7746fae

…button-not-appearing SY-1179 fix update available button not appearing

Merge pull request #831 from synnaxlabs/sy-1218-documentation-site-br…

645a461

…eadcrumbs SY-1218 documentation site breadcrumbs

[console] - fixed auto update CI workflow

45a3fe8

Auto Update JSON File

6956983

Auto Update JSON File

71340fb

Lham42 merged commit 2cb2f04 into main Sep 17, 2024
33 of 34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Synnax 0.29.0 Release Candidate #832

Synnax 0.29.0 Release Candidate #832

Lham42 commented Sep 16, 2024 •

edited

Loading

codecov-commenter commented Sep 16, 2024 •

edited

Loading

Synnax 0.29.0 Release Candidate #832

Synnax 0.29.0 Release Candidate #832

Conversation

Lham42 commented Sep 16, 2024 • edited Loading

Release Candidate Pull Request Template

Key Information

Versioning

Public Packages

Version Consistency

Version Conflicts

CI Tests

CD Builds

User Documentation

Content Changes

Examples

Console

Auto Update

Cluster Connection

Labels

Ranges

Channels

Line Plots

Schematics

Workspaces

Resources

Documentation

Devices

Tasks

OPC UA

Configuration

Read Task

Write Task

National Instruments

Configuration

Read Task

Special Purpose Channels

Write Task

General Usage

Error Handling

Other

codecov-commenter commented Sep 16, 2024 • edited Loading

Codecov Report

Lham42 commented Sep 16, 2024 •

edited

Loading

codecov-commenter commented Sep 16, 2024 •

edited

Loading