Solr-based suggestion / autocomplete by kshepherd · Pull Request #4439 · DSpace/dspace-angular

kshepherd · 2025-06-05T16:34:12Z

Adds Solr-based suggestion to dynamic onebox vocabulary lookups.

UI
In the dynamic-onebox Angular component which traditionally handles vocabulary / authority display like tree lookup or autocomplete, if the vocabulary type is "suggest", it will use a different search method and display template for the suggest terms. If not, the current behaviour is used (lookup / suggest from XML / etc)

Like the backend, the actual suggest term JSON is not fully modelled in Angular, it is just treated as JSON. This is done to keep things light (they are not proper DSpace addressable objects or anything, not used anywhere but as input providers) and due to the structure of the JSON where terms are used as key names, etc.

Developed by The Library Code with the support of Universität Bremen and GESIS.

Checklist

github-actions · 2025-07-08T20:27:22Z

Hi @kshepherd,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

strawburster · 2026-01-29T10:58:57Z

I'm trying to limit the number of new properties on the onebox component, which is already quite a monstrous little thing. I combined the suggestion api and the vocabulary service into a single observable, and I want to combine the suggestrt/suggestrte templates with the existing rt and rte templates. Other than that, this is working as expected. I may adjust the spinner stylistically.

strawburster · 2026-02-04T12:11:34Z

This is working the way I want it to. I made large changes to the onebox component, and I plan on adding more tests for it, as well as tests for the new search service method for getting suggestions. The existing tests should all pass (famous last words)

tdonohue · 2026-02-13T20:41:18Z

@strawburster : Just to clarify, is this now ready for review? If so, we should move this PR out of "Draft" status . If you cannot do so, I can do that on your behalf.

strawburster · 2026-02-14T20:41:01Z

@tdonohue I'm not sure. I feel that this is done on the frontend, but the PR depends on DSpace/DSpace#10855 which is not ready yet. Also, I want to add tests but I suppose that can be part of the review. If you feel that it's appropriate you can change it for me, I do not have access because it is Kim's work.

tdonohue · 2026-02-16T15:22:31Z

@strawburster : If this depends on another PR which is not yet ready, then it sounds like a test & review may not be easy to achieve. Once the other PR is ready, I can remove the "draft" status from both PRs at the same time. Just let me know when to remove the draft status.

kshepherd · 2026-02-16T22:06:55Z

I've added the checklist template back into the issue description here to help us show review / merge readiness

strawburster · 2026-02-19T14:44:06Z

I'm sorry I can't edit the checklist, but linting, circular dependencies, typedocs, i18n, and the last two, could be checked by now. The service implementation for suggestions is tested as far as I think I need to because of its simplicity, but I am still adding more tests to the onebox component for when the vocabulary is of type 'suggest'.

I expect one of the unit tests to fail, because there needs to be a hypermedia link between the discover and suggest endpoints before I can use the HAL service to look it up. This is a reminder to myself to do that once it becomes available in the backend.

strawburster · 2026-02-19T22:42:32Z

I've added onebox component tests for the case where the vocabulary type is 'suggest'. Please check the box for tests as well now, pending further review.

milanmajchrak · 2026-03-11T14:58:14Z

src/app/shared/form/builder/ds-dynamic-form-ui/models/onebox/dynamic-onebox.component.ts

      }
    }
