Bugfix: Add debug option to log response headers by asein-sinch · Pull Request #219 · sinch/sinch-sdk-node

asein-sinch · 2025-12-02T22:35:24Z

How to enable debug logs:

import winston from 'winston';
const winstonLogger = winston.createLogger({
  level: 'debug',
  transports: [new winston.transports.Console()],
  format: winston.format.logstash(),
});

new SinchClient({ projectId, keyId, keySecret, logger:  winstonLogger});

Debug logs:

[Sinch SDK][Debug][AvailableRegionsApi][ListAvailableRegions][401]
HTTP method: GET
URL: https://numbers.api.sinch.com/v1/projects/37b62a7b-0177-429a-bb0b-e10f848de0b8/availableRegions?types=LOCAL&types=MOBILE
Response Headers:  Headers {
  [Symbol(map)]: [Object: null prototype] {
    'www-authenticate': [
      'Bearer error="invalid_token", error_description="Jwt expired at 2023-10-02T14:57:08Z", error_uri="https://tools.ietf.org/html/rfc6750#section-3.1"'
    ],
    'cache-control': [ 'no-cache, no-store, max-age=0, must-revalidate' ],
    pragma: [ 'no-cache' ],
    expires: [ '0' ],
    'x-content-type-options': [ 'nosniff' ],
    'strict-transport-security': [ 'max-age=31536000 ; includeSubDomains' ],
    'x-frame-options': [ 'DENY' ],
    'x-xss-protection': [ '0' ],
    'referrer-policy': [ 'no-referrer' ],
    'x-envoy-upstream-service-time': [ '2' ],
    date: [ 'Tue, 02 Dec 2025 22:25:38 GMT' ],
    server: [ 'istio-envoy' ],
    connection: [ 'close' ],
    'content-length': [ '0' ]
  }
}

JPPortier · 2025-12-03T07:28:36Z

