GH-2456: Change the project type to module, and update files to match the import type (import, from ES6) by kinow · Pull Request #2458 · apache/jena

kinow · 2024-05-06T20:32:38Z

GitHub issue resolved #2456
GitHub issue resolved #2056

Pull request Description:

Changes the project type to module, defining it as an ES6 project. That forces us to use only import everywhere, including Vite, ESLint, and Cypress configuration files.

This also fixes #2056 as it removes the CommonJS imports, using only ES6 import.

Tests are included.
Documentation change and updates are provided for the Apache Jena website
Commits have been squashed to remove intermediate development commit messages.
Key commit messages start with the issue number (GH-xxxx)

By submitting this pull request, I acknowledge that I am making a contribution to the Apache Software Foundation under the terms and conditions of the Contributor's Agreement.

See the Apache Jena "Contributing" guide.

kinow · 2024-05-06T20:36:00Z

Doing it quickly today while it's fresh, as I fixed this on another project a few weeks/months ago. I remember it was annoying finding the right Cypress config, but luckily Jena is using a very similar configuration (no surprise 🤓 )

tupilabs/vue-lumino#130

kinow · 2024-05-06T20:36:48Z

jena-fuseki2/jena-fuseki-ui/eslint.config.js

This replaces .eslintrc.js. Can't find the link in their docs, but somewhere in the eslint 8.x to 9.x they defined the eslint.config.js was the preferred form (makes sense, I think, vite, cypress, etc., follow this pattern too).

kinow · 2024-05-06T20:37:36Z

jena-fuseki2/jena-fuseki-ui/cypress.config.mjs

I think I did the fix on the other project pretty quickly, except for this file. Finding the right config for Cypress was really frustrating. Hence, an important point to be reviewed, by generating the coverage for e2e tests 👍

kinow · 2024-05-06T20:37:59Z

jena-fuseki2/jena-fuseki-ui/package.json

    "test:unit": "vitest run --environment jsdom",
    "test:e2e": "cross-env FUSEKI_PORT=\"${FUSEKI_PORT:=3030}\" PORT=\"${PORT:=8080}\" concurrently --names 'SERVER,CLIENT,TESTS' --prefix-colors 'yellow,blue,green' --success 'first' --kill-others 'yarn run serve:fuseki' 'yarn wait-on http://localhost:${FUSEKI_PORT}/$/ping && yarn run dev' 'yarn wait-on http-get://localhost:${PORT}/index.html && cypress run $@'",
-    "lint": "eslint --ext .js,.vue --ignore-path .gitignore --fix src",
+    "lint": "eslint --fix src",


They dropped the --ext, and now the rest can all be configured in the config.js file.

kinow · 2024-05-06T20:38:25Z

jena-fuseki2/jena-fuseki-ui/package.json

    "sinon": "^17.0.0",
    "vite": "^5.0.12",
-    "vite-plugin-istanbul": "6.0.0",
+    "vite-plugin-istanbul": "6.0.2",


Le fix for the dependabot upgrade bug.

kinow · 2024-05-06T20:38:47Z

jena-fuseki2/jena-fuseki-ui/src/main.js

 * limitations under the License.
 */

-import { createApp, h } from 'vue'


New version of eslint found several issues (I think we were ignoring some too), so remaining changes is mainly fixing that.

kinow · 2024-05-06T20:41:04Z

