feat(cli): allow overriding imagery names

packages/cli/src/cli/cogify/action.job.ts

@@ -6,6 +6,7 @@ import {
   CommandLineIntegerParameter,
   CommandLineStringParameter,
 } from '@rushstack/ts-command-line';
+import { basename } from 'path';
 import { JobCreationContext } from '../../cog/cog.stac.job.js';
 import { CogJobFactory, MaxConcurrencyDefault } from '../../cog/job.factory.js';
 import { GdalCogBuilderDefaults, GdalCogBuilderResampling, GdalResamplingOptions } from '../../gdal/gdal.config.js';
@@ -120,6 +121,7 @@ export class ActionJobCreate extends CommandLineAction {
     }
 
     const ctx: JobCreationContext = {
+      imageryName: basename(sourceLocation.path),
       sourceLocation,
       outputLocation,
       cutline,

packages/cli/src/cog/cog.stac.job.ts

@@ -34,6 +34,8 @@ import {
 export const MaxConcurrencyDefault = 50;
 
 export interface JobCreationContext {
+  imageryName: string;
+
   /** Source config */
   sourceLocation: FileConfig | FileConfigPath;
 

packages/cli/src/cog/job.factory.ts

@@ -1,6 +1,5 @@
 import { Bounds } from '@basemaps/geo';
 import { fsa, isConfigS3Role, isFileConfigPath, LogConfig } from '@basemaps/shared';
-import { basename } from 'path';
 import * as ulid from 'ulid';
 import { CogBuilder } from '../index.js';
 import { BatchJob } from '../cli/cogify/batch.job.js';
@@ -22,8 +21,7 @@ export const CogJobFactory = {
    */
   async create(ctx: JobCreationContext): Promise<CogJob> {
     const id = ctx.override?.id ?? ulid.ulid();
-    const imageryName = basename(ctx.sourceLocation.path).replace(/\./g, '-'); // batch does not allow '.' in names
-    const logger = LogConfig.get().child({ id, imageryName });
+    const logger = LogConfig.get().child({ id, imageryName: ctx.imageryName });
 
     const gdalVersion = await Gdal.version(logger);
     logger.info({ version: gdalVersion }, 'GdalVersion');
@@ -101,7 +99,7 @@ export const CogJobFactory = {
 
     const job = await CogStacJob.create({
       id,
-      imageryName,
+      imageryName: ctx.imageryName,
       metadata,
       ctx,
       addAlpha,

packages/lambda-tiler/src/__test__/tile.import.test.ts

@@ -30,7 +30,7 @@ o.spec('Import', () => {
 
   const tileMatrix = Nztm2000Tms;
   const bucket = 'testSourceBucket';
-  const path = `s3://${bucket}/imagery/`;
+  const path = `s3://${bucket}/imagery_2022/`;
   const role: RoleConfig = {
     bucket,
     accountId: '123456',
@@ -43,6 +43,7 @@ o.spec('Import', () => {
   }
 
   const ctx: JobCreationContext = {
+    imageryName: 'imagery_2022',
     override: {
       projection: tileMatrix.projection,
       resampling: {
@@ -96,7 +97,7 @@ o.spec('Import', () => {
   o('should return Unable to access bucket', async () => {
     // Given... different bucket have no access role
     sandbox.stub(fsa, 'readJson').resolves({ buckets: [role] });
-    const req = getRequest(`s3://wrong-bucket/imagery/`, '2193');
+    const req = getRequest(`s3://wrong-bucket/imagery_2022/`, '2193');
 
     // When ...Then ...
     const res = await Import(req);

packages/lambda-tiler/src/import/make.cog.ts

@@ -6,12 +6,14 @@ import { RoleConfig } from './imagery.find.js';
 export async function getJobCreationContext(
   path: string,
   tileMatrix: TileMatrixSet,
+  name: string,
   role: RoleConfig,
   files: string[],
 ): Promise<JobCreationContext> {
   const bucket = Env.get(Env.ImportImageryBucket);
   if (bucket == null) throw new Error('Output AWS s3 bucket Not Found.');
   const ctx: JobCreationContext = {
+    imageryName: name,
     override: {
       projection: tileMatrix.projection,
       resampling: {

packages/lambda-tiler/src/routes/import.ts

@@ -1,12 +1,13 @@
 import { HttpHeader, LambdaHttpRequest, LambdaHttpResponse } from '@linzjs/lambda';
-import { Config, fsa } from '@basemaps/shared';
+import { Config, extractYearRangeFromName, fsa } from '@basemaps/shared';
 import { createHash } from 'crypto';
 import { findImagery, RoleRegister } from '../import/imagery.find.js';
 import { Nztm2000Tms, TileMatrixSets } from '@basemaps/geo';
 import { getJobCreationContext } from '../import/make.cog.js';
 import { ConfigProcessingJob, JobStatus } from '@basemaps/config';
 import { CogJobFactory } from '@basemaps/cli';
 import * as ulid from 'ulid';
+import { basename } from 'path';
 
 /**
  * Trigger import imagery job by this endpoint
@@ -17,6 +18,7 @@ import * as ulid from 'ulid';
 export async function Import(req: LambdaHttpRequest): Promise<LambdaHttpResponse> {
   const path = req.query.get('path');
   const projection = req.query.get('p');
+  const id = ulid.ulid();
 
   // Parse projection as target, default to process both NZTM2000Quad
   let targetTms = Nztm2000Tms;
@@ -26,22 +28,31 @@ export async function Import(req: LambdaHttpRequest): Promise<LambdaHttpResponse
     targetTms = tileMatrix;
   }
 
-  // Find the imagery from s3
+  // Validate the s3 path
   if (path == null || !path.startsWith('s3://')) return new LambdaHttpResponse(400, `Invalid s3 path: ${path}`);
+
+  // Check if the imagery name contains a year
+  let imageryName = basename(path);
+  const years = extractYearRangeFromName(imageryName);
+  if (years[0] === -1) {
+    const year = new Date().getFullYear().toString();
+    imageryName = `${id}_${year}`;
+  }
+
+  // Find the imagery from s3
   const role = await RoleRegister.findRole(path);
   if (role == null) return new LambdaHttpResponse(403, 'Unable to Access the s3 bucket');
   const files = await findImagery(path);
   if (files.length === 0) return new LambdaHttpResponse(404, 'Imagery Not Found');
 
   // Prepare Cog jobs
-  const ctx = await getJobCreationContext(path, targetTms, role, files);
+  const ctx = await getJobCreationContext(path, targetTms, imageryName, role, files);
 
   const hash = createHash('sha256').update(JSON.stringify(ctx)).digest('base64');
   const jobId = Config.ProcessingJob.id(hash);
   let jobConfig = await Config.ProcessingJob.get(jobId);
   if (jobConfig == null) {
     // Add ids into JobCreationContext
-    const id = ulid.ulid();
     ctx.override!.id = id;
     ctx.override!.processingId = jobId;
     ctx.outputLocation.path = fsa.join(ctx.outputLocation.path, id);