@upstash/redis 0.0.0-ci.babdc47f97e036e2863dfed16300cda2b97bf6ad-20240322001434 → 0.0.0-ci.bb93ac2803c2e927dc8bf1a1b3c5aa2a14034eb6-20240930061920

package/eslint.config.mjs

@@ -0,0 +1,102 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import unicorn from "eslint-plugin-unicorn";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  {
+    ignores: ["**/*.config.*", "**/examples", "**/dist"],
+  },
+  ...compat.extends(
+    "eslint:recommended",
+    "plugin:unicorn/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ),
+  {
+    plugins: {
+      "@typescript-eslint": typescriptEslint,
+      unicorn,
+    },
+
+    languageOptions: {
+      globals: {},
+      ecmaVersion: 5,
+      sourceType: "script",
+
+      parserOptions: {
+        project: "./tsconfig.json",
+      },
+    },
+
+    rules: {
+      "no-console": [
+        "error",
+        {
+          allow: ["warn", "error"],
+        },
+      ],
+
+      "@typescript-eslint/no-magic-numbers": "off",
+      "@typescript-eslint/unbound-method": "off",
+      "@typescript-eslint/prefer-as-const": "error",
+      "@typescript-eslint/consistent-type-imports": "error",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/restrict-template-expressions": "off",
+
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          varsIgnorePattern: "^_",
+          argsIgnorePattern: "^_",
+        },
+      ],
+
+      "@typescript-eslint/prefer-ts-expect-error": "off",
+
+      "@typescript-eslint/no-misused-promises": [
+        "error",
+        {
+          checksVoidReturn: false,
+        },
+      ],
+
+      "unicorn/prevent-abbreviations": "off",
+
+      "no-implicit-coercion": [
+        "error",
+        {
+          boolean: true,
+        },
+      ],
+
+      "no-extra-boolean-cast": [
+        "error",
+        {
+          enforceForLogicalOperands: true,
+        },
+      ],
+
+      "no-unneeded-ternary": [
+        "error",
+        {
+          defaultAssignment: true,
+        },
+      ],
+
+      "unicorn/no-array-reduce": ["off"],
+      "unicorn/no-nested-ternary": "off",
+      "unicorn/no-null": "off",
+      "unicorn/filename-case": "off",
+    },
+  },
+];

package/examples/auto-pipeline/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

package/examples/auto-pipeline/README.md

@@ -0,0 +1,77 @@
+## Auto Pipeline Example
+
+This nextjs example showcases how Auto Pipelining works.
+
+In the `app/data/redis.ts` file, we define a redis client with `enableAutoPipelining: true`:
+
+```tsx
+import { Redis } from '@upstash/redis'
+
+export const LATENCY_LOGGING = true
+export const ENABLE_AUTO_PIPELINING = true
+
+const client = Redis.fromEnv({
+  latencyLogging: LATENCY_LOGGING,
+  enableAutoPipelining: ENABLE_AUTO_PIPELINING
+});
+
+export default client;
+```
+
+We utilize this client in the `app/data/getUsers.ts` and `app/data/getEvents.ts` files to fetch data from the redis server (if there is no data, we insert data for the purposes of this example):
+
+```tsx
+// app/data/getUsers.ts
+
+import client from "./redis"
+
+export async function getUsers() {
+  const keys = await client.scan(0, { match: 'user:*' });
+
+  if (keys[1].length === 0) {
+    // If no keys found, insert sample data
+    client.hmset('user:1', {'username': 'Adam', 'birthday': '1990-01-01'});
+    client.hmset('user:2', {'username': 'Eve', 'birthday': '1980-01-05'});
+    // Add more sample users as needed
+  }
+
+  const users = await Promise.all(keys[1].map(async key => {
+    return client.hgetall(key) ?? {username: "default", birthday: "2000-01-01"};
+  }));
+  return users as {username: string, birthday: string}[]
+}
+```
+
+Both `getUsers` and `getEvents` work in a similar way. They first call and await scan to get the keys. Then, they call `HGETALL` with these keys.
+
+We import the `getUsers` and `getEvents` methods in our page `app/components/page.tsx`:
+
+```tsx
+"use server"
+import client from "../data/redis"
+import { getEvents } from "../data/getEvents";
+import { getUsers } from "../data/getUsers";
+
+const DataComponent = async () => {
+
+
+  const [ users, events ] = await Promise.all([
+    getUsers(),
+    getEvents()
+  ])
+
+  // @ts-ignore pipelineCounter is accessible but not available in the type
+  const counter = client.pipelineCounter
+
+  return (
+    <div>
+    ... skipped to keep the README short ...
+    </div>
+  );
+};
+
+export default DataComponent;
+
+```
+
+Thanks to auto pipelining, the scan commands from the two methods are sent in a single pipeline call. Then, the 4 `HGETALL` commands are sent in a second pipeline. In the end, 6 commands are sent with only two pipelines, with minimal overhead for the programmer.