jena-fuseki2/jena-fuseki-ui/src/views/dataset/Edit.vue

      this.loadingGraph = true
      this.selectedGraph = graphName
      try {
-        const dataEndpoint = this.services['gsp-rw']['srv.endpoints'].find(endpoint => endpoint !== '') || ''


kinow · 2024-05-06T20:41:29Z

jena-fuseki2/jena-fuseki-ui/src/services/mock/json-server.js

 server.get('/tests/reset', (req, res) => {
  // Just delete the datasets to clean up for other tests to have a
-  // brand new environment.
+  // brand-new environment.


Sorry, IDE was a bit picky, so including this change just to satisfy it so that it doesn't show an annoying warning.

kinow · 2024-05-06T22:00:26Z

jena-fuseki2/jena-fuseki-ui/tests/e2e/specs/datasets.cy.js

+      cy.request({
+        url: '/tests/reset',
+        retryOnStatusCodeFailure: true
+      })


It might be my environment, but for some unknown reason the fake Fuseki used in the e2e tests started failing intermittently.

Sometimes everything worked fine, sometimes the second or third test failed.

Tried debugging it, changing settings, but couldn't understand what's happening. Looked at the issues of Json-server but didn't find anything helpful (the test fails with HTTP error 500 on the Json-server reply).

Cypress contains a setting to retry (4 times by default), which fixed the test on my environemnt. Not sure what could have caused it.

kinow · 2024-05-06T22:03:40Z

Ready for review 👍

afs · 2024-05-07T17:44:08Z

jena-fuseki2/jena-fuseki-ui/package.json

    "sinon": "^17.0.0",
    "vite": "^5.0.12",
-    "vite-plugin-istanbul": "6.0.0",
+    "vite-plugin-istanbul": "6.0.2",


Maybe put back the ^ which was removed in the #2457 quick-fix.

Suggested change

"vite-plugin-istanbul": "6.0.2",

"vite-plugin-istanbul": "^6.0.2",

At this point in time it resolves to 6.0.2 and the yarn.lock file only changes to reflect adding the ^.

Missed that, sorry. It's back now 👍

…ch the import type (import, from ES6)

kinow · 2024-05-07T20:50:08Z

jena-fuseki2/jena-fuseki-ui/yarn.lock

-  version "6.0.0"
-  resolved "https://registry.yarnpkg.com/vite-plugin-istanbul/-/vite-plugin-istanbul-6.0.0.tgz#630c1404c09ae242f84b819f001abe4db3f8bf2e"
-  integrity sha512-Vwh2XdesjcLwaPbHSOiWHh+0s7CNovQTPEjUCTkqmJUe0FN2TKsOp0qpoaklOuwrKlL9elhD5fPFxi5lmG62zA==
+vite-plugin-istanbul@^6.0.2:


^6.0.2 ☝️

kinow · 2024-05-07T20:50:30Z

jena-fuseki2/jena-fuseki-ui/package.json

    "sinon": "^17.0.0",
    "vite": "^5.0.12",
-    "vite-plugin-istanbul": "6.0.0",
+    "vite-plugin-istanbul": "^6.0.2",


^6.0.2 👍 ☝️ @afs

kinow · 2024-05-07T21:02:25Z

Executed lint and unit/e2e tests, all passing, merging now. Thanks!

kinow force-pushed the use-type-module branch from ae88f51 to f731711 Compare May 6, 2024 20:33

kinow self-assigned this May 6, 2024

kinow added Fuseki UI bug labels May 6, 2024

kinow force-pushed the use-type-module branch 3 times, most recently from bc72428 to 9777888 Compare May 6, 2024 21:56

kinow marked this pull request as ready for review May 6, 2024 21:58

kinow commented May 6, 2024

View reviewed changes

kinow changed the title ~~Change the project type to module, and update files to match the import type (import, from ES6)~~ GH-2456: Change the project type to module, and update files to match the import type (import, from ES6) May 6, 2024

kinow requested a review from afs May 6, 2024 22:03

afs reviewed May 7, 2024

View reviewed changes

afs approved these changes May 7, 2024

View reviewed changes

kinow force-pushed the use-type-module branch from 9777888 to 51bd345 Compare May 7, 2024 20:11

[GH-2456]: Change the project type to module, and update files to mat…

dd5fb33

…ch the import type (import, from ES6)

kinow force-pushed the use-type-module branch from 51bd345 to dd5fb33 Compare May 7, 2024 20:48

kinow commented May 7, 2024

View reviewed changes

kinow merged commit c93343b into main May 7, 2024

kinow deleted the use-type-module branch May 7, 2024 21:02

	"vite-plugin-istanbul": "6.0.2",
	"vite-plugin-istanbul": "^6.0.2",

Conversation

kinow commented May 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kinow commented May 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kinow commented May 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kinow commented May 7, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kinow commented May 6, 2024 •

edited

Loading