feat: let user configure timeout and proper manage timeout errors (#43)

* feat: let user configure timeout and proper manage timeout errors

* build

Author: masci

README.md

@@ -126,6 +126,11 @@ steps:
     # Default: false
     ignore-timeouts:
 
+    # Timeout value in milliseconds for the HTTP client.
+    # Type: number
+    # Default: 30000 (30 seconds)
+    timeout:
+
     # A list of metric objects to send, defined in YAML format
     # Type: string
     # Default: '[]'

__tests__/main.test.ts

@@ -25,7 +25,8 @@ describe('unit-tests', () => {
       'https://api.datadoghq.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
   })
 
@@ -36,7 +37,8 @@ describe('unit-tests', () => {
       'http://example.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
     process.env['INPUT_API-URL'] = ''
   })
@@ -47,7 +49,8 @@ describe('unit-tests', () => {
       'https://http-intake.logs.datadoghq.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
   })
 
@@ -58,7 +61,8 @@ describe('unit-tests', () => {
       'http://example.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
     process.env['INPUT_LOG-API-URL'] = ''
   })
@@ -69,25 +73,29 @@ describe('unit-tests', () => {
       'https://api.datadoghq.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
     expect(dd.sendEvents).toHaveBeenCalledWith(
       'https://api.datadoghq.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
     expect(dd.sendServiceChecks).toHaveBeenCalledWith(
       'https://api.datadoghq.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
     expect(dd.sendLogs).toHaveBeenCalledWith(
       'https://http-intake.logs.datadoghq.com',
       'fooBarBaz',
       [],
-      false
+      false,
+      30000
     )
   })
 })
@@ -148,6 +156,37 @@ describe('end-to-end tests', () => {
       env: process.env
     }
 
+    try {
+      console.log(cp.execSync(`node ${ip}`, options).toString())
+    } catch (e) {
+      console.log(e.output.toString())
+      throw e
+    }
+  })
+  it('does not fail on timeout errors', () => {
+    process.env['INPUT_API-KEY'] = process.env['DD_API_KEY'] || ''
+    if (process.env['INPUT_API-KEY'] === '') {
+      return
+    }
+    process.env['INPUT_IGNORE-TIMEOUTS'] = 'true'
+    // Set an impossibly low timeout in order to force a client failure
+    process.env['INPUT_TIMEOUT'] = '10'
+
+    process.env['INPUT_METRICS'] = yaml.safeDump([
+      {
+        type: 'count',
+        name: 'test.builds.count',
+        value: 1.0,
+        tags: ['foo:bar'],
+        host: 'example.com'
+      }
+    ])
+
+    const ip = path.join(__dirname, '..', 'lib', 'main.js')
+    const options: cp.ExecSyncOptions = {
+      env: process.env
+    }
+
     try {
       console.log(cp.execSync(`node ${ip}`, options).toString())
     } catch (e) {

__tests__/timeout.test.ts

@@ -0,0 +1,42 @@
+import * as cp from 'child_process'
+import * as yaml from 'js-yaml'
+import * as path from 'path'
+import * as process from 'process'
+import * as dd from '../src/datadog'
+import {run} from '../src/run'
+jest.mock('@actions/http-client')
+
+describe('Datadog client timeout tests', () => {
+  it('should handle timeout errors correctly in sendMetrics', async () => {
+    // Mock the http client to simulate a timeout
+    const mockPost = jest.fn().mockImplementation(() => {
+      return new Promise((_, reject) => {
+        // Simulate a timeout error
+        reject(new Error('Request timeout: /api/v1/series'))
+      })
+    })
+
+    // Mock the HttpClient constructor
+    require('@actions/http-client').HttpClient.mockImplementation(() => ({
+      post: mockPost
+    }))
+
+    const metric: dd.Metric = {
+      type: 'gauge',
+      name: 'test.metric',
+      value: 1,
+      tags: ['test:true'],
+      host: 'test-host'
+    }
+
+    // Test with ignoreTimeouts = true
+    await expect(
+      dd.sendMetrics('http://api.url', 'fake-key', [metric], true, 30000)
+    ).resolves.not.toThrow()
+
+    // Test with ignoreTimeouts = false
+    await expect(
+      dd.sendMetrics('http://api.url', 'fake-key', [metric], false, 30000)
+    ).rejects.toThrow('Request timeout: /api/v1/series')
+  })
+})

action.yml

@@ -27,6 +27,10 @@ inputs:
     description: 'Ignore timeout errors and continue execution'
     required: false
     default: 'false'
+  timeout:
+    description: 'Timeout in milliseconds for the HTTP client'
+    required: false
+    default: '30'
 runs:
   using: 'node20'
   main: 'dist/index.js'

dist/index.js

@@ -38,24 +38,27 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.sendLogs = exports.sendServiceChecks = exports.sendEvents = exports.sendMetrics = exports.getClient = void 0;
 const core = __importStar(__nccwpck_require__(2186));
 const httpm = __importStar(__nccwpck_require__(9925));
-function getClient(apiKey) {
+function getClient(apiKey, timeout) {
     return new httpm.HttpClient('dd-http-client', [], {
         headers: {
             'DD-API-KEY': apiKey,
             'Content-Type': 'application/json'
-        }
+        },
+        socketTimeout: timeout
     });
 }
 exports.getClient = getClient;
 function isTimeoutError(error) {
-    return error.message.includes('timeout') || error.message.includes('Timeout');
+    // force the error into a string so it both works for Error instances and plain strings
+    const error_msg = `${error}`;
+    return error_msg.includes('timeout') || error_msg.includes('Timeout');
 }
 function postMetricsIfAny(http, apiURL, metrics, endpoint, ignoreTimeouts) {
     return __awaiter(this, void 0, void 0, function* () {
         // POST data
         if (metrics.series.length) {
             try {
-                core.debug(`About to send ${metrics.series.length} metrics`);
+                core.debug(`About to send ${metrics.series.length} metrics to ${apiURL}/api/${endpoint}`);
                 const res = yield http.post(`${apiURL}/api/${endpoint}`, JSON.stringify(metrics));
                 if (res.message.statusCode === undefined ||
                     res.message.statusCode >= 400) {
@@ -72,9 +75,9 @@ function postMetricsIfAny(http, apiURL, metrics, endpoint, ignoreTimeouts) {
         }
     });
 }
-function sendMetrics(apiURL, apiKey, metrics, ignoreTimeouts) {
+function sendMetrics(apiURL, apiKey, metrics, ignoreTimeouts, timeout) {
     return __awaiter(this, void 0, void 0, function* () {
-        const http = getClient(apiKey);
+        const http = getClient(apiKey, timeout);
         // distributions use a different procotol.
         const distributions = { series: Array() };
         const otherMetrics = { series: Array() };
@@ -97,11 +100,11 @@ function sendMetrics(apiURL, apiKey, metrics, ignoreTimeouts) {
     });
 }
 exports.sendMetrics = sendMetrics;
-function sendEvents(apiURL, apiKey, events, ignoreTimeouts) {
+function sendEvents(apiURL, apiKey, events, ignoreTimeouts, timeout) {
     return __awaiter(this, void 0, void 0, function* () {
-        const http = getClient(apiKey);
+        const http = getClient(apiKey, timeout);
         let errors = 0;
-        core.debug(`About to send ${events.length} events`);
+        core.debug(`About to send ${events.length} events to ${apiURL}/api/v1/events`);
         for (const ev of events) {
             try {
                 const res = yield http.post(`${apiURL}/api/v1/events`, JSON.stringify(ev));
@@ -125,11 +128,11 @@ function sendEvents(apiURL, apiKey, events, ignoreTimeouts) {
     });
 }
 exports.sendEvents = sendEvents;
-function sendServiceChecks(apiURL, apiKey, serviceChecks, ignoreTimeouts) {
+function sendServiceChecks(apiURL, apiKey, serviceChecks, ignoreTimeouts, timeout) {
     return __awaiter(this, void 0, void 0, function* () {
-        const http = getClient(apiKey);
+        const http = getClient(apiKey, timeout);
         let errors = 0;
-        core.debug(`About to send ${serviceChecks.length} service checks`);
+        core.debug(`About to send ${serviceChecks.length} service checks to ${apiURL}/api/v1/check_run`);
         for (const sc of serviceChecks) {
             try {
                 const res = yield http.post(`${apiURL}/api/v1/check_run`, JSON.stringify(sc));
@@ -153,11 +156,11 @@ function sendServiceChecks(apiURL, apiKey, serviceChecks, ignoreTimeouts) {
     });
 }
 exports.sendServiceChecks = sendServiceChecks;
-function sendLogs(logApiURL, apiKey, logs, ignoreTimeouts) {
+function sendLogs(logApiURL, apiKey, logs, ignoreTimeouts, timeout) {
     return __awaiter(this, void 0, void 0, function* () {
-        const http = getClient(apiKey);
+        const http = getClient(apiKey, timeout);
         let errors = 0;
-        core.debug(`About to send ${logs.length} logs`);
+        core.debug(`About to send ${logs.length} logs to ${logApiURL}/v1/input`);
         for (const log of logs) {
             try {
                 const res = yield http.post(`${logApiURL}/v1/input`, JSON.stringify(log));
@@ -267,16 +270,17 @@ function run() {
     return __awaiter(this, void 0, void 0, function* () {
         const apiKey = core.getInput('api-key', { required: true });
         const apiURL = core.getInput('api-url') || 'https://api.datadoghq.com';
-        const ignoreTimeouts = core.getInput('ignore-timeouts') === 'false';
+        const ignoreTimeouts = core.getInput('ignore-timeouts') === 'true';
+        const timeout = parseInt(core.getInput('timeout')) || 30000;
         const metrics = yaml.safeLoad(core.getInput('metrics')) || [];
-        yield dd.sendMetrics(apiURL, apiKey, metrics, ignoreTimeouts);
+        yield dd.sendMetrics(apiURL, apiKey, metrics, ignoreTimeouts, timeout);
         const events = yaml.safeLoad(core.getInput('events')) || [];
-        yield dd.sendEvents(apiURL, apiKey, events, ignoreTimeouts);
+        yield dd.sendEvents(apiURL, apiKey, events, ignoreTimeouts, timeout);
         const serviceChecks = yaml.safeLoad(core.getInput('service-checks')) || [];
-        yield dd.sendServiceChecks(apiURL, apiKey, serviceChecks, ignoreTimeouts);
+        yield dd.sendServiceChecks(apiURL, apiKey, serviceChecks, ignoreTimeouts, timeout);
         const logApiURL = core.getInput('log-api-url') || 'https://http-intake.logs.datadoghq.com';
         const logs = yaml.safeLoad(core.getInput('logs')) || [];
-        yield dd.sendLogs(logApiURL, apiKey, logs, ignoreTimeouts);
+        yield dd.sendLogs(logApiURL, apiKey, logs, ignoreTimeouts, timeout);
     });
 }
 exports.run = run;

src/datadog.ts

@@ -33,17 +33,20 @@ export interface Log {
   service: string
 }
 
-export function getClient(apiKey: string): httpm.HttpClient {
+export function getClient(apiKey: string, timeout: number): httpm.HttpClient {
   return new httpm.HttpClient('dd-http-client', [], {
     headers: {
       'DD-API-KEY': apiKey,
       'Content-Type': 'application/json'
-    }
+    },
+    socketTimeout: timeout
   })
 }
 
 function isTimeoutError(error: Error): boolean {
-  return error.message.includes('timeout') || error.message.includes('Timeout')
+  // force the error into a string so it both works for Error instances and plain strings
+  const error_msg = `${error}`
+  return error_msg.includes('timeout') || error_msg.includes('Timeout')
 }
 
 async function postMetricsIfAny(
@@ -56,7 +59,9 @@ async function postMetricsIfAny(
   // POST data
   if (metrics.series.length) {
     try {
-      core.debug(`About to send ${metrics.series.length} metrics`)
+      core.debug(
+        `About to send ${metrics.series.length} metrics to ${apiURL}/api/${endpoint}`
+      )
       const res: httpm.HttpClientResponse = await http.post(
         `${apiURL}/api/${endpoint}`,
         JSON.stringify(metrics)
@@ -86,9 +91,10 @@ export async function sendMetrics(
   apiURL: string,
   apiKey: string,
   metrics: Metric[],
-  ignoreTimeouts: boolean
+  ignoreTimeouts: boolean,
+  timeout: number
 ): Promise<void> {
-  const http: httpm.HttpClient = getClient(apiKey)
+  const http: httpm.HttpClient = getClient(apiKey, timeout)
   // distributions use a different procotol.
   const distributions = {series: Array()}
   const otherMetrics = {series: Array()}
@@ -128,12 +134,13 @@ export async function sendEvents(
   apiURL: string,
   apiKey: string,
   events: Event[],
-  ignoreTimeouts: boolean
+  ignoreTimeouts: boolean,
+  timeout: number
 ): Promise<void> {
-  const http: httpm.HttpClient = getClient(apiKey)
+  const http: httpm.HttpClient = getClient(apiKey, timeout)
   let errors = 0
 
-  core.debug(`About to send ${events.length} events`)
+  core.debug(`About to send ${events.length} events to ${apiURL}/api/v1/events`)
   for (const ev of events) {
     try {
       const res: httpm.HttpClientResponse = await http.post(
@@ -167,12 +174,15 @@ export async function sendServiceChecks(
   apiURL: string,
   apiKey: string,
   serviceChecks: ServiceCheck[],
-  ignoreTimeouts: boolean
+  ignoreTimeouts: boolean,
+  timeout: number
 ): Promise<void> {
-  const http: httpm.HttpClient = getClient(apiKey)
+  const http: httpm.HttpClient = getClient(apiKey, timeout)
   let errors = 0
 
-  core.debug(`About to send ${serviceChecks.length} service checks`)
+  core.debug(
+    `About to send ${serviceChecks.length} service checks to ${apiURL}/api/v1/check_run`
+  )
   for (const sc of serviceChecks) {
     try {
       const res: httpm.HttpClientResponse = await http.post(
@@ -208,12 +218,13 @@ export async function sendLogs(
   logApiURL: string,
   apiKey: string,
   logs: Log[],
-  ignoreTimeouts: boolean
+  ignoreTimeouts: boolean,
+  timeout: number
 ): Promise<void> {
-  const http: httpm.HttpClient = getClient(apiKey)
+  const http: httpm.HttpClient = getClient(apiKey, timeout)
   let errors = 0
 
-  core.debug(`About to send ${logs.length} logs`)
+  core.debug(`About to send ${logs.length} logs to ${logApiURL}/v1/input`)
   for (const log of logs) {
     try {
       const res: httpm.HttpClientResponse = await http.post(