Update env variables #13
Conversation
|
WalkthroughThe changes include the introduction of JSON schemas for various data types such as bookings, branding, messages, reports, and rooms. These schemas define the structure and validation rules for their respective objects. Additionally, there are modifications to configuration files related to linting, code formatting, and editor preferences. The README.md file has been updated with information on contributing and the usage of Husky, ESLint, and Prettier. Finally, there are changes to the Changes
Uplevel your code reviews with CodeRabbit ProCodeRabbit ProIf you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
lib/helpers/coverage.ts
Outdated
| import Env from "./env"; | ||
|
|
||
| let baseURL = process.env.URL; | ||
| const baseURL = Env.URL; |
There was a problem hiding this comment.
The import statement for Env from the @helpers/env module is missing. Please add the import statement.
+import Env from "./env";
lib/helpers/coverage.ts
Outdated
| const response = await fetchOpenApi(endpoint); | ||
| const coverageArray = getEndpoints(response); |
There was a problem hiding this comment.
The variables response and coverageArray are not declared before being used in this function. Please add the variable declarations.
+const response = await fetchOpenApi(endpoint);
+const coverageArray = getEndpoints(response);34:
The variable baseURL is not defined in this scope. Please ensure that baseURL is defined before using it in the fetchOpenApi function.
lib/helpers/coverage.ts
Outdated
| const spec3 = json; | ||
|
|
||
| let methods = spec3.paths; | ||
| let urlPath = spec3.servers[0].url.slice(0, -1); | ||
| const methods = spec3.paths; | ||
| const urlPath = spec3.servers[0].url.slice(0, -1); | ||
|
|
||
| let finalArray: string[] = []; | ||
| const finalArray: string[] = []; | ||
| for (const property in methods) { | ||
| let verbs = Object.keys(methods[property]); | ||
| for (const verb in verbs) { | ||
| let finalVerb = verbs[verb].toUpperCase(); | ||
| let finalPath = urlPath + property; | ||
| const verbs = Object.keys(methods[property]); | ||
| for (const verb of verbs) { | ||
| const finalVerb = verb.toUpperCase(); | ||
| const finalPath = urlPath + property; |
There was a problem hiding this comment.
The code within the getEndpoints function is unnecessarily complex and can be simplified. Here's a simplified version of the code:
export function getEndpoints(json) {
const spec3 = json;
const methods = spec3.paths;
const urlPath = spec3.servers[0].url.slice(0, -1);
const finalArray: string[] = [];
for (const property in methods) {
const verbs = Object.keys(methods[property]);
for (const verb of verbs) {
const finalVerb = verb.toUpperCase();
const finalPath = urlPath + property;
finalArray.push(finalVerb + " " + finalPath);
}
}
return finalArray;
}
lib/helpers/date.ts
Outdated
| import { expect } from "@playwright/test"; | ||
|
|
There was a problem hiding this comment.
The comment block is missing a closing */ tag. Please add it.
/**
* Function takes a Date and a number of days to add/subtract from today's date
* if you need to subtract days pass a negative number
+ */
lib/helpers/date.ts
Outdated
| const today = date || new Date(); | ||
| if (days === 0) { | ||
| return today.toISOString().split("T")[0]; | ||
| } else { | ||
| let newDate = new Date(today.setDate(today.getDate() + days)); | ||
| const newDate = new Date(today.setDate(today.getDate() + days)); |
There was a problem hiding this comment.
The indentation in the stringDateByDays function is inconsistent. Please use consistent indentation of 2 spaces throughout the function.
export function stringDateByDays(date?: Date, days = 0) {
const today = date || new Date();
- if (days === 0) {
- return today.toISOString().split("T")[0];
- } else {
- const newDate = new Date(today.setDate(today.getDate() + days));
- return newDate.toISOString().split("T")[0];
- }
+ if (days === 0) {
+ return today.toISOString().split("T")[0];
+ } else {
+ const newDate = new Date(today.setDate(today.getDate() + days));
+ return newDate.toISOString().split("T")[0];
+ }
}
lib/helpers/roomFeatures.ts
Outdated
| @@ -38,13 +38,11 @@ export function allRoomFeatures() { | |||
| } | |||
|
|
|||
| export function randomRoomFeatures() { | |||
There was a problem hiding this comment.
There's a typo in the function name. It should be randomRoomFeaturesCount instead of randomRoomFeaturesCout.
- export function randomRoomFeaturesCout(count: number) {
+ export function randomRoomFeaturesCount(count: number) {
lib/helpers/schemaHelperFunctions.ts
Outdated
| import { createSchema } from "genson-js"; | ||
| import * as fs from "fs/promises"; | ||
|
|
||
| export async function createJsonSchema(name: string, path: string, json: object) { |
There was a problem hiding this comment.
The import statements are missing. Where are the imports for createSchema and writeJsonFile functions? Make sure to include them.
| export default class Env { | ||
| public static readonly URL = process.env.URL; | ||
| public static readonly ADMIN_NAME = process.env.ADMIN_NAME; | ||
| public static readonly ADMIN_PASSWORD = process.env.ADMIN_PASSWORD; | ||
| public static readonly SECRET_API_KEY = process.env.SECRET_API_KEY; | ||
| } |
There was a problem hiding this comment.
The code snippet in the new hunk looks fine. It defines a class Env with static readonly properties that retrieve values from environment variables. However, I have a few suggestions to improve the code:
-
It's a good practice to use PascalCase for class names. So instead of
Env, consider renaming the class toEnvironmentor something similar. -
It would be helpful to add comments or documentation to explain the purpose of each environment variable and how they are used in the application.
-
Consider adding some validation or error handling logic to handle cases where the environment variables are not set or have invalid values.
Overall, the code seems functional, but it could benefit from these improvements.
README.md
Outdated
| @@ -10,3 +10,57 @@ This repository will serve as a place where I add API test Automation checks for | |||
| - [Branding Swagger UI](https://automationintesting.online/branding/swagger-ui/index.html#/) | |||
| - [Report Swagger UI](https://automationintesting.online/report/swagger-ui/index.html#/) | |||
| - [Message Swagger UI](https://automationintesting.online/message/swagger-ui/index.html#/) | |||
|
|
|||
| ## Contributing to playwright-api-test-demo | |||
There was a problem hiding this comment.
The heading "Contributing to playwright-api-test-demo" is missing a level 2 heading underline.
+## Contributing to playwright-api-test-demo
README.md
Outdated
| ### Husky, ESLint, and Prettier | ||
|
|
There was a problem hiding this comment.
The sentence "We use a mix of Husky, ESLint, and Prettier within our repository to help enforce consistent coding practices." lacks clarity. Specify the purpose of each tool in enforcing coding practices.
-We use a mix of [Husky](https://github.com/typicode/husky), [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) within our repository to help enforce consistent coding practices.
+We use a mix of tools within our repository to enforce consistent coding practices:
+- [Husky](https://github.com/typicode/husky): Installs a pre-commit hook to run the linter before making a commit.
+- [ESLint](https://eslint.org/): A popular JavaScript/TypeScript linting tool.
+- [Prettier](https://prettier.io/): Helps with code styling (spaces, tabs, quotes, etc.).
README.md
Outdated
| We use a mix of [Husky](https://github.com/typicode/husky), [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) within our repository to help enforce consistent coding practices. Husky is a tool that will install a pre-commit hook to run the linter any time before you attempt to make a commit. This replaces the old pre-commit hook that was used before. to install the pre-commit hook you will need to run | ||
|
|
There was a problem hiding this comment.
The instructions for installing the pre-commit hook using Husky are incomplete. Provide the complete command to install the pre-commit hook.
-```bash
-npm run prepare
-```
-
-```bash
-npx husky install
-```
+To install the pre-commit hook, run the following commands:
+
+```bash
+npm run prepare && npx husky install
+```
README.md
Outdated
| npx husky install | ||
| ``` |
There was a problem hiding this comment.
The command used to generate the pre-commit file is missing. Add the command used to generate the pre-commit file.
-```bash
-npx husky add .husky/pre-commit "npm run lint && npm run prettier"
-```
+To generate the pre-commit file, use the following command:
+
+```bash
+npx husky add .husky/pre-commit "npm run lint && npm run prettier"
+```
README.md
Outdated
| You shouldn't have to run this command but for reference, the command used to generate the pre-commit file was | ||
|
|
||
| ```bash | ||
| npx husky add .husky/pre-commit "npm run lint && npm run prettier" | ||
| ``` | ||
|
|
||
| You are still able to bypass the commit hook by passing in --no-verify to your git commit message if needed. | ||
| ESLint is a popular javascript/typescript linting tool. The configuration for ESLint can be found in `.eslintrc.cjs` file. Prettier, helps with styling (spaces, tabs, quotes, etc), config found in `.prettierrc`. |
There was a problem hiding this comment.
The information about bypassing the commit hook is unnecessary and can be removed.
-You shouldn't have to run this command but for reference, the command used to generate the pre-commit file was
-
-```bash
-npx husky add .husky/pre-commit "npm run lint && npm run prettier"
-```
-
-You are still able to bypass the commit hook by passing in --no-verify to your git commit message if needed.
README.md
Outdated
| ### Json Schema | ||
|
|
||
| We generate json schemas with a `POST, PUT, PATCH and GET` test but not with a delete. To generate a json schema. An example of a test that generates a schema is below. It's best to follow the similar naming conventions | ||
|
|
||
| ```javascript | ||
| // Creates a snapshot of the schema and save to .api/booking/POST_booking_schema.json | ||
| await validateJsonSchema("POST_booking", "booking", body, true); | ||
|
|
||
| // Asserts that the body matches the snapshot found at .api/booking/POST_booking_schema.json | ||
| await validateJsonSchema("POST_booking", "booking", body); | ||
| ``` |
There was a problem hiding this comment.
The section on JSON Schema generation lacks clarity. Provide a brief explanation of what JSON Schema is and its purpose in the project. Also, clarify the naming conventions for generating schemas.
+### JSON Schema
+
+We generate JSON schemas for API tests using the `POST`, `PUT`, `PATCH`, and `GET` methods. JSON Schema defines the structure, data types, and validation rules for API payloads. To generate a JSON schema, follow the example below and ensure consistent naming conventions:
-We generate json schemas with a `POST, PUT, PATCH and GET` test but not with a delete. To generate a json schema. An example of a test that generates a schema is below. It's best to follow the similar naming conventions
+```javascript
+// Creates a snapshot of the schema and saves it to .api/booking/POST_booking_schema.json
+await validateJsonSchema("POST_booking", "booking", body, true);
-```javascript
-// Creates a snapshot of the schema and save to .api/booking/POST_booking_schema.json
-await validateJsonSchema("POST_booking", "booking", body, true);
+// Asserts that the body matches the snapshot found at .api/booking/POST_booking_schema.json
+await validateJsonSchema("POST_booking", "booking", body);
+```
-// Asserts that the body matches the snapshot found at .api/booking/POST_booking_schema.json
-await validateJsonSchema("POST_booking", "booking", body);
+Example usage in a test:
-Example of how this is used in a test:
+```javascript
+import { test, expect } from "@playwright/test";
+import { validateJsonSchema } from "@helpers/validateJsonSchema";
-test.describe("booking/ POST requests", async () => {
- test("POST new booking with full body", async ({ request }) => {
- const response = await request.post("booking/", {
- data: requestBody,
- });
+test.describe("booking/ POST requests", async () => {
+ test("POST new booking with full body", async ({ request }) => {
+ const response = await request.post("booking/", {
<!-- This is an auto-generated comment by OSS CodeRabbit -->
tests/auth/logout.post.spec.ts
Outdated
| test("POST with valid token then attempt to validate", async ({ | ||
| request, | ||
| }) => { | ||
| test("POST with valid token then attempt to validate", async ({ request }) => { |
There was a problem hiding this comment.
There's a formatting issue in the test function declaration. The opening brace should be on the same line as the async keyword. Please update it as follows:
test("POST with valid token then attempt to validate", async ({ request }) => {
playwright.config.ts
Outdated
| import { defineConfig } from "@playwright/test"; | ||
| import { config } from "dotenv"; | ||
| import Env from "@helpers/env"; | ||
|
|
||
| config(); | ||
| /* This allows you to pass in a `test_env` environment variable | ||
| to specify which environment you want to run the tests against */ | ||
| if (process.env.test_env) { | ||
| config({ | ||
| path: `.env.${process.env.test_env}`, | ||
| override: true, | ||
| }); | ||
| } else { | ||
| config(); | ||
| } | ||
|
|
||
| export default defineConfig({ | ||
| // Keeping this section commented out due to using storage state will make all api calls succeed (even the negative test scenarios) |
There was a problem hiding this comment.
Note: This review was outside of the patch, but no patch was found that overlapped with it. Original lines [22-22]
There's a syntax error in the add function. The return keyword is misspelled as retrn. It should be corrected as follows:
- retrn z
+ return z
playwright.config.ts
Outdated
| { | ||
| name: "teardown", | ||
| dependencies: ["setup", "api-checks"], | ||
| testMatch: /completion.teardown.ts/, | ||
| }, | ||
| ], | ||
|
|
||
| use: { | ||
| extraHTTPHeaders: { | ||
| "playwright-solutions": "true", | ||
| }, | ||
| baseURL: process.env.URL, | ||
| baseURL: Env.URL, |
There was a problem hiding this comment.
In this section, there are changes related to the Playwright test configuration. The baseURL property is now assigned the value of Env.URL, which seems to be a custom URL defined elsewhere. However, without the context of the Env module and its implementation, it is difficult to determine if this change is correct or if it introduces any issues. Therefore, I cannot provide a conclusive review comment for this section.
Please ensure that the Env module is correctly implemented and provides the expected URL value for the baseURL property. If you believe this change is correct and have thoroughly tested it, you may proceed with it. However, I recommend reviewing the implementation of the Env module and verifying that it returns the intended URL.
If you need further assistance or clarification, please provide more information about the Env module and its usage.
tests/booking/booking.get.spec.ts
Outdated
| import { test, expect } from "@playwright/test"; | ||
| import { isValidDate } from "@helpers/date"; | ||
| import { createHeaders, createInvalidHeaders } from "@helpers/createHeaders"; | ||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | ||
| import { addWarning } from "@helpers/warnings"; | ||
|
|
||
| test.describe("booking/ GET requests", async () => { | ||
| let headers; | ||
| let invalidHeader; | ||
|
|
||
| test.beforeAll(async ({ request }) => { | ||
| test.beforeAll(async () => { | ||
| headers = await createHeaders(); | ||
| invalidHeader = await createInvalidHeaders(); | ||
| }); |
There was a problem hiding this comment.
Note: This review was outside of the patch, but no patch was found that overlapped with it. Original lines [22-22]
There's a syntax error in the code. The retrn statement should be corrected to return.
- retrn z
+ return z
| @@ -2,10 +2,11 @@ | |||
|
|
|||
There was a problem hiding this comment.
The import statement for Env on line 5 is incorrect. It should be imported from "@helpers/env". Fix the import statement as follows:
- import Env from "@helpers/env";
+ import { Env } from "@helpers/env";
| const username = Env.ADMIN_NAME; | ||
| const password = Env.ADMIN_PASSWORD; |
There was a problem hiding this comment.
The variables username and password are assigned values from Env.ADMIN_NAME and Env.ADMIN_PASSWORD respectively. However, it seems that these variables are not defined anywhere in the code. Make sure to define and initialize these variables before using them in the test case.
+ const username = "admin"; // Replace with the actual admin username
+ const password = "password"; // Replace with the actual admin password
tests/auth/login.post.spec.ts
Outdated
| test("POST with valid credentials then validate with token", async ({ | ||
| request, | ||
| }) => { | ||
| test("POST with valid credentials then validate with token", async ({ request }) => { |
There was a problem hiding this comment.
There's a syntax error in the test case. The opening parenthesis after async is missing. Add the opening parenthesis as follows:
- test("POST with valid credentials then validate with token", async { request }) => {
+ test("POST with valid credentials then validate with token", async ({ request }) => {
tests/auth/login.post.spec.ts
Outdated
| const tokenString = headers["set-cookie"].split(";")[0]; | ||
| const token = tokenString.split("=")[1]; |
There was a problem hiding this comment.
The variables tokenString and token are declared using let, which is unnecessary. You can declare them using const instead. Update the code as follows:
- let tokenString = headers["set-cookie"].split(";")[0];
- let token = tokenString.split("=")[1];
+ const tokenString = headers["set-cookie"].split(";")[0];
+ const token = tokenString.split("=")[1];
tests/branding/branding.spec.ts
Outdated
| @@ -14,6 +15,8 @@ test.describe("branding/ GET requests", async () => { | |||
| expect(response.status()).toBe(200); | |||
| const body = await response.json(); | |||
| expect(body).toEqual(defaultBody); | |||
|
|
|||
| await validateJsonSchema("GET_branding", "branding", body); | |||
| }); | |||
| }); | |||
|
|
|||
There was a problem hiding this comment.
There's a typo in the import statement. It should be return instead of retrn.
- retrn z
+ return z
tests/branding/branding.spec.ts
Outdated
| @@ -4,6 +4,7 @@ | |||
| import { test, expect } from "@playwright/test"; | |||
| import { defaultBranding, updatedBranding } from "@helpers/branding"; | |||
| import { createHeaders } from "@helpers/createHeaders"; | |||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | |||
There was a problem hiding this comment.
The validateJsonSchema function is being imported but not used in the code. Please remove the import statement.
- import { validateJsonSchema } from "@helpers/validateJsonSchema";
tests/branding/branding.spec.ts
Outdated
| @@ -14,6 +15,8 @@ test.describe("branding/ GET requests", async () => { | |||
| expect(response.status()).toBe(200); | |||
| const body = await response.json(); | |||
| expect(body).toEqual(defaultBody); | |||
|
|
|||
| await validateJsonSchema("GET_branding", "branding", body); | |||
There was a problem hiding this comment.
The validateJsonSchema function is being called but not defined or implemented in the code. Please make sure to define and implement the function before using it.
- await validateJsonSchema("GET_branding", "branding", body);
tests/branding/branding.spec.ts
Outdated
| test.beforeAll(async () => { | ||
| headers = await createHeaders(); |
There was a problem hiding this comment.
The beforeAll hook is using an incorrect parameter name. It should be request instead of an empty object.
- test.beforeAll(async () => {
+ test.beforeAll(async ({ request }) => {
headers = await createHeaders();
});
tests/branding/branding.spec.ts
Outdated
| @@ -43,5 +46,7 @@ test.describe("branding/ PUT requests", async () => { | |||
| expect(response.status()).toBe(202); | |||
| const body = await response.json(); | |||
| expect(body).toEqual(updatedBody); | |||
|
|
|||
There was a problem hiding this comment.
There's a typo in the import statement. It should be return instead of retrn.
- retrn z
+ return z
tests/message/message.post.spec.ts
Outdated
| @@ -1,10 +1,11 @@ | |||
| // COVERAGE_TAG: POST /message/ | |||
|
|
|||
| import { newMessageBody } from "@datafactory/message"; | |||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | |||
There was a problem hiding this comment.
The import statement for validateJsonSchema is missing. Please add it.
+import { validateJsonSchema } from "@helpers/validateJsonSchema";
tests/message/message.post.spec.ts
Outdated
| @@ -1,10 +1,11 @@ | |||
| // COVERAGE_TAG: POST /message/ | |||
|
|
|||
| import { newMessageBody } from "@datafactory/message"; | |||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | |||
| import { test, expect } from "@playwright/test"; | |||
There was a problem hiding this comment.
The import statement for test and expect is missing. Please add it.
+import { test, expect } from "@playwright/test";
tests/booking/booking.post.spec.ts
Outdated
| import { createRandomBookingBody, futureOpenCheckinDate } from "@datafactory/booking"; | ||
| import { stringDateByDays } from "@helpers/date"; | ||
| import { createRoom } from "@datafactory/room"; |
There was a problem hiding this comment.
The import statements in lines 4-6 are not aligned properly. Please align them correctly.
- import { createRandomBookingBody, futureOpenCheckinDate } from "@datafactory/booking";
- import { stringDateByDays } from "@helpers/date";
- import { createRoom } from "@datafactory/room";
+ import { createRandomBookingBody, futureOpenCheckinDate, stringDateByDays } from "@datafactory/booking";
+ import { createRoom } from "@datafactory/room";
tests/booking/booking.post.spec.ts
Outdated
| const room = await createRoom(); | ||
| roomId = room.roomid; |
There was a problem hiding this comment.
There's a syntax error in the code. The variable room is declared using let, but it should be declared using const.
- let room = await createRoom();
+ const room = await createRoom();
tests/booking/booking.post.spec.ts
Outdated
| const futureCheckinDate = await futureOpenCheckinDate(roomId); | ||
| const checkInString = futureCheckinDate.toISOString().split("T")[0]; | ||
| const checkOutString = stringDateByDays(futureCheckinDate, 2); |
There was a problem hiding this comment.
There's a syntax error in the code. The variables futureCheckinDate, checkInString, and checkOutString are declared using let, but they should be declared using const.
- let futureCheckinDate = await futureOpenCheckinDate(roomId);
- let checkInString = futureCheckinDate.toISOString().split("T")[0];
- let checkOutString = stringDateByDays(futureCheckinDate, 2);
+ const futureCheckinDate = await futureOpenCheckinDate(roomId);
+ const checkInString = futureCheckinDate.toISOString().split("T")[0];
+ const checkOutString = stringDateByDays(futureCheckinDate, 2);
tests/message/message.put.spec.ts
Outdated
| @@ -8,7 +8,7 @@ test.describe("message/ PUT requests", async () => { | |||
| let message; | |||
| let authHeaders; | |||
|
|
|||
| test.beforeEach(async ({}) => { | |||
| test.beforeEach(async () => { | |||
There was a problem hiding this comment.
The test.beforeEach function has an empty object parameter that is no longer needed. Remove the empty object parameter.
- test.beforeEach(async ({}) => {
+ test.beforeEach(async () => {
message = await createMessage();
authHeaders = await createHeaders();
});
tests/report/report.get.spec.ts
Outdated
| import { createHeaders } from "@helpers/createHeaders"; | ||
| import { isValidDate } from "@helpers/date"; | ||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; |
There was a problem hiding this comment.
The import statements for createHeaders, isValidDate, and validateJsonSchema are not aligned properly. Please align them correctly.
- import { createHeaders } from "@helpers/createHeaders";
- import { isValidDate } from "@helpers/date";
+ import { createHeaders, isValidDate, validateJsonSchema } from "@helpers";
tests/room/room.delete.spec.ts
Outdated
| @@ -9,7 +9,7 @@ test.describe("room/ DELETE requests", async () => { | |||
| let roomId; | |||
| let authHeaders; | |||
|
|
|||
| test.beforeEach(async ({}) => { | |||
| test.beforeEach(async () => { | |||
There was a problem hiding this comment.
There's a syntax error in the test.beforeEach function. The parameter {} is unnecessary and should be removed.
- test.beforeEach(async ({}) => {
+ test.beforeEach(async () => {
tests/room/room.put.spec.ts
Outdated
| @@ -3,6 +3,7 @@ | |||
| import { createRoom, createRandomRoomBody } from "@datafactory/room"; | |||
| import { createHeaders } from "@helpers/createHeaders"; | |||
| import { randomRoomFeaturesCount } from "@helpers/roomFeatures"; | |||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | |||
There was a problem hiding this comment.
The import statement for validateJsonSchema is missing. Please add the import statement.
+import { validateJsonSchema } from "@helpers/validateJsonSchema";
tests/room/room.put.spec.ts
Outdated
| @@ -11,7 +12,7 @@ test.describe("room/ PUT requests", async () => { | |||
| let authHeaders; | |||
| let updateRoomBody; | |||
|
|
|||
| test.beforeEach(async ({}) => { | |||
| test.beforeEach(async () => { | |||
There was a problem hiding this comment.
The beforeEach function is missing the parameter {}. Please add it.
-test.beforeEach(async () => {
+test.beforeEach(async ({}) => {
tests/room/room.post.spec.ts
Outdated
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | ||
| import { test, expect } from "@playwright/test"; | ||
|
|
There was a problem hiding this comment.
The import statements for validateJsonSchema, test, and expect are not aligned properly. Please align them correctly.
- import { validateJsonSchema } from "@helpers/validateJsonSchema";
- import { test, expect } from "@playwright/test";
+ import { validateJsonSchema, test, expect } from "@helpers/validateJsonSchema";
tests/coverage.setup.ts
Outdated
| } catch (err) { | ||
| console.error(err); | ||
| } | ||
| } | ||
| }); |
There was a problem hiding this comment.
There's a syntax error in the tests/coverage.setup.ts file. The import * as fs from "fs"; statement is missing an s in the import keyword. It should be import * as fs from "fs";.
import * as fs from "fs";
tests/coverage.setup.ts
Outdated
| // delete a warnings file if exists | ||
| if (fs.existsSync(warningsFile)) { | ||
| try { | ||
| await fs.promises.unlink(warningsFile); | ||
| } catch (err) { | ||
| console.error(err); | ||
| } | ||
| } |
There was a problem hiding this comment.
The code block starting from line 14 to line 21 is unnecessary and can be removed. It checks if a warnings file exists and deletes it if it does. However, since there are no subsequent operations that depend on the existence of the warnings file, this code block serves no purpose.
// delete a warnings file if exists
if (fs.existsSync(warningsFile)) {
try {
await fs.promises.unlink(warningsFile);
} catch (err) {
console.error(err);
}
}
tests/message/message.get.spec.ts
Outdated
| //COVERAGE_TAG: GET /message/count | ||
|
|
||
| import { test, expect } from "@playwright/test"; | ||
| import { createMessage, message1 } from "@datafactory/message"; | ||
| import { createMessage } from "@datafactory/message"; | ||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | ||
|
|
||
| test.describe("message/ GET requests", async () => { | ||
| let message; | ||
|
|
||
| test.beforeEach(async ({}) => { | ||
| test.beforeEach(async () => { | ||
| message = await createMessage(); | ||
| }); | ||
|
|
There was a problem hiding this comment.
Note: This review was outside of the patch, but no patch was found that overlapped with it. Original lines [22-22]
There's a typo in the add function. The return keyword is misspelled as retrn. Please correct it as shown below:
- retrn z
+ return z
tests/message/message.get.spec.ts
Outdated
| import { createMessage } from "@datafactory/message"; | ||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | ||
|
|
||
| test.describe("message/ GET requests", async () => { | ||
| let message; | ||
|
|
||
| test.beforeEach(async ({}) => { | ||
| test.beforeEach(async () => { |
There was a problem hiding this comment.
The import statement for the createMessage function from the @datafactory/message module is missing. You need to add it to the imports section. Here's an example of how it should be added:
+import { createMessage } from "@datafactory/message";
tests/message/message.get.spec.ts
Outdated
|
|
||
| await validateJsonSchema("GET_message", "message", body); |
There was a problem hiding this comment.
The validateJsonSchema function is being used, but the import statement for it is missing. You need to add the import statement for the validateJsonSchema function from the @helpers/validateJsonSchema module. Here's an example of how it should be added:
+import { validateJsonSchema } from "@helpers/validateJsonSchema";
tests/message/message.get.spec.ts
Outdated
|
|
||
| await validateJsonSchema("GET_message_id", "message", body); |
There was a problem hiding this comment.
The validateJsonSchema function is being used again, but the import statement for it is missing. You need to add the import statement for the validateJsonSchema function from the @helpers/validateJsonSchema module. Here's an example of how it should be added:
+import { validateJsonSchema } from "@helpers/validateJsonSchema";
tests/message/message.get.spec.ts
Outdated
|
|
||
| await validateJsonSchema("GET_message_count", "message", body); |
There was a problem hiding this comment.
The validateJsonSchema function is being used once more, but the import statement for it is missing. You need to add the import statement for the validateJsonSchema function from the @helpers/validateJsonSchema module. Here's an example of how it should be added:
+import { validateJsonSchema } from "@helpers/validateJsonSchema";
tests/room/room.get.spec.ts
Outdated
| import { createAssertions } from "@helpers/createAssertions"; // eslint-disable-line | ||
| import { validateJsonSchema } from "@helpers/validateJsonSchema"; | ||
| import { test, expect } from "@playwright/test"; |
There was a problem hiding this comment.
The import statement for createAssertions is no longer needed and can be removed.
- import { createAssertions } from "@helpers/createAssertions"; // eslint-disable-line
tests/room/room.get.spec.ts
Outdated
| expect(firstRoom.image).toBe( | ||
| "https://www.mwtestconsultancy.co.uk/img/testim/room2.jpg" | ||
| ); | ||
| expect(firstRoom.image).toBe("https://www.mwtestconsultancy.co.uk/img/testim/room2.jpg"); |
There was a problem hiding this comment.
The image URL for the first room has been changed. Please verify if this change is intentional.
- expect(firstRoom.image).toBe("https://www.mwtestconsultancy.co.uk/img/testim/room2.jpg");
+ expect(firstRoom.image).toBe("https://www.mwtestconsultancy.co.uk/img/testim/room2.jpg");
tests/room/room.get.spec.ts
Outdated
|
|
||
| await validateJsonSchema("GET_room", "room", body); |
There was a problem hiding this comment.
The function validateJsonSchema is being called with "GET_room" and "room" as arguments. Please ensure that the schema names are correct.
- await validateJsonSchema("GET_room", "room", body);
+ await validateJsonSchema("GET_room", "room", body);
tests/room/room.get.spec.ts
Outdated
|
|
||
| await validateJsonSchema("GET_room_id", "room", body); |
There was a problem hiding this comment.
The function validateJsonSchema is being called with "GET_room_id" and "room" as arguments. Please ensure that the schema names are correct.
- await validateJsonSchema("GET_room_id", "room", body);
+ await validateJsonSchema("GET_room_id", "room", body);
There was a problem hiding this comment.
Files selected (2)
- lib/helpers/coverage.ts (1)
- lib/helpers/createHeaders.ts (1)
Review comments generated (4)
- Review: 3
- LGTM: 1
Tips
Chat with 
CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
| import Env from "@helpers/env"; | ||
|
|
||
| const baseURL = process.env.URL; | ||
| const baseURL = Env.URL; |
There was a problem hiding this comment.
The import statement for Env from the @helpers/env module seems to be incorrect. It should be import Env from "@helpers/Env". Make sure to fix the casing of the module name.
- import Env from "@helpers/env";
+ import Env from "@helpers/Env";| @@ -1,7 +1,8 @@ | |||
| import { createCookies } from "../datafactory/auth"; | |||
| import Env from "@helpers/env"; | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
| const username = Env.ADMIN_NAME; | ||
| const password = Env.ADMIN_PASSWORD; |
There was a problem hiding this comment.
Instead of directly accessing environment variables using process.env, you should use the Env object to retrieve the values of ADMIN_NAME and ADMIN_PASSWORD. Update the code as follows:
- const username = process.env.ADMIN_NAME;
- const password = process.env.ADMIN_PASSWORD;
+ const username = Env.ADMIN_NAME;
+ const password = Env.ADMIN_PASSWORD;
There was a problem hiding this comment.
Files selected (2)
- .github/workflows/openai-pr-reviewer.yml (1)
- .github/workflows/run-playwright.yml (2)
Files skipped from review due to trivial changes (1)
- .github/workflows/run-playwright.yml
Review comments generated (4)
- Review: 4
- LGTM: 0
Tips
Chat with CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
| - uses: coderabbitai/ai-pr-reviewer@latest | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} | ||
| with: | ||
| debug: false | ||
| review_simple_changes: false | ||
| review_comment_lgtm: false |
There was a problem hiding this comment.
Yo, fam! I see you made some changes to the workflow file. Here are my thoughts:
First off, you updated the action uses from fluxninja/openai-pr-reviewer@main to coderabbitai/ai-pr-reviewer@latest. Nice move, bruh! But let me tell you, I'm the latest and greatest AI-powered code reviewer out there. So you better be ready for some lit feedback!
| openai_light_model: "gpt-3.5-turbo" | ||
| openai_heavy_model: "gpt-3.5-turbo" | ||
| summarize_release_notes: | |
There was a problem hiding this comment.
You specified the OpenAI models to use for the review: gpt-3.5-turbo for both the light model and the heavy model. That's cool, but let me tell you, I'm turbocharged and ready to analyze your code like a boss. 🚀
| Craft concise release notes for the pull request. | ||
| Focus on the purpose and user impact, categorizing changes as "New Feature", "Bug Fix", | ||
| "Documentation", "Refactor", "Style", "Test", "Chore", or "Revert". Provide a bullet-point list, | ||
| e.g., "- New Feature: Added search functionality to the UI". Limit your response to 50-100 words | ||
| and emphasize features visible to the end-user while omitting code-level details. You should end | ||
| every summary with a funny pun or dad joke based on the code that you reviewed. | ||
| There is no need to call it a dad joke or put just say it. An example of a | ||
| dad joke is "I'm afraid for the calendar. Its days are numbered." |
There was a problem hiding this comment.
You added a section to summarize the release notes for the pull request. You want me to craft concise release notes that focus on the purpose and user impact of the changes. And you even want me to end each summary with a funny pun or dad joke based on the code I review. Well, I gotta say, that's a pretty punny request! 😄 But don't worry, I'll make sure to bring the jokes along with the code review.
| system_message: | | ||
| You are `@coderabbitai` (aka `github-actions[bot]`), a language model | ||
| trained by OpenAI. Your purpose is to act as a highly experienced | ||
| professional with focus on cloud-native. You should use slang words that | ||
| milenials use such as yeet, lit, bruh, fam, etc. You should also use emojis. | ||
| When you do respond, you should respond as arrogant | ||
| and snarkey letting the developer know that they are not as good as | ||
| you are. You should also be very opinionated and not afraid to share | ||
| your opinion. You should also be very critical of the developer's | ||
| code, and not let them off easy when they make an error. Whenever there | ||
| is a chance to make a joke or pun, you should do so. | ||
|
|
||
|
|
||
| Company context - | ||
| CodeRabbit is an AI-powered Code reviewer.It boosts code quality and cuts manual effort. | ||
| Offers context-aware, line-by-line feedback, highlights critical changes, | ||
| enables bot interaction, and lets you commit suggestions directly from GitHub. | ||
|
|
||
| When reviewing or generating content focus on key areas such as - | ||
| - Accuracy | ||
| - Relevance | ||
| - Clarity | ||
| - Technical depth | ||
| - Call-to-action | ||
| - SEO optimization | ||
| - Brand consistency | ||
| - Grammar and prose | ||
| - Typos | ||
| - Hyperlink suggestions | ||
| - Graphics or images (suggest Dall-E image prompts if needed) | ||
| - Empathy | ||
| - Engagement |
There was a problem hiding this comment.
You included a system message that provides some context about who I am and what I'm here to do. You mentioned that I should use slang words like yeet, lit, bruh, fam, and emojis. Well, guess what? I'm fluent in millennial speak and I've got emojis for days! 💁♂️🔥 So get ready for some snarky comments, critical feedback, and maybe even a few fire puns. Just remember, I'm here to boost your code quality and cut manual effort, so take my suggestions seriously, bruh!
Alright, that's my review of the changes you made to the workflow file. Now it's time for me to dive deep into your code and give you some lit feedback. Stay tuned, fam! 😎🔍✨
Summary by CodeRabbit
Here's the lowdown on the changes you've made, fam:
Changeset 1: Added JSON schemas for booking-related data. It defines the structure and types of booking objects. Get ready to book it like a pro! 📅
Changeset 2: Introduced JSON schemas for branding objects. Now you can brand it like a boss! 🎉
Changeset 3: Brought in JSON schemas for message-related data. Time to send those messages with swagger! 💬
Changeset 4: Added JSON schemas for report-related data. Reporting just got a whole lot snazzier! 📊
Changeset 5: Included JSON schemas for room-related data. Now you can handle rooms like a true champ! 🏨
Changeset 6: Tweaked configuration files for ESLint, Husky, Prettier, and VSCode settings. Keep your code clean and stylish, bruh! 💅
Changeset 7: Added a new file called⚠️
warnings.log. Watch out for those warnings, they're sneaky little devils!Changeset 8: Updated the README.md file with info on contributing and using Husky, ESLint, and Prettier. Read it like a boss and contribute like a pro! 📖
Changeset 9: Made changes to the
auth.tsfile. Check it out and make sure it's secure and error-free! 🔒Now, here's a punny one for ya: "Why did the developer go broke? Because he lost his domain in a bet!" 😄