Add Workspace Metadata by Mythicaeda · Pull Request #1807 · NASA-AMMOS/plandev

Mythicaeda · 2026-03-25T16:19:51Z

Tickets addressed: Closes Metadata for SeqDev Workspace files - Protocol and API #1802 and closes Metadata for Seqdev Workspaces - Managed fields and Read-only flag #1804
Review: By commit
Merge strategy: Merge (no squash)

Description

Adds new endpoints for handling metadata files and update existing file endpoints to reject directly updating metadata files
Updates the reserved Metadata extension from .aerie to .meta.seqdev
Updates listContents endpoint to hide METADATA-type files by default, and to provide the contents of the metadata files if the withMetadata flag is provided
Updates file move/copy/delete so that metadata files are consistently handled before their corresponding file. Before, it varied based on endpoint
Restricts move/copy/save/delete file endpoints to reject with a 423 Locked status if the file is marked as "readOnly"

Verification

I'd like to add some tests that focus on the contents of the metadata files, and how they're reconstructed after deletion, as well as basic bindings tests for the endpoints.

Documentation

No docs are invalidated, but we should add documenting these new endpoints to writing docs for the other workspace server endpoints

Future work

- Update WorkspaceBindings to use new error

- Update Move and Copy to consistently use java.nio.Files instead of a mix of java.nio.Files and java.io.File - Update thrown exceptions list for accuracy

…thods together

- Will no longer include METADATA type files in response - Made RenderType in charge of the Aerie Metadata type for the backend, as that extension is expected to be fairly constant - Remove unneeded Optional wrapper from `listFiles` method

- No longer updates `lastEditedBy` when the metadata is updated (unless that field is missing)

- Move user setup to before tests are run - Move shared User objects to the User helper class - Move APIResponse Body Parser to RequestBodyHelper

- Allow readonly files to be copied - Update the metadata on file copy

…be found

…d as readonly - move exceptions into "Exceptions" package

Error Responses were not using the provided Javax serializer on the single item endpoints due to already being converted to JsonObject

Was only running Copy instructions if the user did not have sufficient permissions

- add missing 500 logs to copy/delete

- do not restrict folder rename

dandelany

Reviewed with @Mythicaeda - minor comments added.

Still in progress: reviewing Test files and doing some more backend testing locally

dandelany · 2026-04-16T02:50:15Z

