@redocly/cli 1.25.2 → 1.25.4

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @redocly/cli
 
+## 1.25.4
+
+### Patch Changes
+
+- Added a warning message to the `push` and `push-status` commands to notify users about upcoming or ongoing resource deprecation.
+- Updated @redocly/openapi-core to v1.25.4.
+
+## 1.25.3
+
+### Patch Changes
+
+- Updated @redocly/openapi-core to v1.25.3.
+
 ## 1.25.2
 
 ### Patch Changes

package/lib/cms/api/__tests__/api.client.test.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_fetch_1 = require("node-fetch");
 const FormData = require("form-data");
+const colorette_1 = require("colorette");
 const api_client_1 = require("../api-client");
 jest.mock('node-fetch', () => ({
     default: jest.fn(),
@@ -20,7 +21,7 @@ describe('ApiClient', () => {
     describe('getDefaultBranch()', () => {
         let apiClient;
         beforeEach(() => {
-            apiClient = new api_client_1.ReuniteApiClient({ domain: testDomain, apiKey: testToken, version, command });
+            apiClient = new api_client_1.ReuniteApi({ domain: testDomain, apiKey: testToken, version, command });
         });
         it('should get default project branch', async () => {
             mockFetchResponse({
@@ -70,19 +71,19 @@ describe('ApiClient', () => {
             mountBranchName: 'remote-mount-branch-name',
             mountPath: 'remote-mount-path',
         };
+        const responseMock = {
+            id: 'remote-id',
+            type: 'CICD',
+            mountPath: 'remote-mount-path',
+            mountBranchName: 'remote-mount-branch-name',
+            organizationId: testOrg,
+            projectId: testProject,
+        };
         let apiClient;
         beforeEach(() => {
-            apiClient = new api_client_1.ReuniteApiClient({ domain: testDomain, apiKey: testToken, version, command });
+            apiClient = new api_client_1.ReuniteApi({ domain: testDomain, apiKey: testToken, version, command });
         });
         it('should upsert remote', async () => {
-            const responseMock = {
-                id: 'remote-id',
-                type: 'CICD',
-                mountPath: 'remote-mount-path',
-                mountBranchName: 'remote-mount-branch-name',
-                organizationId: testOrg,
-                projectId: testProject,
-            };
             mockFetchResponse({
                 ok: true,
                 json: jest.fn().mockResolvedValue(responseMock),
@@ -162,7 +163,7 @@ describe('ApiClient', () => {
         };
         let apiClient;
         beforeEach(() => {
-            apiClient = new api_client_1.ReuniteApiClient({ domain: testDomain, apiKey: testToken, version, command });
+            apiClient = new api_client_1.ReuniteApi({ domain: testDomain, apiKey: testToken, version, command });
         });
         it('should push to remote', async () => {
             let passedFormData = new FormData();
@@ -216,4 +217,117 @@ describe('ApiClient', () => {
             await expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new api_client_1.ReuniteApiError('Failed to push. Not found.', 404));
         });
     });
+    describe('Sunset header', () => {
+        const upsertRemoteMock = {
+            requestFn: () => apiClient.remotes.upsert(testOrg, testProject, {
+                mountBranchName: 'remote-mount-branch-name',
+                mountPath: 'remote-mount-path',
+            }),
+            responseBody: {
+                id: 'remote-id',
+                type: 'CICD',
+                mountPath: 'remote-mount-path',
+                mountBranchName: 'remote-mount-branch-name',
+                organizationId: testOrg,
+                projectId: testProject,
+            },
+        };
+        const getDefaultBranchMock = {
+            requestFn: () => apiClient.remotes.getDefaultBranch(testOrg, testProject),
+            responseBody: {
+                branchName: 'test-branch',
+            },
+        };
+        const pushMock = {
+            requestFn: () => apiClient.remotes.push(testOrg, testProject, {
+                remoteId: 'test-remote-id',
+                commit: {
+                    message: 'test-message',
+                    author: {
+                        name: 'test-name',
+                        email: 'test-email',
+                    },
+                    branchName: 'test-branch-name',
+                },
+            }, [{ path: 'some-file.yaml', stream: Buffer.from('text content') }]),
+            responseBody: {
+                branchName: 'rem/cicd/rem_01he7sr6ys2agb7w0g9t7978fn-main',
+                hasChanges: true,
+                files: [
+                    {
+                        type: 'file',
+                        name: 'some-file.yaml',
+                        path: 'docs/remotes/some-file.yaml',
+                        lastModified: 1698925132394.2993,
+                        mimeType: 'text/yaml',
+                    },
+                ],
+                commitSha: 'bb23a2f8e012ac0b7b9961b57fb40d8686b21b43',
+                outdated: false,
+            },
+        };
+        const endpointMocks = [upsertRemoteMock, getDefaultBranchMock, pushMock];
+        let apiClient;
+        beforeEach(() => {
+            apiClient = new api_client_1.ReuniteApi({ domain: testDomain, apiKey: testToken, version, command });
+        });
+        it.each(endpointMocks)('should report endpoint sunset in the past', async ({ responseBody, requestFn }) => {
+            jest.spyOn(process.stdout, 'write').mockImplementationOnce(() => true);
+            const sunsetDate = new Date('2024-09-06T12:30:32.456Z');
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue(responseBody),
+                headers: new Headers({
+                    Sunset: sunsetDate.toISOString(),
+                }),
+            });
+            await requestFn();
+            apiClient.reportSunsetWarnings();
+            expect(process.stdout.write).toHaveBeenCalledWith((0, colorette_1.red)(`The "push" command is not compatible with your version of Redocly CLI. Update to the latest version by running "npm install @redocly/cli@latest".\n\n`));
+        });
+        it.each(endpointMocks)('should report endpoint sunset in the future', async ({ responseBody, requestFn }) => {
+            jest.spyOn(process.stdout, 'write').mockImplementationOnce(() => true);
+            const sunsetDate = new Date(Date.now() + 1000 * 60 * 60 * 24);
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue(responseBody),
+                headers: new Headers({
+                    Sunset: sunsetDate.toISOString(),
+                }),
+            });
+            await requestFn();
+            apiClient.reportSunsetWarnings();
+            expect(process.stdout.write).toHaveBeenCalledWith((0, colorette_1.yellow)(`The "push" command will be incompatible with your version of Redocly CLI after ${sunsetDate.toLocaleString()}. Update to the latest version by running "npm install @redocly/cli@latest".\n\n`));
+        });
+        it('should report only expired resource', async () => {
+            jest.spyOn(process.stdout, 'write').mockImplementationOnce(() => true);
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue(upsertRemoteMock.responseBody),
+                headers: new Headers({
+                    Sunset: new Date('2024-08-06T12:30:32.456Z').toISOString(),
+                }),
+            });
+            await upsertRemoteMock.requestFn();
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue(getDefaultBranchMock.responseBody),
+                headers: new Headers({
+                    Sunset: new Date(Date.now() + 1000 * 60 * 60 * 24).toISOString(),
+                }),
+            });
+            await getDefaultBranchMock.requestFn();
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue(pushMock.responseBody),
+                headers: new Headers({
+                    Sunset: new Date('2024-08-06T12:30:32.456Z').toISOString(),
+                }),
+            });
+            await pushMock.requestFn();
+            apiClient.reportSunsetWarnings();
+            expect(process.stdout.write).toHaveBeenCalledTimes(1);
+            expect(process.stdout.write).toHaveBeenCalledWith((0, colorette_1.red)(`The "push" command is not compatible with your version of Redocly CLI. Update to the latest version by running "npm install @redocly/cli@latest".\n\n`));
+        });
+    });
 });

package/lib/cms/api/api-client.d.ts

@@ -2,21 +2,25 @@ import { type FetchWithTimeoutOptions } from '../../utils/fetch-with-timeout';
 import type { Response } from 'node-fetch';
 import type { ReadStream } from 'fs';
 import type { ListRemotesResponse, PushResponse, UpsertRemoteResponse } from './types';
+interface BaseApiClient {
+    request(url: string, options: FetchWithTimeoutOptions): Promise<Response>;
+}
+type CommandOption = 'push' | 'push-status';
+export type SunsetWarning = {
+    sunsetDate: Date;
+    isSunsetExpired: boolean;
+};
+export type SunsetWarningsBuffer = SunsetWarning[];
 export declare class ReuniteApiError extends Error {
     status: number;
     constructor(message: string, status: number);
 }
-declare class ReuniteBaseApiClient {
-    protected version: string;
-    protected command: string;
-    constructor(version: string, command: string);
-    protected getParsedResponse<T>(response: Response): Promise<T>;
-    protected request(url: string, options: FetchWithTimeoutOptions): Promise<Response>;
-}
-declare class RemotesApiClient extends ReuniteBaseApiClient {
+declare class RemotesApi {
+    private client;
     private readonly domain;
     private readonly apiKey;
-    constructor(domain: string, apiKey: string, version: string, command: string);
+    constructor(client: BaseApiClient, domain: string, apiKey: string);
+    protected getParsedResponse<T>(response: Response): Promise<T>;
     getDefaultBranch(organizationId: string, projectId: string): Promise<string>;
     upsert(organizationId: string, projectId: string, remote: {
         mountPath: string;
@@ -37,14 +41,18 @@ declare class RemotesApiClient extends ReuniteBaseApiClient {
         pushId: string;
     }): Promise<PushResponse>;
 }
-export declare class ReuniteApiClient {
-    remotes: RemotesApiClient;
+export declare class ReuniteApi {
+    private apiClient;
+    private version;
+    private command;
+    remotes: RemotesApi;
     constructor({ domain, apiKey, version, command, }: {
         domain: string;
         apiKey: string;
         version: string;
-        command: 'push' | 'push-status';
+        command: CommandOption;
     });
+    reportSunsetWarnings(): void;
 }
 export type PushPayload = {
     remoteId: string;

package/lib/cms/api/api-client.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReuniteApiClient = exports.ReuniteApiError = void 0;
+exports.ReuniteApi = exports.ReuniteApiError = void 0;
+const colorette_1 = require("colorette");
 const FormData = require("form-data");
 const fetch_with_timeout_1 = require("../../utils/fetch-with-timeout");
 class ReuniteApiError extends Error {
@@ -10,38 +11,70 @@ class ReuniteApiError extends Error {
     }
 }
 exports.ReuniteApiError = ReuniteApiError;
-class ReuniteBaseApiClient {
+class ReuniteApiClient {
     constructor(version, command) {
         this.version = version;
         this.command = command;
+        this.sunsetWarnings = [];
     }
-    async getParsedResponse(response) {
-        const responseBody = await response.json();
-        if (response.ok) {
-            return responseBody;
-        }
-        throw new ReuniteApiError(`${responseBody.title || response.statusText || 'Unknown error'}.`, response.status);
-    }
-    request(url, options) {
+    async request(url, options) {
         const headers = {
             ...options.headers,
             'user-agent': `redocly-cli/${this.version.trim()} ${this.command}`,
         };
-        return (0, fetch_with_timeout_1.default)(url, {
+        const response = await (0, fetch_with_timeout_1.default)(url, {
             ...options,
             headers,
         });
+        this.collectSunsetWarning(response);
+        return response;
+    }
+    collectSunsetWarning(response) {
+        const sunsetTime = this.getSunsetDate(response);
+        if (!sunsetTime)
+            return;
+        const sunsetDate = new Date(sunsetTime);
+        if (sunsetTime > Date.now()) {
+            this.sunsetWarnings.push({
+                sunsetDate,
+                isSunsetExpired: false,
+            });
+        }
+        else {
+            this.sunsetWarnings.push({
+                sunsetDate,
+                isSunsetExpired: true,
+            });
+        }
+    }
+    getSunsetDate(response) {
+        const { headers } = response;
+        if (!headers) {
+            return;
+        }
+        const sunsetDate = headers.get('sunset') || headers.get('Sunset');
+        if (!sunsetDate) {
+            return;
+        }
+        return Date.parse(sunsetDate);
     }
 }
-class RemotesApiClient extends ReuniteBaseApiClient {
-    constructor(domain, apiKey, version, command) {
-        super(version, command);
+class RemotesApi {
+    constructor(client, domain, apiKey) {
+        this.client = client;
         this.domain = domain;
         this.apiKey = apiKey;
     }
+    async getParsedResponse(response) {
+        const responseBody = await response.json();
+        if (response.ok) {
+            return responseBody;
+        }
+        throw new ReuniteApiError(`${responseBody.title || response.statusText || 'Unknown error'}.`, response.status);
+    }
     async getDefaultBranch(organizationId, projectId) {
         try {
-            const response = await this.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/source`, {
+            const response = await this.client.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/source`, {
                 timeout: fetch_with_timeout_1.DEFAULT_FETCH_TIMEOUT,
                 method: 'GET',
                 headers: {
@@ -62,7 +95,7 @@ class RemotesApiClient extends ReuniteBaseApiClient {
     }
     async upsert(organizationId, projectId, remote) {
         try {
-            const response = await this.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/remotes`, {
+            const response = await this.client.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/remotes`, {
                 timeout: fetch_with_timeout_1.DEFAULT_FETCH_TIMEOUT,
                 method: 'POST',
                 headers: {
@@ -103,7 +136,7 @@ class RemotesApiClient extends ReuniteBaseApiClient {
         }
         payload.isMainBranch && formData.append('isMainBranch', 'true');
         try {
-            const response = await this.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/pushes`, {
+            const response = await this.client.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/pushes`, {
                 method: 'POST',
                 headers: {
                     Authorization: `Bearer ${this.apiKey}`,
@@ -122,7 +155,7 @@ class RemotesApiClient extends ReuniteBaseApiClient {
     }
     async getRemotesList({ organizationId, projectId, mountPath, }) {
         try {
-            const response = await this.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/remotes?filter=mountPath:/${mountPath}/`, {
+            const response = await this.client.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/remotes?filter=mountPath:/${mountPath}/`, {
                 timeout: fetch_with_timeout_1.DEFAULT_FETCH_TIMEOUT,
                 method: 'GET',
                 headers: {
@@ -142,7 +175,7 @@ class RemotesApiClient extends ReuniteBaseApiClient {
     }
     async getPush({ organizationId, projectId, pushId, }) {
         try {
-            const response = await this.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/pushes/${pushId}`, {
+            const response = await this.client.request(`${this.domain}/api/orgs/${organizationId}/projects/${projectId}/pushes/${pushId}`, {
                 timeout: fetch_with_timeout_1.DEFAULT_FETCH_TIMEOUT,
                 method: 'GET',
                 headers: {
@@ -161,9 +194,32 @@ class RemotesApiClient extends ReuniteBaseApiClient {
         }
     }
 }
-class ReuniteApiClient {
+class ReuniteApi {
     constructor({ domain, apiKey, version, command, }) {
-        this.remotes = new RemotesApiClient(domain, apiKey, version, command);
+        this.command = command;
+        this.version = version;
+        this.apiClient = new ReuniteApiClient(this.version, this.command);
+        this.remotes = new RemotesApi(this.apiClient, domain, apiKey);
+    }
+    reportSunsetWarnings() {
+        const sunsetWarnings = this.apiClient.sunsetWarnings;
+        if (sunsetWarnings.length) {
+            const [{ isSunsetExpired, sunsetDate }] = sunsetWarnings.sort((a, b) => {
+                // First, prioritize by expiration status
+                if (a.isSunsetExpired !== b.isSunsetExpired) {
+                    return a.isSunsetExpired ? -1 : 1;
+                }
+                // If both are either expired or not, sort by sunset date
+                return a.sunsetDate > b.sunsetDate ? 1 : -1;
+            });
+            const updateVersionMessage = `Update to the latest version by running "npm install @redocly/cli@latest".`;
+            if (isSunsetExpired) {
+                process.stdout.write((0, colorette_1.red)(`The "${this.command}" command is not compatible with your version of Redocly CLI. ${updateVersionMessage}\n\n`));
+            }
+            else {
+                process.stdout.write((0, colorette_1.yellow)(`The "${this.command}" command will be incompatible with your version of Redocly CLI after ${sunsetDate.toLocaleString()}. ${updateVersionMessage}\n\n`));
+            }
+        }
     }
 }
-exports.ReuniteApiClient = ReuniteApiClient;
+exports.ReuniteApi = ReuniteApi;

package/lib/cms/commands/__tests__/push-status.test.js

@@ -15,8 +15,9 @@ jest.mock('colorette', () => ({
 }));
 jest.mock('../../api', () => ({
     ...jest.requireActual('../../api'),
-    ReuniteApiClient: jest.fn().mockImplementation(function (...args) {
+    ReuniteApi: jest.fn().mockImplementation(function (...args) {
         this.remotes = remotes;
+        this.reportSunsetWarnings = jest.fn();
     }),
 }));
 jest.mock('@redocly/openapi-core', () => ({

package/lib/cms/commands/__tests__/push.test.js

@@ -14,8 +14,9 @@ jest.mock('@redocly/openapi-core', () => ({
 }));
 jest.mock('../../api', () => ({
     ...jest.requireActual('../../api'),
-    ReuniteApiClient: jest.fn().mockImplementation(function (...args) {
+    ReuniteApi: jest.fn().mockImplementation(function (...args) {
         this.remotes = remotes;
+        this.reportSunsetWarnings = jest.fn();
     }),
 }));
 describe('handlePush()', () => {
@@ -269,7 +270,7 @@ describe('handlePush()', () => {
             config: mockConfig,
             version: 'cli-version',
         });
-        expect(api_1.ReuniteApiClient).toBeCalledWith({
+        expect(api_1.ReuniteApi).toBeCalledWith({
             domain: 'test-domain-from-env',
             apiKey: 'test-api-key',
             version: 'cli-version',

package/lib/cms/commands/push-status.js

@@ -28,7 +28,7 @@ async function handlePushStatus({ argv, config, version, }) {
     const continueOnDeployFailures = argv['continue-on-deploy-failures'] || false;
     try {
         const apiKey = (0, api_1.getApiKeys)(domain);
-        const client = new api_1.ReuniteApiClient({ domain, apiKey, version, command: 'push-status' });
+        const client = new api_1.ReuniteApi({ domain, apiKey, version, command: 'push-status' });
         let pushResponse;
         pushResponse = await (0, utils_2.retryUntilConditionMet)({
             operation: () => client.remotes.getPush({
@@ -119,6 +119,7 @@ async function handlePushStatus({ argv, config, version, }) {
             printScorecard(pushResponse.status.production.scorecard);
         }
         printPushStatusInfo({ orgId, projectId, pushId, startedAt });
+        client.reportSunsetWarnings();
         const summary = {
             preview: pushResponse.status.preview,
             production: pushResponse.isMainBranch ? pushResponse.status.production : null,

package/lib/cms/commands/push.js

@@ -30,10 +30,11 @@ async function handlePush({ argv, config, version, }) {
         const author = parseCommitAuthor(argv.author);
         const apiKey = (0, api_1.getApiKeys)(domain);
         const filesToUpload = collectFilesToPush(argv.files || argv.apis);
+        const commandName = 'push';
         if (!filesToUpload.length) {
-            return (0, miscellaneous_1.printExecutionTime)('push', startedAt, `No files to upload`);
+            return (0, miscellaneous_1.printExecutionTime)(commandName, startedAt, `No files to upload`);
         }
-        const client = new api_1.ReuniteApiClient({ domain, apiKey, version, command: 'push' });
+        const client = new api_1.ReuniteApi({ domain, apiKey, version, command: commandName });
         const projectDefaultBranch = await client.remotes.getDefaultBranch(orgId, projectId);
         const remote = await client.remotes.upsert(orgId, projectId, {
             mountBranchName: projectDefaultBranch,
@@ -77,7 +78,8 @@ async function handlePush({ argv, config, version, }) {
             });
         }
         verbose &&
-            (0, miscellaneous_1.printExecutionTime)('push', startedAt, `${(0, utils_1.pluralize)('file', filesToUpload.length)} uploaded to organization ${orgId}, project ${projectId}. Push ID: ${id}.`);
+            (0, miscellaneous_1.printExecutionTime)(commandName, startedAt, `${(0, utils_1.pluralize)('file', filesToUpload.length)} uploaded to organization ${orgId}, project ${projectId}. Push ID: ${id}.`);
+        client.reportSunsetWarnings();
         return {
             pushId: id,
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.25.2",
+  "version": "1.25.4",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.25.2",
+    "@redocly/openapi-core": "1.25.4",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",