Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(api): uses akash-api protobuf generated files instead of local ones (#184) #73

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

ygrishajev
Copy link
Contributor

@ygrishajev ygrishajev commented Apr 8, 2024

Summary

This PR updates our project's approach to managing dependencies and configurations, introduces codebase cleanups, and modifies testing frameworks. We are transitioning to using akash-api protobuf-generated files, reducing reliance on locally maintained versions while ensuring continued support for older client project dependencies.

Changes

  1. Protobuf Integration: Transitioned to using akash-api protobuf-generated files instead of local versions. This shift ensures alignment with the latest specifications and streamlines our data models.

  2. Legacy Support: Maintained local protobuf files under v1beta1 to support client projects that depend on these older versions. This ensures compatibility and stability for existing implementations.

  3. TypeScript Configuration: Updated tsconfig.json to include the akash-api package exports. This enhancement simplifies module resolution and optimizes our TypeScript environment.

  4. Code Cleanup: Eliminated unused sections of code from our codebase, enhancing readability and maintainability.

  5. Testing with Deployment Snapshot: Updated the deployment snapshot used in our tests. Please review and confirm that the new snapshot functions correctly and meets the test scenarios' requirements in our environment.

  6. Local Testing Setup: Temporarily included a zipped version of the akash-api package locally to facilitate passing CI tests. This measure will remain until the package is available on npm, allowing uninterrupted progress in development and testing.

Request for Confirmation

  • Please review the changes to the deployment snapshot and confirm its efficacy for use in our testing frameworks. Your confirmation is critical to ensure our testing environments accurately reflect production conditions.

Notes

  • This PR will be in draft status until akash-api is available on npm. This strategy prevents external dependencies from hindering our development and testing processes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

had to change this snapshot for tests to pass. To me it seems safe. However would like to get a confirmation

tsconfig.json Outdated
@@ -43,7 +43,7 @@
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
"moduleResolution": "Node16" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would allow to support npm packages exports definition natively

package.json Outdated Show resolved Hide resolved
@ygrishajev ygrishajev force-pushed the feature/akash-api branch 2 times, most recently from ce667cd to 94f73e9 Compare April 12, 2024 09:18
@ygrishajev ygrishajev requested a review from a team April 12, 2024 09:26
@ygrishajev ygrishajev changed the title Feature/akash api Use akash-api protobuf generated files instead of local ones (#184) Apr 12, 2024
@ygrishajev ygrishajev marked this pull request as ready for review April 17, 2024 15:24
@@ -83,7 +84,7 @@
"ts-loader": "^9.2.3",
"ts-node": "^10.0.0",
"ts-proto": "^1.104.0",
"typescript": "^4.3.4",
"typescript": "^4.7.4",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was a locked version anyway

@ygrishajev ygrishajev changed the title Use akash-api protobuf generated files instead of local ones (#184) refactor(api): uses akash-api protobuf generated files instead of local ones (#184) Apr 17, 2024

Verified

This commit was signed with the committer’s verified signature.
ygrishajev Iaroslav Gryshaiev
…al ones (#184)
@@ -58,7 +58,6 @@ Object {
},
],
"signedBy": Object {
"allOf": Array [],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you test a deployment with this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so. I did the same flow as we did together

@ygrishajev ygrishajev requested review from baktun14 and Redm4x April 18, 2024 16:27
@ygrishajev ygrishajev merged commit 47e9624 into main Apr 19, 2024
1 check passed
@ygrishajev ygrishajev deleted the feature/akash-api branch April 19, 2024 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants