feat(python-notebook-migration): add database tables for Notebook Migration tool#5055
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5055 +/- ##
============================================
- Coverage 51.59% 49.94% -1.65%
+ Complexity 2420 2419 -1
============================================
Files 1056 1054 -2
Lines 41046 40752 -294
Branches 4407 4372 -35
============================================
- Hits 21176 20355 -821
- Misses 18631 19170 +539
+ Partials 1239 1227 -12
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
|
Please check this pr: #4401, for database changes |
Contributor
Author
I have addressed this issue |
mengw15
reviewed
May 25, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to no response for status checks
yangzhang75
pushed a commit
to yangzhang75/texera
that referenced
this pull request
Jun 22, 2026
…ration tool (apache#5055) <!-- Thanks for sending a pull request (PR)! Here are some tips for you: 1. If this is your first time, please read our contributor guidelines: [Contributing to Texera](https://github.com/apache/texera/blob/main/CONTRIBUTING.md) 2. Ensure you have added or run the appropriate tests for your PR 3. If the PR is work in progress, mark it a draft on GitHub. 4. Please write your PR title to summarize what this PR proposes, we are following Conventional Commits style for PR titles as well. 5. Be sure to keep the PR description updated to reflect all changes. --> ### What changes were proposed in this PR? <!-- Please clarify what changes you are proposing. The purpose of this section is to outline the changes. Here are some tips for you: 1. If you propose a new API, clarify the use case for a new API. 2. If you fix a bug, you can clarify why it is a bug. 3. If it is a refactoring, clarify what has been changed. 3. It would be helpful to include a before-and-after comparison using screenshots or GIFs. 4. Please consider writing useful notes for better and faster reviews. --> This PR adds two new tables to the database, `notebook` and `workflow_notebook_mapping`. These tables will be used in the new Python Notebook Migration tool to store the user-uploaded notebook and the generated mapping between the notebook and workflow. ### Any related issues, documentation, discussions? <!-- Please use this section to link other resources if not mentioned already. 1. If this PR fixes an issue, please include `Fixes apache#1234`, `Resolves apache#1234` or `Closes apache#1234`. If it is only related, simply mention the issue number. 2. If there is design documentation, please add the link. 3. If there is a discussion in the mailing list, please add the link. --> Closes apache#5054 The parent issue is apache#4301 #### Schema <img width="1580" height="838" alt="image" src="https://github.com/user-attachments/assets/33896320-56c5-45d6-bbd4-6d74fc365a49" /> ### How was this PR tested? <!-- If tests were added, say they were added here. Or simply mention that if the PR is tested with existing test cases. Make sure to include/update test cases that check the changes thoroughly including negative and positive cases if possible. If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future. If tests were not added, please describe why they were not added and/or why it was difficult to add. --> New tables were manually confirmed to be created successfully and usable. ### Was this PR authored or co-authored using generative AI tooling? <!-- If generative AI tooling has been used in the process of authoring this PR, please include the phrase: 'Generated-by: ' followed by the name of the tool and its version. If no, write 'No'. Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details. --> No --------- Co-authored-by: Meng Wang <mengw15@uci.edu>
PG1204
pushed a commit
to PG1204/texera
that referenced
this pull request
Jun 25, 2026
…service in backend (apache#5258) ### What changes were proposed in this PR? Introduces the microservice that mediates between Texera and the JupyterLab docker stack landed in `migration-tool-jupyter-docker`. Adds a new SBT subproject `notebook-migration-service` plus shared config and a frontend dev-proxy route. **New SBT subproject `notebook-migration-service/`:** - **`build.sbt`** and **`project/build.properties`** — module SBT setup; module depends on the existing `Auth`, `Config`, and `DAO` projects - **`src/main/scala/.../NotebookMigrationService.scala`** — Dropwizard `Application` entry point; sets Jersey URL pattern to `/api/*`, registers the resource class, initializes the shared SQL connection via `SqlServer.initConnection(StorageConfig.jdbcUrl, …)`, and wires in `RequestLoggingFilter`. - **`src/main/scala/.../NotebookMigrationServiceConfiguration.scala`** — Dropwizard `Configuration` subclass. - **`src/main/scala/.../resource/NotebookMigrationResource.scala`** — five REST endpoints under `/notebook-migration`: - `GET /get-jupyter-url` — health-checks the Jupyter container and returns its base URL. - `GET /get-jupyter-iframe-url` — returns the iframe-ready URL for `notebook.ipynb`. - `POST /set-notebook` — receives a notebook JSON, PUTs it into JupyterLab via its `/api/contents/work/{name}` API. - `POST /store-notebook-and-mapping` — persists a notebook + workflow-notebook mapping into Postgres in a single transaction (writes to the `notebook` and `workflow_notebook_mapping` tables added by `migration-tool-database-tables`). - `POST /fetch-notebook-and-mapping` — returns the most recent notebook + mapping for a given (wid, vid). - **`src/main/resources/logback.xml`** — logging config. - **`src/main/resources/notebook-migration-service-web-config.yaml`** — Dropwizard server config (HTTP port `9098`, DB connection refs). **Root build wiring:** - **`build.sbt`** — declares the new `NotebookMigrationService` SBT subproject and adds it to the `TexeraProject` aggregation. **Shared config:** - **`common/config/src/main/resources/storage.conf`** — new `jupyter { url = "http://localhost:9100" }` block, overridable via `STORAGE_JUPYTER_URL`. - **`common/config/src/main/scala/.../StorageConfig.scala`** — adds the `jupyterURL` accessor. **Frontend dev proxy:** - **`frontend/proxy.config.json`** — routes `/api/notebook-migration/*` to `http://localhost:9098`. ### Any related issues, documentation, discussions? Closes apache#5257 Parent issue apache#4301 - Hard dependency: **must be merged after `migration-tool-database-tables`** apache#5055 — the resource imports jOOQ-generated `Notebook` / `WorkflowNotebookMapping` classes that only exist once the schema PR is merged. - Soft dependency: the JupyterLab container from `migration-tool-jupyter-docker` is what `StorageConfig.jupyterURL` points to. Without it running, the Jupyter-related endpoints return a 500 with `"Cannot connect to Jupyter server"`. Service still starts and the DB-persistence endpoints work in isolation. ### How was this PR tested? ### Was this PR authored or co-authored using generative AI tooling? Generated-by: Claude Code (Claude Opus 4.7) --------- Signed-off-by: Ryan Zhang <97552093+zyratlo@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Meng Wang <mengw15@uci.edu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this PR?
This PR adds two new tables to the database,
notebookandworkflow_notebook_mapping. These tables will be used in the new Python Notebook Migration tool to store the user-uploaded notebook and the generated mapping between the notebook and workflow.Any related issues, documentation, discussions?
Closes #5054
The parent issue is #4301
Schema
How was this PR tested?
New tables were manually confirmed to be created successfully and usable.
Was this PR authored or co-authored using generative AI tooling?
No