Fix scheduler readme and hints (#130)

* fix scheduler readme and hints

* undo -u=

* gracefully handle 202 response

* refactor the scheduler endpoint input

Author: maorb-dev

README.md

@@ -596,11 +596,11 @@ DESCRIPTION
   Create a new scheduler job for an app
 
 EXAMPLES
-  $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "/my-endpoint"
+  $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "my-endpoint"
 
-  $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "/my-endpoint" -n "My-special-job" -d "My description"
+  $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "my-endpoint" -n "My-special-job" -d "My description"
 
-  $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "/my-endpoint" -r 3 -b 10 -t 60
+  $ mapps scheduler:create -a APP_ID -s "0 * * * *" -u "my-endpoint" -r 3 -b 10 -t 60
 ```
 
 _See code: [src/commands/scheduler/create.ts](https://github.com/mondaycom/monday-apps-cli/blob/v4.7.2/src/commands/scheduler/create.ts)_
@@ -714,7 +714,7 @@ DESCRIPTION
 EXAMPLES
   $ mapps scheduler:update -a APP_ID -n "my-job" -s "0 * * * *"
 
-  $ mapps scheduler:update -a APP_ID -n "my-job" -u "/my-endpoint"
+  $ mapps scheduler:update -a APP_ID -n "my-job" -u "my-endpoint"
 
   $ mapps scheduler:update -a APP_ID -n "my-job" -d "My description" -r 3 -b 10 -t 60
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaycom/apps-cli",
-  "version": "4.7.3",
+  "version": "4.7.4",
   "description": "A cli tool to manage apps (and monday-code projects) in monday.com",
   "author": "monday.com Apps Team",
   "type": "module",

src/commands/scheduler/create.ts

@@ -7,14 +7,15 @@ import { SchedulerService } from 'src/services/scheduler-service';
 import { printJobs, validateCronExpression, validateTargetUrl } from 'src/services/scheduler-service.utils';
 import logger from 'src/utils/logger';
 import { chooseRegionIfNeeded, getRegionFromString } from 'src/utils/region';
+import { addPrefixIfNotExists } from 'src/utils/urls-builder';
 import { isDefined } from 'src/utils/validations';
 
 export default class SchedulerCreate extends AuthenticatedCommand {
   static description = 'Create a new scheduler job for an app';
   static examples = [
-    '<%= config.bin %> <%= command.id %> -a APP_ID -s "0 * * * *" -u "/my-endpoint"',
-    '<%= config.bin %> <%= command.id %> -a APP_ID -s "0 * * * *" -u "/my-endpoint" -n "My-special-job" -d "My description"',
-    '<%= config.bin %> <%= command.id %> -a APP_ID -s "0 * * * *" -u "/my-endpoint" -r 3 -b 10 -t 60',
+    '<%= config.bin %> <%= command.id %> -a APP_ID -s "0 * * * *" -u "my-endpoint"',
+    '<%= config.bin %> <%= command.id %> -a APP_ID -s "0 * * * *" -u "my-endpoint" -n "My-special-job" -d "My description"',
+    '<%= config.bin %> <%= command.id %> -a APP_ID -s "0 * * * *" -u "my-endpoint" -r 3 -b 10 -t 60',
   ];
 
   static flags = SchedulerCreate.serializeFlags(SchedulerFlags);
@@ -33,6 +34,7 @@ export default class SchedulerCreate extends AuthenticatedCommand {
       if (!schedule) schedule = await PromptService.promptInput(SchedulerMessages.schedule, true);
       validateCronExpression(schedule);
       if (!targetUrl) targetUrl = await PromptService.promptInput(SchedulerMessages.targetUrl, true);
+      targetUrl = addPrefixIfNotExists(targetUrl, '/');
       validateTargetUrl(targetUrl);
       if (!description) description = await PromptService.promptInput(SchedulerMessages.description, false, true);
       if (!maxRetries) maxRetries = await PromptService.promptInputNumber(SchedulerMessages.maxRetries, false, true);

src/commands/scheduler/update.ts

@@ -8,13 +8,14 @@ import { printJobs, validateCronExpression, validateTargetUrl } from 'src/servic
 import { UpdateJobRequest } from 'src/types/services/scheduler-service';
 import logger from 'src/utils/logger';
 import { chooseRegionIfNeeded, getRegionFromString } from 'src/utils/region';
+import { addPrefixIfNotExists } from 'src/utils/urls-builder';
 import { isDefined, isDefinedAndNotEmpty } from 'src/utils/validations';
 
 export default class SchedulerUpdate extends AuthenticatedCommand {
   static description = 'Update a scheduler job for an app';
   static examples = [
     '<%= config.bin %> <%= command.id %> -a APP_ID -n "my-job" -s "0 * * * *"',
-    '<%= config.bin %> <%= command.id %> -a APP_ID -n "my-job" -u "/my-endpoint"',
+    '<%= config.bin %> <%= command.id %> -a APP_ID -n "my-job" -u "my-endpoint"',
     '<%= config.bin %> <%= command.id %> -a APP_ID -n "my-job" -d "My description" -r 3 -b 10 -t 60',
   ];
 
@@ -45,6 +46,7 @@ export default class SchedulerUpdate extends AuthenticatedCommand {
       if (!schedule) schedule = await PromptService.promptInput(SchedulerMessages.schedule, false, true);
       if (schedule) validateCronExpression(schedule);
       if (!targetUrl) targetUrl = await PromptService.promptInput(SchedulerMessages.targetUrl, false, true);
+      targetUrl = addPrefixIfNotExists(targetUrl, '/');
       if (targetUrl) validateTargetUrl(targetUrl);
       if (!maxRetries) maxRetries = await PromptService.promptInputNumber(SchedulerMessages.maxRetries, false, true);
       if (!minBackoffDuration)

src/commands/storage/remove-data.ts

@@ -16,6 +16,8 @@ const MESSAGES = {
   force: 'Skip the confirmation step',
   operationAborted: 'Operation aborted',
   removingData: 'Removing data...',
+  operationAccepted: 'We got your request, it will take a few minutes to complete',
+  operationSuccess: 'Operation completed successfully',
 };
 
 export default class RemoveData extends AuthenticatedCommand {
@@ -61,7 +63,13 @@ export default class RemoveData extends AuthenticatedCommand {
       }
 
       logger.log(MESSAGES.removingData);
-      await removeAppStorageDataForAccount(appId, clientAccountId);
+      const response = await removeAppStorageDataForAccount(appId, clientAccountId);
+
+      if (response.statusCode === 202) {
+        logger.log(MESSAGES.operationAccepted);
+      } else {
+        logger.log(MESSAGES.operationSuccess);
+      }
 
       this.preparePrintCommand(this, { appId, clientAccountId, force });
     } catch (error: unknown) {

src/consts/scheduler/messages.ts

@@ -5,7 +5,7 @@ export const SchedulerMessages = {
   name: 'Scheduled job name (no whitespace)',
   description: 'Scheduled job description (optional)',
   schedule: 'Cron expression for the job schedule (relative to UTC)',
-  targetUrl: 'Target URL path for the job (must start with /, will be relative to /mndy-cronjob)',
+  targetUrl: 'Target URL path for the job endpoint (will be relative to /mndy-cronjob/<YOUR_ENDPOINT>)',
   maxRetries: 'Maximum number of retries for failed jobs (optional)',
   minBackoffDuration: 'Minimum backoff duration in seconds between retries (optional)',
   timeout: 'Job execution timeout in seconds (optional)',

src/services/api-service.ts

@@ -99,7 +99,7 @@ export async function execute<T extends BaseResponseHttpMetaData>(
     });
 
     logger.debug({ res: response }, DEBUG_TAG);
-    const result = { ...response.data, statusCode: 200, headers: response.headers };
+    const result = { ...response.data, statusCode: response?.status || 200, headers: response.headers };
     const validatedResult = validateResponseIfError(result, schemaValidator);
     return (validatedResult as T) || result;
   } catch (error: any | Error | AxiosError) {

src/services/apps-service.ts

@@ -12,7 +12,7 @@ import { getTunnelingDomain } from 'services/tunnel-service';
 import { AppCreateCommandTasksContext } from 'types/commands/app-create';
 import { HttpError } from 'types/errors';
 import { AccountId, AppId } from 'types/general';
-import { HttpMethodTypes } from 'types/services/api-service';
+import { BaseResponseHttpMetaData, HttpMethodTypes } from 'types/services/api-service';
 import { App, CreateAppResponse, ListAppResponse } from 'types/services/apps-service';
 import { appsUrlBuilder } from 'utils/urls-builder';
 
@@ -107,11 +107,14 @@ export const checkIfAppSupportMultiRegion = async (appId: number): Promise<boole
   return Boolean(app.mondayCodeConfig?.isMultiRegion);
 };
 
-export const removeAppStorageDataForAccount = async (appId: AppId, targetAccountId: AccountId): Promise<void> => {
+export const removeAppStorageDataForAccount = async <T extends BaseResponseHttpMetaData>(
+  appId: AppId,
+  targetAccountId: AccountId,
+): Promise<T> => {
   try {
     const path = removeAppStorageDataForAccountUrl(appId, targetAccountId);
     const url = appsUrlBuilder(path);
-    await execute(
+    return await execute<T>(
       {
         url,
         headers: { Accept: 'application/json' },

src/utils/urls-builder.ts

@@ -10,4 +10,12 @@ const getLastParam = (url: string): string => {
   return url.split('/').pop() || url;
 };
 
-export { appsUrlBuilder, getLastParam };
+const addPrefixIfNotExists = (url: string, prefix: string): string => {
+  if (url.startsWith(prefix)) {
+    return url;
+  }
+
+  return `${prefix}${url}`;
+};
+
+export { addPrefixIfNotExists, appsUrlBuilder, getLastParam };