feature/GW-1763/branch-protections

.github/workflows/pull-request-from-branch-check.yaml

@@ -0,0 +1,18 @@
+name: Main Branch Protection
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check-branch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch
+        run: |
+          if [[ ${GITHUB_HEAD_REF} != development ]] && [[ ${GITHUB_HEAD_REF} != documentation ]] && ! [[ ${GITHUB_HEAD_REF} =~ ^hotfix/ ]]; 
+          then
+            echo "Error: Pull request must come from 'development', 'documentation' or 'hotfix/' branch"
+            exit 1
+          fi

appinfo/routes.php

@@ -22,6 +22,8 @@
 		['name' => 'synchronizations#test', 'url' => '/api/synchronizations-test/{id}', 'verb' => 'POST'],
 		// Mapping endpoints
 		['name' => 'mappings#test', 'url' => '/api/mappings/test', 'verb' => 'POST'],
+		['name' => 'mappings#saveObject', 'url' => '/api/mappings/objects', 'verb' => 'POST'],
+		['name' => 'mappings#getObjects', 'url' => '/api/mappings/objects', 'verb' => 'GET'],
 		// Running endpoints
 		['name' => 'endpoints#run', 'url' => '/api/v1/{endpoint}', 'verb' => 'GET'],
 		['name' => 'endpoints#run', 'url' => '/api/v1/{endpoint}', 'verb' => 'PUT'],

lib/Controller/MappingsController.php

@@ -31,7 +31,8 @@ public function __construct(
         IRequest $request,
         private readonly IAppConfig $config,
         private readonly MappingMapper $mappingMapper,
-        private readonly MappingService $mappingService
+        private readonly MappingService $mappingService,
+        private readonly ObjectService $objectService
     )
     {
         parent::__construct($appName, $request);
@@ -291,4 +292,47 @@ public function test(ObjectService $objectService, IURLGenerator $urlGenerator):
             'validationErrors' => $validationErrors
         ]);
     }
+
+    /**
+     * Saves a mapping object
+     *
+     * This method saves a mapping object based on POST data.
+     *
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     */
+    public function saveObject(): JSONResponse
+    {
+        // Check if the OpenRegister service is available
+		$openRegisters = $this->objectService->getOpenRegisters();
+		if ($openRegisters !== null) {
+            $data = $this->request->getParams();
+            return new JSONResponse($openRegisters->saveObject($data['register'], $data['schema'], $data['object']));
+		}
+    }
+
+    /**
+     * Retrieves a list of objects to map to
+     *
+     * This method retrieves a list of objects to map to based on GET data.
+     *
+     * @NoAdminRequired
+     * @NoCSRFRequired
+     */
+    public function getObjects(): JSONResponse
+    {
+        // Check if the OpenRegister service is available
+		$openRegisters = $this->objectService->getOpenRegisters();
+        $data = [];
+		if ($openRegisters !== null) {
+			$data['openRegisters'] = true;
+			$data['availableRegisters'] = $openRegisters->getRegisters();
+		}
+        else {
+            $data['openRegisters'] = false;
+        }
+
+        return new JSONResponse($data);
+
+    }
 }

lib/Db/CallLog.php

@@ -80,8 +80,9 @@ public function jsonSerialize(): array
             'synchronizationId' => $this->synchronizationId,            
             'userId' => $this->userId,
             'sessionId' => $this->sessionId,
-            'expires' => $this->expires,
-            'created' => $this->created,
+            'expires' => isset($this->expires) ? $this->expires->format('c') : null,
+            'created' => isset($this->created) ? $this->created->format('c') : null,
+
         ];
     }
 }

lib/Service/SynchronizationService.php

