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

v3.0.0 #32

Merged
merged 26 commits into from
Dec 2, 2024
Merged

v3.0.0 #32

merged 26 commits into from
Dec 2, 2024

Conversation

yxx4c
Copy link
Owner

@yxx4c yxx4c commented Dec 2, 2024

No description provided.

yxx4c and others added 26 commits November 24, 2024 22:36
…and better readability

feat(cache): include isCached flag in cache results to indicate cache status
refactor(cache): update cache key generation and retrieval to support optional cacheKey configuration
refactor(types): modify type definitions to accommodate new cache result structure and optional properties
…ce string for cache and database operations

chore(example): comment out optional transformer and cacheKey configurations for simplicity and future reference
style(example): improve code readability by formatting and organizing log messages
…uilding, and testing

feat(tests): create unit tests for user operations and cache management
chore: add bun configuration file for test coverage reporting
fix: update nodemon command to include bun fix for better build process
fix: update package.json test script to run bun test for consistency
fix: update .gitignore to exclude coverage and environment files
fix: remove unnecessary .gitignore from example directory
feat(prisma): set up Prisma schema and migrations for user management
feat(data): add mock user data for testing purposes
feat(functions): implement user management functions with caching capabilities
fix: adjust TypeScript configuration to include only source files in compilation
chore: change pretest command to use prisma migrate instead of generate
refactor: update cache type from STRING to JSON in client configuration
test: add unit tests for various user operations with different cache types
…bility and maintainability by consolidating cache commands into a single object

feat(cacheUncache.ts): implement CacheContext and RedisCacheCommands types for better type safety and clarity in cache operations
chore(cacheUncache.ts): remove redundant setCache and getCache implementations to streamline code and reduce duplication
fix(cacheUncache.ts): ensure correct handling of cache expiration and stale data logic in getCache function
refactor(types.ts): add CacheContext and RedisCacheCommands types to enhance type definitions for caching operations
feat(compose.yaml): add postgres service with configuration for user, password, and database
feat(compose.yaml): add latency service to simulate network delay for testing purposes
…ves after a specified time

test(staled-cache.test.ts): use delay function in user retrieval test to simulate waiting time before assertion
…stgres services for testing environment

fix(ci): modify test step to use local service URIs instead of secrets for easier local testing
…se methods for consistency and clarity

fix(cacheUncache.ts): update getCache function to use new method names for Redis commands to ensure proper functionality
refactor(types.ts): update RedisCacheCommands type definition to reflect method name changes for better type safety
… settings to enhance readability and maintainability
…obs and steps for a more streamlined publishing process

feat(publish.yml): change trigger from push to pull_request for better control over when the publish job runs
BREAKING CHANGE: The addition of cache context creates breaking changes
The response returned from prisma is now modified and returned as an
object with the key result in it, which contains the actual result.

- Additionally, this object contains the cache context such as
        isCached: Boolean; [True if data returned from cache, else false]
feat(cacheContext)!: Cache Context and More
chore(package.json): add semantic-release to automate versioning and …
…publish workflow to ensure it runs on code pushes to main and next branches
…ches for push and pull requests to improve CI process
…ns for better visibility of package versions
show latest and next npm version in readme, run test on push to dev and pr to all branches
chore(test.yml): remove pull_request trigger to streamline workflow
@yxx4c yxx4c merged commit 73cfda4 into main Dec 2, 2024
1 check passed
Copy link

github-actions bot commented Dec 2, 2024

🎉 This PR is included in version 3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant