chore: log deprecated feature usages

Author: PierreJeanjacquot

api/README.md

@@ -41,3 +41,14 @@ npm run start
 ```sh
 npm run dev:pretty
 ```
+
+## deprecations
+
+- `POST /sconify` is deprecated, websocket API request `SCONIFY_BUILD` should be
+  used instead.
+- `POST /sconify/build` is deprecated, websocket API request `SCONIFY_BUILD`
+  should be used instead.
+- websocket API request `SCONIFY` is deprecated, websocket API request
+  `SCONIFY_BUILD` should be used instead.
+- template `Python` is deprecated, template `Python3.13` should be used instead.
+- sconeVersion `v5` is deprecated, sconeVersion `v5.9` should be used instead.

api/src/constants/constants.ts

@@ -33,14 +33,14 @@ export const TEMPLATE_CONFIG: Record<
   JavaScript: {
     // node binary name does not change from one version to another
     binary: '/usr/local/bin/node',
-    // for scone 5.7 this was necessary
+    // deprecated for scone 5.7 this was necessary
     sconeCuratedImage:
       'registry.scontain.com:5050/sconecuratedimages/node:14.4.0-alpine3.11',
   },
   'Python3.13': {
     binary: '/usr/local/bin/python3.13',
   },
-  // legacy template name Python used Python 3.8
+  // deprecated legacy template name Python used Python 3.8
   Python: {
     binary: '/usr/local/bin/python3.8',
   },

api/src/index.ts

@@ -10,7 +10,7 @@ import { requestIdMiddleware } from './utils/requestId.js';
 import { errorHandlerMiddleware } from './utils/errors.js';
 import { attachWebSocketServer } from './utils/websocket.js';
 import {
-  sconifyBuildHttpHandler,
+  deprecated_sconifyBuildHttpHandler,
   sconifyBuildWsHandler,
 } from './sconify/sconifyBuild.handler.js';
 
@@ -34,7 +34,7 @@ app.use(loggerMiddleware);
 // deprecated endpoint, clients should use /sconify/build
 app.post('/sconify', deprecated_sconifyHttpHandler);
 
-app.post('/sconify/build', sconifyBuildHttpHandler);
+app.post('/sconify/build', deprecated_sconifyBuildHttpHandler);
 
 // Health endpoint
 app.get('/health', (req, res) => {

api/src/sconify/deprecated_sconify.handler.ts

@@ -4,6 +4,7 @@ import { TEMPLATE_CONFIG, type TemplateName } from '../constants/constants.js';
 import { ethereumAddressZodSchema } from '../utils/ethereumAddressZodSchema.js';
 import { deprecated_sconify } from './deprecated_sconify.service.js';
 import type { Request, Response } from 'express';
+import { logger } from '../utils/logger.js';
 
 const bodySchema = z.object({
   yourWalletPublicAddress: ethereumAddressZodSchema,
@@ -25,7 +26,7 @@ const bodySchema = z.object({
     .default('JavaScript'),
 });
 
-async function handleSconifyRequest(requestObj: object) {
+async function deprecated_handleSconifyRequest(requestObj: object) {
   let yourWalletPublicAddress;
   let dockerhubImageToSconify;
   let dockerhubPushToken;
@@ -54,18 +55,19 @@ async function handleSconifyRequest(requestObj: object) {
 }
 
 export async function deprecated_sconifyWsHandler(message: object) {
+  logger.warn('deprecated feature hit: ws request SCONIFY');
   const { sconifiedImage, appContractAddress } =
-    await handleSconifyRequest(message);
+    await deprecated_handleSconifyRequest(message);
   return { sconifiedImage, appContractAddress };
 }
 
 export async function deprecated_sconifyHttpHandler(
   req: Request,
   res: Response
 ) {
-  const { sconifiedImage, appContractAddress } = await handleSconifyRequest(
-    req.body || {}
-  );
+  logger.warn('deprecated feature hit: POST /sconify');
+  const { sconifiedImage, appContractAddress } =
+    await deprecated_handleSconifyRequest(req.body || {});
   res.status(200).json({
     success: true,
     sconifiedImage,

api/src/sconify/sconifyBuild.handler.ts

@@ -8,6 +8,7 @@ import {
 import { ethereumAddressZodSchema } from '../utils/ethereumAddressZodSchema.js';
 import { sconify } from './sconifyBuild.service.js';
 import type { Request, Response } from 'express';
+import { logger } from '../utils/logger.js';
 
 const bodySchema = z.object({
   yourWalletPublicAddress: ethereumAddressZodSchema,
@@ -51,6 +52,13 @@ async function handleSconifyRequest(requestObj: object) {
       }),
     });
   }
+  if (template === 'Python') {
+    logger.warn('Deprecated feature hit: template === "Python"');
+  }
+  if (sconeVersion === 'v5') {
+    logger.warn('Deprecated feature hit: sconeVersion === "v5"');
+  }
+
   const { dockerImage, dockerImageDigest, fingerprint, entrypoint } =
     await sconify({
       dockerImageToSconify: dockerhubImageToSconify,
@@ -85,7 +93,11 @@ export async function sconifyBuildWsHandler(message: object) {
   };
 }
 
-export async function sconifyBuildHttpHandler(req: Request, res: Response) {
+export async function deprecated_sconifyBuildHttpHandler(
+  req: Request,
+  res: Response
+) {
+  logger.warn('Deprecated feature hit: POST /sconify/build');
   const {
     dockerImage,
     dockerImageDigest,