package/examples/auto-pipeline/app/components/DataComponent.tsx

@@ -0,0 +1,49 @@
+"use server"
+import client from "../data/redis"
+import { getEvents } from "../data/getEvents";
+import { getUsers } from "../data/getUsers";
+
+const DataComponent = async () => {
+
+
+  const [ users, events ] = await Promise.all([
+    getUsers(),
+    getEvents()
+  ])
+
+  // @ts-ignore pipelineCounter is accessible but not available in the type
+  const counter = client.pipelineCounter
+
+  return (
+    <div>
+
+      <div>
+        <h2>Users</h2>
+        <ul>
+          {users.map(user =>
+            <li key={user.username}>
+              <strong>{user.username}</strong> - {user.birthday}
+            </li>
+          )}
+        </ul>
+      </div>
+
+      <div>
+        <h2>Events</h2>
+        <ul>
+          {events.map(event =>
+            <li key={event.name}>
+              <strong>{event.name}</strong> - {event.date}
+            </li>
+          )}
+        </ul>
+      </div>
+
+      <div>
+        <h2>Number of Pipelines Called:</h2> {counter}
+      </div>
+    </div>
+  );
+};
+
+export default DataComponent;

package/examples/auto-pipeline/app/data/getEvents.ts

@@ -0,0 +1,18 @@
+
+import client from "./redis"
+
+export async function getEvents() {
+  const keys = await client.scan(0, { match: 'event:*' });
+
+  if (keys[1].length === 0) {
+    // If no keys found, insert sample data
+    client.hmset('event:1', {'name': 'Sample Event 1', 'date': '2024-05-13'});
+    client.hmset('event:2', {'name': 'Sample Event 2', 'date': '2024-05-14'});
+    // Add more sample events as needed
+  }
+
+  const events = await Promise.all(keys[1].map(async key => {
+    return client.hgetall(key) ?? {name: "default", date: "2000-01-01"};
+  }));
+  return events as {name: string, date: string}[]
+};

package/examples/auto-pipeline/app/data/getUsers.ts

@@ -0,0 +1,18 @@
+
+import client from "./redis"
+
+export async function getUsers() {
+  const keys = await client.scan(0, { match: 'user:*' });
+
+  if (keys[1].length === 0) {
+    // If no keys found, insert sample data
+    client.hmset('user:1', {'username': 'Adam', 'birthday': '1990-01-01'});
+    client.hmset('user:2', {'username': 'Eve', 'birthday': '1980-01-05'});
+    // Add more sample users as needed
+  }
+
+  const users = await Promise.all(keys[1].map(async key => {
+    return client.hgetall(key) ?? {username: "default", birthday: "2000-01-01"};
+  }));
+  return users as {username: string, birthday: string}[]
+}

package/examples/auto-pipeline/app/data/redis.ts

@@ -0,0 +1,12 @@
+
+import { Redis } from '@upstash/redis'
+
+export const LATENCY_LOGGING = true
+export const ENABLE_AUTO_PIPELINING = true
+
+const client = Redis.fromEnv({
+  latencyLogging: LATENCY_LOGGING,
+  enableAutoPipelining: ENABLE_AUTO_PIPELINING
+});
+
+export default client;

package/examples/auto-pipeline/app/layout.tsx

@@ -0,0 +1,22 @@
+import type { Metadata } from "next";
+import { Inter } from "next/font/google";
+import "./globals.css";
+
+const inter = Inter({ subsets: ["latin"] });
+
+export const metadata: Metadata = {
+  title: "Create Next App",
+  description: "Generated by create next app",
+};
+
+export default function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  return (
+    <html lang="en">
+      <body className={inter.className}>{children}</body>
+    </html>
+  );
+}

package/examples/auto-pipeline/app/page.tsx

