Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"@map-colonies/mc-priority-queue": "^8.1.0",
"@map-colonies/mc-utils": "^3.5.1",
"@map-colonies/openapi-express-viewer": "^3.0.0",
"@map-colonies/raster-shared": "^7.6.1-alpha.1",
"@map-colonies/raster-shared": "^7.7.0-alpha.1",
"@map-colonies/read-pkg": "0.0.1",
"@map-colonies/storage-explorer-middleware": "^1.3.0",
"@map-colonies/telemetry": "^6.1.0",
Expand Down
3 changes: 2 additions & 1 deletion src/containerConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ import config from 'config';
import { instancePerContainerCachingFactory } from 'tsyringe';
import { DependencyContainer } from 'tsyringe/dist/typings/types';
import xxhashFactory from 'xxhash-wasm';
import type { HashAlgorithm } from '@map-colonies/raster-shared';
import { SERVICES, SERVICE_NAME } from './common/constants';
import { InjectionObject, registerDependencies } from './common/dependencyRegistration';
import { tracing } from './common/tracing';
import { INFO_ROUTER_SYMBOL, infoRouterFactory } from './info/routes/infoRouter';
import { INGESTION_ROUTER_SYMBOL, ingestionRouterFactory } from './ingestion/routes/ingestionRouter';
import { CHECKSUM_PROCESSOR } from './utils/hash/constants';
import type { ChecksumProcessor, HashAlgorithm } from './utils/hash/interfaces';
import type { ChecksumProcessor } from './utils/hash/interfaces';
import { INGESTION_SCHEMAS_VALIDATOR_SYMBOL, schemasValidationsFactory } from './utils/validation/schemasValidator';
import { VALIDATE_ROUTER_SYMBOL, validateRouterFactory } from './validate/routes/validateRouter';

Expand Down
15 changes: 1 addition & 14 deletions src/ingestion/interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
/* eslint-disable @typescript-eslint/no-magic-numbers */
import { ICreateJobResponse } from '@map-colonies/mc-priority-queue';
import { ingestionBaseJobParamsSchema, ingestionValidationTaskParamsSchema } from '@map-colonies/raster-shared';
import { ingestionBaseJobParamsSchema, ingestionValidationTaskParamsSchema, Checksum } from '@map-colonies/raster-shared';
import z from 'zod';
import { checksumSchema, type Checksum } from '../utils/hash/interfaces';

