Fix: update db utils script to reflect new architecture

[lanterno]

The dbUtils script is outdated, and doesn't work with the current backend. I've adjusted the script, and tested it.

Currently, there's no tests, but it might be a good idea later to add some.

Reviewing each commit separately should provide a better idea of the logical sequence of changes.

ToDo:

• Rename the file to a more sensible name cli.ts
• Use a proper CLI library/tool
• Add some unit tests (maybe)

closes #300

[lanterno]

I was planning to change the JS script into typescript, but apparently, it's a bit more complex to have a CLI in typescript, so I'll do that in another PR.

Update: there's also Commander.js that I'm investigating now. Still, for the next PR 😉

[PascalinDe]

I'm wondering if /src is really the best place... maybe add a directory /src/scripts to make it clear that it's not part of the application code?

apart from that LGTM

[lanterno]

@PascalinDe since it's a small script, I was thinking about renaming it to cli.ts in my next PR.
I think it goes along with the naming for the backend code server.ts.

What do you think?

[PascalinDe]

@PascalinDe since it's a small script, I was thinking about renaming it to cli.ts in my next PR. I think it goes along with the naming for the backend code server.ts.

What do you think?

sounds great!

[pierluca]

To add to @PascalinDe 's comments and your suggestion to rename this cli.js, I'd like to bring up the NPM convention of having a bin/ folder and defining it in the bin key in the package.json, with a shebang at the top. This would allow the usage of npx, which is always nice.

For references:
https://docs.npmjs.com/cli/v9/configuring-npm/package-json#bin
https://blog.shahednasser.com/how-to-create-a-npx-tool/

[pierluca]

Obviously this could be in a follow up PR and not now :-)

[lanterno]

Check it out.. now it's npx cli addAdmin --sciper 123

[PascalinDe]

now that it is merged, can you update README.docker as well? thanks!

[PascalinDe]

the script is not executing properly in the Docker image:

root@40c225d12de8:/web/backend# NODE_PATH=./node_modules node -e 'require("./src/dbUtils").addAdmin("...")'
/web/backend/src/dbUtils.js:9
import { SequelizeAdapter } from 'casbin-sequelize-adapter';
^^^^^^

SyntaxError: Cannot use import statement outside a module
    at internalCompileFunction (node:internal/vm:73:18)
    at wrapSafe (node:internal/modules/cjs/loader:1153:20)
    at Module._compile (node:internal/modules/cjs/loader:1197:27)
    at Module._extensions..js (node:internal/modules/cjs/loader:1287:10)
    at Module.load (node:internal/modules/cjs/loader:1091:32)
    at Module._load (node:internal/modules/cjs/loader:938:12)
    at Module.require (node:internal/modules/cjs/loader:1115:19)
    at require (node:internal/modules/helpers:119:18)
    at [eval]:1:1
    at Script.runInThisContext (node:vm:122:12)

Node.js v20.5.0

I'm not very familiar with JavaScript, maybe it's not meant to be run like this? can you please clarify?

[lanterno]

@PascalinDe @pierluca I rebased the PR to include the docker changes made by @PascalinDe, and I'm now using a CLI library called CommanderJS to build a CLI. along with npx and node bin, it's a great combination to have a cli tool

example: npx cli addAdmin --sciper 1234

I hope you like it :)

[coveralls]

Pull Request Test Coverage Report for Build 5829454076

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.05%) to 57.444%

---

Totals
Change from base Build 5809092943:	0.05%
Covered Lines:	3272
Relevant Lines:	5696

---

💛 - Coveralls

fixed

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication

[PascalinDe]

can you please update the README.docker as well?

[pierluca]

Very nice ! LGTM

[coveralls]

Pull Request Test Coverage Report for Build 5829454076

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.05%) to 57.444%

---

Totals
Change from base Build 5809092943:	0.05%
Covered Lines:	3272
Relevant Lines:	5696

---

💛 - Coveralls