Feat: Edit metadata resources #1188

woutslabbinck · 2022-03-02T11:40:51Z

📁 Related issues

Closes #1027

✍️ Description

This PR implements the design choices from issue #1027.

Behaviour changes of a GET request:

now allowed to GET a metadata resource

Behaviour changes of a POST request (PostOperationHandler):

not allowed to create a metadata resource (via a slug)

Behaviour changes of a PUT request (PutOperationHandler):

not allowed to update metadata resources
not allowed to update existing containers

Behaviour changes of a PATCH request (PatchOperationHandler && RepresentationPatchHandler)

not allowed to change pim:storage or ldp:contains triples
not allowed to update metadata of metadata
not allowed to update metadata when a corresponding resource does not exist yet

Behaviour changes of a DELETE request (DeleteOperationHandler):

not allowed to delete metadata resources

✅ PR check list

Before this pull request can be merged, a core maintainer will check whether

this PR is labeled with the correct semver label
- semver.patch: Backwards compatible bug fixes.
- semver.minor: Backwards compatible feature additions.
- semver.major: Breaking changes. This includes changing interfaces or configuration behaviour.
the correct branch is targeted. Patch updates can target main, other changes should target the latest versions/* branch.
the RELEASE_NOTES.md document in case of relevant feature or config changes.

…w metadata files to be edited when a resource is available

…h PUT to container

… operationhandlers

…ible to edit (read reset) metadata

… editing

joachimvh

Some high level changes are still going to be needed to make this a generic solution.

config/util/auxiliary/strategies/meta.json

src/http/ldp/DeleteOperationHandler.ts

src/http/ldp/PatchOperationHandler.ts

src/storage/patch/RepresentationPatchHandler.ts

src/storage/mapping/BaseFileIdentifierMapper.ts

test/unit/storage/DataAccessorBasedStore.test.ts

…eck to new patchhandler which is more generic

…handler down to DABS

… to DataAccessors (part 1)

…riteMetadata in DataAccessor.ts (now taking subject identifier instead of metadata resource identifier)

…efault in the (converting.json)

# Conflicts: # RELEASE_NOTES.md

…metadata on PUT

joachimvh

Most comments are minor refactors. Only one that might still be an issue is the container generation issue.

Did not look at the tests because at this point it's hard to know where still to look there 😅. Let me know if there are tests of specific classes you want me to look at.

config/storage/backend/regex.json

config/storage/middleware/stores/patching.json

documentation/metadata-editing.md

src/storage/patch/RdfPatcher.ts

src/storage/patch/RepresentationPatchHandler.ts

templates/config/defaults.json

… already exist

joachimvh

Very minor comments remaining as you can see. Can fix them myself if you prefer at this point.

src/http/output/metadata/AuxiliaryLinkMetadataWriter.ts

joachimvh · 2022-08-04T09:41:57Z

src/http/representation/RdfDatasetRepresentation.ts

+  /**
+   * The data of this representation which conforms to the RDF/JS Dataset interface
+   * (https://rdf.js.org/dataset-spec/#dataset-interface).
+   */
  dataset: Store;


Suggested change

dataset: Store;

dataset: Dataset;

How much of a hassle would it be to use this type? Can be imported from rdf-js.

If the answer is that we would need multiple casts in several places then Store can stay, but if it changes (almost) nothing it would be better to use the correct interface here.

src/pods/generate/TemplatedResourcesGenerator.ts

joachimvh · 2022-08-04T09:49:30Z

src/storage/patch/ImmutableMetadataPatcher.ts

-    );
+    const immutablePatternMap = new Map<FilterPattern, Quad[]>();
+    const baseSubject = namedNode(this.metadataStrategy.getSubjectIdentifier(input.identifier).path);
+


Suggested change

joachimvh · 2022-08-04T10:59:50Z

test/unit/init/ContainerInitializer.test.ts

+  it('does not log warnings when container resource creation fails.', async(): Promise<void> => {
+    store.setRepresentation.mockRejectedValueOnce(new ConflictHttpError('bad input'));
+    generatorData = [
+      { identifier: { path: 'http://test.com/foo/' }, representation: '/container/' as any },
+    ];
+    await expect(initializer.handle()).resolves.toBeUndefined();
+    expect(generator.generate).toHaveBeenCalledTimes(1);
+    expect(store.setRepresentation).toHaveBeenCalledTimes(1);
+  });


This test still succeeds even though the specific code for this was removed 😄. This test should have checked if the logger emitted a warning, but since that piece of code is gone again it can just be removed.

joachimvh

🥳

woutslabbinck added 7 commits January 26, 2022 16:32

feat: only allow metadata to be edited with PATCH request & only allo…

30901c2

…w metadata files to be edited when a resource is available

fix: remove unnecesary log at POST

d45553f

feat: PUT resets metadata contents + not possible to add metadata wit…

fc1148e

…h PUT to container

feat: add metadataStrategy (auxiliaryStrategy) + use that strategy in…

2890f33

… operationhandlers

feat: PUT request on existing LDPC is not allowed as it would be poss…

79c8ec6

…ible to edit (read reset) metadata

test: add unit tests to operationhandlers to handle metadata editing

8b29123

test: add unit tests to representationPatchHandler to handle metadata…

3d9af24

… editing

woutslabbinck added the semver.major Requires a major version bump label Mar 2, 2022