export interface SourcesValidationResponse {
isValid: boolean;
Expand Down Expand Up @@ -62,15 +61,3 @@ export interface ChecksumValidationParameters {
}

export interface ValidationTaskParameters extends BaseValidationTaskParams, ChecksumValidationParameters {}

export interface ValidationTaskParametersPartial extends Omit<ValidationTaskParameters, 'isValid'> {
isValid?: boolean;
}

export const validationTaskParametersSchema = ingestionValidationTaskParamsSchema.extend({
checksums: z.array(checksumSchema),
});

export const validationTaskParametersSchemaPartial = validationTaskParametersSchema.partial({ isValid: true });

export type TaskValidationParametersPartial = z.infer<typeof validationTaskParametersSchemaPartial>;
30 changes: 12 additions & 18 deletions src/ingestion/models/ingestionManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import {
inputFilesSchema,
rasterProductTypeSchema,
resourceIdSchema,
ingestionValidationTaskParamsSchema,
type Checksum as IChecksum,
type FileMetadata,
type IngestionNewJobParams,
type IngestionSwapUpdateJobParams,
Expand All @@ -31,20 +33,12 @@ import { CatalogClient } from '../../serviceClients/catalogClient';
import { JobManagerWrapper } from '../../serviceClients/jobManagerWrapper';
import { MapProxyClient } from '../../serviceClients/mapProxyClient';
import { Checksum } from '../../utils/hash/checksum';
import { Checksum as IChecksum } from '../../utils/hash/interfaces';
import { getAbsolutePathInputFiles } from '../../utils/paths';
import { getShapefileFiles } from '../../utils/shapefile';
import { ZodValidator } from '../../utils/validation/zodValidator';
import { ValidateManager } from '../../validate/models/validateManager';
import { ChecksumError, throwInvalidJobStatusError } from '../errors/ingestionErrors';
import type {
ChecksumValidationParameters,
IngestionBaseJobParams,
ResponseId,
TaskValidationParametersPartial,
ValidationTaskParametersPartial,
} from '../interfaces';
import { validationTaskParametersSchemaPartial } from '../interfaces';
import type { BaseValidationTaskParams, ChecksumValidationParameters, IngestionBaseJobParams, ResponseId } from '../interfaces';
import type { RasterLayerMetadata } from '../schemas/layerCatalogSchema';
import type { IngestionNewLayer } from '../schemas/newLayerSchema';
import type { IngestionUpdateLayer } from '../schemas/updateLayerSchema';
Expand Down Expand Up @@ -214,9 +208,9 @@ export class IngestionManager {
throwInvalidJobStatusError(jobId, retryJob.status, this.logger, activeSpan);
}

const validationTask: ITaskResponse<TaskValidationParametersPartial> = await this.getValidationTask(jobId, logCtx);
const validationTask: ITaskResponse<BaseValidationTaskParams> = await this.getValidationTask(jobId, logCtx);
const { resourceId, productType } = this.parseAndValidateJobIdentifiers(retryJob.resourceId, retryJob.productType);
await this.zodValidator.validate(validationTaskParametersSchemaPartial, validationTask.parameters);
await this.zodValidator.validate(ingestionValidationTaskParamsSchema, validationTask.parameters);
await this.polygonPartsManagerClient.deleteValidationEntity(resourceId, productType);

if (validationTask.parameters.isValid === true) {
Expand All @@ -238,8 +232,8 @@ export class IngestionManager {
}

@withSpanAsyncV4
private async getValidationTask(jobId: string, logCtx: LogContext): Promise<ITaskResponse<TaskValidationParametersPartial>> {
const tasks = await this.jobManagerWrapper.getTasksForJob<TaskValidationParametersPartial>(jobId);
private async getValidationTask(jobId: string, logCtx: LogContext): Promise<ITaskResponse<BaseValidationTaskParams>> {
const tasks = await this.jobManagerWrapper.getTasksForJob<BaseValidationTaskParams>(jobId);

const validationTask = tasks.find((task) => task.type === this.validationTaskType);

Expand All @@ -265,7 +259,7 @@ export class IngestionManager {
@withSpanAsyncV4
private async hardReset(
retryJob: IJobResponse<IngestionBaseJobParams, unknown>,
validationTask: ITaskResponse<TaskValidationParametersPartial>,
validationTask: ITaskResponse<BaseValidationTaskParams>,
shouldConsiderChecksumChanges: boolean,
logCtx: LogContext
): Promise<void> {
Expand Down Expand Up @@ -298,7 +292,7 @@ export class IngestionManager {

const reportToSet: FileMetadata | undefined = validationTask.parameters.report ?? undefined;

const updatedParameters: ValidationTaskParametersPartial = {
const updatedParameters: BaseValidationTaskParams = {
isValid: validationTask.parameters.isValid,
report: reportToSet,
checksums: updatedChecksums,
Expand Down Expand Up @@ -369,18 +363,18 @@ export class IngestionManager {
}

@withSpanAsyncV4
private async manualResetJobAndTask(jobId: string, taskId: string, parameters: ValidationTaskParametersPartial, logCtx: LogContext): Promise<void> {
private async manualResetJobAndTask(jobId: string, taskId: string, parameters: BaseValidationTaskParams, logCtx: LogContext): Promise<void> {
this.logger.debug({ msg: 'manually updating validation task and job status to PENDING', logContext: logCtx, jobId, taskId });

const taskParameters: IUpdateTaskBody<ValidationTaskParametersPartial> = {
const taskParameters: IUpdateTaskBody<BaseValidationTaskParams> = {
parameters,
status: OperationStatus.PENDING,
attempts: 0,
percentage: 0,
reason: '',
};

await this.jobManagerWrapper.updateTask<ValidationTaskParametersPartial>(jobId, taskId, taskParameters);
await this.jobManagerWrapper.updateTask<BaseValidationTaskParams>(jobId, taskId, taskParameters);
await this.jobManagerWrapper.updateJob(jobId, { status: OperationStatus.PENDING, reason: '' });
this.logger.debug({ msg: 'validation task and job status updated to PENDING successfully', logContext: logCtx, jobId, taskId });
}
Expand Down
3 changes: 2 additions & 1 deletion src/utils/hash/checksum.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ import type { Logger } from '@map-colonies/js-logger';
import { withSpanAsyncV4 } from '@map-colonies/telemetry';
import { trace, type Tracer } from '@opentelemetry/api';
import { inject, injectable } from 'tsyringe';
import type { Checksum as IChecksum } from '@map-colonies/raster-shared';
import { SERVICES } from '../../common/constants';
import type { LogContext } from '../../common/interfaces';
import { ChecksumError } from '../../ingestion/errors/ingestionErrors';
import { CHECKSUM_PROCESSOR } from './constants';
import type { ChecksumProcessor, Checksum as IChecksum } from './interfaces';
import type { ChecksumProcessor } from './interfaces';

@injectable()
export class Checksum {
Expand Down
17 changes: 1 addition & 16 deletions src/utils/hash/interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import z from 'zod';
import { HASH_ALGORITHMS } from './constants';
import { HashAlgorithm } from '@map-colonies/raster-shared';

/**
* Interface describing a hash processor instance.
Expand All @@ -25,20 +24,6 @@ interface HashProcessor {
reset?: () => void;
}

export type HashAlgorithm = (typeof HASH_ALGORITHMS)[number];

export interface Checksum {
algorithm: HashAlgorithm;
checksum: string;
fileName: string;
}

export const checksumSchema = z.object({
algorithm: z.enum(HASH_ALGORITHMS),
checksum: z.string(),
fileName: z.string(),
});

/**
* Interface describing a checksum processor instance.
* Provides a consistent API for calculating checksums.
Expand Down