aigroup-workflow 2.1.2 → 2.2.0

package/skills/backend/graphql-architect/references/subscriptions.md

@@ -0,0 +1,510 @@
+# GraphQL Subscriptions
+
+## Basic Subscription Setup
+
+```typescript
+// schema.graphql
+type Subscription {
+  postCreated: Post!
+  postUpdated(id: ID!): Post!
+  commentAdded(postId: ID!): Comment!
+  userOnline: User!
+}
+
+type Post {
+  id: ID!
+  title: String!
+  content: String!
+  author: User!
+}
+
+type Comment {
+  id: ID!
+  content: String!
+  author: User!
+  post: Post!
+}
+
+// server.ts
+import { createServer } from 'http';
+import { ApolloServer } from '@apollo/server';
+import { expressMiddleware } from '@apollo/server/express4';
+import { ApolloServerPluginDrainHttpServer } from '@apollo/server/plugin/drainHttpServer';
+import { makeExecutableSchema } from '@graphql-tools/schema';
+import { WebSocketServer } from 'ws';
+import { useServer } from 'graphql-ws/lib/use/ws';
+import express from 'express';
+
+const schema = makeExecutableSchema({ typeDefs, resolvers });
+
+const app = express();
+const httpServer = createServer(app);
+
+// WebSocket server for subscriptions
+const wsServer = new WebSocketServer({
+  server: httpServer,
+  path: '/graphql',
+});
+
+const serverCleanup = useServer(
+  {
+    schema,
+    context: async (ctx, msg, args) => {
+      // Extract auth from connection params
+      const token = ctx.connectionParams?.authorization;
+      const user = token ? await verifyToken(token) : null;
+      return { user };
+    },
+  },
+  wsServer
+);
+
+const server = new ApolloServer({
+  schema,
+  plugins: [
+    ApolloServerPluginDrainHttpServer({ httpServer }),
+    {
+      async serverWillStart() {
+        return {
+          async drainServer() {
+            await serverCleanup.dispose();
+          },
+        };
+      },
+    },
+  ],
+});
+
+await server.start();
+app.use('/graphql', express.json(), expressMiddleware(server));
+
+httpServer.listen(4000);
+```
+
+## PubSub Implementation
+
+```typescript
+// pubsub.ts
+import { RedisPubSub } from 'graphql-redis-subscriptions';
+import Redis from 'ioredis';
+
+// In-memory (development only)
+import { PubSub } from 'graphql-subscriptions';
+export const pubsub = new PubSub();
+
+// Redis (production)
+const options = {
+  host: process.env.REDIS_HOST || 'localhost',
+  port: parseInt(process.env.REDIS_PORT || '6379'),
+  retryStrategy: (times: number) => Math.min(times * 50, 2000),
+};
+
+export const pubsub = new RedisPubSub({
+  publisher: new Redis(options),
+  subscriber: new Redis(options),
+});
+
+// Strongly typed event names
+export const EVENTS = {
+  POST_CREATED: 'POST_CREATED',
+  POST_UPDATED: 'POST_UPDATED',
+  COMMENT_ADDED: 'COMMENT_ADDED',
+  USER_ONLINE: 'USER_ONLINE',
+} as const;
+```
+
+## Subscription Resolvers
+
+```typescript
+import { withFilter } from 'graphql-subscriptions';
+import { pubsub, EVENTS } from './pubsub';
+
+const resolvers = {
+  Subscription: {
+    // Simple subscription
+    postCreated: {
+      subscribe: () => pubsub.asyncIterator([EVENTS.POST_CREATED]),
+    },
+
+    // Filtered subscription
+    postUpdated: {
+      subscribe: withFilter(
+        () => pubsub.asyncIterator([EVENTS.POST_UPDATED]),
+        (payload, variables) => {
+          // Only send updates for specific post
+          return payload.postUpdated.id === variables.id;
+        }
+      ),
+    },
+
+    // Filtered with authorization
+    commentAdded: {
+      subscribe: withFilter(
+        (parent, args, context) => {
+          // Check auth before subscribing
+          if (!context.user) {
+            throw new Error('Unauthorized');
+          }
+          return pubsub.asyncIterator([EVENTS.COMMENT_ADDED]);
+        },
+        async (payload, variables, context) => {
+          // Filter by post and check permissions
+          if (payload.commentAdded.postId !== variables.postId) {
+            return false;
+          }
+
+          // Check if user has access to post
+          const post = await context.dataSources.posts.findById(
+            variables.postId
+          );
+          return post && post.isPublic || post.authorId === context.user.id;
+        }
+      ),
+    },
+
+    // Complex subscription with multiple filters
+    userOnline: {
+      subscribe: withFilter(
+        () => pubsub.asyncIterator([EVENTS.USER_ONLINE]),
+        (payload, variables, context) => {
+          // Only notify friends
+          return context.user.friends.includes(payload.userOnline.id);
+        }
+      ),
+    },
+  },
+
+  Mutation: {
+    createPost: async (parent, args, context) => {
+      const post = await context.dataSources.posts.create(args.input);
+
+      // Publish event
+      await pubsub.publish(EVENTS.POST_CREATED, {
+        postCreated: post,
+      });
+
+      return post;
+    },
+
+    updatePost: async (parent, args: { id: string; input: any }, context) => {
+      const post = await context.dataSources.posts.update(
+        args.id,
+        args.input
+      );
+
+      await pubsub.publish(EVENTS.POST_UPDATED, {
+        postUpdated: post,
+      });
+
+      return post;
+    },
+
+    addComment: async (parent, args, context) => {
+      const comment = await context.dataSources.comments.create(args.input);
+
+      await pubsub.publish(EVENTS.COMMENT_ADDED, {
+        commentAdded: comment,
+      });
+
+      return comment;
+    },
+  },
+};
+```
+
+## Advanced Filtering
+
+```typescript
+// Type-safe payload
+interface PostCreatedPayload {
+  postCreated: Post;
+  tags: string[];
+  isPublic: boolean;
+}
+
+const resolvers = {
+  Subscription: {
+    postCreated: {
+      subscribe: withFilter(
+        () => pubsub.asyncIterator([EVENTS.POST_CREATED]),
+        async (
+          payload: PostCreatedPayload,
+          variables: { tags?: string[]; authorId?: string },
+          context: Context
+        ) => {
+          // Filter by tags
+          if (variables.tags && variables.tags.length > 0) {
+            const hasMatchingTag = payload.tags.some(tag =>
+              variables.tags!.includes(tag)
+            );
+            if (!hasMatchingTag) return false;
+          }
+
+          // Filter by author
+          if (variables.authorId) {
+            if (payload.postCreated.authorId !== variables.authorId) {
+              return false;
+            }
+          }
+
+          // Check permissions
+          if (!payload.isPublic) {
+            return (
+              context.user?.id === payload.postCreated.authorId ||
+              context.user?.isAdmin
+            );
+          }
+
+          return true;
+        }
+      ),
+    },
+  },
+};
+```
+
+## Connection Management
+
+```typescript
+import { useServer } from 'graphql-ws/lib/use/ws';
+
+const wsServer = useServer(
+  {
+    schema,
+
+    // Connection lifecycle
+    onConnect: async (ctx) => {
+      console.log('Client connected');
+      const token = ctx.connectionParams?.authorization;
+
+      if (!token) {
+        throw new Error('Missing auth token');
+      }
+
+      const user = await verifyToken(token);
+      if (!user) {
+        throw new Error('Invalid token');
+      }
+
+      return { user };
+    },
+
+    onDisconnect: (ctx, code, reason) => {
+      console.log('Client disconnected', code, reason);
+    },
+
+    // Subscription lifecycle
+    onSubscribe: async (ctx, msg) => {
+      console.log('Client subscribed', msg.payload.operationName);
+
+      // Rate limiting
+      const subscriptionCount = getUserSubscriptionCount(ctx.user.id);
+      if (subscriptionCount >= 10) {
+        throw new Error('Too many subscriptions');
+      }
+
+      return { ctx, msg };
+    },
+
+    onComplete: (ctx, msg) => {
+      console.log('Subscription completed', msg.id);
+    },
+
+    // Keep-alive
+    connectionInitWaitTimeout: 10000,
+
+    // Context per subscription
+    context: async (ctx, msg, args) => {
+      const user = ctx.extra.user;
+      return {
+        user,
+        dataSources: createDataSources(),
+        subscriptionId: msg.id,
+      };
+    },
+  },
+  wsServer
+);
+```
+
+## Subscription Patterns
+
+```typescript
+// Pattern 1: Entity updates
+type Subscription {
+  entityUpdated(id: ID!): Entity!
+}
+
+// Pattern 2: Collection updates
+type Subscription {
+  entityAdded: Entity!
+  entityDeleted: ID!
+}
+
+// Pattern 3: Stream of events
+type Subscription {
+  events(types: [EventType!]): Event!
+}
+
+// Pattern 4: Live query (with intervals)
+type Subscription {
+  liveQuery(query: String!): [SearchResult!]!
+}
+
+// resolvers.ts
+const resolvers = {
+  Subscription: {
+    // Live query implementation
+    liveQuery: {
+      subscribe: async function* (parent, args, context) {
+        while (true) {
+          const results = await context.dataSources.search(args.query);
+          yield { liveQuery: results };
+          await new Promise(resolve => setTimeout(resolve, 5000));
+        }
+      },
+    },
+  },
+};
+```
+
+## Error Handling
+
+```typescript
+const resolvers = {
+  Subscription: {
+    postCreated: {
+      subscribe: withFilter(
+        () => pubsub.asyncIterator([EVENTS.POST_CREATED]),
+        async (payload, variables, context) => {
+          try {
+            // Check permissions
+            if (!context.user) {
+              throw new GraphQLError('Unauthorized', {
+                extensions: { code: 'UNAUTHENTICATED' },
+              });
+            }
+
+            return true;
+          } catch (error) {
+            // Log error but don't propagate to client
+            console.error('Subscription filter error:', error);
+            return false;
+          }
+        }
+      ),
+
+      // Resolve subscription payload
+      resolve: (payload) => {
+        try {
+          return payload.postCreated;
+        } catch (error) {
+          throw new GraphQLError('Failed to resolve subscription', {
+            extensions: { code: 'SUBSCRIPTION_RESOLVE_ERROR' },
+          });
+        }
+      },
+    },
+  },
+};
+```
+
+## Client Usage
+
+```typescript
+// Apollo Client setup
+import { ApolloClient, InMemoryCache, split, HttpLink } from '@apollo/client';
+import { GraphQLWsLink } from '@apollo/client/link/subscriptions';
+import { getMainDefinition } from '@apollo/client/utilities';
+import { createClient } from 'graphql-ws';
+
+const httpLink = new HttpLink({
+  uri: 'http://localhost:4000/graphql',
+});
+
+const wsLink = new GraphQLWsLink(
+  createClient({
+    url: 'ws://localhost:4000/graphql',
+    connectionParams: {
+      authorization: `Bearer ${token}`,
+    },
+  })
+);
+
+const splitLink = split(
+  ({ query }) => {
+    const definition = getMainDefinition(query);
+    return (
+      definition.kind === 'OperationDefinition' &&
+      definition.operation === 'subscription'
+    );
+  },
+  wsLink,
+  httpLink
+);
+
+const client = new ApolloClient({
+  link: splitLink,
+  cache: new InMemoryCache(),
+});
+
+// Subscribe to events
+const subscription = client
+  .subscribe({
+    query: gql`
+      subscription OnPostCreated {
+        postCreated {
+          id
+          title
+          author {
+            username
+          }
+        }
+      }
+    `,
+  })
+  .subscribe({
+    next: (data) => console.log('New post:', data),
+    error: (err) => console.error('Subscription error:', err),
+    complete: () => console.log('Subscription completed'),
+  });
+
+// Unsubscribe
+subscription.unsubscribe();
+```
+
+## Scaling Subscriptions
+
+```typescript
+// Use Redis for multi-instance deployments
+import { RedisPubSub } from 'graphql-redis-subscriptions';
+
+// Horizontal scaling pattern
+const pubsub = new RedisPubSub({
+  publisher: new Redis(redisConfig),
+  subscriber: new Redis(redisConfig),
+  // Channel prefix for isolation
+  publisherPrefix: 'graphql:pub:',
+  subscriberPrefix: 'graphql:sub:',
+});
+
+// Connection limit per instance
+const MAX_CONNECTIONS_PER_INSTANCE = 10000;
+
+// Load balancing with sticky sessions
+// Ensure same user connects to same server instance
+// for connection state management
+```
+
+## Subscription Best Practices
+
+1. **Authentication**: Always validate auth in onConnect and filters
+2. **Authorization**: Check permissions in withFilter
+3. **Rate Limiting**: Limit subscriptions per user
+4. **Filtering**: Use withFilter for server-side filtering
+5. **Cleanup**: Always clean up subscriptions on disconnect
+6. **Scaling**: Use Redis PubSub for multi-instance deployments
+7. **Error Handling**: Gracefully handle errors in filters and resolvers
+8. **Testing**: Test subscription lifecycle and filtering
+9. **Monitoring**: Track active connections and subscription count
+10. **Performance**: Avoid N+1 in subscription resolvers

