@datadog/datadog-ci 0.17.6-alpha → 0.17.9

package/dist/helpers/tags.d.ts

@@ -0,0 +1,28 @@
+export declare const CI_PIPELINE_URL = "ci.pipeline.url";
+export declare const CI_PROVIDER_NAME = "ci.provider.name";
+export declare const CI_PIPELINE_ID = "ci.pipeline.id";
+export declare const CI_PIPELINE_NAME = "ci.pipeline.name";
+export declare const CI_PIPELINE_NUMBER = "ci.pipeline.number";
+export declare const CI_WORKSPACE_PATH = "ci.workspace_path";
+export declare const GIT_REPOSITORY_URL = "git.repository_url";
+export declare const CI_JOB_URL = "ci.job.url";
+export declare const CI_JOB_NAME = "ci.job.name";
+export declare const CI_STAGE_NAME = "ci.stage.name";
+export declare const CI_LEVEL = "_dd.ci.level";
+export declare const CI_BUILD_LEVEL = "_dd.ci.build_level";
+export declare const GIT_BRANCH = "git.branch";
+export declare const GIT_COMMIT_AUTHOR_DATE = "git.commit.author.date";
+export declare const GIT_COMMIT_AUTHOR_EMAIL = "git.commit.author.email";
+export declare const GIT_COMMIT_AUTHOR_NAME = "git.commit.author.name";
+export declare const GIT_COMMIT_COMMITTER_DATE = "git.commit.committer.date";
+export declare const GIT_COMMIT_COMMITTER_EMAIL = "git.commit.committer.email";
+export declare const GIT_COMMIT_COMMITTER_NAME = "git.commit.committer.name";
+export declare const GIT_COMMIT_MESSAGE = "git.commit.message";
+export declare const GIT_SHA = "git.commit.sha";
+export declare const GIT_TAG = "git.tag";
+export declare const SPAN_TYPE = "span.type";
+/**
+ * Receives an array of the form ['key:value', 'key2:value2']
+ * and returns an object of the form {key: 'value', key2: 'value2'}
+ */
+export declare const parseTags: (tags: string[]) => {};

package/dist/helpers/upload.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="node" />
+import FormData from 'form-data';
+import { ReadStream } from 'fs';
+import { ApiKeyValidator } from './apikey';
+import { RequestBuilder } from './interfaces';
+/** Multipart payload destined to be sent to Datadog's API
+ */
+export interface MultipartPayload {
+    content: Map<string, MultipartValue>;
+}
+export interface MultipartValue {
+    options?: FormData.AppendOptions | string;
+    value: string | ReadStream;
+}
+export interface UploadOptions {
+    /** ApiKeyValidator (optional) throws an InvalidConfigurationException when upload fails because
+     * of an invalid API key. Callers should most likely catch this exception and display it as a
+     * nice error message.
+     */
+    apiKeyValidator?: ApiKeyValidator;
+    /** Retries is the amount of upload retries before giving up. Some requests are never retried
+     * (400, 413).
+     */
+    retries: number;
+    /** Callback when upload fails (retries are not considered as failure)
+     */
+    onError(error: Error): void;
+    /** Callback to execute before retries
+     */
+    onRetry(error: Error, attempts: number): void;
+    /** Callback to execute before upload.
+     */
+    onUpload(): void;
+}
+export declare enum UploadStatus {
+    Success = 0,
+    Failure = 1,
+    Skipped = 2
+}
+/** Upload a MultipartPayload to Datadog's API using the provided RequestBuilder.
+ * This handles retries as well as logging information about upload if a logger is provided in
+ * the options
+ */
+export declare const upload: (requestBuilder: RequestBuilder) => (payload: MultipartPayload, opts: UploadOptions) => Promise<UploadStatus>;

package/dist/helpers/upload.js

@@ -13,9 +13,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.upload = exports.UploadStatus = void 0;
-const async_retry_1 = __importDefault(require("async-retry"));
 const form_data_1 = __importDefault(require("form-data"));
-const errorCodesNoRetry = [400, 403, 413];
+const retry_1 = require("./retry");
 var UploadStatus;
 (function (UploadStatus) {
     UploadStatus[UploadStatus["Success"] = 0] = "Success";
@@ -29,10 +28,10 @@ var UploadStatus;
 const upload = (requestBuilder) => (payload, opts) => __awaiter(void 0, void 0, void 0, function* () {
     opts.onUpload();
     try {
-        yield uploadWithRetry(requestBuilder, {
+        yield retry_1.retryRequest(() => uploadMultipart(requestBuilder, payload), {
             onRetry: opts.onRetry,
             retries: opts.retries,
-        })(payload);
+        });
         return UploadStatus.Success;
     }
     catch (error) {
@@ -52,31 +51,10 @@ const upload = (requestBuilder) => (payload, opts) => __awaiter(void 0, void 0,
     }
 });
 exports.upload = upload;
-const uploadWithRetry = (requestBuilder, retryOpts) => (payload) => __awaiter(void 0, void 0, void 0, function* () {
-    // Upload function, passed to async-retry
-    const doUpload = (bail) => __awaiter(void 0, void 0, void 0, function* () {
-        try {
-            yield uploadMultipart(requestBuilder)(payload);
-        }
-        catch (error) {
-            if (error.response) {
-                // If it's an axios error
-                if (!errorCodesNoRetry.includes(error.response.status)) {
-                    // And a status code that is not excluded from retries, throw the error so that upload is retried
-                    throw error;
-                }
-            }
-            // If it's another error or an axios error we don't want to retry, bail
-            bail(error);
-        }
-    });
-    // Do the actual call
-    return async_retry_1.default(doUpload, retryOpts);
-});
 // Dependency follows-redirects sets a default maxBodyLength of 10 MB https://github.com/follow-redirects/follow-redirects/blob/b774a77e582b97174813b3eaeb86931becba69db/index.js#L391
 // We don't want any hard limit enforced by the CLI, the backend will enforce a max size by returning 413 errors.
 const maxBodyLength = Infinity;
-const uploadMultipart = (request) => (payload) => __awaiter(void 0, void 0, void 0, function* () {
+const uploadMultipart = (request, payload) => __awaiter(void 0, void 0, void 0, function* () {
     const form = new form_data_1.default();
     payload.content.forEach((value, key) => {
         form.append(key, value.value, value.options);

package/dist/helpers/user-provided-git.d.ts

@@ -0,0 +1 @@
+export declare const getUserGitMetadata: () => {};

package/dist/helpers/utils.d.ts

@@ -0,0 +1,31 @@
+import { AxiosRequestConfig } from 'axios';
+import ProxyAgent from 'proxy-agent';
+import type { SpanTags } from './interfaces';
+export declare const pick: <T extends object, K extends keyof T>(base: T, keys: K[]) => Partial<T>;
+export declare const getConfig: (configPath: string) => Promise<any>;
+export declare const parseConfigFile: <T>(baseConfig: T, configPath?: string | undefined) => Promise<T>;
+declare type ProxyType = 'http' | 'https' | 'socks' | 'socks4' | 'socks4a' | 'socks5' | 'socks5h' | 'pac+data' | 'pac+file' | 'pac+ftp' | 'pac+http' | 'pac+https';
+export interface ProxyConfiguration {
+    auth?: {
+        password: string;
+        username: string;
+    };
+    host?: string;
+    port?: number;
+    protocol: ProxyType;
+}
+export declare const getProxyUrl: (options?: ProxyConfiguration | undefined) => string;
+export interface RequestOptions {
+    apiKey: string;
+    appKey?: string;
+    baseUrl: string;
+    headers?: Map<string, string>;
+    overrideUrl?: string;
+    proxyOpts?: ProxyConfiguration;
+}
+export declare const getRequestBuilder: (options: RequestOptions) => (args: AxiosRequestConfig) => import("axios").AxiosPromise<any>;
+export declare const getProxyAgent: (proxyOpts?: ProxyConfiguration | undefined) => ReturnType<typeof ProxyAgent>;
+export declare const getApiHostForSite: (site: string) => string;
+export declare const buildPath: (...args: string[]) => string;
+export declare const removeEmptyValues: (tags: SpanTags) => {};
+export {};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datadog/datadog-ci",
-  "version": "0.17.6-alpha",
+  "version": "0.17.9",
   "description": "Run datadog actions from the CI.",
   "main": "dist/index.js",
   "repository": "https://github.com/DataDog/datadog-ci",
@@ -79,6 +79,7 @@
     "@types/xml2js": "0.4.9",
     "jest": "27.0.5",
     "jest-environment-node": "27.0.5",
+    "jest-matcher-specific-error": "1.0.0",
     "prettier": "2.0.5",
     "proxy": "1.0.2",
     "ts-jest": "27.0.3",