@@ -83,6 +83,9 @@ public function __construct(
 	 */
     public function synchronize(Synchronization $synchronization, ?bool $isTest = false): array
 	{
+        if (empty($synchronization->getSourceId()) === true) {
+            throw new Exception('sourceId of synchronziation cannot be empty. Canceling synchronization..');
+        }
 
         $objectList = $this->getAllObjectsFromSource(synchronization: $synchronization, isTest: $isTest);
 
@@ -151,7 +154,7 @@ private function getOriginId(Synchronization $synchronization, array $object): i
         $sourceConfig = $synchronization->getSourceConfig();
 
         // Check if a custom ID position is defined in the source configuration
-        if (isset($sourceConfig['idPosition']) === true) {
+        if (isset($sourceConfig['idPosition']) === true && empty($sourceConfig['idPosition']) === false) {
             // Override default with custom ID position from config
             $originIdPosition = $sourceConfig['idPosition'];
         }
@@ -391,19 +394,21 @@ public function getAllObjectsFromApi(Synchronization $synchronization, ?bool $is
 
         // Current page is 2 because the first call made above is page 1.
         $currentPage = 2;
-        $usedNextEndpoint = false;
+        $useNextEndpoint = false;
+        if (array_key_exists('next', $body)) {
+            $useNextEndpoint = true;
+        }
 
 
 		// Continue making API calls if there are more pages from 'next' the response body or if paginationQuery is set
-		while($nextEndpoint = $this->getNextEndpoint(body: $body, url: $source->getLocation(), sourceConfig: $sourceConfig, currentPage: $currentPage)) {
-            $usedNextEndpoint = true;
+		while($useNextEndpoint === true && $nextEndpoint = $this->getNextEndpoint(body: $body, url: $source->getLocation(), sourceConfig: $sourceConfig, currentPage: $currentPage)) {
             // Do not pass $config here becuase it overwrites the query attached to nextEndpoint
 			$response = $this->callService->call(source: $source, endpoint: $nextEndpoint)->getResponse();
 			$body = json_decode($response['body'], true);
 			$objects = array_merge($objects, $this->getAllObjectsFromArray($body, $synchronization));
 		}
 
-		if ($usedNextEndpoint === false) {
+		if ($useNextEndpoint === false) {
 			do {
 				$config   = $this->getNextPage(config: $config, sourceConfig: $sourceConfig, currentPage: $currentPage);
 				$response = $this->callService->call(source: $source, endpoint: $endpoint, method: 'GET', config: $config)->getResponse();
@@ -523,7 +528,6 @@ public function getAllObjectsFromArray(array $array, Synchronization $synchroniz
 	 */
     public function getNextlinkFromCall(array $body): ?string
     {
-        // Check if the 'next' key exists in the response body
 		return $body['next'] ?? null;
     }
 }

src/components/CreateEndpointDialog.vue

@@ -1 +0,0 @@
-

src/components/CreateWebhookDialog.vue

@@ -1 +0,0 @@
-

src/components/EditEndpointDialog.vue

@@ -1 +0,0 @@
-

src/components/EditWebhookDialog.vue

@@ -1 +0,0 @@
-

src/entities/callLog/index.js

@@ -1,4 +1,3 @@
 export * from './callLog.ts'
 export * from './callLog.types.ts'
 export * from './callLog.mock.ts'
-

src/entities/endpoint/index.js

@@ -1,4 +1,3 @@
 export * from './endpoint.ts'
 export * from './endpoint.types.ts'
 export * from './endpoint.mock.ts'
-

src/entities/index.js

@@ -8,4 +8,4 @@ export * from './webhook/index.js'
 export * from './mapping/index.js'
 export * from './synchronization/index.js'
 export * from './source/index.js'
-export * from './callLog/index.js' 
+export * from './callLog/index.js'

src/entities/jobLog/index.js

@@ -1,4 +1,3 @@
 export * from './jobLog.types.ts'
 export * from './jobLog.types.ts'
 export * from './jobLog.mock.ts'
-

src/entities/mapping/mapping.ts

@@ -13,7 +13,7 @@ export class Mapping extends ReadonlyBaseClass implements TMapping {
 	public readonly name: string
 	public readonly description: string
 	public readonly mapping: Record<string, unknown>
-	public readonly unset: any[]
+	public readonly unset: string[]
 	public readonly cast: Record<string, unknown>
 	public readonly passThrough: boolean
 	public readonly dateCreated: string
@@ -47,7 +47,7 @@ export class Mapping extends ReadonlyBaseClass implements TMapping {
 			name: z.string().max(255),
 			description: z.string(),
 			mapping: z.record(z.any()),
-			unset: z.array(z.any()),
+			unset: z.array(z.string()),
 			cast: z.record(z.any()),
 			passThrough: z.boolean(),
 			dateCreated: z.string().or(z.literal('')),

src/entities/mapping/mapping.types.ts

@@ -7,7 +7,7 @@ export type TMapping = {
     name: string
     description: string
     mapping: Record<string, unknown>
-    unset: any[]
+    unset: string[]
     cast: Record<string, unknown>
     passThrough: boolean
     dateCreated: string

src/entities/source/source.mock.ts

@@ -4,6 +4,7 @@ import { TSource } from './source.types'
 export const mockSourceData = (): TSource[] => [
 	{
 		id: '5137a1e5-b54d-43ad-abd1-4b5bff5fcd3f',
+		uuid: '5137a1e5-b54d-43ad-abd1-4b5bff5fcd3f',
 		name: 'Test Source 1',
 		description: 'A test source for demonstration',
 		location: 'https://api.test1.com',
@@ -43,6 +44,7 @@ export const mockSourceData = (): TSource[] => [
 	},
 	{
 		id: '4c3edd34-a90d-4d2a-8894-adb5836ecde8',
+		uuid: '4c3edd34-a90d-4d2a-8894-adb5836ecde8',
 		name: 'Test Source 2',
 		description: 'Another test source',
 		location: 'https://api.test2.com',

src/entities/source/source.ts

@@ -7,6 +7,7 @@ import ReadonlyBaseClass from '../ReadonlyBaseClass.js'
 export class Source extends ReadonlyBaseClass implements TSource {
 
 	public readonly id: string
+	public readonly uuid: string
 	public readonly name: string
 	public readonly description: string
 	public readonly reference: string
@@ -47,6 +48,7 @@ export class Source extends ReadonlyBaseClass implements TSource {
 	constructor(source: TSource) {
 		const processedSource: TSource = {
 			id: source.id || null,
+			uuid: source.uuid || '',
 			name: source.name || '',
 			description: source.description || '',
 			reference: source.reference || '',
@@ -91,6 +93,7 @@ export class Source extends ReadonlyBaseClass implements TSource {
 	public validate(): SafeParseReturnType<TSource, unknown> {
 		const schema = z.object({
 			id: z.string().nullable(),
+			uuid: z.string(),
 			name: z.string().max(255),
 			description: z.string(),
 			reference: z.string(),

src/entities/source/source.types.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export type TSource = {
     id: string
+    uuid: string
     name: string
     description: string
     reference: string

src/modals/Endpoint/DeleteEndpoint.vue

@@ -8,7 +8,7 @@ import { endpointStore, navigationStore } from '../../store/store.js'
 		size="normal"
 		:can-close="false">
 		<p v-if="!success">
-			Do you want to delete <b>{{ endpointStore.endpointItem.name }}</b>? This action cannot be undone.
+			Do you want to delete <b>{{ endpointStore.endpointItem?.name }}</b>? This action cannot be undone.
 		</p>
 
 		<NcNoteCard v-if="success" type="success">

src/modals/JobArgument/DeleteJobArgument.vue

@@ -22,7 +22,7 @@ import { navigationStore, jobStore } from '../../store/store.js'
 			Do you want to delete <b>{{ jobStore.jobArgumentKey }}</b>? This action cannot be undone.
 		</p>
 		<template #actions>
-			<NcButton :disabled="loading" icon="" @click="navigationStore.setModal(false)">
+			<NcButton :disabled="loading" icon="" @click="closeModal">
 				<template #icon>
 					<Cancel :size="20" />
 				</template>
@@ -94,11 +94,7 @@ export default {
 					this.success = true
 
 					// Wait for the user to read the feedback then close the model
-					const self = this
-					this.closeTimeoutFunc = setTimeout(function() {
-						self.success = null
-						navigationStore.setModal(false)
-					}, 2000)
+					this.closeTimeoutFunc = setTimeout(this.closeModal, 2000)
 				})
 				.catch((err) => {
 					this.error = err

src/modals/MappingTest/TestMapping.vue

@@ -19,7 +19,8 @@ import { navigationStore } from '../../store/store.js'
 					@mapping-selected="receiveMappingSelected"
 					@mapping-test="receiveMappingTest" />
 				<TestMappingResult ref="mappingResultRef"
-					:mapping-test="mappingTest" />
+					:mapping-test="mappingTest"
+					:schema="schema" />
 			</div>
 		</div>
 	</NcModal>
@@ -82,7 +83,7 @@ export default {
 			value.error !== undefined && (this.mappingTest.error = value.error) // boolean / string
 		},
 		receiveSchemaSelected(value) {
-			value.selected && (this.schema.selected = value.selected)
+			value?.selected !== undefined && (this.schema.selected = value.selected)
 			value.schemas && (this.schema.schemas = value.schemas)
 			value.success !== undefined && (this.schema.success = value.success) // boolean
 			value.loading !== undefined && (this.schema.loading = value.loading) // boolean

src/modals/MappingTest/components/TestMappingMappingSelect.vue

@@ -143,6 +143,10 @@ import { mappingStore } from '../../../store/store.js'
 					:error="!validJson(mappingItem.cast, true)"
 					:helper-text="!validJson(mappingItem.cast, true) ? 'Invalid JSON' : ''" />
 
+				<NcTextArea :value.sync="mappingItem.unset"
+					label="unset"
+					helper-text="Enter a comma-separated list of keys." />
+
 				<div class="buttons">
 					<NcButton class="reset-button"
 						type="secondary"
@@ -229,6 +233,7 @@ export default {
 				description: '',
 				mapping: '{}',
 				cast: '{}',
+				unset: '', // array as string
 			},
 			// use uniqueMappingId as the "No mapping" option's ID to avoid any possible truthy comparisons
 			uniqueMappingId: Symbol('No Mapping'), // Symbol creates a truly unique value, so unique making 2 of the same symbol will never be the same.
@@ -296,12 +301,14 @@ export default {
 					description: '',
 					mapping: '{}',
 					cast: '{}',
+					unset: '',
 				}
 			} else {
 				this.mappingItem.name = this.mappings.value.fullMapping.name
 				this.mappingItem.description = this.mappings.value.fullMapping.description
 				this.mappingItem.mapping = JSON.stringify(this.mappings.value.fullMapping.mapping, null, 2)
 				this.mappingItem.cast = JSON.stringify(this.mappings.value.fullMapping.cast, null, 2)
+				this.mappingItem.unset = this.mappings.value.fullMapping.unset.join(', ') // turn the array into a string
 			}
 		},
 		async fetchMappings(currentMappingItem = null) {
@@ -419,6 +426,7 @@ export default {
 					description: this.mappingItem.description,
 					mapping: JSON.parse(this.mappingItem.mapping),
 					cast: this.mappingItem.cast ? JSON.parse(this.mappingItem.cast) : null,
+					unset: this.mappingItem.unset.split(/ *, */g),
 				},
 				inputObject: JSON.parse(this.inputObject.value),
 				schema: this.schemas.value?.id,
@@ -443,6 +451,7 @@ export default {
 				description: this.mappingItem.description,
 				mapping: JSON.parse(this.mappingItem.mapping),
 				cast: JSON.parse(this.mappingItem.cast),
+				unset: this.mappingItem.unset.split(/ *, */g),
 			})
 
 			mappingStore.saveMapping(newMappingItem)