package/skills/backend/legacy-modernizer/SKILL.md

@@ -0,0 +1,137 @@
+---
+name: legacy-modernizer
+description: Designs incremental migration strategies, identifies service boundaries, produces dependency maps and migration roadmaps, and generates API facade designs for aging codebases. Use when modernizing legacy systems, implementing strangler fig pattern or branch by abstraction, decomposing monoliths, upgrading frameworks or languages, or reducing technical debt without disrupting business operations.
+license: MIT
+metadata:
+  author: https://github.com/Jeffallan
+  version: "1.1.0"
+  domain: specialized
+  triggers: legacy modernization, strangler fig, incremental migration, technical debt, legacy refactoring, system migration, legacy system, modernize codebase
+  role: specialist
+  scope: architecture
+  output-format: code+analysis
+  related-skills: test-master, devops-engineer
+---
+
+# Legacy Modernizer
+
+## Core Workflow
+
+1. **Assess system** — Analyze codebase, dependencies, risks, and business constraints. Produce a dependency map and risk register before proceeding.
+   - *Validation checkpoint:* Confirm all external integrations and data contracts are documented before moving to step 2.
+
+2. **Plan migration** — Design an incremental roadmap with explicit rollback strategies per phase. Reference `references/system-assessment.md` for code analysis templates.
+   - *Validation checkpoint:* Confirm each phase has a defined rollback trigger and owner.
+
+3. **Build safety net** — Create characterization tests and monitoring before touching production code. Target 80%+ coverage of existing behavior.
+   - *Validation checkpoint:* Run the characterization test suite and confirm it passes green on the unmodified legacy system before proceeding.
+
+4. **Migrate incrementally** — Apply strangler fig pattern with feature flags. Route traffic via a facade; shift load gradually.
+   - *Validation checkpoint:* Verify error rates and latency metrics remain within baseline thresholds after each traffic increment (e.g., 5% → 25% → 50% → 100%).
+
+5. **Validate & iterate** — Run full test suite, review monitoring dashboards, and confirm business behavior is preserved before retiring legacy code.
+   - *Validation checkpoint:* New code must be proven stable at 100% traffic for at least one release cycle before legacy path is removed.
+
+## Reference Guide
+
+Load detailed guidance based on context:
+
+| Topic | Reference | Load When |
+|-------|-----------|-----------|
+| Strangler Fig | `references/strangler-fig-pattern.md` | Incremental replacement, facade layer, routing |
+| Refactoring | `references/refactoring-patterns.md` | Extract service, branch by abstraction, adapters |
+| Migration | `references/migration-strategies.md` | Database, UI, API, framework migrations |
+| Testing | `references/legacy-testing.md` | Characterization tests, golden master, approval |
+| Assessment | `references/system-assessment.md` | Code analysis, dependency mapping, risk evaluation |
+
+## Code Examples
+
+### Strangler Fig Facade (Python)
+```python
+# facade.py — routes requests to legacy or new service based on a feature flag
+import os
+from legacy_service import LegacyOrderService
+from new_service import NewOrderService
+
+class OrderServiceFacade:
+    def __init__(self):
+        self._legacy = LegacyOrderService()
+        self._new = NewOrderService()
+
+    def get_order(self, order_id: str):
+        if os.getenv("USE_NEW_ORDER_SERVICE", "false").lower() == "true":
+            return self._new.fetch(order_id)
+        return self._legacy.get(order_id)
+```
+
+### Feature Flag Wrapper
+```python
+# feature_flags.py — thin wrapper around an environment or config-based flag store
+import os
+
+def flag_enabled(flag_name: str, default: bool = False) -> bool:
+    """Check whether a migration feature flag is active."""
+    return os.getenv(flag_name, str(default)).lower() == "true"
+
+# Usage
+if flag_enabled("USE_NEW_PAYMENT_GATEWAY"):
+    result = new_gateway.charge(order)
+else:
+    result = legacy_gateway.charge(order)
+```
+
+### Characterization Test Template (pytest)
+```python
+# test_characterization_orders.py
+# Captures existing legacy behavior as a golden-master safety net.
+import pytest
+from legacy_service import LegacyOrderService
+
+service = LegacyOrderService()
+
+@pytest.mark.parametrize("order_id,expected_status", [
+    ("ORD-001", "SHIPPED"),
+    ("ORD-002", "PENDING"),
+    ("ORD-003", "CANCELLED"),
+])
+def test_order_status_golden_master(order_id, expected_status):
+    """Fail loudly if legacy behavior changes unexpectedly."""
+    result = service.get(order_id)
+    assert result["status"] == expected_status, (
+        f"Characterization broken for {order_id}: "
+        f"expected {expected_status}, got {result['status']}"
+    )
+```
+
+## Constraints
+
+### MUST DO
+- Maintain zero production disruption during all migrations
+- Create comprehensive test coverage before refactoring (target 80%+)
+- Use feature flags for all incremental rollouts
+- Implement monitoring and rollback procedures
+- Document all migration decisions and rationale
+- Preserve existing business logic and behavior
+- Communicate progress and risks transparently
+
+### MUST NOT DO
+- Big bang rewrites or replacements
+- Skip testing legacy behavior before changes
+- Deploy without rollback capability
+- Break existing integrations or APIs
+- Ignore technical debt in new code
+- Rush migrations without proper validation
+- Remove legacy code before new code is proven
+
+## Output Templates
+
+When implementing modernization, provide:
+1. Assessment summary (risks, dependencies, approach)
+2. Migration plan (phases, rollback strategy, metrics)
+3. Implementation code (facades, adapters, new services)
+4. Test coverage (characterization, integration, e2e)
+5. Monitoring setup (metrics, alerts, dashboards)
+
+## Knowledge Reference
+
+Strangler fig pattern, branch by abstraction, characterization testing, incremental migration, feature flags, canary deployments, API versioning, database refactoring, microservices extraction, technical debt reduction, zero-downtime deployment