Code Generation Tool

[bobur-khay]

This is a take over of PR: eclipse-thingweb/td-tools#61

The goal is to create a package of a code generation tool that creates a protocol specific code snippet in a chosen library of a programming language and integrate it to the playground.

Taking over the previous PR I could not make it run and had a different vision of the use of AI generation:

• The Bring Your Own Token principal requires the playground of either:

  1. Stroring the token in the local storage which causes security concerns (e.g. XSS)
  2. Making the user pasting their token every time they use the playground which makes them generate new tokens every time or keeping them somewhere

  In both cases the user needs a developer account in their respective LLM provider and has to know how to generate the token which reduces UX imo. Therefore, after discussing this with @egekorkan I implemented another concept where the tool generates a prompt that user can paste in an LLM of their own choice:

  • We do not handle the user tokens
  • The user is not limited in the number of LLM providers that are supported by the tool
  • Reduces the complexity of the package

The tool is inside of this repository for now for testing purposes. Later it can be moved to the td-tools repository.

[netlify]

✅ Deploy Preview for thingweb-playground ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	b555cbd
🔍 Latest deploy log	https://app.netlify.com/projects/thingweb-playground/deploys/6a4eb85f664782000859f8d1
😎 Deploy Preview	https://deploy-preview-718--thingweb-playground.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 27 (🔴 down 1 from production) Accessibility: 79 (no change from production) Best Practices: 100 (no change from production) SEO: 80 (no change from production) PWA: 70 (no change from production) View the detailed breakdown and full score reports
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[egekorkan]

Initial review based on git diff

• Netlify previews are failing due to dependencies. Not sure how the CI tests are passing if the problem is so basic :D
• For the tests, did you also do tests with a live Thing? like your coffee machine example or http://plugfest.thingweb.io/http-data-schema-thing ?

[egekorkan]

• Web package is working nicely.
• CLI:
  • tsx as a dependency is missing
  • Modbus and javascript is not working? Or is the base not used to detect protocol?
  • When the output prompt step comes and I put a path, ~/Downloads does not work

However, given that the CLI will live in td-tools, we can still go ahead and fix the issues in the commits to that repo

[bobur-khay]

  * Modbus and javascript is not working? Or is the base not used to detect protocol?

Could you please share your inputs? Modbus serial works fine for me.

[bobur-khay]

  * When the output prompt step comes and I put a path, `~/Downloads` does not work

The path input was only relative. I added support for absolute path inputs and an interactive mode for selecting the file or folder to ease the input. Could you test that again please?

[egekorkan]

The path input was only relative. I added support for absolute path inputs and an interactive mode for selecting the file or folder to ease the input. Could you test that again please?

This is working.

Modbus in Javascript with the following TD does not work. It is generated from https://github.com/wot-oss/thingmodels/blob/main/siemens/siemens/3nacom-fuse/v1.0.0-20240802121832-3b18ae135fbc.tm.json but use the attachment. The generation results in a prompt even though we have modbus binding
td.json

[bobur-khay]

@egekorkan I have refactored the code and improved the protocol detection. Now it should work fine.

[egekorkan]

I think the feature is ready to move to the td-tools and further improvements can be done there. I still see some frictions like fetch showing up even for modbus but that can be an improvement. @bobur-khay can you make a PR with only the core tooling in td-tools?

[bobur-khay]

I still see some frictions like fetch showing up even for modbus but that can be an improvement

It is happening on the playground right? For the mvp it only shows a comment saying the protocol is not supported. Wanted to implement filtered options later on. On the cli it should be like this:

If the problem appeared in the cli, could you share the input td pls?

[egekorkan]

It was only in Playground so it is fine for now :)

[bobur-khay]

Copied the package to eclipse-thingweb/td-tools#77

Will remove it from this PR once the other one is merged

[egekorkan]

@bobur-khay the package is published at https://www.npmjs.com/package/@thingweb/code-gen

[bobur-khay]

There was a publish problem for the code-gen package. Fixed it here eclipse-thingweb/td-tools#80

[bobur-khay]

Ready for final review

[egekorkan]

Also some basic tests are needed. the actual tool is ofc tested in td-tools but would be nice to test if the console gets populated with code

[egekorkan]

could you make sure that this "regression" is needed?

[bobur-khay]

Looks like a merge-conflict error, reversed it

[bobur-khay]

Also some basic tests are needed. the actual tool is ofc tested in td-tools but would be nice to test if the console gets populated with code

Tests added