@@ -0,0 +1,15 @@
+"use server"
+
+import React from 'react';
+import DataComponent from './components/DataComponent'
+
+const HomePage = () => {
+  return (
+    <div>
+      <h1>Home Page</h1>
+      <DataComponent />
+    </div>
+  );
+};
+
+export default HomePage;

package/examples/auto-pipeline/next.config.mjs

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default nextConfig;

package/examples/auto-pipeline/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "auto-pipeline",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@upstash/redis": "latest",
+    "next": "14.2.3",
+    "react": "^18",
+    "react-dom": "^18"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "eslint": "^8",
+    "eslint-config-next": "14.2.3",
+    "postcss": "^8",
+    "tailwindcss": "^3.4.1",
+    "typescript": "^5"
+  }
+}

package/examples/auto-pipeline/postcss.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    tailwindcss: {},
+  },
+};
+
+export default config;

package/examples/auto-pipeline/public/next.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

package/examples/auto-pipeline/public/vercel.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 283 64"><path fill="black" d="M141 16c-11 0-19 7-19 18s9 18 20 18c7 0 13-3 16-7l-7-5c-2 3-6 4-9 4-5 0-9-3-10-7h28v-3c0-11-8-18-19-18zm-9 15c1-4 4-7 9-7s8 3 9 7h-18zm117-15c-11 0-19 7-19 18s9 18 20 18c6 0 12-3 16-7l-8-5c-2 3-5 4-8 4-5 0-9-3-11-7h28l1-3c0-11-8-18-19-18zm-10 15c2-4 5-7 10-7s8 3 9 7h-19zm-39 3c0 6 4 10 10 10 4 0 7-2 9-5l8 5c-3 5-9 8-17 8-11 0-19-7-19-18s8-18 19-18c8 0 14 3 17 8l-8 5c-2-3-5-5-9-5-6 0-10 4-10 10zm83-29v46h-9V5h9zM37 0l37 64H0L37 0zm92 5-27 48L74 5h10l18 30 17-30h10zm59 12v10l-3-1c-6 0-10 4-10 10v15h-9V17h9v9c0-5 6-9 13-9z"/></svg>

package/examples/auto-pipeline/tailwind.config.ts

@@ -0,0 +1,20 @@
+import type { Config } from "tailwindcss";
+
+const config: Config = {
+  content: [
+    "./pages/**/*.{js,ts,jsx,tsx,mdx}",
+    "./components/**/*.{js,ts,jsx,tsx,mdx}",
+    "./app/**/*.{js,ts,jsx,tsx,mdx}",
+  ],
+  theme: {
+    extend: {
+      backgroundImage: {
+        "gradient-radial": "radial-gradient(var(--tw-gradient-stops))",
+        "gradient-conic":
+          "conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))",
+      },
+    },
+  },
+  plugins: [],
+};
+export default config;

package/examples/auto-pipeline/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/examples/aws-cdk-python/README.md