woutslabbinck requested a review from joachimvh March 2, 2022 11:40

woutslabbinck added 2 commits March 2, 2022 14:37

Merge branch 'versions/4.0.0' into feat/metadata-editing

6c5e5f3

fix: update dependency of meta.json to version 3.0.0

a8063e9

woutslabbinck force-pushed the feat/metadata-editing branch from d7cf765 to a8063e9 Compare March 2, 2022 13:45

fix: lint and dependency still v2

345b2e0

joachimvh requested changes Mar 3, 2022

View reviewed changes

bourgeoa mentioned this pull request Mar 7, 2022

Container .meta shall forbid container reserved triples nodeSolidServer/node-solid-server#1679

Open

woutslabbinck added 14 commits March 10, 2022 11:50

fix: replaced file references to resource references + moved Patch ch…

e03415f

…eck to new patchhandler which is more generic

fix: moved checking metadata resources checking from DELETE and POST …

2f89df1

…handler down to DABS

fix: remove PATCH message about metadata extension

3404fff

fix: move PATCH message about metadata extension

e71841f

WIP: adding writeMetadata + getMetadata in DABS and add writeMetadata…

3a4ffe8

… to DataAccessors (part 1)

WIP: implement writeMetadata in memorybackend + change resourceExists

f1dd71d

WIP: implement writeMetadata in SparqlDataAccessor.ts

3477135

test: fix test interfaces

9f51a56

test: InMemoryDataAccessor.ts resulted into changing identifier for w…

8f002d4

…riteMetadata in DataAccessor.ts (now taking subject identifier instead of metadata resource identifier)

test: accessor tests implemented for metadata

e4d3aa6

test: add RdfImmutableCheckPatcher.test.ts

dd3dd83

test: add tests in DataAccessorBasedStore.test.ts

a3ea48c

test: fix template config for DynamicPods test

f0d29a2

test: add integration tests for metadata

178f6bc

woutslabbinck requested a review from joachimvh March 16, 2022 10:39

woutslabbinck added 13 commits July 25, 2022 13:16

feat: remove metadataGenerator from acl.json and fix tests accordingly

5857e02

WIP: preserve metadata on PUT

42d4079

feat: preserve metadata on PUT

e2b86ff

fix: keep metadata on PATCHes

2b77751

test: add unit tests for preserving metadata on PUT

8e1b87e

fix: remove inConverter from sparql endpoint as that is already the d…

cdddb3c

…efault in the (converting.json)

fix: add metadatastrategy to RepresentationConvertingStore in regex.json

f34c168

test: add integration tests for preserving metadata on PUT

62e6ac7

Merge branch 'versions/5.0.0' into feat/metadata-editing

01a5e0c

# Conflicts: # RELEASE_NOTES.md

docs: update release notes and adding documentation about preserving …

bb30fe7

…metadata on PUT

WIP: Template create setRepresentation

7f525f0

fix: Move container exists and not allowed check to setRepresentation

5daf687

test: fix lint

8677504

woutslabbinck requested a review from joachimvh August 1, 2022 13:03

joachimvh requested changes Aug 2, 2022

View reviewed changes

woutslabbinck added 8 commits August 2, 2022 15:17

fix: update configs and documentation

4d4925b

refactor: update and add documentation + small refactoring

5372246

refactor: update and add documentation + small refactoring + fix tests

88db588

fix: Dynamic pod config + tests

49a3996

fix: TemplatedResourcesGenerator does not create containers when they…

ced58c4

… already exist

fix: metadata preservation now deals with complex content types

fff8d07

docs: explain the case when there is no content-type

9207da2

Merge branch 'versions/5.0.0' into feat/metadata-editing

f106b22

woutslabbinck requested a review from joachimvh August 3, 2022 14:20

joachimvh requested changes Aug 4, 2022

View reviewed changes

fix: minor comments

f4c8490

joachimvh approved these changes Aug 4, 2022

View reviewed changes

joachimvh merged commit ca62511 into CommunitySolidServer:versions/5.0.0 Aug 4, 2022

joachimvh mentioned this pull request Aug 8, 2022

Design of resource metadata editing #1027

Closed

joachimvh mentioned this pull request Dec 16, 2022

feat: Take preferences as input in RepresentationConvertingStore #1469

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Edit metadata resources #1188

Feat: Edit metadata resources #1188

woutslabbinck commented Mar 2, 2022 •

edited

Loading

joachimvh left a comment

joachimvh left a comment

joachimvh left a comment

joachimvh Aug 4, 2022

joachimvh Aug 4, 2022

joachimvh Aug 4, 2022

joachimvh left a comment

Feat: Edit metadata resources #1188

Feat: Edit metadata resources #1188

Conversation

woutslabbinck commented Mar 2, 2022 • edited Loading

📁 Related issues

✍️ Description

✅ PR check list

joachimvh left a comment

Choose a reason for hiding this comment

joachimvh left a comment

Choose a reason for hiding this comment

joachimvh left a comment

Choose a reason for hiding this comment

joachimvh Aug 4, 2022

Choose a reason for hiding this comment

joachimvh Aug 4, 2022

Choose a reason for hiding this comment

joachimvh Aug 4, 2022

Choose a reason for hiding this comment

joachimvh left a comment

Choose a reason for hiding this comment

woutslabbinck commented Mar 2, 2022 •

edited

Loading