@platformatic/watt-extra 1.13.0-alpha.1 → 1.13.0-alpha.3

package/lib/watt.js

@@ -53,11 +53,15 @@ class Watt {
   }
 
   async spawn () {
+    this.#logger.info('[ECS-DEBUG] spawn: enter')
     try {
       this.runtime = await this.#createRuntime()
+      this.#logger.info('[ECS-DEBUG] spawn: createRuntime returned, about to call runtime.start()')
       this.#logger.info('Starting runtime -WATT')
       await this.runtime.start()
+      this.#logger.info('[ECS-DEBUG] spawn: runtime.start() returned')
       await this.updateSharedContext(this.#sharedContext)
+      this.#logger.info('[ECS-DEBUG] spawn: updateSharedContext returned')
       this.#logger.info('Runtime started')
     } catch (err) {
       this.#logger.error(
@@ -155,14 +159,17 @@ class Watt {
   }
 
   async #createRuntime () {
+    this.#logger.info('[ECS-DEBUG] createRuntime: enter')
     this.#logger.info('Creating runtime')
     const { create, transform } = this.#require('@platformatic/runtime')
 
+    this.#logger.info('[ECS-DEBUG] createRuntime: about to call platformatic create()')
     this.#logger.info('Creating runtime')
 
     const runtime = await create(this.#appDir, null, {
       isProduction: true,
       transform: async (config) => {
+        this.#logger.info('[ECS-DEBUG] createRuntime: transform called')
         config = await transform(config)
 
         this.#config = config
@@ -171,9 +178,11 @@ class Watt {
         this.#logger.info('Patching runtime config')
 
         this.#patchRuntimeConfig(config)
+        this.#logger.info('[ECS-DEBUG] createRuntime: transform done')
         return config
       }
     })
+    this.#logger.info('[ECS-DEBUG] createRuntime: platformatic create() returned')
 
     /* c8 ignore next 3 */
     const restartListener = restartRuntime.bind(null, runtime)
@@ -182,11 +191,15 @@ class Watt {
       process.removeListener('SIGUSR2', restartListener)
     })
 
+    this.#logger.info('[ECS-DEBUG] createRuntime: about to configureServices')
     await this.#configureServices(runtime)
+    this.#logger.info('[ECS-DEBUG] createRuntime: configureServices returned, about to runtime.init()')
 
     try {
       await runtime.init()
+      this.#logger.info('[ECS-DEBUG] createRuntime: runtime.init() returned')
     } catch (e) {
+      this.#logger.error({ err: ensureLoggableError(e) }, '[ECS-DEBUG] createRuntime: runtime.init() threw')
       await runtime.close()
       throw e
     }
@@ -508,13 +521,18 @@ class Watt {
   }
 
   async #configureServices (runtime) {
+    this.#logger.info('[ECS-DEBUG] configureServices: enter')
     if (typeof runtime.setApplicationConfigPatch !== 'function') {
+      this.#logger.info('[ECS-DEBUG] configureServices: runtime has no setApplicationConfigPatch, skipping')
       return
     }
 
     const config = runtime.getRuntimeConfig(true)
+    const apps = config.applications ?? []
+    this.#logger.info({ count: apps.length, apps: apps.map(a => ({ id: a.id, type: a.type, entrypoint: a.entrypoint })) }, '[ECS-DEBUG] configureServices: iterating apps')
 
-    for (const app of config.applications ?? []) {
+    for (const app of apps) {
+      this.#logger.info({ id: app.id, type: app.type }, '[ECS-DEBUG] configureServices: handling app')
       if (app.type === 'next') {
         await this.#configureNextService(runtime, app)
       } else if (
@@ -528,19 +546,24 @@ class Watt {
       } else if (app.type === '@platformatic/regina') {
         await this.#configureReginaService(runtime, app)
       }
+      this.#logger.info({ id: app.id }, '[ECS-DEBUG] configureServices: done with app')
     }
+    this.#logger.info('[ECS-DEBUG] configureServices: all apps configured')
   }
 
   async #configureNextService (runtime, service) {
+    this.#logger.info({ id: service.id, path: service.path, entrypoint: service.entrypoint }, '[ECS-DEBUG] configureNextService: enter')
     let nextSchema
 
     try {
       const nextPackage = createRequire(
         resolve(service.path, 'index.js')
       ).resolve('@platformatic/next')
+      this.#logger.info({ nextPackage }, '[ECS-DEBUG] configureNextService: resolved @platformatic/next')
       nextSchema = JSON.parse(
         await readFile(resolve(nextPackage, '../schema.json'), 'utf8')
       )
+      this.#logger.info('[ECS-DEBUG] configureNextService: read next schema')
     } catch (e) {
       this.#logger.error(
         { err: ensureLoggableError(e) },
@@ -589,6 +612,7 @@ class Watt {
   }
 
   async #configurePlatformaticServices (runtime, app) {
+    this.#logger.info({ id: app.id, entrypoint: app.entrypoint, type: app.type }, '[ECS-DEBUG] configurePlatformaticServices: enter')
     if (app.entrypoint) {
       const config = app
       const patches = [{ op: 'add', path: '/server/trustProxy', value: true }]
@@ -601,20 +625,27 @@ class Watt {
 
       this.#patchService(runtime, app.id, patches)
     }
+    this.#logger.info({ id: app.id }, '[ECS-DEBUG] configurePlatformaticServices: exit')
   }
 
   async #configureReginaService (runtime, app) {
+    this.#logger.info({ id: app.id }, '[ECS-DEBUG] configureReginaService: enter')
     const privateIp = await this.#getPrivateIp()
     const port = this.#getRuntimePort()
     const address = `http://${privateIp}:${port}`
+    this.#logger.info({ id: app.id, address }, '[ECS-DEBUG] configureReginaService: applying patch')
 
     this.#patchService(runtime, app.id, [
       { op: 'add', path: '/regina/memberAddress', value: address }
     ])
+    this.#logger.info({ id: app.id }, '[ECS-DEBUG] configureReginaService: exit')
   }
 
   async #getPrivateIp () {
-    const { address } = await dns.lookup(os.hostname())
+    const hostname = os.hostname()
+    this.#logger.info({ hostname }, '[ECS-DEBUG] getPrivateIp: about to dns.lookup')
+    const { address } = await dns.lookup(hostname)
+    this.#logger.info({ hostname, address }, '[ECS-DEBUG] getPrivateIp: resolved')
     return address
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/watt-extra",
-  "version": "1.13.0-alpha.1",
+  "version": "1.13.0-alpha.3",
   "description": "The Platformatic runtime manager",
   "type": "module",
   "scripts": {

package/plugins/auth.js

@@ -43,12 +43,20 @@ async function loadK8sToken (log) {
 // endpoint. K8s identity travels via the SA JWT, so no resolution needed there.
 async function resolveEcsIdentity (log) {
   const metadataUrl = `${process.env.ECS_CONTAINER_METADATA_URI_V4}/task`
+  log.info({ metadataUrl }, '[ECS-DEBUG] resolveEcsIdentity: fetching task metadata')
   try {
     const res = await fetch(metadataUrl)
+    log.info({ status: res.status, ok: res.ok }, '[ECS-DEBUG] resolveEcsIdentity: metadata fetch returned')
     if (!res.ok) throw new Error(`status ${res.status}`)
     const meta = await res.json()
+    log.info({ TaskARN: meta.TaskARN, Cluster: meta.Cluster, Family: meta.Family, LaunchType: meta.LaunchType }, '[ECS-DEBUG] resolveEcsIdentity: parsed metadata')
     const id = meta.TaskARN?.split('/').pop()
-    const namespace = meta.Cluster
+    // meta.Cluster may be either the short name or the full cluster ARN
+    // (e.g. 'arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster'). We
+    // strip down to the short name so callers can interpolate it into
+    // URL paths without producing extra path segments.
+    const cluster = meta.Cluster
+    const namespace = cluster?.includes('/') ? cluster.split('/').pop() : cluster
     if (!id || !namespace) throw new Error('TaskARN or Cluster missing in metadata')
     log.info({ id, namespace }, 'Resolved ECS task identity')
     return { id, namespace }

package/plugins/init.js

@@ -26,6 +26,14 @@ async function initPlugin (app) {
     const applicationDir = app.env.PLT_APP_DIR
     const instanceId = app.provider === 'k8s' ? os.hostname() : app.machineIdentity?.id
 
+    app.log.info({
+      provider: app.provider,
+      hostname: os.hostname(),
+      machineIdentity: app.machineIdentity,
+      instanceId,
+      applicationDir
+    }, '[ECS-DEBUG] init: computed instanceId')
+
     app.log.info({ applicationName, applicationDir }, 'Loading watt-extra application')
 
     // Skip ICC initialization if PLT_ICC_URL is not set
@@ -39,6 +47,14 @@ async function initPlugin (app) {
 
     const instanceConfig = await initApplicationInstance(instanceId, applicationName)
     app.log.info({ applicationId: instanceConfig.applicationId }, 'Got application info')
+    app.log.info({
+      iccServices: instanceConfig.iccServices,
+      enableSlicerInterceptor: instanceConfig.enableSlicerInterceptor,
+      enableTrafficInterceptor: instanceConfig.enableTrafficInterceptor,
+      enableOpenTelemetry: instanceConfig.enableOpenTelemetry,
+      httpCacheKeys: Object.keys(instanceConfig.httpCache?.clientOpts || {}),
+      configKeys: Object.keys(instanceConfig.config || {})
+    }, '[ECS-DEBUG] init: ICC instanceConfig details')
 
     instanceConfig.scaler ??= { version: 'v1' }
 

package/test/auth.test.js

@@ -214,3 +214,42 @@ test('auth plugin sends ECS identity headers when running on ECS', async (t) =>
   equal(responseBody.headers['x-ecs-cluster'], 'my-cluster')
   equal(responseBody.headers.authorization, undefined, 'No Authorization header on ECS')
 })
+
+test('auth plugin strips cluster ARN to short name in x-ecs-cluster header', async (t) => {
+  const originalEnv = { ...process.env }
+
+  t.after(() => {
+    process.env = originalEnv
+  })
+
+  // ECS task metadata sometimes returns the full cluster ARN in the Cluster
+  // field. ICC interpolates this value into URL paths, so the short name
+  // (which contains no slashes) is the only safe form to send.
+  const metadata = fastify()
+  metadata.get('/task', async () => ({
+    TaskARN: 'arn:aws:ecs:us-east-1:123456789012:task/my-cluster/abcdef0123',
+    Cluster: 'arn:aws:ecs:us-east-1:123456789012:cluster/my-cluster'
+  }))
+  await metadata.listen({ port: 0 })
+  const metadataUrl = `http://localhost:${metadata.server.address().port}`
+  t.after(() => metadata.close())
+
+  process.env.ECS_CONTAINER_METADATA_URI_V4 = metadataUrl
+
+  const server = fastify()
+  server.get('/', async (request) => {
+    return { headers: request.headers }
+  })
+  await server.listen({ port: 0 })
+  const url = `http://localhost:${server.server.address().port}`
+  t.after(() => server.close())
+
+  const app = createMockApp('ecs')
+  await authPlugin(app)
+
+  equal(app.machineIdentity?.namespace, 'my-cluster', 'Namespace should be stripped to cluster short name')
+
+  const response = await request(url, { dispatcher: app.dispatcher })
+  const responseBody = await response.body.json()
+  equal(responseBody.headers['x-ecs-cluster'], 'my-cluster')
+})