Merge pull request #741 from futa-ikeda/refactor/configurable-api-root

[ENG-9649] Use configurable api root

Author: futa-ikeda

src/app/shared/components/addons/addon-setup-account-form/addon-setup-account-form.component.html

@@ -1,5 +1,15 @@
 <form [formGroup]="addonForm()" (ngSubmit)="handleSubmit()" class="flex flex-column gap-5">
   <p-card>
+    @if (hasConfigurableApiRoot()) {
+      <h2 class="mb-2">
+        {{ 'settings.addons.form.fields.hostUrl' | translate }}
+      </h2>
+      <p class="mb-2">
+        {{ 'settings.addons.form.fields.hostUrlDescription' | translate }}
+      </p>
+      <input class="mb-4" pInputText [formControlName]="formControls.HostUrl" />
+    }
+
     @if (isAccessSecretKeysFormat()) {
       <h2 class="mb-2">
         {{ 'settings.addons.form.fields.accessKey' | translate }}
@@ -23,13 +33,6 @@ <h2 class="mb-2">
     }
 
     @if (isDataverseApiTokenFormat()) {
-      <h2 class="mb-2">
-        {{ 'settings.addons.form.fields.hostUrl' | translate }}
-      </h2>
-      <p class="mb-2">
-        {{ 'settings.addons.form.fields.hostUrlDescription' | translate }}
-      </p>
-      <input class="mb-4" pInputText [formControlName]="formControls.HostUrl" />
       <h2 class="mb-2">
         {{ 'settings.addons.form.fields.apiToken' | translate }}
       </h2>
@@ -43,13 +46,6 @@ <h2 class="mb-2">
     }
 
     @if (isUsernamePasswordFormat()) {
-      <h2 class="mb-2">
-        {{ 'settings.addons.form.fields.hostUrl' | translate }}
-      </h2>
-      <p class="mb-2">
-        {{ 'settings.addons.form.fields.hostUrlDescription' | translate }}
-      </p>
-      <input class="mb-4" pInputText [formControlName]="formControls.HostUrl" />
       <h2 class="mb-2">
         {{ 'settings.addons.form.fields.username' | translate }}
       </h2>
@@ -71,13 +67,6 @@ <h2 class="mb-2">
     }
 
     @if (isRepoTokenFormat()) {
-      <h2 class="mb-2">
-        {{ 'settings.addons.form.fields.hostUrl' | translate }}
-      </h2>
-      <p class="mb-2">
-        {{ 'settings.addons.form.fields.hostUrlDescription' | translate }}
-      </p>
-      <input class="mb-4" pInputText [formControlName]="formControls.HostUrl" />
       <h2 class="mb-2">
         {{ 'settings.addons.form.fields.personalAccessToken' | translate }}
       </h2>

src/app/shared/components/addons/addon-setup-account-form/addon-setup-account-form.component.ts

@@ -66,6 +66,8 @@ export class AddonSetupAccountFormComponent {
     return format === CredentialsFormat.OAUTH2 || format === CredentialsFormat.OAUTH;
   });
 
+  readonly hasConfigurableApiRoot = computed(() => !!this.addon().configurableApiRoot);
+
   handleSubmit(): void {
     if (!this.isFormValid) return;
 

src/app/shared/mappers/addon.mapper.ts

@@ -29,6 +29,7 @@ export class AddonMapper {
       credentialsFormat: response.attributes.credentials_format,
       providerName: response.attributes.display_name,
       iconUrl: response.attributes.icon_url,
+      configurableApiRoot: response.attributes.configurable_api_root,
     };
   }
 

src/app/shared/models/addons/addon-json-api.models.ts

@@ -10,6 +10,7 @@ export interface AddonGetResponseJsonApi {
     credentials_format: string;
     wb_key: string;
     icon_url: string;
+    configurable_api_root: boolean;
     [key: string]: unknown;
   };
   relationships: {

src/app/shared/models/addons/addon.model.ts

@@ -7,6 +7,7 @@ export interface AddonModel {
   supportedFeatures?: string[];
   providerName?: string;
   credentialsFormat?: string;
+  configurableApiRoot?: boolean;
   authUrl?: string | null;
   authorizedCapabilities?: string[];
   authorizedOperationNames?: string[];

src/app/shared/services/addons/addon-form.service.ts

@@ -28,23 +28,23 @@ export class AddonFormService {
     const formControls: Partial<AddonForm> = {
       [AddonFormControls.AccountName]: this.formBuilder.control<string>(addon.displayName || '', Validators.required),
     };
+    if (addon.configurableApiRoot) {
+      formControls[AddonFormControls.HostUrl] = this.formBuilder.control<string>('', Validators.required);
+    }
 
     switch (addon.credentialsFormat) {
       case CredentialsFormat.ACCESS_SECRET_KEYS:
         formControls[AddonFormControls.AccessKey] = this.formBuilder.control<string>('', Validators.required);
         formControls[AddonFormControls.SecretKey] = this.formBuilder.control<string>('', Validators.required);
         break;
       case CredentialsFormat.DATAVERSE_API_TOKEN:
-        formControls[AddonFormControls.HostUrl] = this.formBuilder.control<string>('', Validators.required);
         formControls[AddonFormControls.ApiToken] = this.formBuilder.control<string>('', Validators.required);
         break;
       case CredentialsFormat.USERNAME_PASSWORD:
-        formControls[AddonFormControls.HostUrl] = this.formBuilder.control<string>('', Validators.required);
         formControls[AddonFormControls.Username] = this.formBuilder.control<string>('', Validators.required);
         formControls[AddonFormControls.Password] = this.formBuilder.control<string>('', Validators.required);
         break;
       case CredentialsFormat.REPO_TOKEN:
-        formControls[AddonFormControls.HostUrl] = this.formBuilder.control<string>('', Validators.required);
         formControls[AddonFormControls.PersonalAccessToken] = this.formBuilder.control<string>('', Validators.required);
         break;
     }

src/app/shared/services/addons/addons.service.spec.ts

@@ -42,6 +42,7 @@ describe('Service: Addons', () => {
         supportedFeatures: ['DOWNLOAD_AS_ZIP', 'FORKING', 'LOGS', 'PERMISSIONS', 'REGISTERING'],
         type: 'external-storage-services',
         wbKey: 'figshare',
+        configurableApiRoot: false,
       })
     );
 

src/app/shared/stores/addons/addons.state.spec.ts

@@ -59,6 +59,7 @@ describe('State: Addons', () => {
             supportedFeatures: ['DOWNLOAD_AS_ZIP', 'FORKING', 'LOGS', 'PERMISSIONS', 'REGISTERING'],
             type: 'external-storage-services',
             wbKey: 'figshare',
+            configurableApiRoot: false,
           })
         );
 
@@ -76,6 +77,7 @@ describe('State: Addons', () => {
             supportedFeatures: ['DOWNLOAD_AS_ZIP', 'FORKING', 'LOGS', 'PERMISSIONS', 'REGISTERING'],
             type: 'external-storage-services',
             wbKey: 'figshare',
+            configurableApiRoot: false,
           })
         );
         expect(loading()).toBeFalsy();

src/testing/mocks/addon.mock.ts

@@ -12,4 +12,5 @@ export const MOCK_ADDON: AddonModel = {
   providerName: 'Test Provider',
   wbKey: 'github',
   iconUrl: 'https://test.com/icon.png',
+  configurableApiRoot: false,
 };