+
+    if (this.model.vocabularyOptions.type === 'suggest') {


Maybe you can use here if (this.isSolrSuggest) {?

milanmajchrak · 2026-03-11T15:02:22Z

src/app/shared/form/builder/ds-dynamic-form-ui/models/onebox/dynamic-onebox.component.ts

    this.dispatchUpdate(event.item);
  }

+  onSelectSuggestedTerm(event: NgbTypeaheadSelectItemEvent) {


Is this used? The onSelectItem is used in the https://github.com/DSpace/dspace-angular/pull/4439/changes#diff-377e31db1a603b93958cf2e2d7ba4b7366281905e4b17da965ca9913294b0dbfR87

milanmajchrak · 2026-03-11T15:04:55Z

src/app/shared/form/form.reducer.ts

      fieldIndex: action.payload.fieldIndex,
      message: action.payload.errorMessage,
    };
+    console.dir(error);


Is it necessary to keep this? It will log every form validation error object to the browser console.

milanmajchrak · 2026-03-11T15:40:52Z

src/app/shared/form/builder/ds-dynamic-form-ui/models/onebox/dynamic-onebox.component.ts

    AsyncPipe,
    AuthorityConfidenceStateDirective,
    FormsModule,
+    FormsModule,


Duplicity import? FormsModule and NgbTypeaheadModule

milanmajchrak · 2026-03-11T15:43:22Z

...rm/builder/ds-dynamic-form-ui/models/relation-group/dynamic-relation-group.component.spec.ts

        provideMockStore({ initialState }),
        provideMockActions(() => new Observable<any>()),
        { provide: VocabularyService, useValue: vocabularyServiceStub },
+        { provide: SearchService, useValue: SearchServiceStub },


useValue: searchServiceStub not SearchServiceStub

strawburster · 2026-03-13T14:24:49Z

Thanks for the review @milanmajchrak ! They are all good suggestions. I'm curious if you have had a chance to test this yourself?

milanmajchrak · 2026-03-13T15:40:37Z

Thanks for the review @milanmajchrak ! They are all good suggestions. I'm curious if you have had a chance to test this yourself?

I was only involved in the testing to some extent, while my colleague did most of it. She was able to run it successfully, and then we went through it together. She also verified that the functionality works in a comparable way to our CLARIN-DSpace customization, and we were satisfied with the results.

github-actions · 2026-03-13T17:36:11Z

Hi @kshepherd,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

milanmajchrak · 2026-03-16T11:39:39Z

src/assets/i18n/cs.json5

  "form.other-information.orcid": "ORCID",

+  // "form.other-information.weight": "Weight",
+  "form.other-information.weight": "Hmotnost",


We discussed this translation with UFAL and concluded that it is not correct in Czech. The correct wording is Váha. Could you please fix it in this PR?

github-actions bot assigned kshepherd Jun 5, 2025

kshepherd marked this pull request as draft June 5, 2025 16:50

kshepherd mentioned this pull request Jun 18, 2025

Add solr based autocomplete option to submission form input DSpace/DSpace#10237

Closed

10 tasks

kshepherd mentioned this pull request Jun 25, 2025

Solr-based suggestion / autocomplete DSpace/DSpace#10855

Open

10 tasks

github-actions bot added the merge conflict label Jul 8, 2025

strawburster force-pushed the feature/TLC-790_solr_suggest_main branch from 5b7602f to 6c6f045 Compare January 28, 2026 15:19

github-actions bot removed the merge conflict label Jan 28, 2026

tdonohue added component: submission new feature labels Jan 30, 2026

tdonohue added this to DSpace 10.0 Release Jan 30, 2026

tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Jan 30, 2026

strawburster force-pushed the feature/TLC-790_solr_suggest_main branch 3 times, most recently from bca4d58 to 48550ca Compare February 4, 2026 12:04

strawburster force-pushed the feature/TLC-790_solr_suggest_main branch 2 times, most recently from d8f1178 to 4a9cbfe Compare February 19, 2026 14:37

pnbecker marked this pull request as ready for review February 19, 2026 14:52

tdonohue requested review from atarix83 and vins01-4science February 19, 2026 15:58

tdonohue moved this from 🙋 Needs Reviewers Assigned to 👀 Under Review in DSpace 10.0 Release Feb 19, 2026

kshepherd assigned strawburster Feb 20, 2026

strawburster force-pushed the feature/TLC-790_solr_suggest_main branch from 935b754 to 9e5a9dd Compare February 20, 2026 11:09

milanmajchrak suggested changes Mar 11, 2026

View reviewed changes

strawburster force-pushed the feature/TLC-790_solr_suggest_main branch from 9e5a9dd to 0015a82 Compare March 13, 2026 14:20

strawburster added 3 commits March 13, 2026 15:26

[TLC-790] Solr-based suggestion in onebox

59cc7d8

Search service suggestion tests

6396b93

Added onebox component tests

9dacac0

strawburster force-pushed the feature/TLC-790_solr_suggest_main branch from 0015a82 to 9dacac0 Compare March 13, 2026 14:26

github-actions bot added the merge conflict label Mar 13, 2026

milanmajchrak suggested changes Mar 16, 2026

View reviewed changes

Conversation

kshepherd commented Jun 5, 2025 • edited by pnbecker Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

github-actions bot commented Jul 8, 2025

Uh oh!

strawburster commented Jan 29, 2026

Uh oh!

strawburster commented Feb 4, 2026

Uh oh!

tdonohue commented Feb 13, 2026

Uh oh!

strawburster commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tdonohue commented Feb 16, 2026

Uh oh!

kshepherd commented Feb 16, 2026

Uh oh!

strawburster commented Feb 19, 2026

Uh oh!

strawburster commented Feb 19, 2026

Uh oh!

milanmajchrak Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

milanmajchrak Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

milanmajchrak Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

milanmajchrak Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

milanmajchrak Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

strawburster commented Mar 13, 2026

Uh oh!

milanmajchrak commented Mar 13, 2026

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

milanmajchrak Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kshepherd commented Jun 5, 2025 •

edited by pnbecker

Loading

strawburster commented Feb 14, 2026 •

edited

Loading