Debugging unit tests with Zod

[MartinM85]

When implementing a new command I'm facing a weird issue with Zod. I have a Zod schema

const options = globalOptionsZod
  .extend({
    workingDays: z.string().transform((value) => value.split(',')).pipe(z.enum(['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday']).array()).optional(),
  })
  .strict();

The workingDays option is a comma separated list of days transformed to array of enums.

In the command implementation, I send the workingDays in the request body.

const requestOptions: CliRequestOptions = {
  url: requestUrl,
  headers: {
    accept: 'application/json;odata.metadata=none'
  },
  responseType: 'json',
  data: {
      workingHours: {
        daysOfWeek: args.options.workingDays
      }
    }
};

It works fine when executing the command like

m365 command --workingDays 'monday,tuesday,wednesday,thursday,friday'

When debugging the command I see the request (the workingDays option is transformed to the array)

{
  "url": "https://graph.microsoft.com/v1.0/me/mailboxSettings",
  "method": "patch",
  "headers": {
    "Accept": "application/json;odata.metadata=none",
    "user-agent": "NONISV|SharePointPnP|CLIMicrosoft365/10.3.0",
    "accept-encoding": "gzip, deflate",
    "X-ClientService-ClientTag": "M365CLI:10.3.0",
    "authorization": "Bearer ..."
  },
  "responseType": "json",
  "decompress": true,
  "data": {
    "workingHours": {
      "daysOfWeek": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ]
    }
  }
}

I have a unit test

it('updates working days of signed-in user', async () => {
  const patchStub = sinon.stub(request, 'patch').callsFake(async (opts) => {
    if (opts.url === `https://graph.microsoft.com/v1.0/me/mailboxSettings`) {
      return mailboxSettingsResponse;
    }

    throw 'Invalid request';
  });

  await command.action(logger, {
    options: {
      workingDays: 'monday,tuesday,wednesday,thursday,friday'
    }
  });

  assert.deepStrictEqual(patchStub.lastCall.args[0].data, {
    workingHours: {
      daysOfWeek: [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ]
    }
  });
});

But it fails because workingDays is not converted from string to an array

       updates working days of signed-in user:

      AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
+ actual - expected

  {
    workingHours: {
+     daysOfWeek: 'monday,tuesday,wednesday,thursday,friday'
-     daysOfWeek: [
-       'monday',
-       'tuesday',
-       'wednesday',
-       'thursday',
-       'friday'
-     ]
    }
  }
      + expected - actual

       {
         "workingHours": {
      -    "daysOfWeek": "monday,tuesday,wednesday,thursday,friday"
      +    "daysOfWeek": [
      +      "monday"
      +      "tuesday"
      +      "wednesday"
      +      "thursday"
      +      "friday"
      +    ]
         }
       }

I can't figure out if something is wrong in my implementation or in Zod library.

[MartinM85]

I've checked how the options are processed when a command is executing and in unit tests of commands that use ZodSchema it' necessary to parse the schema

it('updates working days of signed-in user', async () => {
  const patchStub = sinon.stub(request, 'patch').callsFake(async (opts) => {
    if (opts.url === `https://graph.microsoft.com/v1.0/me/mailboxSettings`) {
      return mailboxSettingsResponse;
    }

    throw 'Invalid request';
  });

  const result = commandOptionsSchema.safeParse({
    workingDays: 'monday,tuesday,wednesday,thursday,friday'
  });

  await command.action(logger, {
    options: result.data
  });

  assert.deepStrictEqual(patchStub.lastCall.args[0].data, {
    workingHours: {
      daysOfWeek: [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ]
    }
  });
});