@@ -0,0 +1,36 @@
+# AWS CDK TypeScript Example
+
+### Prerequisites
+
+- Complete all steps in [Getting started with the AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html)
+
+### Project Setup
+
+Clone the example and install dependencies
+
+```shell
+git clone https://github.com/upstash/redis-js.git
+cd redis-js/examples/aws-cdk-python
+npm install
+```
+
+### Database Setup
+
+Create a Redis database using [Upstash Console](https://console.upstash.com) or [Upstash CLI](https://github.com/upstash/cli) and export `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` to your environment.
+
+```shell
+export UPSTASH_REDIS_REST_URL=<YOUR_URL>
+export UPSTASH_REDIS_REST_TOKEN=<YOUR_TOKEN>
+```
+
+### Deploy
+
+Run in the top folder:
+
+```shell
+cdk synth
+cdk bootstrap
+cdk deploy
+```
+
+Visit the output url.

package/examples/aws-cdk-python/cdk.json

@@ -0,0 +1,72 @@
+{
+  "app": "npx ts-node --prefer-ts-exts bin/aws-cdk-python.ts",
+  "watch": {
+    "include": [
+      "**"
+    ],
+    "exclude": [
+      "README.md",
+      "cdk*.json",
+      "**/*.d.ts",
+      "**/*.js",
+      "tsconfig.json",
+      "package*.json",
+      "yarn.lock",
+      "node_modules",
+      "test"
+    ]
+  },
+  "context": {
+    "@aws-cdk/aws-lambda:recognizeLayerVersion": true,
+    "@aws-cdk/core:checkSecretUsage": true,
+    "@aws-cdk/core:target-partitions": [
+      "aws",
+      "aws-cn"
+    ],
+    "@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
+    "@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
+    "@aws-cdk/aws-ecs:arnFormatIncludesClusterName": true,
+    "@aws-cdk/aws-iam:minimizePolicies": true,
+    "@aws-cdk/core:validateSnapshotRemovalPolicy": true,
+    "@aws-cdk/aws-codepipeline:crossAccountKeyAliasStackSafeResourceName": true,
+    "@aws-cdk/aws-s3:createDefaultLoggingPolicy": true,
+    "@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption": true,
+    "@aws-cdk/aws-apigateway:disableCloudWatchRole": true,
+    "@aws-cdk/core:enablePartitionLiterals": true,
+    "@aws-cdk/aws-events:eventsTargetQueueSameAccount": true,
+    "@aws-cdk/aws-iam:standardizedServicePrincipals": true,
+    "@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker": true,
+    "@aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName": true,
+    "@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy": true,
+    "@aws-cdk/aws-route53-patters:useCertificate": true,
+    "@aws-cdk/customresources:installLatestAwsSdkDefault": false,
+    "@aws-cdk/aws-rds:databaseProxyUniqueResourceName": true,
+    "@aws-cdk/aws-codedeploy:removeAlarmsFromDeploymentGroup": true,
+    "@aws-cdk/aws-apigateway:authorizerChangeDeploymentLogicalId": true,
+    "@aws-cdk/aws-ec2:launchTemplateDefaultUserData": true,
+    "@aws-cdk/aws-secretsmanager:useAttachedSecretResourcePolicyForSecretTargetAttachments": true,
+    "@aws-cdk/aws-redshift:columnId": true,
+    "@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2": true,
+    "@aws-cdk/aws-ec2:restrictDefaultSecurityGroup": true,
+    "@aws-cdk/aws-apigateway:requestValidatorUniqueId": true,
+    "@aws-cdk/aws-kms:aliasNameRef": true,
+    "@aws-cdk/aws-autoscaling:generateLaunchTemplateInsteadOfLaunchConfig": true,
+    "@aws-cdk/core:includePrefixInUniqueNameGeneration": true,
+    "@aws-cdk/aws-efs:denyAnonymousAccess": true,
+    "@aws-cdk/aws-opensearchservice:enableOpensearchMultiAzWithStandby": true,
+    "@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion": true,
+    "@aws-cdk/aws-efs:mountTargetOrderInsensitiveLogicalId": true,
+    "@aws-cdk/aws-rds:auroraClusterChangeScopeOfInstanceParameterGroupWithEachParameters": true,
+    "@aws-cdk/aws-appsync:useArnForSourceApiAssociationIdentifier": true,
+    "@aws-cdk/aws-rds:preventRenderingDeprecatedCredentials": true,
+    "@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource": true,
+    "@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction": true,
+    "@aws-cdk/aws-codepipeline:crossAccountKeysDefaultValueToFalse": true,
+    "@aws-cdk/aws-codepipeline:defaultPipelineTypeToV2": true,
+    "@aws-cdk/aws-kms:reduceCrossAccountRegionPolicyScope": true,
+    "@aws-cdk/aws-eks:nodegroupNameAttribute": true,
+    "@aws-cdk/aws-ec2:ebsDefaultGp3Volume": true,
+    "@aws-cdk/aws-ecs:removeDefaultDeploymentAlarm": true,
+    "@aws-cdk/custom-resources:logApiResponseDataPropertyTrueDefault": false
+  }
+}

package/examples/aws-cdk-python/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  testEnvironment: 'node',
+  roots: ['<rootDir>/test'],
+  testMatch: ['**/*.test.ts'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  }
+};

package/examples/aws-cdk-python/lib/api/index.py

@@ -0,0 +1,10 @@
+from upstash_redis import Redis
+
+redis = Redis.from_env()
+
+def handler(event, context):
+    count = redis.incr('counter')
+    return {
+        'statusCode': 200,
+        'body': f'Counter: {count}'
+    }

package/examples/aws-cdk-python/lib/api/requirements.txt

@@ -0,0 +1 @@
+upstash-redis