inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

AAE-24018 Readonly dropdown with the rest config don't fetch options when form rule change it to not readonly (#9959)

Browse Source 
* AAE-24018 Update dropdown-cloud.widget

* AAE-24018 Upadate dropdown.widget

* AAE-24018 Small update
This commit is contained in:
Wiktor Danielewski 2024-07-31 09:38:17 +02:00 committed by GitHub
parent 9cb01e2085
commit 72ea94e928
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 117 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/process-services-cloud/src/lib/form/components/widgets/dropdown/dropdown-cloud.widget.html
View File

@ -30,7 +30,7 @@
<mat-option id="readonlyOption" *ngIf="isReadOnlyType()" [value]="field.value">{{field.value}}</mat-option>
</mat-select>
</mat-form-field>
<div *ngIf="!previewState">
<div *ngIf="!previewState && !isReadOnlyField">
<error-widget [error]="field.validationSummary"></error-widget>
<error-widget class="adf-dropdown-required-message" *ngIf="showRequiredMessage()"
required="{{ 'FORM.FIELD.REQUIRED' | translate }}"></error-widget>

77
lib/process-services-cloud/src/lib/form/components/widgets/dropdown/dropdown-cloud.widget.spec.ts
View File

@ -37,6 +37,7 @@ import { HarnessLoader } from '@angular/cdk/testing';
import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';
import { MatSelectHarness } from '@angular/material/select/testing';
import { MatFormFieldHarness } from '@angular/material/form-field/testing';
import { DebugElement } from '@angular/core';
describe('DropdownCloudWidgetComponent', () => {
let formService: FormService;
@ -118,35 +119,79 @@ describe('DropdownCloudWidgetComponent', () => {
expect(await allOptions[2].getText()).toEqual('option_3');
});
it('should NOT load data from restUrl when field is readonly', () => {
it('should NOT load data from restUrl when form is readonly', () => {
spyOn(formCloudService, 'getRestWidgetData');
widget.field.readOnly = true;
widget.field.readOnly = false;
widget.field.restUrl = 'https://fake-rest-url';
widget.field.optionType = 'rest';
widget.field.restIdProperty = 'name';
widget.field.form.readOnly = true;
widget.ngOnInit();
expect(formCloudService.getRestWidgetData).not.toHaveBeenCalled();
});
it('should show error message if the restUrl failed to fetch options', async () => {
const jsonDataSpy = spyOn(formCloudService, 'getRestWidgetData').and.returnValue(throwError('Failed to fetch options'));
describe('should load data from restUrl when form is NOT readonly', () => {
beforeEach(() => {
spyOn(formCloudService, 'getRestWidgetData').and.returnValue(of([]));
widget.field.restUrl = 'https://fake-rest-url';
widget.field.optionType = 'rest';
widget.field.restIdProperty = 'name';
widget.field.form.readOnly = false;
});
it('when widget is NOT readonly', () => {
widget.field.readOnly = false;
widget.ngOnInit();
expect(formCloudService.getRestWidgetData).toHaveBeenCalled();
});
it('when widget is readonly', () => {
widget.field.readOnly = true;
widget.ngOnInit();
expect(formCloudService.getRestWidgetData).toHaveBeenCalled();
});
});
describe('when failed on loading options from restUrl', () => {
let getRestWidgetDataSpy: jasmine.Spy;
const getErrorMessageElement = (): DebugElement => fixture.debugElement.query(By.css('.adf-dropdown-failed-message'));
const errorIcon: string = 'error_outline';
widget.field.restUrl = 'https://fake-rest-url';
widget.field.optionType = 'rest';
widget.field.restIdProperty = 'name';
widget.ngOnInit();
beforeEach(() => {
getRestWidgetDataSpy = spyOn(formCloudService, 'getRestWidgetData').and.returnValue(throwError('Failed to fetch options'));
widget.field.restUrl = 'https://fake-rest-url';
widget.field.optionType = 'rest';
});
const dropdown = await loader.getHarness(MatSelectHarness.with({ selector: '.adf-select' }));
await dropdown.open();
it('should show error message when widget is NOT readonly', () => {
widget.field.readOnly = false;
const failedErrorMsgElement = fixture.debugElement.query(By.css('.adf-dropdown-failed-message'));
expect(jsonDataSpy).toHaveBeenCalled();
expect(widget.isRestApiFailed).toBe(true);
expect(widget.field.options.length).toEqual(0);
expect(failedErrorMsgElement.nativeElement.textContent.trim()).toBe(errorIcon + 'FORM.FIELD.REST_API_FAILED');
widget.ngOnInit();
fixture.detectChanges();
const errorMessageElement = getErrorMessageElement();
expect(getRestWidgetDataSpy).toHaveBeenCalled();
expect(widget.isRestApiFailed).toBe(true);
expect(widget.field.options.length).toEqual(0);
expect(errorMessageElement.nativeElement.textContent.trim()).toBe(errorIcon + 'FORM.FIELD.REST_API_FAILED');
});
it('should NOT show error message when widget is readonly', async () => {
widget.field.readOnly = true;
widget.ngOnInit();
fixture.detectChanges();
const errorMessageElement = getErrorMessageElement();
expect(getRestWidgetDataSpy).toHaveBeenCalled();
expect(widget.isRestApiFailed).toBe(true);
expect(widget.field.options.length).toEqual(0);
expect(errorMessageElement).toBe(null);
});
});
it('should preselect dropdown widget value when Json (rest call) passed', async () => {

10
lib/process-services-cloud/src/lib/form/components/widgets/dropdown/dropdown-cloud.widget.ts
View File

@ -84,7 +84,7 @@ export class DropdownCloudWidgetComponent extends WidgetComponent implements OnI
private checkFieldOptionsSource(): void {
switch (true) {
case this.isReadOnly():
case this.isReadOnlyForm():
break;
case this.hasRestUrl() && !this.isLinkedWidget():
this.persistFieldOptionsFromRestApi();
@ -392,7 +392,11 @@ export class DropdownCloudWidgetComponent extends WidgetComponent implements OnI
}
}
private isReadOnly(): boolean {
private isReadOnlyForm(): boolean {
return !!this.field?.form?.readOnly;
}
get isReadOnlyField(): boolean {
return this.field.readOnly;
}
@ -410,7 +414,7 @@ export class DropdownCloudWidgetComponent extends WidgetComponent implements OnI
}
updateOptions(): void {
if (this.isReadOnly()) {
if (this.isReadOnlyForm()) {
this.list$ = of(this.field.options);
}

6
lib/process-services/src/lib/form/widgets/dropdown/dropdown.widget.html
View File

@ -15,7 +15,9 @@
<mat-option id="readonlyOption" *ngIf="isReadOnlyType()" [value]="field.value">{{field.value}}</mat-option>
</mat-select>
</mat-form-field>
<error-widget [error]="field.validationSummary"></error-widget>
<error-widget class="adf-dropdown-required-message" *ngIf="showRequiredMessage()"
<ng-container *ngIf="!isReadOnlyField">
<error-widget [error]="field.validationSummary"></error-widget>
<error-widget class="adf-dropdown-required-message" *ngIf="showRequiredMessage()"
required="{{ 'FORM.FIELD.REQUIRED' | translate }}"></error-widget>
</ng-container>
</div>

49
lib/process-services/src/lib/form/widgets/dropdown/dropdown.widget.spec.ts
View File

@ -17,7 +17,15 @@
import { ComponentFixture, TestBed } from '@angular/core/testing';
import { Observable, of } from 'rxjs';
import { WidgetVisibilityService, FormFieldOption, FormFieldModel, FormModel, FormFieldTypes, CoreTestingModule } from '@alfresco/adf-core';
import {
WidgetVisibilityService,
FormFieldOption,
FormFieldModel,
FormModel,
FormFieldTypes,
CoreTestingModule,
ErrorMessageModel
} from '@alfresco/adf-core';
import { DropdownWidgetComponent } from './dropdown.widget';
import { TaskFormService } from '../../services/task-form.service';
import { ProcessDefinitionService } from '../../services/process-definition.service';
@ -66,27 +74,40 @@ describe('DropdownWidgetComponent', () => {
expect(taskFormService.getRestFieldValues).not.toHaveBeenCalled();
});
it('should request field values from service', () => {
describe('requesting field options', () => {
let getRestFieldValuesSpy: jasmine.Spy;
const taskId = '<form-id>';
const fieldId = '<field-id>';
const form = new FormModel({
taskId
beforeEach(() => {
getRestFieldValuesSpy = spyOn(taskFormService, 'getRestFieldValues').and.returnValue(of([]));
widget.field = new FormFieldModel(new FormModel({ taskId }), { id: fieldId, restUrl: '<url>' });
});
widget.field = new FormFieldModel(form, {
id: fieldId,
restUrl: '<url>'
it('should request options from service when form is NOT readonly', () => {
widget.field.form.readOnly = false;
widget.ngOnInit();
expect(getRestFieldValuesSpy).toHaveBeenCalledWith(taskId, fieldId);
});
spyOn(taskFormService, 'getRestFieldValues').and.returnValue(
new Observable((observer) => {
observer.next(null);
observer.complete();
})
);
it('should NOT request options from service when form is readonly', () => {
widget.field.form.readOnly = true;
widget.ngOnInit();
expect(getRestFieldValuesSpy).not.toHaveBeenCalled();
});
});
it('should NOT display any error when widget is readonly', () => {
widget.field = new FormFieldModel(new FormModel({}, undefined, false), { readOnly: true });
widget.field.validationSummary = { message: 'Some error occurred' } as ErrorMessageModel;
widget.ngOnInit();
expect(taskFormService.getRestFieldValues).toHaveBeenCalledWith(taskId, fieldId);
fixture.detectChanges();
expect(element.querySelector('.adf-dropdown-required-message')).toBeNull();
});
it('should preserve empty option when loading fields', () => {

10
lib/process-services/src/lib/form/widgets/dropdown/dropdown.widget.ts
View File

@ -52,7 +52,7 @@ export class DropdownWidgetComponent extends WidgetComponent implements OnInit {
}
ngOnInit() {
if (this.field?.restUrl) {
if (this.field?.restUrl && !this.isReadOnlyForm()) {
if (this.field.form.taskId) {
this.getValuesByTaskId();
} else {
@ -102,4 +102,12 @@ export class DropdownWidgetComponent extends WidgetComponent implements OnInit {
showRequiredMessage(): boolean {
return (this.isInvalidFieldRequired() || this.field.value === 'empty') && this.isTouched();
}
get isReadOnlyField(): boolean {
return this.field.readOnly;
}
private isReadOnlyForm(): boolean {
return !!this.field?.form?.readOnly;
}
}