+
+  private debug(context: ResponsePluginContext) {
+    if (context.requestOptions.logHeadersOnError && !context.response?.ok) {
+      console.debug(


We should think about supporting also for this SDK a logger interface.

Added logger

JPPortier · 2025-12-03T12:56:43Z

-        context.response?.headers,
+    if (!context.response?.ok) {
+      this.logger.debug(
+        `[Sinch SDK][Debug][${context.apiName}][${context.operationId}][${context.response?.status}]\nHTTP method: ${context.requestOptions.method}\nURL: ${context.url}\nResponse Headers: ${this.formatHeaders(context.response?.headers)}`,


What do you think about having the logger itself adding these formatting information ?

this.logger: will know "it is" SDK -> it will add it when emitting log

this.logger.debug: logger.debug function will know it is debug level then it will be added when emitting log

PROS:

all calls to logger will be prefixed by same ... prefix

all calls to logger./debug/info/..will have same prefix regarding log level

all logs will have same pattern [Sinch SDK][level] and no human error to forgot them services will call logger function

Use global console for SinchLogger fallbacks so tests can spy on warnings, and drop unused OAuth2 token request logger after v1.5-next error handling.

JPPortier · 2026-06-12T10:06:47Z

      this.lazyClient.getApiClient();
    } catch (error) {
-      console.error('Impossible to assign the new credentials to the SMS API');
+      new SinchLogger(this.lazyClient.sharedConfig.logger ?? console).error(


Here we are assuming we have to send a log onto console even if configuration could have been, by purpose of SDK user, to NOT have any logger (multliple times)

What do you think :

either we assume there is, by contract, a logger defined

test if null/undefined and do not log anything

Fixed 🟡
Removed all ?? console fallbacks; call sites use resolveLogger(...). logger: null → silent NOOP_LOGGER.
packages/sms/src/rest/v1/sms-domain-api.ts (and all other *-service.ts / *-domain-api.ts)

JPPortier · 2026-06-12T12:00:03Z

   * @param {SinchClientParameters} params - The object containing the Sinch credentials.
   */
  constructor(params: SinchClientParameters) {
+    if (!params.logger) {


See comment about using or not a default logger.
What if for any purpose an end user do not want any log ? (thinking about a logging call causing an issue)
It won't be possible.
We could have distinction between null VS undefined to provide

null -> a dummy logger not logging anything

undefined -> a default logger based onto init of SinchLogger

And, by contract we could remove all validation against not defined logger. e.g.: https://github.com/sinch/sinch-sdk-node/pull/219/changes#diff-85a0299065d0f2bd71e5151e1983edb3447d2d9770692d9f8ac007467246bc20R69

Fixed 🟡

null -> silent

undefined -> default console

packages/sdk-core/src/sinch-client.ts resolved once via resolveLogger() in SinchClient and each Service constructor.

JPPortier · 2026-06-12T16:19:29Z

  ): PluginRunner<V | Record<string, unknown>, V> {
    return {
      transform: (res: V) => {
+        this.debug(context);


🤔
Not a big fan to have a dependency onto logger/SinchLogger here.
Finally: it is "just" a container.

We could think about who should be responsible of logging.
Here, not sure a "simple" container should log itself something.
It is an exception response. Why not having transport layer performing the log itself and removing dependency onto any logger here?

Fixed 🟡
Logger removed from ExceptionResponse. Failed HTTP debug logging moved to ApiFetchClient.
packages/sdk-client/src/client/api-fetch-client.ts

JPPortier · 2026-06-12T16:21:27Z

+export interface Logger {
+  debug(message: string, ...meta: any[]): void;
+  info(message: string, ...meta: any[]): void;
+  warn(message: string, ...meta: any[]): void;
+  error(message: string, ...meta: any[]): void;
+}


We could imagine, for performance/memory consumption purpose having interface defining a callback called by logger when the message will be really send.
Then; it will avoid to format message before calling logger which will finally decide to not log anything because of required severity is not reached.

Done 🟢
Logger methods now accept either a plain string or a callback () => string. The SDK builds the message only when the logger actually emits it.

JPPortier · 2026-06-12T16:21:53Z

  ...SupportedMailgunRegion,
 };
+
+export interface LoggerParameters {


Strictly speaking; this is nor defining "logger parameters" but the logger itself

Fixed 🟡
Renamed to WithLogger

… API classes

…hLogger

… and warning messages

…ger calls across multiple files

asein-sinch requested a review from rpredescu-sinch December 2, 2025 22:35

asein-sinch requested review from JPPortier and matsk-sinch as code owners December 2, 2025 22:35

JPPortier reviewed Dec 3, 2025

View reviewed changes

asein-sinch requested a review from JPPortier December 3, 2025 18:35

JPPortier approved these changes Dec 4, 2025

View reviewed changes

Comment thread packages/sdk-client/src/logger/logger.ts

asein-sinch and others added 4 commits June 11, 2026 10:27

Bugfix: Add debug option to log response headers

2e07e59

Fix comment

f8cad96

Fix comments

21161c9

Fix post-rebase logger integration issues in sdk-client.

71c6593

Use global console for SinchLogger fallbacks so tests can spy on warnings, and drop unused OAuth2 token request logger after v1.5-next error handling.

Hurus111 force-pushed the Bugfix_Add-debug-option-to-log-response-headers branch from fe7b383 to 71c6593 Compare June 11, 2026 08:52

Hurus111 changed the base branch from v1.2 to v1.5-next June 11, 2026 09:01

Hurus111 requested review from Hurus111 and edu-sinch as code owners June 11, 2026 09:01

Hurus111 requested a review from JPPortier June 12, 2026 07:27

JPPortier reviewed Jun 12, 2026

View reviewed changes

Hurus111 added 5 commits June 15, 2026 15:28

feat(sdk-client): add configurable logging primitives

c74f552

refactor(sdk-client): move failed HTTP debug logging to ApiFetchClient

48ee36b

feat: resolve logger at entry points and remove console fallbacks

ece0485

test(sdk-client): add logger tests and update service logging assertions

e1577ef

docs(sdk-client): changelog for v1.5.0 configurable logging

536d161

Hurus111 requested a review from JPPortier June 15, 2026 14:30

Hurus111 added 5 commits June 17, 2026 18:03

feat(sdk-client): add logger example script and update package.json

f01225c

refactor(sdk-client): replace SinchLogger with direct logger calls in…

0e1f4b0

… API classes

refactor(sdk-client): enhance resolveLogger to wrap loggers with Sinc…

620695c

…hLogger

refactor(fax): simplify convertToSupportedFileType by removing logger…

bef88be

… and warning messages

refactor(sdk-client): remove SinchLogger usage in favor of direct log…

dad3cf7

…ger calls across multiple files

Conversation

asein-sinch commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

asein-sinch commented Dec 2, 2025 •

edited

Loading