+
+        // Validate that the optional keys have the correct type, if they're present
+        if (metadata.containsKey("readOnly")) {
+          readOnly = metadata.getBoolean("readOnly");


It feels weird to be setting this important piece of state only as a side-effect of a method called validate - can we move this up to the constructor after the validateMetadata call?

dandelany · 2026-04-16T19:51:10Z

@@ -0,0 +1,43 @@
+package gov.nasa.jpl.aerie.e2e.utils;


let's add a comment to this file to note it gets auto-loaded by the launcher session listener file

dandelany · 2026-04-16T20:39:07Z

+   *  - "deep": deep merge JSON Object params (combine nested properties)
+   *  - "shallow": shallow merge of JSON Object params (combine only top-level properties)
+   *  - "overwrite": replace JSON Object params with the new value, if provided
+   * Defaults to "deep" if not provided


should say 'defaults to shallow'

dandelany · 2026-04-16T20:41:04Z

+   * If the metadata files contents are malformed, returns a 500 error response
+   * If the user passes a malformed set of keys (including non-existent top-level keys or a non-json object "user" field), returns a 400 error.
+   *
+   * Also takes in a query param "mergeBehavior", which can be one of "deep", "shallow", and "overwrite". Behavior is as follows:


note that this part is only applicable to the user object, and eg. doesn't overwrite the entire metadata object

dandelany · 2026-04-16T20:52:49Z

+
+    // Check that the underlying file exists
+    if (!workspaceService.checkFileExists(pathInfo.workspaceId, pathInfo.filePath)) {
+      context.status(404).json(new FormattedError(new NoSuchFileException(pathInfo.workspaceId, pathInfo.filePath)));


let's remove the check for the underlying file here, since this could be a useful endpoint for cleaning up "orphan" metadata files

dandelany · 2026-04-16T21:32:52Z


-    boolean success = true;
+  private boolean isReadOnly(final Path repoPath, final Path filePath)


dedupe this with the previous function & have one call the other

dandelany · 2026-04-16T21:48:16Z

+      // Fill in "created" information, using the "metadataLastEdited" information as a fallback
+      contents.createdBy().ifPresentOrElse(
+          c -> generator.write("createdBy", c),
+          () -> generator.write("createdBy", contents.metadataLastEditedBy()));


try and use lastEditedBy as fallback before metadataLastEditedBy

dandelany · 2026-04-16T21:55:02Z

+  ) throws JsonException {
+    final var mergedBuilder = new MetadataUpdates.Builder(updates.metadataLastEditedBy(), updates.metadataLastEditedAt());
+
+    // Upsert the fields, skipping "lastEditedAt" and "lastEditedBy" (as they're already set),


should say "skipping metadataLastEditedBy and metadataLastEditedBy"

dandelany · 2026-04-16T21:57:38Z

+      MetadataUpdates updates,
+      MetadataMergeBehavior mergeBehavior
+  ) throws JsonException {
+    final var mergedBuilder = new MetadataUpdates.Builder(updates.metadataLastEditedBy(), updates.metadataLastEditedAt());


add comment/note that these are fallbacks only representing the metadata file changed time

dandelany · 2026-04-16T22:10:43Z

+        final var userObject = fileContentsBuilder.getUser();
+        if (userObject == null) continue;
+
+        final var path = new ArrayList<>(Arrays.asList(key.split("\\.")));


let's have a comment somewhere (eg. in service interface file) that explains that nested keys are supported by that API

Mythicaeda · 2026-04-17T18:14:12Z

Comments have been addressed in the 6 newest commits

Mythicaeda temporarily deployed to e2e-test March 25, 2026 16:19 — with GitHub Actions Inactive

Mythicaeda had a problem deploying to e2e-test March 25, 2026 16:19 — with GitHub Actions Failure

Mythicaeda temporarily deployed to e2e-test March 26, 2026 21:08 — with GitHub Actions Inactive

Mythicaeda temporarily deployed to e2e-test March 26, 2026 23:09 — with GitHub Actions Inactive

Mythicaeda force-pushed the feat/workspace-metadata branch from 8390b04 to ec20854 Compare March 26, 2026 23:16

Mythicaeda had a problem deploying to e2e-test March 26, 2026 23:17 — with GitHub Actions Failure

Mythicaeda temporarily deployed to e2e-test March 26, 2026 23:17 — with GitHub Actions Inactive

Mythicaeda had a problem deploying to e2e-test March 26, 2026 23:17 — with GitHub Actions Failure

Mythicaeda force-pushed the feat/workspace-metadata branch from ec20854 to b2a94e4 Compare March 27, 2026 14:09

Mythicaeda temporarily deployed to e2e-test March 27, 2026 14:09 — with GitHub Actions Inactive

Mythicaeda had a problem deploying to e2e-test March 27, 2026 14:09 — with GitHub Actions Failure

Mythicaeda force-pushed the feat/workspace-metadata branch from b2a94e4 to daced4a Compare March 27, 2026 17:38

Mythicaeda temporarily deployed to e2e-test March 27, 2026 17:38 — with GitHub Actions Inactive

Mythicaeda had a problem deploying to e2e-test March 27, 2026 17:38 — with GitHub Actions Failure

Mythicaeda temporarily deployed to e2e-test March 27, 2026 17:38 — with GitHub Actions Inactive

Mythicaeda force-pushed the feat/workspace-metadata branch from daced4a to 5ac618e Compare March 27, 2026 18:15

Mythicaeda temporarily deployed to e2e-test March 27, 2026 18:15 — with GitHub Actions Inactive

Mythicaeda had a problem deploying to e2e-test March 27, 2026 18:15 — with GitHub Actions Failure

Mythicaeda temporarily deployed to e2e-test March 27, 2026 18:15 — with GitHub Actions Inactive

Mythicaeda force-pushed the feat/workspace-metadata branch from 5ac618e to 99d8a25 Compare March 27, 2026 18:41

Mythicaeda temporarily deployed to e2e-test March 27, 2026 18:41 — with GitHub Actions Inactive

Mythicaeda had a problem deploying to e2e-test March 27, 2026 18:41 — with GitHub Actions Failure

Mythicaeda temporarily deployed to e2e-test March 27, 2026 18:41 — with GitHub Actions Inactive

AaronPlave mentioned this pull request Mar 27, 2026

Sequence metadata UI NASA-AMMOS/plandev-ui#1901

Closed

1 task

Mythicaeda force-pushed the feat/workspace-metadata branch from 99d8a25 to b411532 Compare March 27, 2026 20:01

Mythicaeda temporarily deployed to e2e-test March 27, 2026 20:02 — with GitHub Actions Inactive

Mythicaeda added 22 commits April 16, 2026 15:21

Add MalformedRequest Error

93dcbf9

- Update WorkspaceBindings to use new error

Add new endpoints to WorkspaceService

4671a9c

Add new endpoints for workspace metadata

f7eb27f

Update Create/Copy/Move/Delete File Endpoints to support Metadata

9d3bfc7

- Update Move and Copy to consistently use java.nio.Files instead of a mix of java.nio.Files and java.io.File - Update thrown exceptions list for accuracy

Reorganize contents of WorkspaceFileSystemService to group related me…

8030ece

…thods together

Update reserved extension in the DB

112374c

Remove WorkspaceService.isMetadataFile in favor of RenderType method

7852e22

Update Metadata File when file is edited, copied, or moved

a9d5b2e

- No longer updates `lastEditedBy` when the metadata is updated (unless that field is missing)

Restrict File Endpoints from handling Metadata Files

dd086fd

Verify file is not "readOnly" before edit or delete

9882865

Add in a "mergeBehavior" query param

56d17ed

Split BindingsTests into multiple files

1f38633

- Move user setup to before tests are run - Move shared User objects to the User helper class - Move APIResponse Body Parser to RequestBodyHelper

Fix Copy:

0cc5938

- Allow readonly files to be copied - Update the metadata on file copy

Set default merge behavior to "shallow"

d151814

Return "NO_SUCH_FILE" instead of "INTERNAL_ERROR" when a file cannot …

ff402a9

…be found

Return "FILE_LOCKED" instead of "INTERNAL_ERROR" when a file is marke…

0407712

…d as readonly - move exceptions into "Exceptions" package

Fix Single Endpoint Error Responses

8e5cb5e

Error Responses were not using the provided Javax serializer on the single item endpoints due to already being converted to JsonObject

Fix permissions check error in Single Item Copy

e4b8ec3

Was only running Copy instructions if the user did not have sufficient permissions

Confirm that directory does not contain locked items before delete

28872fa

- add missing 500 logs to copy/delete

Restrict folder move if it contains a readOnly file

9520f01

- do not restrict folder rename

Update E2E Tests

fa91ca1

dandelany requested changes Apr 16, 2026

View reviewed changes

Mythicaeda added 6 commits April 17, 2026 14:13

Remove "underlying file existence check" from DeleteMetadata Endpoint

d8f36de

Dedupe isReadOnly

419e54f

Log on failure in DeleteFile

be49e8f

Make "FileNode.readOnly" final

e533d72

Comment Updates

9a49491

Attempt to use last file edit before most recent metadata edit

b382210

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Workspace Metadata#1807

Add Workspace Metadata#1807
Mythicaeda wants to merge 29 commits intodevelopfrom
feat/workspace-metadata

Mythicaeda commented Mar 25, 2026 •

edited

Loading

Uh oh!

dandelany left a comment

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

dandelany Apr 16, 2026

Uh oh!

Mythicaeda commented Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		boolean success = true;
		private boolean isReadOnly(final Path repoPath, final Path filePath)

Conversation

Mythicaeda commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Verification

Documentation

Future work

Uh oh!

dandelany left a comment

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!

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!

Mythicaeda commented Apr 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Mythicaeda commented Mar 25, 2026 •

edited

Loading