@squiz/dxp-cli-next 5.15.0-develop.4 → 5.15.0

package/lib/datastore/utils.js

@@ -138,7 +138,7 @@ exports.handleCommandError = handleCommandError;
 function throwErrorIfNotLoggedIn(command) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!(yield (0, ApplicationStore_1.getApplicationFile)(ApplicationStore_1.STORE_FILES.sessionCookie))) {
-            command.error(chalk_1.default.red('You must login to interact with the job runner. See `dxp-next auth login`'));
+            command.error(chalk_1.default.red('You must login to interact with the datastore service. See `dxp-next auth login`'));
         }
     });
 }

package/lib/porter/constants.d.ts

@@ -1,8 +1,10 @@
 export declare const SQUIZ_ROOT_TENANT = "SquizRoot-0000";
 export declare const PORTER_REGION = "au";
+export declare const PORTER_SERVICE_NAME = "porter";
 export declare const PORTER_ERRORS: {
     projectAlreadyExists: string;
     projectNameMissing: string;
     projectDirectoryInvalid: string;
     portIdBlankError: string;
+    loginError: string;
 };

package/lib/porter/constants.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PORTER_ERRORS = exports.PORTER_REGION = exports.SQUIZ_ROOT_TENANT = void 0;
+exports.PORTER_ERRORS = exports.PORTER_SERVICE_NAME = exports.PORTER_REGION = exports.SQUIZ_ROOT_TENANT = void 0;
 exports.SQUIZ_ROOT_TENANT = 'SquizRoot-0000';
 exports.PORTER_REGION = 'au';
+exports.PORTER_SERVICE_NAME = 'porter';
 exports.PORTER_ERRORS = {
     projectAlreadyExists: 'Project directory already exists. Please choose a project directory that does not exist',
     projectNameMissing: 'Project name is missing from the config.json file',
     projectDirectoryInvalid: 'You must be within a porter project directory to use this command',
     portIdBlankError: 'Cannot be blank.',
+    loginError: 'To use this service you must be logged in as a DXP super admin, Squiz support staff or be assigned the Migration Agent secondary role for the selected tenant',
 };

package/lib/porter/utils/BuildDXPUrl/BuildDXPUrl.d.ts

@@ -0,0 +1,4 @@
+export declare function buildDXPUrl(serviceName: string, tenantID?: string, override?: string, region?: string): Promise<{
+    dxpUrl: string;
+    tenant: string | undefined;
+}>;

package/lib/porter/utils/BuildDXPUrl/BuildDXPUrl.js

@@ -0,0 +1,34 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDXPUrl = void 0;
+const ApplicationConfig_1 = require("../../../ApplicationConfig");
+const CoreUtils_1 = require("../CoreUtils/CoreUtils");
+function buildDXPUrl(serviceName, tenantID, override, region) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!override) {
+            const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)(tenantID);
+            (0, CoreUtils_1.logDebug)(`existingConfig: ${JSON.stringify(existingConfig)}`);
+            return {
+                dxpUrl: `${existingConfig.baseUrl}/__dxp/${region || existingConfig.region}/${serviceName}`,
+                tenant: existingConfig.tenant,
+            };
+        }
+        else {
+            (0, CoreUtils_1.logDebug)(`Using override URL: ${override}`);
+            return {
+                dxpUrl: `${override}/__dxp/${region || 'au'}/${serviceName}`,
+                tenant: tenantID,
+            };
+        }
+    });
+}
+exports.buildDXPUrl = buildDXPUrl;

package/lib/porter/utils/BuildPorterUrl/BuildPorterUrl.d.ts

@@ -1 +1 @@
-export declare function buildPorterUrl(override?: string): Promise<string>;
+export declare function buildPorterUrl(): Promise<string>;

package/lib/porter/utils/BuildPorterUrl/BuildPorterUrl.js

@@ -10,18 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildPorterUrl = void 0;
-const ApplicationConfig_1 = require("../../../ApplicationConfig");
 const constants_1 = require("../../constants");
-const CoreUtils_1 = require("../CoreUtils/CoreUtils");
-function buildPorterUrl(override) {
+const BuildDXPUrl_1 = require("../BuildDXPUrl/BuildDXPUrl");
+function buildPorterUrl() {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!override) {
-            const existingConfig = yield (0, ApplicationConfig_1.fetchApplicationConfig)();
-            (0, CoreUtils_1.logDebug)(`existingConfig: ${JSON.stringify(existingConfig)}`);
-            return `${existingConfig.baseUrl}/__dxp/${constants_1.PORTER_REGION}/porter/${constants_1.SQUIZ_ROOT_TENANT}`;
-        }
-        (0, CoreUtils_1.logDebug)(`Using override URL: ${override}`);
-        return `${override}/__dxp/${constants_1.PORTER_REGION}/porter/${constants_1.SQUIZ_ROOT_TENANT}`;
+        const { dxpUrl, tenant } = yield (0, BuildDXPUrl_1.buildDXPUrl)(constants_1.PORTER_SERVICE_NAME, undefined, undefined, 'au');
+        return `${dxpUrl}/${tenant}`;
     });
 }
 exports.buildPorterUrl = buildPorterUrl;

package/lib/porter/utils/BuildPorterUrl/BuildPorterUrl.spec.js

