Make sure all Endaoment projects have been added to our DB

[mohammadranjbarz]

related to #1598 (comment)

Summary by CodeRabbit

• New Features

  • Enhanced project slug generation and database interactions for improved consistency and readability.
  • Added a new descriptionSummary field to project entries for more detailed project descriptions.

• Bug Fixes

  • Revised SQL queries to ensure correct handling of project categories and data consistency.

• Chores

  • Updated project names in the data import file to include versioning for differentiation.

• Documentation

  • Expanded filtering criteria in utilities to account for additional special characters in project titles.

[coderabbitai]

Walkthrough

This update introduces crucial migration changes designed to enhance database interactions and improve project management functionalities. Key modifications include refined import paths, updated SQL logic for data insertion and deletion, and the introduction of utility functions for slug generation. Additionally, project names have been versioned by appending "2," and the character filtering for titles has been broadened. Overall, these enhancements support better code clarity, maintainability, and data integrity.

Changes

File(s)	Change Summary
migration/1719740230650-add_endaoment_organization.ts	Updated import paths for ORGANIZATION_LABELS and NETWORK_IDS to reflect directory restructuring; no functional changes made.
migration/1719808494903-create_endaoments_categories.ts	Swapped name and value in the INSERT statement and updated the DELETE clause; affects data integrity and retrieval processes.
migration/1719808494904-add_endaoment_projects.ts	Introduced utility functions for slug generation, added descriptionSummary to INSERT statement, and modified category ID retrieval logic.
migration/data/importedEndaomentProjects.ts	Updated project names by appending "2" for versioning without altering other properties.
src/utils/utils.ts	Expanded the filtering criteria in titleWithoutSpecialCharacters by adding the right single quotation mark.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Migration
    participant Database

    User->>Migration: Initiate project creation
    Migration->>Database: Insert project data with slug
    Database-->>Migration: Confirm insertion
    Migration->>User: Confirm project created

Loading

🐰 In fields of green where bunnies hop,
New slugs and names make our spirits pop!
With data refined and paths that align,
We celebrate changes, oh how they shine!
So let’s leap with joy, both big and small,
For these lovely updates, we cherish them all! 🌼✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 09fab0a and f24d1e3.

Files selected for processing (1)

• migration/1719808494904-add_endaoment_projects.ts (4 hunks)

Additional comments not posted (4)

migration/1719808494904-add_endaoment_projects.ts (4)

2-5: Verify the correctness of import paths.

Ensure that the paths for endaomentProjectCategoryMapping, endaomentProjects, NETWORK_IDS, and ReviewStatus are correct and the modules are available.

Verification successful

---

The import paths are correct.

The paths for endaomentProjectCategoryMapping, endaomentProjects, NETWORK_IDS, and ReviewStatus are valid and the modules are available.

• migration/data/endaomentProjectCategoryMapping.ts
• migration/data/importedEndaomentProjects.ts
• src/provider.ts
• src/entities/project.ts

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of imported modules.

# Test: Check if the files exist. Expect: All files to be found.
fd 'endaomentProjectCategoryMapping' --type f
fd 'importedEndaomentProjects' --type f
fd 'provider' --type f
fd 'project' --type f

Length of output: 8424

---

Line range hint 213-224:
Ensure the down method correctly reverts changes.

The down method should accurately revert the changes made by the up method, including deleting projects and related data.

Verification successful

---

The down method correctly reverts the changes made by the up method.

The down method accurately deletes the projects and project addresses associated with the Endaoment organization, ensuring proper rollback of changes.

• File: migration/1719808494904-add_endaoment_projects.ts
• Lines: 1-55

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the correctness of the `down` method.

# Test: Check if the `down` method correctly reverts changes. Expect: Proper deletion of projects and related data.
ast-grep --lang typescript --pattern $'async down(queryRunner: QueryRunner): Promise<void> { $$$ }'

Length of output: 582

---

Script:

#!/bin/bash
# Description: Verify the correctness of the `down` method.

# Test: Check if the `down` method correctly reverts changes. Expect: Proper deletion of projects and related data.
ast-grep --lang typescript --pattern $'function down(queryRunner: QueryRunner): Promise<void> { $$$ }'

Length of output: 103

---

Script:

#!/bin/bash
# Description: Verify the correctness of the `down` method.

# Test: Check if the `down` method correctly reverts changes. Expect: Proper deletion of projects and related data.

# Search for the `down` method in both `async` and non-`async` forms.
ast-grep --lang typescript --pattern $'async down(queryRunner: QueryRunner): Promise<void> { $$$ }' || \
ast-grep --lang typescript --pattern $'down(queryRunner: QueryRunner): Promise<void> { $$$ }'

Length of output: 1153

---

Script:

#!/bin/bash
# Description: Verify the correctness of the `down` method.

# Test: Check if the `down` method correctly reverts changes. Expect: Proper deletion of projects and related data.

# Search for the `down` method and include context lines to capture the surrounding code.
rg 'async down\(queryRunner: QueryRunner\): Promise<void>' -A 20

Length of output: 127608

---

91-94: Ensure the utility functions are correctly used.

The utility functions titleWithoutSpecialCharacters and creteSlugFromProject (typo noted) are used for slug generation. Ensure these functions are correctly implemented and return expected values.

---

Line range hint 117-142:
Ensure SQL queries handle special characters properly.

The SQL queries for inserting projects should handle special characters in project descriptions and titles to prevent SQL injection.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Meriem-BM]

LGTM @mohammadranjbarz !

[coderabbitai]

Actionable comments posted: 2

[coderabbitai]

Fix the typo in the import statement.

The function creteSlugFromProject seems to have a typo. It should likely be createSlugFromProject.

-  creteSlugFromProject,
+  createSlugFromProject,

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	creteSlugFromProject,
	titleWithoutSpecialCharacters,
	} from '../src/utils/utils';
	createSlugFromProject,
	titleWithoutSpecialCharacters,
	} from '../src/utils/utils';

[coderabbitai]

Optimize the getCategoryNames function.

The getCategoryNames function could be optimized for better readability and performance.

const getCategoryNames = (nteeCode: string): string[] => {
  const mapping = endaomentProjectCategoryMapping.find(
    category => category.nteeCode === nteeCode,
  );
  return mapping
    ? [mapping.category1, mapping.category2, mapping.category3, mapping.category4].filter(Boolean)
    : [];
};

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	const getCategoryNames = (nteeCode: string): string[] => {
	const mapping = endaomentProjectCategoryMapping.find(
	category => category.nteeCode === nteeCode,
	);
	return mapping
	? [
	mapping.category1,
	mapping.category2,
	mapping.category3,
	mapping.category4,
	].filter(Boolean)
	: [];
	};
	const categoryNames = getCategoryNames(String(project.nteeCode));
	const getCategoryNames = (nteeCode: string): string[] => {
	const mapping = endaomentProjectCategoryMapping.find(
	category => category.nteeCode === nteeCode,
	);
	return mapping
	? [mapping.category1, mapping.category2, mapping.category3, mapping.category4].filter(Boolean)
	: [];
	};
	const categoryNames = getCategoryNames(String(project.nteeCode));