feat: add baseURL option for dynamic http question (#1541)

Author: zacharyjhankin

apps/backend/db_patches/0209_addBaseulrtodynamiccs.sql

@@ -0,0 +1,16 @@
+DO
+$$
+BEGIN
+    IF register_patch('addBaseulrtodynamiccs.sql', 'Zachary Hankin', 'Adds an option to the dynamic HTTP question type allowing use of base domain', '2026-5-21') THEN
+        UPDATE questions
+        SET default_config = jsonb_set(
+            default_config::jsonb,
+            '{useBaseDomain}',
+            'false'::jsonb,
+            true
+        )
+        WHERE data_type = 'DYNAMIC_MULTIPLE_CHOICE';
+    END IF;
+END;
+$$
+LANGUAGE plpgsql;

apps/backend/db_patches/db_seeds/0005_ProposalQuestions.sql

@@ -376,7 +376,7 @@ VALUES
   (
     'dynamic_multiple_choice_question', 
     'DYNAMIC_MULTIPLE_CHOICE', 'Dynamic multiple choice question from seeds', 
-    '{"variant":"dropdown", "url":"", "jsonPath":"","isMultipleSelect":true, "apiCallRequestHeaders":[], "readPermissions":[]}', 
+    '{"variant":"dropdown", "url":"", "jsonPath":"","isMultipleSelect":true, "apiCallRequestHeaders":[], "readPermissions":[], "useBaseDomain":false}', 
     '2023-02-08 10:23:10.285415+00', 
     '2023-02-08 10:23:10.285415+00', 
     'dynamic_multiple_choice_question', 
@@ -389,7 +389,7 @@ INSERT INTO templates_has_questions(
 VALUES 
   (
     'dynamic_multiple_choice_question', 
-    proposal_template_id_var, proposal_topic_id_var, 10, '{"variant":"dropdown", "url":"", "jsonPath":"","isMultipleSelect":true, "apiCallRequestHeaders":[],"readPermissions":[]}'
+    proposal_template_id_var, proposal_topic_id_var, 10, '{"useBaseDomain":false, "variant":"dropdown", "url":"", "jsonPath":"","isMultipleSelect":true, "apiCallRequestHeaders":[],"readPermissions":[]}'
   );
 INSERT INTO answers(
   questionary_id, question_id, answer

apps/backend/example.development.env

@@ -44,7 +44,7 @@ NODE_ENV=development
 # DEPENDENCY_CONFIG=<e2e|ess|stfc|test>
 PING_PUBLIC_CRT=dummypingsecret
 DATABASE_URL=postgres://duouser:duopassword@127.0.0.1:5432/duo
-BASE_URL=localhost:3000
+BASE_URL=http://localhost:3000
 JWT_TOKEN_LIFE=7d
 JWT_SECRET=qMyLZALzs229ybdQXNyzYRdju7X784TH
 # SPARKPOST_TOKEN=insertokenhere

apps/backend/src/datasources/mockups/TemplateDataSource.ts

@@ -126,6 +126,20 @@ const dummyTemplateStepsFactory = () => {
       config: {
         url: '',
         jsonPath: '',
+        useBaseDomain: false,
+      } as DynamicMultipleChoiceConfig,
+    }),
+  });
+
+  const dmcQuestionWithBaseDomain = dummyQuestionTemplateRelationFactory({
+    question: dummyQuestionFactory({
+      id: 'dmcQuestionWithBaseDomain',
+      naturalKey: 'dmcQuestionWithBaseDomain',
+      dataType: DataType.DYNAMIC_MULTIPLE_CHOICE,
+      config: {
+        url: 'getListOfCountries',
+        useBaseDomain: true,
+        jsonPath: '',
       } as DynamicMultipleChoiceConfig,
     }),
   });
@@ -138,6 +152,7 @@ const dummyTemplateStepsFactory = () => {
       config: {
         url: 'api-url',
         jsonPath: '',
+        useBaseDomain: false,
         apiCallRequestHeaders: [
           {
             name: 'header1',
@@ -160,6 +175,7 @@ const dummyTemplateStepsFactory = () => {
       config: {
         url: 'api-url',
         jsonPath: '$..option',
+        useBaseDomain: false,
       } as DynamicMultipleChoiceConfig,
     }),
   });
@@ -175,6 +191,7 @@ const dummyTemplateStepsFactory = () => {
       dmcQuestionEmptyUrl,
       dmcQuestionEmptyJsonPath,
       dmcQuestionWithUrlAndJsonPath,
+      dmcQuestionWithBaseDomain,
     ]),
   ];
 };

apps/backend/src/models/questionTypes/DynamicMultipleChoice.ts

@@ -29,6 +29,7 @@ export const dynamicMultipleChoiceDefinition: Question<DataType.DYNAMIC_MULTIPLE
       config.variant = 'radio';
       config.url = '';
       config.jsonPath = '';
+      config.useBaseDomain = false;
       config.isMultipleSelect = false;
       config.apiCallRequestHeaders = [];
       config.readPermissions = [];

apps/backend/src/queries/TemplateQueries.spec.ts

@@ -153,6 +153,34 @@ describe('getDynamicMultipleChoiceOptions', () => {
     expect(options).toEqual(['option1', 'option2']);
   });
 
+  it('Should return options if selected useBaseDomain', async () => {
+    process.env = {
+      ...process.env,
+      BASE_URL: 'http://mocked.example.com',
+    };
+
+    jest
+      .spyOn(global, 'fetch')
+      .mockImplementation((input: RequestInfo | URL) => {
+        const url = typeof input === 'string' ? input : input.toString();
+
+        if (url === 'http://mocked.example.com/getListOfCountries') {
+          return Promise.resolve({
+            json: () => Promise.resolve(['option1', 'option2']),
+            ok: true,
+          } as Response);
+        } else {
+          return Promise.reject(new Error('Unknown URL'));
+        }
+      });
+
+    const options = await templateQueries.getDynamicMultipleChoiceOptions(
+      dummyUserWithRole,
+      'dmcQuestionWithBaseDomain'
+    );
+
+    expect(options).toEqual(['option1', 'option2']);
+  });
   it('should use the question template relation if a template ID is supplied', async () => {
     const templateDataSource = container.resolve<TemplateDataSourceMock>(
       Tokens.TemplateDataSource

apps/backend/src/queries/TemplateQueries.ts

@@ -104,10 +104,11 @@ export default class TemplateQueries {
     if (!question) return [];
 
     const config = question.config as DynamicMultipleChoiceConfig;
-    if (config.url === '') return [];
+    const dynamicURL = constructDynamicURL(config.url, config.useBaseDomain);
+    if (dynamicURL === '') return [];
 
     try {
-      const response = await fetch(config.url, {
+      const response = await fetch(dynamicURL, {
         headers: config.apiCallRequestHeaders?.reduce(
           (acc, header) => ({
             ...acc,
@@ -166,3 +167,11 @@ export default class TemplateQueries {
     return this.dataSource.getQuestion(questionId);
   }
 }
+
+function constructDynamicURL(url: string, useBaseURL: boolean): string {
+  if (useBaseURL) {
+    return `${process.env.BASE_URL}/${url}`;
+  }
+
+  return url;
+}

apps/backend/src/resolvers/queries/ServerConfigQuery.ts

@@ -0,0 +1,11 @@
+import { Query, Resolver } from 'type-graphql';
+
+import { ServerConfig } from '../types/ServerConfig';
+
+@Resolver()
+export class ServerConfigQuery {
+  @Query(() => ServerConfig, { nullable: false })
+  ServerConfig() {
+    return { baseURL: process.env.BASE_URL };
+  }
+}

apps/backend/src/resolvers/types/FieldConfig.ts

@@ -156,6 +156,9 @@ export class DynamicMultipleChoiceConfig extends ConfigBase {
   @Field(() => String)
   jsonPath: string;
 
+  @Field(() => Boolean)
+  useBaseDomain: boolean;
+
   @Field(() => Boolean)
   isMultipleSelect: boolean;
 

apps/backend/src/resolvers/types/ServerConfig.ts

@@ -0,0 +1,7 @@
+import { ObjectType, Field } from 'type-graphql';
+
+@ObjectType()
+export class ServerConfig {
+  @Field(() => String)
+  public baseURL: string;
+}