@@ -33,7 +33,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const FetchApplicationConfig = __importStar(require("../../../ApplicationConfig"));
-const constants_1 = require("../../constants");
 const BuildPorterUrl_1 = require("./BuildPorterUrl");
 describe('buildPorterUrl', () => {
     let fetchApplicationConfigSpy;
@@ -48,12 +47,6 @@ describe('buildPorterUrl', () => {
             tenant: 'tenant',
         }));
         const porterUrl = yield (0, BuildPorterUrl_1.buildPorterUrl)();
-        expect(porterUrl).toBe(`base/__dxp/${constants_1.PORTER_REGION}/porter/${constants_1.SQUIZ_ROOT_TENANT}`);
-    }));
-    it('should construct the URL using the provided override base URL', () => __awaiter(void 0, void 0, void 0, function* () {
-        const overrideBaseUrl = 'override';
-        const porterUrl = yield (0, BuildPorterUrl_1.buildPorterUrl)(overrideBaseUrl);
-        expect(porterUrl).toBe(`${overrideBaseUrl}/__dxp/${constants_1.PORTER_REGION}/porter/${constants_1.SQUIZ_ROOT_TENANT}`);
-        expect(fetchApplicationConfigSpy).not.toHaveBeenCalled();
+        expect(porterUrl).toEqual('base/__dxp/au/porter/tenant');
     }));
 });

package/lib/porter/utils/ErrorUtils/ErrorUtils.js

@@ -17,6 +17,7 @@ const axios_1 = __importDefault(require("axios"));
 const chalk_1 = __importDefault(require("chalk"));
 const ApplicationStore_1 = require("../../../ApplicationStore");
 const CheckAuthorisation_1 = require("../AuthUtils/CheckAuthorisation");
+const constants_1 = require("../../constants");
 function handleCommandError(command, error) {
     if (!axios_1.default.isAxiosError(error)) {
         if (!!process.env.DEBUG && error.stack) {
@@ -31,8 +32,7 @@ function handleCommandError(command, error) {
         return command.error(chalk_1.default.red(error.message));
     }
     if (error.response.status === 401 || error.response.status === 403) {
-        const errorMessage = 'You must be logged in as a DXP super admin or Squiz support staff to use this service';
-        return command.error(chalk_1.default.red(errorMessage));
+        return command.error(chalk_1.default.red(constants_1.PORTER_ERRORS.loginError));
     }
     if (error.response.status >= 500) {
         const errorMessage = `Action failed. Service responded with "${error.response.status}" response code`;
@@ -64,7 +64,7 @@ function throwErrorIfNotLoggedIn(command) {
         }
         const isAuthorised = yield (0, CheckAuthorisation_1.checkAuthorisation)();
         if (!isAuthorised) {
-            command.error(chalk_1.default.red('You must login to interact with the porter service. See `dxp-next auth login`'));
+            command.error(chalk_1.default.red(constants_1.PORTER_ERRORS.loginError));
         }
     });
 }

package/lib/porter/utils/ErrorUtils/ErrorUtils.spec.js

@@ -37,6 +37,7 @@ const commander_1 = require("commander");
 const GetApplicationFile = __importStar(require("../../../ApplicationStore"));
 const CheckAuthorisation = __importStar(require("../AuthUtils/CheckAuthorisation"));
 const ErrorUtils_1 = require("./ErrorUtils");
+const constants_1 = require("../../constants");
 describe('handleCommandError', () => {
     let stderrSpy;
     beforeEach(() => {
@@ -95,7 +96,7 @@ describe('handleCommandError', () => {
         }));
         expect(stderrSpy).toHaveBeenCalledTimes(1);
         // read the mock call strings directly otherwise colours cause test failures with .toEqual()
-        expect(stderrSpy.mock.calls[0][0]).toContain('You must be logged in as a DXP super admin or Squiz support staff to use this service');
+        expect(stderrSpy.mock.calls[0][0]).toContain(constants_1.PORTER_ERRORS.loginError);
     }));
     it('correctly displays the console logs for invalid-params errors from the porter service', () => __awaiter(void 0, void 0, void 0, function* () {
         const command = new commander_1.Command();
@@ -173,7 +174,7 @@ describe('throwErrorIfNotLoggedIn', () => {
             .spyOn(CheckAuthorisation, 'checkAuthorisation')
             .mockImplementationOnce(() => Promise.resolve(false));
         yield (0, ErrorUtils_1.throwErrorIfNotLoggedIn)(command);
-        expect(stderrSpy.mock.calls[0][0]).toContain('You must login to interact with the porter service. See `dxp-next auth login');
+        expect(stderrSpy.mock.calls[0][0]).toContain(constants_1.PORTER_ERRORS.loginError);
         expect(process.exit).toHaveBeenCalled();
     }));
     it('should not call the command error if logged in', () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/porter/utils/index.d.ts

@@ -1,5 +1,6 @@
 export * from './AuthUtils/CheckAuthorisation';
 export * from './BuildPorterUrl/BuildPorterUrl';
+export * from './BuildDXPUrl/BuildDXPUrl';
 export * from './CoreUtils/CoreUtils';
 export * from './DoesPathExist/DoesPathExist';
 export * from './ErrorUtils/ErrorUtils';

package/lib/porter/utils/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AuthUtils/CheckAuthorisation"), exports);
 __exportStar(require("./BuildPorterUrl/BuildPorterUrl"), exports);
+__exportStar(require("./BuildDXPUrl/BuildDXPUrl"), exports);
 __exportStar(require("./CoreUtils/CoreUtils"), exports);
 __exportStar(require("./DoesPathExist/DoesPathExist"), exports);
 __exportStar(require("./ErrorUtils/ErrorUtils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.15.0-develop.4",
+  "version": "5.15.0",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },